Merge branch 'master' into feature/ITBL-2397-in-app-consume

Author: davidtruong

CHANGELOG.md

@@ -15,6 +15,21 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 #### Fixed
 - nothing yet
 
+## [2.1.5](https://github.com/Iterable/iterable-android-sdk/releases/tag/2.1.5)
+ _Released on 2017-06-09_
+ 
+#### Added
+- Added full support for newly created Firebase applications
+- Added new functionality for `registerForPush` which takes in the optional pushServicePlatform
+	- `IterableConstants.MESSAGING_PLATFORM_GOOGLE` (GCM)
+	- `IterableConstants. MESSAGING_PLATFORM_FIREBASE` (FCM)
+- `IterableFirebaseInstanceIDService` handles firebase token registrations automatically on install.
+- Added in default tracked device values for `registerDeviceToken`
+
+#### Changed
+- Changed IterablePushRegistrationGCM to IterablePushRegistration so the registration class is not GCM specific.
+- Changed the disable logic to no longer enable the deviceToken prior to disabling.
+
 ## [2.1.4](https://github.com/Iterable/iterable-android-sdk/releases/tag/2.1.4)
  _Released on 2017-02-23_
 

README.md

@@ -58,6 +58,17 @@ protected void onCreate(Bundle savedInstanceState) {
 }
 ```
 
+# Firebase Messaging
+At this time there is no requirement to upgrade to FCM since Google will continue to support current versions of GCM android.
+
+If you want to use using Firebase Cloud Messaging (FCM) instead of Google Cloud Messaging (GCM) pass in `IterableConstants. MESSAGING_PLATFORM_FIREBASE` as the pushServicePlatform.
+
+```java
+public void registerForPush(String iterableAppId, String projectNumber, String pushServicePlatform) {
+```
+
+**Note**: If you are upgrading to FCM, do not downgrade back to GCM as this will cause devices to be registered for notifications twice and users will get duplicate notifications.
+
 # License
 
 The MIT License

iterableapi/build.gradle

@@ -41,7 +41,7 @@ ext {
     siteUrl = 'https://github.com/Iterable/iterable-android-sdk'
     gitUrl = 'https://github.com/Iterable/iterable-android-sdk.git'
 
-    libraryVersion = '2.1.4'
+    libraryVersion = '2.1.5'
 
     developerId = 'davidtruong'
     developerName = 'David Truong'

iterableapi/src/androidTest/java/com/iterable/iterableapi/IterablePushRegistrationTest.java

@@ -0,0 +1,74 @@
+package com.iterable.iterableapi;
+
+import android.app.Application;
+import android.content.Context;
+import android.content.SharedPreferences;
+import android.test.ApplicationTestCase;
+
+/**
+ * Tests
+ * Created by David Truong dt@iterable.com.
+ */
+public class IterablePushRegistrationTest extends ApplicationTestCase<Application> {
+    public IterablePushRegistrationTest() {
+        super(Application.class);
+    }
+
+    Context appContext;
+    IterableApi iterableApi;
+    String senderID = "111111111111";
+
+    public void setUp() throws Exception {
+        super.setUp();
+
+        appContext = getContext().getApplicationContext();
+        iterableApi = IterableApi.sharedInstanceWithApiKey(appContext, "fake_key", "test_email");
+
+        SharedPreferences sharedPref = appContext.getSharedPreferences(IterableConstants.PUSH_APP_ID, Context.MODE_PRIVATE);
+        SharedPreferences.Editor editor = sharedPref.edit();
+        editor.remove(IterableConstants.PUSH_APP_ID);
+        editor.commit();
+    }
+
+    /**
+     * Tests getting a token for GCM
+     * @throws Exception
+     */
+    public void testGetGCMToken() throws Exception {
+        IterablePushRegistration registration = new IterablePushRegistration();
+        IterablePushRegistration.PushRegistrationObject registrationObject = registration.getDeviceToken(senderID, IterableConstants.MESSAGING_PLATFORM_GOOGLE, "test_application_GCM", false);
+        assertNotNull(registrationObject.token);
+        assertEquals(IterableConstants.MESSAGING_PLATFORM_GOOGLE, registrationObject.messagingPlatform);
+
+        SharedPreferences sharedPref = appContext.getSharedPreferences(IterableConstants.PUSH_APP_ID, Context.MODE_PRIVATE);
+        String pushIdPref = sharedPref.getString(IterableConstants.PUSH_APP_ID, null);
+        assertNull(pushIdPref);
+    }
+
+    /**
+     * Tests getting a token for FCM. Defaults to GCM if the project hasn't upgraded to Firebase and included the google-services.json
+     * Checks the sharedPref flag that is set after upgrading to firebase.
+     * @throws Exception
+     */
+    public void testGetFCMToken() throws Exception {
+        IterablePushRegistration registration = new IterablePushRegistration();
+        SharedPreferences sharedPref;
+        String pushIdPref;
+        IterablePushRegistration.PushRegistrationObject registrationObject = registration.getDeviceToken(senderID, IterableConstants.MESSAGING_PLATFORM_FIREBASE, "test_application_FCM", false);
+        assertNotNull(registrationObject.token);
+        if (IterablePushRegistration.getFirebaseResouceId(appContext) != 0) {
+            //FCM registration
+            sharedPref = appContext.getSharedPreferences(IterableConstants.PUSH_APP_ID, Context.MODE_PRIVATE);
+            pushIdPref = sharedPref.getString(IterableConstants.PUSH_APP_ID, null);
+            assertNotNull(pushIdPref);
+            assertEquals(IterableConstants.MESSAGING_PLATFORM_FIREBASE, registrationObject.messagingPlatform);
+
+        } else {
+            //GCM registration
+            sharedPref = appContext.getSharedPreferences(IterableConstants.PUSH_APP_ID, Context.MODE_PRIVATE);
+            pushIdPref = sharedPref.getString(IterableConstants.PUSH_APP_ID, null);
+            assertNull(pushIdPref);
+            assertEquals(IterableConstants.MESSAGING_PLATFORM_GOOGLE, registrationObject.messagingPlatform);
+        }
+    }
+}

iterableapi/src/main/java/com/iterable/iterableapi/IterableApi.java

@@ -6,29 +6,18 @@
 import android.content.SharedPreferences;
 import android.os.Build;
 import android.os.Bundle;
-import android.util.Log;
 
 import com.google.android.gms.ads.identifier.AdvertisingIdClient;
 import com.google.android.gms.common.GooglePlayServicesNotAvailableException;
 import com.google.android.gms.common.GooglePlayServicesRepairableException;
-import com.google.android.gms.gcm.GoogleCloudMessaging;
-import com.google.android.gms.iid.InstanceID;
-import com.google.firebase.iid.FirebaseInstanceId;
 
 import org.json.JSONException;
 import org.json.JSONObject;
 
 import java.io.IOException;
 import java.text.SimpleDateFormat;
 import java.util.Date;
-import java.util.Objects;
-import java.util.Set;
 import java.util.TimeZone;
-import java.util.concurrent.Callable;
-import java.util.concurrent.ExecutionException;
-import java.util.concurrent.ExecutorService;
-import java.util.concurrent.Executors;
-import java.util.concurrent.Future;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -323,17 +312,28 @@ public boolean isIterableIntent(Intent intent) {
     }
 
     /**
-     * Registers an existing device token with Iterable.
-     * Recommended to use registerForPush if you do not already have a deviceToken
+     * Registers a device token with Iterable.
      * @param applicationName
      * @param token
      */
-    public void registerDeviceToken(final String applicationName, final String token) {
-        new Thread(new Runnable() {
-            public void run() {
-            registerDeviceToken(applicationName, token, null);
-            }
-        }).start();
+    public void registerDeviceToken(String applicationName, String token) {
+        registerDeviceToken(applicationName, token, null);
+    }
+
+    /**
+     * Registers a device token with Iterable.
+     * @param applicationName
+     * @param token
+     * @param pushServicePlatform
+     */
+    public void registerDeviceToken(final String applicationName, final String token, final String pushServicePlatform) {
+        if (token != null) {
+            new Thread(new Runnable() {
+                public void run() {
+                    registerDeviceToken(applicationName, token, pushServicePlatform, null);
+                }
+            }).start();
+        }
     }
 
     /**
@@ -501,8 +501,6 @@ public void registerForPush(String iterableAppId, String projectNumber, String p
     /**
      * Disables the device from push notifications
      *
-     * The disablePush call
-     *
      * @param iterableAppId
      * @param gcmProjectNumber
      */
@@ -513,14 +511,11 @@ public void disablePush(String iterableAppId, String gcmProjectNumber) {
     /**
      * Disables the device from push notifications
      *
-     * The disablePush call
-     *
      * @param iterableAppId
      * @param projectNumber
      * @param pushServicePlatform
      */
     public void disablePush(String iterableAppId, String projectNumber, String pushServicePlatform) {
-
         IterablePushRegistrationData data = new IterablePushRegistrationData(iterableAppId, projectNumber, pushServicePlatform, IterablePushRegistrationData.PushRegistrationAction.DISABLE);
         new IterablePushRegistration().execute(data);
     }
@@ -601,7 +596,7 @@ public void trackInAppClick(String messageId, int buttonIndex) {
         JSONObject requestJSON = new JSONObject();
 
         try {
-            requestJSON.put(IterableConstants.KEY_EMAIL, _email);
+            addEmailOrUserIdToJson(requestJSON);
             requestJSON.put(IterableConstants.KEY_MESSAGE_ID, messageId);
             requestJSON.put(IterableConstants.ITERABLE_IN_APP_BUTTON_INDEX, buttonIndex);
         }
@@ -696,6 +691,48 @@ protected void disablePush(String token) {
         sendPostRequest(IterableConstants.ENDPOINT_DISABLE_DEVICE, requestJSON);
     }
 
+    /**
+     * Registers the GCM registration ID with Iterable.
+     * @param applicationName
+     * @param token
+     * @param pushServicePlatform
+     * @param dataFields
+     */
+    protected void registerDeviceToken(String applicationName, String token, String pushServicePlatform, JSONObject dataFields) {
+        String platform = IterableConstants.MESSAGING_PLATFORM_GOOGLE;
+
+        JSONObject requestJSON = new JSONObject();
+        try {
+            addEmailOrUserIdToJson(requestJSON);
+
+            if (dataFields == null) {
+                dataFields = new JSONObject();
+            }
+            if (pushServicePlatform != null) {
+                dataFields.put(IterableConstants.FIREBASE_COMPATIBLE, pushServicePlatform.equalsIgnoreCase(IterableConstants.MESSAGING_PLATFORM_FIREBASE));
+            }
+            dataFields.put(IterableConstants.DEVICE_BRAND, Build.BRAND); //brand: google
+            dataFields.put(IterableConstants.DEVICE_MANUFACTURER, Build.MANUFACTURER); //manufacturer: samsung
+            dataFields.putOpt(IterableConstants.DEVICE_ADID, getAdvertisingId()); //ADID: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
+            dataFields.put(IterableConstants.DEVICE_SYSTEM_NAME, Build.DEVICE); //device name: toro
+            dataFields.put(IterableConstants.DEVICE_SYSTEM_VERSION, Build.VERSION.RELEASE); //version: 4.0.4
+            dataFields.put(IterableConstants.DEVICE_MODEL, Build.MODEL); //device model: Galaxy Nexus
+            dataFields.put(IterableConstants.DEVICE_SDK_VERSION, Build.VERSION.SDK_INT); //sdk version/api level: 15
+
+            JSONObject device = new JSONObject();
+            device.put(IterableConstants.KEY_TOKEN, token);
+            device.put(IterableConstants.KEY_PLATFORM, platform);
+            device.put(IterableConstants.KEY_APPLICATION_NAME, applicationName);
+            device.putOpt(IterableConstants.KEY_DATA_FIELDS, dataFields);
+            requestJSON.put(IterableConstants.KEY_DEVICE, device);
+
+        } catch (JSONException e) {
+            e.printStackTrace();
+        }
+
+        sendPostRequest(IterableConstants.ENDPOINT_REGISTER_DEVICE_TOKEN, requestJSON);
+    }
+
 //---------------------------------------------------------------------------------------
 //endregion
 
@@ -732,44 +769,6 @@ private void tryTrackNotifOpen(Intent calledIntent) {
         }
     }
 
-    /**
-     * Registers the GCM registration ID with Iterable.
-     * @param applicationName
-     * @param token
-     * @param dataFields
-     */
-    private void registerDeviceToken(String applicationName, String token, JSONObject dataFields) {
-        String platform = IterableConstants.MESSAGING_PLATFORM_GOOGLE;
-
-        JSONObject requestJSON = new JSONObject();
-        try {
-            addEmailOrUserIdToJson(requestJSON);
-
-            if (dataFields == null) {
-                dataFields = new JSONObject();
-                dataFields.put("brand", Build.BRAND); //brand: google
-                dataFields.put("manufacturer", Build.MANUFACTURER); //manufacturer: samsung
-                dataFields.putOpt("advertisingId", getAdvertisingId()); //ADID: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
-                dataFields.put("systemName", Build.DEVICE); //device name: toro
-                dataFields.put("systemVersion", Build.VERSION.RELEASE); //version: 4.0.4
-                dataFields.put("model", Build.MODEL); //device model: Galaxy Nexus
-                dataFields.put("sdkVersion", Build.VERSION.SDK_INT); //sdk version/api level: 15
-            }
-
-            JSONObject device = new JSONObject();
-            device.put(IterableConstants.KEY_TOKEN, token);
-            device.put(IterableConstants.KEY_PLATFORM, platform);
-            device.put(IterableConstants.KEY_APPLICATION_NAME, applicationName);
-            device.putOpt(IterableConstants.KEY_DATA_FIELDS, dataFields);
-            requestJSON.put(IterableConstants.KEY_DEVICE, device);
-
-        } catch (JSONException e) {
-            e.printStackTrace();
-        }
-
-        sendPostRequest(IterableConstants.ENDPOINT_REGISTER_DEVICE_TOKEN, requestJSON);
-    }
-
     /**
      * Sends the POST request to Iterable.
      * Performs network operations on an async thread instead of the main thread.

iterableapi/src/main/java/com/iterable/iterableapi/IterableConstants.java

@@ -48,7 +48,7 @@ public final class IterableConstants {
     public static final String PUSH_GCM_PROJECT_NUMBER          = "GCMProjectNumber";
     public static final String PUSH_DISABLE_AFTER_REGISTRATION  = "DisableAfterRegistration";
 
-    public static final String MESSAGING_PUSH_SERVICE_PLATFORM = "PushServicePlatform";
+    public static final String MESSAGING_PUSH_SERVICE_PLATFORM  = "PushServicePlatform";
     public static final String MESSAGING_PLATFORM_GOOGLE        = "GCM";
     public static final String MESSAGING_PLATFORM_FIREBASE      = "FCM";
     public static final String MESSAGING_PLATFORM_AMAZON        = "ADM";
@@ -59,14 +59,30 @@ public final class IterableConstants {
     public static final String ITERABLE_DATA_TITLE  = "title";
     public static final String ITERABLE_DATA_SOUND  = "sound";
 
+    //Device
+    public static final String DEVICE_BRAND             = "brand";
+    public static final String DEVICE_MANUFACTURER      = "manufacturer";
+    public static final String DEVICE_ADID              = "advertisingId";
+    public static final String DEVICE_SYSTEM_NAME       = "systemName";
+    public static final String DEVICE_SYSTEM_VERSION    = "systemVersion";
+    public static final String DEVICE_MODEL             = "model";
+    public static final String DEVICE_SDK_VERSION       = "sdkVersion";
+
     public static final String INSTANCE_ID_CLASS        = "com.google.android.gms.iid.InstanceID";
-    public static final String FIREBASE_MESSAGING_CLASS = "com.google.firebase.messaging.FirebaseMessaging";
     public static final String ICON_FOLDER_IDENTIFIER   = "drawable";
     public static final String NOTIFICATION_ICON_NAME   = "iterable_notification_icon";
     public static final String NOTIFICATION_COLOR       = "iterable_notification_color";
     public static final String DEFAULT_SOUND            = "default";
     public static final String SOUND_FOLDER_IDENTIFIER  = "raw";
     public static final String ANDROID_RESOURCE_PATH    = "android.resource://";
+    public static final String ANDROID_STRING    = "string";
+
+    //Firebase
+    public static final String FIREBASE_RESOURCE_ID     = "firebase_database_url";
+    public static final String FIREBASE_MESSAGING_CLASS = "com.google.firebase.messaging.FirebaseMessaging";
+    public static final String FIREBASE_COMPATIBLE      = "firebaseCompatible";
+    public static final String FIREBASE_TOKEN_TYPE      = "tokenRegistrationType";
+    public static final String FIREBASE_INITIAL_UPGRADE = "initialFirebaseUpgrade";
 
     public static final String ITBL_DEEPLINK_IDENTIFIER = "/a/[A-Za-z0-9]+";
     public static final String DATEFORMAT = "yyyy-MM-dd HH:mm:ss";