Adds in option to toggle logging for debugMode.

davidtruong · davidtruong · commit 98d24c2781bb · 2016-06-30T16:32:12.000-07:00
Changed sharedInstanceWithApiKey to be able to take in a more generic context rather than an Activity. Added in helper functions to handle passing in new Intents to track pushOpens (onNewIntent &amp; isIterableIntent)

Deprecated registerForPush/disablePush (String, String) in favor of (String, double)
Code cleanup / review feedback
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterableApi.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterableApi.java
@@ -5,7 +5,6 @@
 import android.content.Intent;
 import android.content.SharedPreferences;
 import android.os.Bundle;
-import android.util.Log;
 
 import org.json.JSONException;
 import org.json.JSONObject;
@@ -28,6 +27,7 @@ public class IterableApi {
     private String _apiKey;
     private String _email;
 
+    private boolean _debugMode;
     private Bundle _payloadData;
     private IterableNotificationData _notificationData;
 
@@ -41,24 +41,98 @@ private IterableApi(Context context, String apiKey, String email){
      * @param currentActivity The current activity
      * @return stored instance of IterableApi
      */
-    public static IterableApi sharedInstanceWithApiKey(Activity currentActivity, String apiKey, String email)
+    public static IterableApi sharedInstanceWithApiKey(Activity currentActivity, String apiKey,
+                                                       String email)
     {
-        Context applicationContext = currentActivity.getApplicationContext();
+        return sharedInstanceWithApiKey(currentActivity, apiKey, email, false);
+    }
+
+    /**
+     * Returns a shared instance of IterableApi. Updates the client data if an instance already exists.
+     * Should be called whenever the app is opened.
+     * Allows the IterableApi to be intialized with debugging enabled
+     * @param currentActivity The current activity
+     * @return stored instance of IterableApi
+     */
+    public static IterableApi sharedInstanceWithApiKey(Activity currentActivity, String apiKey,
+                                                       String email, boolean debugMode)
+    {
+        return sharedInstanceWithApiKey((Context) currentActivity, apiKey, email, debugMode);
+    }
+
+    /**
+     * Returns a shared instance of IterableApi. Updates the client data if an instance already exists.
+     * Should be called whenever the app is opened.
+     * @param currentActivity The current activity
+     * @return stored instance of IterableApi
+     */
+    public static IterableApi sharedInstanceWithApiKey(Context currentActivity, String apiKey,
+                                                       String email)
+    {
+        return sharedInstanceWithApiKey(currentActivity, apiKey, email, false);
+    }
+
+    /**
+     * Returns a shared instance of IterableApi. Updates the client data if an instance already exists.
+     * Should be called whenever the app is opened.
+     * Allows the IterableApi to be intialized with debugging enabled
+     * @param currentContext The current context
+     * @return stored instance of IterableApi
+     */
+    public static IterableApi sharedInstanceWithApiKey(Context currentContext, String apiKey,
+                                                       String email, boolean debugMode)
+    {
+        Context applicationContext = currentContext.getApplicationContext();
 
-        if (sharedInstance == null)
-        {
+        if (sharedInstance == null) {
             sharedInstance = new IterableApi(applicationContext, apiKey, email);
         } else{
             sharedInstance.updateData(applicationContext, apiKey, email);
         }
 
-        Intent calledIntent = currentActivity.getIntent();
-        sharedInstance.setPayloadData(calledIntent);
-        sharedInstance.tryTrackNotifOpen(calledIntent);
+        if (currentContext instanceof Activity) {
+            Activity currentActivity = (Activity) currentContext;
+            Intent calledIntent = currentActivity.getIntent();
+            if (isIterableIntent(calledIntent)) {
+                sharedInstance.setPayloadData(calledIntent);
+                sharedInstance.tryTrackNotifOpen(calledIntent);
+            }
+        } else {
+            IterableLogger.w(TAG, "Notification Opens will not be tracked: "+
+                "sharedInstanceWithApiKey called with a Context that is not an instance of Activity. " +
+                "Pass in an Activity to IterableApi.sharedInstanceWithApiKey to enable open tracking" +
+                "or call onNewIntent when a new Intent is received.");
+        }
+
+        sharedInstance.setDebugMode(debugMode);
 
         return sharedInstance;
     }
 
+    public static void onNewIntent(Intent intent) {
+        if (sharedInstance == null) {
+            IterableLogger.w(TAG, "sharedInstanceWithApiKey needs to be called before onNewIntent " +
+                    "can be called");
+            return;
+        } else if (isIterableIntent(intent)) {
+            sharedInstance.setPayloadData(intent);
+            sharedInstance.tryTrackNotifOpen(intent);
+        } else {
+            IterableLogger.d(TAG, "onNewIntent not triggered by an Iterable notification");
+        }
+
+    }
+
+    public static boolean isIterableIntent(Intent intent) {
+        if (intent != null) {
+            Bundle extras = intent.getExtras();
+            if (extras != null && extras.containsKey(IterableConstants.ITERABLE_DATA_KEY)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     private void updateData(Context context, String apiKey, String email) {
         this._applicationContext = context;
         this._apiKey = apiKey;
@@ -69,6 +143,14 @@ protected Context getMainActivityContext() {
         return _applicationContext;
     }
 
+    protected void setDebugMode(boolean debugMode) {
+        _debugMode = debugMode;
+    }
+
+    protected boolean getDebugMode() {
+        return _debugMode;
+    }
+
     /**
      * Sets the icon to be displayed in notifications.
      * The icon name should match the resource name stored in the /res/drawable directory.
@@ -95,18 +177,18 @@ protected static String getNotificationIcon(Context context) {
      * Automatically generates a GCM token and registers it with Iterable.
      * @param iterableAppId The applicationId of the Iterable Push Integration
      *                      - https://app.iterable.com/integrations/mobilePush
-     * @param gcmProjectId  The Google Project Number
+     * @param gcmProjectNumber  The Google Project Number
      *                       - https://console.developers.google.com/iam-admin/settings
      */
-    public void registerForPush(String iterableAppId, String gcmProjectId) {
-        registerForPush(iterableAppId, gcmProjectId, false);
+    public void registerForPush(String iterableAppId, double gcmProjectNumber) {
+        registerForPush(iterableAppId, gcmProjectNumber, false);
     }
 
-    protected void registerForPush(String iterableAppId, String gcmProjectId, boolean disableAfterRegistration) {
+    protected void registerForPush(String iterableAppId, double gcmProjectNumber, boolean disableAfterRegistration) {
         Intent pushRegistrationIntent = new Intent(_applicationContext, IterablePushReceiver.class);
         pushRegistrationIntent.setAction(IterableConstants.ACTION_PUSH_REGISTRATION);
         pushRegistrationIntent.putExtra(IterableConstants.PUSH_APPID, iterableAppId);
-        pushRegistrationIntent.putExtra(IterableConstants.PUSH_PROJECTID, gcmProjectId);
+        pushRegistrationIntent.putExtra(IterableConstants.PUSH_PROJECT_NUMBER, gcmProjectNumber);
         pushRegistrationIntent.putExtra(IterableConstants.PUSH_DISABLE_AFTER_REGISTRATION, disableAfterRegistration);
         _applicationContext.sendBroadcast(pushRegistrationIntent);
     }
@@ -310,7 +392,7 @@ public void updateUser(JSONObject dataFields) {
         sendRequest(IterableConstants.ENDPOINT_UPDATEUSER, requestJSON);
     }
 
-    public void disablePush(String iterableAppId, String gcmProjectId) {
+    public void disablePush(String iterableAppId, double gcmProjectId) {
         registerForPush(iterableAppId, gcmProjectId, true);
     }
 
@@ -346,7 +428,7 @@ public String getPayloadData(String key) {
 
     void setPayloadData(Intent intent) {
         Bundle extras = intent.getExtras();
-        if (extras != null && !extras.isEmpty() && extras.containsKey(IterableConstants.ITERABLE_DATA_KEY)) {
+        if (extras != null && extras.containsKey(IterableConstants.ITERABLE_DATA_KEY)) {
             setPayloadData(extras);
         }
     }
@@ -382,7 +464,7 @@ public int getCampaignId() {
         return returnId;
     }
 
-    public static void initDebugMode(String url) {
+    public static void overrideURLEndpointPath(String url) {
         IterableRequest.overrideUrl = url;
     }
 
@@ -396,4 +478,49 @@ private void sendRequest(String resourcePath, JSONObject json) {
         IterableApiRequest request = new IterableApiRequest(_apiKey, resourcePath, json.toString());
         new IterableRequest().execute(request);
     }
+
+//region Deprecated Fuctions
+//---------------------------------------------------------------------------------------
+
+    /**
+     * deprecated function
+     *
+     * @deprecated use {@link #registerForPush(String, double)} instead.
+     */
+    @Deprecated
+    public void registerForPush(String iterableAppId, String gcmProjectId) {
+        Double projectId = 0.0;
+
+        try {
+            projectId = Double.parseDouble(gcmProjectId);
+        } catch (NumberFormatException e) {
+            IterableLogger.e(TAG, "gcmProjectID must be a double", e);
+            return;
+        }
+
+        registerForPush(iterableAppId, projectId, false);
+    }
+
+    /**
+     * deprecated function
+     *
+     * @deprecated use {@link #disablePush(String, double)} instead.
+     */
+    @Deprecated
+    public void disablePush(String iterableAppId, String gcmProjectId) {
+        Double projectId = 0.0;
+
+        try {
+            projectId = Double.parseDouble(gcmProjectId);
+        } catch (NumberFormatException e) {
+            IterableLogger.e(TAG, "gcmProjectID must be a double");
+            e.printStackTrace();
+            return;
+        }
+
+        registerForPush(iterableAppId, projectId, true);
+    }
+//---------------------------------------------------------------------------------------
+//endregion
+
 }
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterableConstants.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterableConstants.java
@@ -38,9 +38,8 @@ public final class IterableConstants {
     public static final String ENDPOINT_UPDATEEMAIL         = "users/updateEmail";
     public static final String ENDPOINT_UPDATEUSER          = "users/update";
 
-
     public static final String PUSH_APPID = "IterableAppId";
-    public static final String PUSH_PROJECTID = "GCMProjectNumber";
+    public static final String PUSH_PROJECT_NUMBER = "GCMProjectNumber";
     public static final String PUSH_DISABLE_AFTER_REGISTRATION = "DisableAfterRegistration";
 
     public static final String MESSAGING_PLATFORM_GOOGLE = "GCM";
@@ -50,4 +49,7 @@ public final class IterableConstants {
     public static final String ITERABLE_DATA_KEY = "itbl";
     public static final String ITERABLE_DATA_BODY = "body";
     public static final String ITERABLE_DATA_TITLE = "title";
+
+    public static final String INSTANCE_ID_CLASS = "com.google.android.gms.iid.InstanceID";
+    public static final String ICON_FOLDER_IDENTIFIER = "drawable";
 }
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterableLogger.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterableLogger.java
@@ -0,0 +1,50 @@
+package com.iterable.iterableapi;
+
+import android.util.Log;
+
+/**
+ * Created by David Truong dt@iterable.com.
+ */
+class IterableLogger {
+
+
+    public static void d(String tag, String msg) {
+        if (isDebugMode()) {
+            Log.d(tag, msg);
+        }
+    }
+
+    public static void d(String tag, String msg, Throwable tr) {
+        if (isDebugMode()) {
+            Log.d(tag, msg, tr);
+        }
+    }
+
+    public static void w(String tag, String msg) {
+        if (isDebugMode()) {
+            Log.w(tag, msg);
+        }
+    }
+
+    public static void w(String tag, String msg, Throwable tr) {
+        if (isDebugMode()) {
+            Log.w(tag, msg, tr);
+        }
+    }
+
+    public static void e(String tag, String msg) {
+        if (isDebugMode()) {
+            Log.e(tag, msg);
+        }
+    }
+
+    public static void e(String tag, String msg, Throwable tr) {
+        if (isDebugMode()) {
+            Log.e(tag, msg, tr);
+        }
+    }
+
+    private static boolean isDebugMode() {
+        return (IterableApi.sharedInstance != null) ? IterableApi.sharedInstance.getDebugMode() : false;
+    }
+}
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterableNotificationData.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterableNotificationData.java
@@ -25,28 +25,23 @@ class IterableNotificationData {
             if (iterableJson.has(IterableConstants.IS_GHOST_PUSH)) {
                 isGhostPush = iterableJson.getBoolean(IterableConstants.IS_GHOST_PUSH);
             }
-
-            //TODO: do we need to parse out any additional dataFields to pass to trackPushOpen?
         } catch (JSONException e) {
             e.printStackTrace();
         }
     }
 
     public int getCampaignId()
     {
-        //include validation, logic, logging or whatever you like here
         return this.campaignId;
     }
 
     public int getTemplateId()
     {
-        //include validation, logic, logging or whatever you like here
         return this.templateId;
     }
 
     public boolean getIsGhostPush()
     {
-        //include validation, logic, logging or whatever you like here
         return this.isGhostPush;
     }
 }
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterablePushReceiver.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterablePushReceiver.java
@@ -5,7 +5,6 @@
 import android.content.Context;
 import android.content.Intent;
 import android.content.pm.PackageManager;
-import android.util.Log;
 
 /**
  *
@@ -16,7 +15,6 @@ public class IterablePushReceiver extends BroadcastReceiver{
     static final String TAG = "IterablePushReceiver";
 
     private static final String ACTION_GCM_RECEIVE_INTENT = "com.google.android.c2dm.intent.RECEIVE";
-    private static final String ACTION_GCM_REGISTRATION_INTENT = "com.google.android.c2dm.intent.REGISTRATION";
 
     @Override
     public void onReceive(Context context, Intent intent) {
@@ -26,14 +24,12 @@ public void onReceive(Context context, Intent intent) {
            handlePushRegistration(context, intent);
         } else if (intentAction.equals(ACTION_GCM_RECEIVE_INTENT)) {
             handlePushReceived(context, intent);
-        } else if (intentAction.equals(ACTION_GCM_REGISTRATION_INTENT)) {
-            Log.d(TAG, "received GCM registration intent action");
         }
     }
 
     private void handlePushRegistration(Context context, Intent intent) {
         String iterableAppId = intent.getStringExtra(IterableConstants.PUSH_APPID);
-        String projectNumber = intent.getStringExtra(IterableConstants.PUSH_PROJECTID);
+        double projectNumber = intent.getDoubleExtra(IterableConstants.PUSH_PROJECT_NUMBER, 0);
         boolean disablePush = intent.getBooleanExtra(IterableConstants.PUSH_DISABLE_AFTER_REGISTRATION, false);
         IterableGCMRegistrationData data = new IterableGCMRegistrationData(iterableAppId, projectNumber, disablePush);
         new IterablePushRegistrationGCM().execute(data);
@@ -53,18 +49,19 @@ private void handlePushReceived(Context context, Intent intent) {
                 e.printStackTrace();
             }
 
-            int iconId = appContext.getResources().getIdentifier(
+            int resourceIconId = appContext.getResources().getIdentifier(
                     IterableApi.getNotificationIcon(context),
-                    "drawable",
+                    IterableConstants.ICON_FOLDER_IDENTIFIER,
                     appContext.getPackageName());
 
-            if (iconId == 0) {
+            int iconId = 0;
+            if (resourceIconId != 0) {
+                iconId = resourceIconId;
+            } else if (appContext.getApplicationInfo().icon != 0) {
+                IterableLogger.d(TAG, "No Notification Icon defined - defaulting to app icon");
                 iconId = appContext.getApplicationInfo().icon;
-                if (iconId != 0) {
-                    Log.d(TAG, "No Notification Icon defined - defaulting to app icon");
-                } else {
-                    Log.w(TAG, "No Notification Icon defined - push notifications will not be displayed");
-                }
+            } else {
+                IterableLogger.w(TAG, "No Notification Icon defined - push notifications will not be displayed");
             }
 
             IterableNotification notificationBuilder = IterableNotification.createNotification(
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterablePushRegistrationGCM.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterablePushRegistrationGCM.java
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterableRequest.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterableRequest.java

Original file line number	Diff line number	Diff line change
`@@ -25,28 +25,23 @@ class IterableNotificationData {`
`25`	`25`	`if (iterableJson.has(IterableConstants.IS_GHOST_PUSH)) {`
`26`	`26`	`isGhostPush = iterableJson.getBoolean(IterableConstants.IS_GHOST_PUSH);`
`27`	`27`	`}`
`28`		`-`
`29`		`- //TODO: do we need to parse out any additional dataFields to pass to trackPushOpen?`
`30`	`28`	`} catch (JSONException e) {`
`31`	`29`	`e.printStackTrace();`
`32`	`30`	`}`
`33`	`31`	`}`
`34`	`32`
`35`	`33`	`public int getCampaignId()`
`36`	`34`	`{`
`37`		`- //include validation, logic, logging or whatever you like here`
`38`	`35`	`return this.campaignId;`
`39`	`36`	`}`
`40`	`37`
`41`	`38`	`public int getTemplateId()`
`42`	`39`	`{`
`43`		`- //include validation, logic, logging or whatever you like here`
`44`	`40`	`return this.templateId;`
`45`	`41`	`}`
`46`	`42`
`47`	`43`	`public boolean getIsGhostPush()`
`48`	`44`	`{`
`49`		`- //include validation, logic, logging or whatever you like here`
`50`	`45`	`return this.isGhostPush;`
`51`	`46`	`}`
`52`	`47`	`}`