Merge pull request #29 from comapi/dev

Deep links support for latest Android OS

Author: MarcinSwierczek

COMAPI/foundation/build.gradle

@@ -67,7 +67,7 @@ dependencies {
 
 ext {
     PUBLISH_GROUP_ID = 'com.comapi'
-    PUBLISH_VERSION = '1.4.0'
+    PUBLISH_VERSION = '1.5.0'
     PUBLISH_ARTIFACT_ID = 'foundation'
 }
 

COMAPI/foundation/src/main/AndroidManifest.xml

@@ -32,6 +32,8 @@
     <!-- SDK will receive a notification when phone finish booting. This is to restore the services and keep SDK responsive -->
     <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
 
+    <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
+
     <application>
 
         <!-- Broadcast receiver for boot completed broadcasts to resume work after device restart. -->
@@ -45,9 +47,6 @@
             </intent-filter>
         </receiver>
 
-        <receiver android:name="com.comapi.internal.receivers.NotificationClickReceiver"
-            android:exported="false"/>
-
         <!-- Service to handle Instance ID service token refresh notifications for FCM security. -->
         <service
             android:name="com.comapi.internal.push.IDService"

COMAPI/foundation/src/main/java/com/comapi/BaseClient.java

@@ -21,13 +21,17 @@
 package com.comapi;
 
 import android.app.Application;
+import android.content.ActivityNotFoundException;
 import android.content.Context;
+import android.content.Intent;
+import android.net.Uri;
 import android.os.Handler;
 import android.os.Looper;
-import androidx.annotation.NonNull;
 import android.text.TextUtils;
 import android.util.Pair;
 
+import androidx.annotation.NonNull;
+
 import com.comapi.internal.CallbackAdapter;
 import com.comapi.internal.ComapiException;
 import com.comapi.internal.IClient;
@@ -46,7 +50,12 @@
 import com.comapi.internal.network.SessionCreateManager;
 import com.comapi.internal.network.api.RestApi;
 import com.comapi.internal.network.sockets.SocketController;
+import com.comapi.internal.push.PushDataKeys;
 import com.comapi.internal.push.PushManager;
+import com.google.firebase.messaging.RemoteMessage;
+
+import org.json.JSONException;
+import org.json.JSONObject;
 
 import java.io.File;
 import java.util.concurrent.CopyOnWriteArrayList;
@@ -214,8 +223,6 @@ restApi, new Handler(mainLooper),
                 lifecycleListeners.add(socketController.createLifecycleListener());
                 initialiseLifecycleObserver(application);
 
-                pushMgr.setService(service);
-
                 sub.onNext(state.compareAndSet(GlobalState.INITIALISING, GlobalState.INITIALISED));
                 sub.onCompleted();
 
@@ -407,4 +414,83 @@ public void addListener(StateListener listener) {
     public void removeListener(StateListener listener) {
         listenerListAdapter.removeListener(listener);
     }
+
+    protected Observable<PushHandleResult> handlePush(Context activityContext, Intent i, boolean startActivity) {
+        if (i.hasExtra(PushDataKeys.KEY_PUSH_DEEP_LINK)) {
+            JSONObject deepLinkData;
+            try {
+                deepLinkData = new JSONObject((String) i.getSerializableExtra(PushDataKeys.KEY_PUSH_DEEP_LINK));
+                if (deepLinkData.has(PushDataKeys.KEY_PUSH_URL)) {
+                    String url = deepLinkData.getString(PushDataKeys.KEY_PUSH_URL);
+                    Observable<Boolean> tracking;
+                    if (deepLinkData.has(PushDataKeys.KEY_PUSH_TRACKING_URL)) {
+                        String trackingUrl = deepLinkData.getString(PushDataKeys.KEY_PUSH_TRACKING_URL);
+                        tracking = service.sendClickData(trackingUrl);
+                    } else {
+                        tracking = Observable.fromCallable(() -> false);
+                    }
+                    return Observable.fromCallable(() -> {
+                        if (startActivity) {
+                            Intent intent = new Intent();
+                            intent.setData(Uri.parse(url));
+                            intent.setAction(Intent.ACTION_VIEW);
+                            intent.addCategory(Intent.CATEGORY_DEFAULT);
+                            intent.addCategory(Intent.CATEGORY_BROWSABLE);
+                            try {
+                                activityContext.startActivity(intent);
+                                return true;
+                            } catch (ActivityNotFoundException e) {
+                                return false;
+                            }
+                        } else {
+                            return false;
+                        }
+
+                    }).flatMap(isStartActivitySuccessful -> tracking.map(isTrackingSuccessful -> new PushHandleResult(url, null, isTrackingSuccessful, isStartActivitySuccessful)));
+                }
+            } catch (Exception e) {
+                log.f(e.getMessage(), e);
+                return Observable.error(e);
+            }
+        } else if (i.hasExtra(PushDataKeys.KEY_PUSH_DATA)) {
+            try {
+                JSONObject data = new JSONObject((String) i.getSerializableExtra(PushDataKeys.KEY_PUSH_DATA));
+                return  Observable.fromCallable(() -> new PushHandleResult(null, data, false, false));
+            } catch (Exception e) {
+                return  Observable.error(e);
+            }
+        }
+
+        return  Observable.fromCallable(() -> new PushHandleResult(null, null, false, false));
+    }
+
+    /**
+     * Parse Firebase Push RemoteNotification to extract deep link url or data send with Dotdigital program
+     * @param message RemoteMessage received in a push handler implementing PushMessageListener registered with SDK initialisation call.
+     * @return parsed deep link url or data
+     */
+    static public PushDetails parsePushMessage(RemoteMessage message) throws JSONException {
+        RemoteMessage.Notification n = message.getNotification();
+        if (message.getData().containsKey(PushDataKeys.KEY_PUSH_DEEP_LINK)) {
+            String deepLinkDataJson = message.getData().get(PushDataKeys.KEY_PUSH_DEEP_LINK);
+            if (deepLinkDataJson != null) {
+                JSONObject deepLinkData = new JSONObject(deepLinkDataJson);
+                if (deepLinkData.has(PushDataKeys.KEY_PUSH_URL)) {
+                    String url = deepLinkData.getString(PushDataKeys.KEY_PUSH_URL);
+                    return new PushDetails(url, null);
+                }
+            } else {
+                return new PushDetails(null, null);
+            }
+        } else if (message.getData().containsKey(PushDataKeys.KEY_PUSH_DATA)) {
+            String dataJson = message.getData().get(PushDataKeys.KEY_PUSH_DATA);
+            if (dataJson != null) {
+                JSONObject data = new JSONObject(dataJson);
+                return  new PushDetails(null, data);
+            } else {
+                return new PushDetails(null, null);
+            }
+        }
+        return new PushDetails(null, null);
+    }
 }

COMAPI/foundation/src/main/java/com/comapi/BaseComapi.java

@@ -38,7 +38,7 @@ class BaseComapi {
     /**
      * Version of the ComapiImpl SDK MAJOR.MINOR.PATCH.BUILD
      */
-    private final static String SDK_VERSION = "1.4.0";
+    private final static String SDK_VERSION = "1.5.0";
 
     private static final Set<String> apiSpaces = Collections.synchronizedSet(new HashSet<String>());
 

COMAPI/foundation/src/main/java/com/comapi/ComapiClient.java

@@ -22,7 +22,10 @@
 
 import android.app.Application;
 import android.content.Context;
+import android.content.Intent;
+
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 
 import com.comapi.internal.CallbackAdapter;
 
@@ -110,4 +113,19 @@ public void copyLogs(@NonNull File file, Callback<File> callback) {
     public void clean(@NonNull Context context) {
         super.clean(context);
     }
+
+    /**
+     * Handles click push notification tracking and opens deep link
+     * @param activityContext pass calling activity here
+     * @param i intent that is retrieved by getIntent() in onCreate or intent passed to onNewIntent lifecycle callbacks
+     * @param startActivity should start activity from deep link url
+     * @param callback Contains result of the push notification processing
+     *                 getUrl - url passed as a deep link with the notification by dotdigital program
+     *                 getData - data passed with the notification by dotdigital program
+     *                 isTrackingSuccessful - was call to record a click for analytics successful;
+     *                 isStartActivitySuccessful - was starting activity from url successful
+     */
+    public void handlePushNotification(@NonNull Context activityContext, @NonNull Intent i, boolean startActivity, @Nullable Callback<PushHandleResult> callback) {
+        adapter.adapt(super.handlePush(activityContext, i, startActivity),callback);
+    }
 }

COMAPI/foundation/src/main/java/com/comapi/PushDetails.java

@@ -0,0 +1,28 @@
+package com.comapi;
+
+import androidx.annotation.Nullable;
+
+import org.json.JSONObject;
+
+public class PushDetails {
+
+    @Nullable
+    private final String url;
+    @Nullable
+    private final JSONObject data;
+
+    public PushDetails(@Nullable String url, @Nullable JSONObject data) {
+        this.url = url;
+        this.data = data;
+    }
+
+    @Nullable
+    public String getUrl() {
+        return url;
+    }
+
+    @Nullable
+    public JSONObject getData() {
+        return data;
+    }
+}

COMAPI/foundation/src/main/java/com/comapi/PushHandleResult.java

@@ -0,0 +1,25 @@
+package com.comapi;
+
+import androidx.annotation.Nullable;
+
+import org.json.JSONObject;
+
+public class PushHandleResult extends PushDetails {
+
+    private final boolean isClickRecorded;
+    private final boolean isDeepLinkCalled;
+
+    public PushHandleResult(@Nullable String url, @Nullable JSONObject data, boolean isClickRecorded, boolean isDeepLinkCalled) {
+        super(url, data);
+        this.isClickRecorded = isClickRecorded;
+        this.isDeepLinkCalled = isDeepLinkCalled;
+    }
+
+    public boolean isClickRecorded() {
+        return isClickRecorded;
+    }
+
+    public boolean isDeepLinkCalled() {
+        return isDeepLinkCalled;
+    }
+}

COMAPI/foundation/src/main/java/com/comapi/RxComapiClient.java

@@ -22,6 +22,8 @@
 
 import android.app.Application;
 import android.content.Context;
+import android.content.Intent;
+
 import androidx.annotation.NonNull;
 
 import com.comapi.internal.CallbackAdapter;
@@ -137,4 +139,19 @@ void addLifecycleListener(LifecycleListener listener) {
     protected RxComapiService getComapiService() {
         return service;
     }
+
+    /**
+     * Handles click push notification tracking and opens deep link
+     * @param activityContext pass calling activity here
+     * @param i intent that is retrieved by getIntent() in onCreate or intent passed to onNewIntent lifecycle callbacks
+     * @param startActivity should start activity from deep link url
+     * @return Observable containing result of the push notification processing
+     *         getUrl - url passed as a deep link with the notification
+     *         getData - data passed with the notification by dotdigital program
+     *         isTrackingSuccessful - was call to record a click for analytics successful;
+     *         isStartActivitySuccessful - was starting activity from url successful
+     */
+    public Observable<PushHandleResult> handlePushNotification(Context activityContext, Intent i, boolean startActivity) {
+        return super.handlePush(activityContext, i, startActivity);
+    }
 }

COMAPI/foundation/src/main/java/com/comapi/internal/IClient.java

@@ -21,6 +21,7 @@
 package com.comapi.internal;
 
 import android.content.Context;
+
 import androidx.annotation.NonNull;
 
 import com.comapi.ComapiClient;