Merge pull request #70 from parley-messaging/develop

3.11.0

Author: alexkok

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 3.11.0 - Released 18 Sep 2024
+
+- [Chat Message] Fixed an issue causing agent images not to load since 3.10.0.
+- [Network] Added support for providing a custom network session to prevent using Parley's default implementation. Check out the [Advanced - Network](https://github.com/parley-messaging/android-library?tab=readme-ov-file#network) section to use this.
+- [Network] *Important* `ParleyNetwork.setInterceptor()` is removed. Use a custom network session instead, or provide the interceptor with the default `RetrofitNetworkSession` of Parley, as described in the [Advanced - Network](https://github.com/parley-messaging/android-library?tab=readme-ov-file#network) section.
+
 ## 3.10.0 - Released 30 Jul 2024
 
 - [Source] Parley now uses Kotlin at certain parts. Make sure to configure Kotlin in your project in case it doesn't use Kotlin yet.

Gemfile.lock

@@ -163,8 +163,8 @@ GEM
       trailblazer-option (>= 0.1.1, < 0.2.0)
       uber (< 0.2.0)
     retriable (3.1.2)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
+    rexml (3.3.6)
+      strscan
     rouge (2.0.7)
     ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
@@ -193,13 +193,13 @@ GEM
     unicode-display_width (1.8.0)
     webrick (1.7.0)
     word_wrap (1.0.0)
-    xcodeproj (1.21.0)
+    xcodeproj (1.25.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)
       colored2 (~> 3.1)
       nanaimo (~> 0.3.0)
-      rexml (~> 3.2.4)
+      rexml (>= 3.3.2, < 4.0)
     xcpretty (0.3.0)
       rouge (~> 2.0.7)
     xcpretty-travis-formatter (1.0.1)

README.md

@@ -57,7 +57,7 @@ allprojects {
 To integrate Parley, specify the following in your `app/build.gradle` file:
 
 ```groovy
-implementation 'com.github.parley-messaging:android-library:3.10.0'
+implementation 'com.github.parley-messaging:android-library:3.11.0'
 ```
 
 ### Upgrading
@@ -222,10 +222,36 @@ Parley.setNetwork(network);
 
 **Custom interceptor**
 
-If needed to apply a custom interceptor, for example when the headers could be dynamic. This can be done by creating an `okhttp3.Interceptor` and attaching that to the ParleyNetwork:
+If the only need is to apply a custom interceptor to the default network session of Parley, for example when using dynamic headers. It's possible to create an `okhttp3.Interceptor`, create the default `RetrofitNetworkSession` with the interceptor and provide that to the `ParleyNetwork` configuration.
 
 ```java
-network.setInterceptor(interceptor);
+ParleyNetworkSession networkSession = new RetrofitNetworkSession(interceptor);
+ParleyNetwork network = new ParleyNetwork(
+        "https://api.parley.nu/",
+        "clientApi/v1.7/",
+        ApiVersion.V1_7,
+        R.xml.parley_network_security_config,
+        networkSession
+);
+
+Parley.setNetwork(network);
+```
+
+**Custom network config**
+
+If using a custom interceptor is not enough, it's also possible to fully create you own `ParleyNetworkSession` implementation. You'll need to implement the `ParleyNetworkSession` interface. Then provide the custom `ParleyNetworkSession` to the `ParleyNetwork` configuration:
+
+```java
+ParleyNetworkSession networkSession = new CustomNetworkSession();
+ParleyNetwork network = new ParleyNetwork(
+        "https://api.parley.nu/",
+        "clientApi/v1.7/",
+        ApiVersion.V1_7,
+        R.xml.parley_network_security_config,
+        networkSession
+);
+
+Parley.setNetwork(network);
 ```
 
 **Custom SSL pinning**

app/build.gradle

@@ -9,7 +9,7 @@ android {
         minSdkVersion 21
         targetSdk 34
         versionCode 1
-        versionName "3.10.0"
+        versionName "3.11.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
     buildTypes {
@@ -42,7 +42,7 @@ dependencies {
     implementation "com.google.firebase:firebase-messaging:23.4.1"
 
     // Library
-//    implementation 'com.github.parley-messaging:android-library:3.10.0' // Remote
+//    implementation 'com.github.parley-messaging:android-library:3.11.0' // Remote
     implementation project(':parley') // Local
 
     // Tests

app/src/main/java/nu/parley/ui/IdentifierActivity.java

@@ -10,11 +10,8 @@
 import android.widget.ProgressBar;
 import android.widget.TextView;
 
-import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 
-import com.google.android.gms.tasks.OnCompleteListener;
-import com.google.android.gms.tasks.Task;
 import com.google.firebase.messaging.FirebaseMessaging;
 
 import java.security.InvalidKeyException;

parley/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'maven-publish'
 apply plugin: 'org.jetbrains.kotlin.android'
 
 group = 'com.github.parley-messaging'
-version = '3.10.0'
+version = '3.11.0'
 
 android {
     namespace 'nu.parley.android'
@@ -61,7 +61,10 @@ dependencies {
 
     // Retrofit
     implementation "com.squareup.retrofit2:retrofit:2.9.0"
-    implementation "com.squareup.retrofit2:converter-gson:2.9.0"
+    implementation 'com.squareup.retrofit2:converter-scalars:2.9.0'
+
+    // Gson
+    implementation "com.google.code.gson:gson:2.11.0"
 
     // Glide
     implementation "com.github.bumptech.glide:glide:4.15.1"

parley/src/main/java/nu/parley/android/Parley.java

@@ -581,7 +581,7 @@ private void configureI(Context context, String secret, @Nullable String uniqueD
         this.secret = secret;
 
         if (uniqueDeviceIdentifier == null) {
-            this.uniqueDeviceIdentifier = DeviceRepository.getDeviceId(context);
+            this.uniqueDeviceIdentifier = DeviceRepository.Companion.getDeviceId(context);
         } else {
             this.uniqueDeviceIdentifier = uniqueDeviceIdentifier;
         }

parley/src/main/java/nu/parley/android/ParleyNetwork.java

@@ -1,14 +1,13 @@
 package nu.parley.android;
 
-import androidx.annotation.Nullable;
 import androidx.annotation.XmlRes;
 
-import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 
 import nu.parley.android.data.model.ApiVersion;
-import okhttp3.Interceptor;
+import nu.parley.android.data.net.service.RetrofitNetworkSession;
+import nu.parley.android.data.net.service.ParleyNetworkSession;
 
 /**
  * Provides the network configuration for Parley.
@@ -20,12 +19,11 @@ public final class ParleyNetwork {
 
     public final String url;
     public final Map<String, String> headers;
-    @Nullable
-    public Interceptor interceptor;
     @XmlRes
     final Integer securityConfigResourceFile;
     public final String path;
     public final ApiVersion apiVersion;
+    public final ParleyNetworkSession networkSession;
 
     /**
      * Applies the default network settings of Parley.
@@ -36,6 +34,7 @@ public final class ParleyNetwork {
         this.apiVersion = ApiVersion.V1_7;
         this.securityConfigResourceFile = R.xml.parley_network_security_config;
         this.headers = new HashMap<>();
+        this.networkSession = new RetrofitNetworkSession();
     }
 
     /**
@@ -45,7 +44,17 @@ public final class ParleyNetwork {
      */
     @SuppressWarnings("unused")
     public ParleyNetwork(String url, String path, ApiVersion apiVersion, @XmlRes Integer securityConfigResourceFile) {
-        this(url, path, apiVersion, securityConfigResourceFile, new HashMap<String, String>());
+        this(url, path, apiVersion, securityConfigResourceFile, new HashMap<String, String>(), new RetrofitNetworkSession());
+    }
+
+    /**
+     * Convenience for ParleyNetwork(url, path, apiVersion, securityConfigResourceFile, parleyNetworkSession).
+     *
+     * @see #ParleyNetwork(String, String, ApiVersion, Integer, Map)
+     */
+    @SuppressWarnings("unused")
+    public ParleyNetwork(String url, String path, ApiVersion apiVersion, @XmlRes Integer securityConfigResourceFile, ParleyNetworkSession parleyNetworkSession) {
+        this(url, path, apiVersion, securityConfigResourceFile, new HashMap<String, String>(), parleyNetworkSession);
     }
 
     /**
@@ -67,18 +76,29 @@ public ParleyNetwork(String url, String path, ApiVersion apiVersion, @XmlRes Int
         this.apiVersion = apiVersion;
         this.securityConfigResourceFile = securityConfigResourceFile;
         this.headers = headers;
+        this.networkSession = new RetrofitNetworkSession();
     }
 
-
     /**
-     * Sets the network interceptor for the Parley client.
+     * Apply custom network settings. Parley requires SSL pinning, so it expects a valid security config file.
      *
-     * @param interceptor the interceptor to set
-     * @return the current instance of the Parley network configuration
+     * <p>
+     * <b>Note:</b>* Make sure to add the reference to the `AndroidManifest.xml` as well.
+     * </p>
+     *
+     * @param url                        Url to your Parley backend service.
+     * @param path                       Path to the Parley chat API.
+     * @param apiVersion                 API version of the Parley chat API. Note that the `path` should use the same api version as well.
+     * @param securityConfigResourceFile Android Network Security Configuration file xml resource with SSL Pinning configuration.
+     * @param headers                    Additional headers to append to each network request of Parley.
      */
-    public ParleyNetwork setInterceptor(Interceptor interceptor) {
-        this.interceptor = interceptor;
-        return this;
+    public ParleyNetwork(String url, String path, ApiVersion apiVersion, @XmlRes Integer securityConfigResourceFile, Map<String, String> headers, ParleyNetworkSession parleyNetworkSession) {
+        this.url = url;
+        this.path = path;
+        this.apiVersion = apiVersion;
+        this.securityConfigResourceFile = securityConfigResourceFile;
+        this.headers = headers;
+        this.networkSession = parleyNetworkSession;
     }
 
     /**

parley/src/main/java/nu/parley/android/data/model/Message.java

@@ -255,11 +255,6 @@ public Media getMedia() {
 
     @Nullable
     public String getImageUrl() {
-        if (image != null) {
-            // Legacy: Messages from clientApi 1.5 and lower
-            return image;
-        }
-
         if (getMedia() != null && getMedia().getMimeType().isImage()) {
             if (localUrl == null) {
                 // Messages from clientApi 1.6 and higher
@@ -270,6 +265,12 @@ public String getImageUrl() {
             }
         }
 
+        if (image != null) {
+            // Legacy: Messages from clientApi 1.5 and lower.
+            // Legacy: Agent messages have both media and image filled.
+            return image;
+        }
+
         return null;
     }
 

parley/src/main/java/nu/parley/android/data/net/Connectivity.java

@@ -18,12 +18,14 @@
 
 import nu.parley.android.Parley;
 import nu.parley.android.data.net.response.ParleyErrorResponse;
+import nu.parley.android.data.net.service.RetrofitNetworkSession;
+import nu.parley.android.data.net.service.ParleyNetworkSession;
 import okhttp3.Interceptor;
 import okhttp3.OkHttpClient;
 import okhttp3.Request;
 import okhttp3.Response;
 import retrofit2.Retrofit;
-import retrofit2.converter.gson.GsonConverterFactory;
+import retrofit2.converter.scalars.ScalarsConverterFactory;
 
 public final class Connectivity {
 
@@ -38,7 +40,7 @@ public final class Connectivity {
     public static Retrofit getRetrofit() {
         Retrofit.Builder retrofitBuilder = new Retrofit.Builder()
                 .baseUrl(Parley.getInstance().getNetwork().getBaseUrl())
-                .addConverterFactory(GsonConverterFactory.create())
+                .addConverterFactory(ScalarsConverterFactory.create())
                 .client(getOkHttpClient());
 
         return retrofitBuilder.build();
@@ -116,10 +118,13 @@ public static Map<String, String> getParleyHeaders() {
      * @return the OkHttpClient.Builder with the added interceptor.
      */
     private static OkHttpClient.Builder addInterceptor(OkHttpClient.Builder builder) {
-        if (Parley.getInstance().getNetwork().interceptor != null) {
-            return builder.addInterceptor(Parley.getInstance().getNetwork().interceptor);
-        }
-        return builder;
+        ParleyNetworkSession networkSession = Parley.getInstance().getNetwork().networkSession;
+
+        if (!(networkSession instanceof RetrofitNetworkSession)) return builder;
+        Interceptor interceptor = ((RetrofitNetworkSession) networkSession).getInterceptor();
+
+        if (interceptor == null) return builder;
+        return builder.addInterceptor(interceptor);
     }
 
     public static String toMediaUrl(String mediaId) {