[PR-10806] Debug mode improvements

human-spider · human-spider · commit 70bc31bfd3bb · 2019-02-04T19:00:04.000+02:00
* Added ability to use randomized or custom device ID in debug mode
* Debug mode now initialized via `Talkable.initialize` method
* Added missing getters to the Reward model
diff --git a/app/src/main/java/com/talkable/demo/MainActivity.java b/app/src/main/java/com/talkable/demo/MainActivity.java
@@ -216,7 +216,6 @@ public void run() {
     }
 
     public void onDeepLinkingClick(View view) {
-        Talkable.setDebug(true);
         EditText webUuidText = findViewById(R.id.webUUIDText);
         String webUuid = webUuidText.getText().toString();
         EditText offerIdText = findViewById(R.id.offerIDText);
@@ -229,6 +228,5 @@ public void onDeepLinkingClick(View view) {
             paramsMap.put(VISITOR_OFFER_KEY, offerId);
         }
         TalkableDeepLinking.track(paramsMap);
-        Talkable.setDebug(false);
     }
 }
diff --git a/sdk/build.gradle b/sdk/build.gradle
@@ -10,8 +10,8 @@ android {
     defaultConfig {
         minSdkVersion 16
         targetSdkVersion 26
-        versionCode 37
-        versionName "0.5.6"
+        versionCode 38
+        versionName "0.5.7"
         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
     }
     buildTypes {
diff --git a/sdk/src/main/java/com/talkable/sdk/Talkable.java b/sdk/src/main/java/com/talkable/sdk/Talkable.java
@@ -66,32 +66,25 @@ public class Talkable {
     public static final String ERROR_REASON_SITE_NOT_FOUND = "SITE_NOT_FOUND";
 
     private static OkHttpClient httpClient;
-    private static String server, siteSlug, nativeFeatures, defaultUserAgent;
-    private static boolean debug = false;
+    private static String server, siteSlug, nativeFeatures, defaultUserAgent, debugDeviceId;
     private static Map<String, String> credentialsMap;
-    private static Boolean initialized = false;
+    private static Boolean initialized = false, debug = false;
 
     //----------------+
     // Initialization |
     //----------------+
 
     public static void initialize(Context context) throws IncorrectInstallationException {
-        Context applicationContext = context.getApplicationContext();
+        initialize(context, null);
+    }
 
-        credentialsMap = ManifestInfo.getCredentialsConfiguration(context);
-        if (credentialsMap.keySet().size() == 1) {
-            String talkableSiteSlug = credentialsMap.keySet().iterator().next();
-            initialize(applicationContext, talkableSiteSlug);
-        } else {
-            String defaultSiteSlug = ManifestInfo.getDefaultSiteSlug(applicationContext);
-            if (defaultSiteSlug != null && !defaultSiteSlug.isEmpty()) {
-                initialize(applicationContext, defaultSiteSlug);
-            } else {
-                throw new IncorrectInstallationException("Default site slug is not specified. " +
-                        "Set default site slug inside an element with `" + ManifestInfo.DEFAULT_SITE_SLUG_KEY+
-                        "` name");
-            }
+    public static void initialize(Context context, String initialSiteSlug, boolean debug, String debugDeviceId) throws IncorrectInstallationException {
+        Talkable.debug = debug;
+        if (debug) {
+            Talkable.debugDeviceId = debugDeviceId == null ? UUID.randomUUID().toString() : debugDeviceId;
+            Log.d(TAG, "Debug mode engaged. Device ID: " + debugDeviceId);
         }
+        initialize(context, initialSiteSlug);
     }
 
     public static void initialize(Context context, String initialSiteSlug) throws IncorrectInstallationException {
@@ -100,10 +93,24 @@ public static void initialize(Context context, String initialSiteSlug) throws In
             return;
         }
 
-        Log.d(TAG, "Initializing Talkable SDK with `" + initialSiteSlug + "` site slug");
-
         Context applicationContext = context.getApplicationContext();
 
+        if (initialSiteSlug == null) {
+            credentialsMap = ManifestInfo.getCredentialsConfiguration(context);
+            if (credentialsMap.keySet().size() == 1) {
+                initialSiteSlug = credentialsMap.keySet().iterator().next();
+            } else {
+                initialSiteSlug = ManifestInfo.getDefaultSiteSlug(applicationContext);
+            }
+            if (initialSiteSlug == null || initialSiteSlug.isEmpty()) {
+                throw new IncorrectInstallationException("Default site slug is not specified. " +
+                        "Set default site slug inside an element with `" + ManifestInfo.DEFAULT_SITE_SLUG_KEY+
+                        "` name");
+            }
+        }
+
+        Log.d(TAG, "Initializing Talkable SDK with `" + initialSiteSlug + "` site slug");
+
         loadConfig(applicationContext);
         setSiteSlug(initialSiteSlug);
         setHttpClient(applicationContext);
@@ -374,14 +381,14 @@ public static void setSiteSlug(String newSiteSlug) {
         siteSlug = newSiteSlug;
     }
 
-    public static void setDebug(boolean newDebug) {
-        debug = newDebug;
-    }
-
     public static boolean getDebug() {
         return debug;
     }
 
+    public static String getDebugDeviceId() {
+        return debugDeviceId;
+    }
+
     public static Boolean isInitialized() {
         return initialized;
     }
@@ -412,15 +419,11 @@ public static void trackAppOpen(Activity activity) {
     }
 
     public static void trackAppInstall() {
-        if (!getDebug() && TalkablePreferencesStore.isAppInstallTracked()) {
+        if (!TalkablePreferencesStore.isAppInstallTracked()) {
             return;
         }
 
         String eventId = TalkablePreferencesStore.getAndroidId();
-        if (getDebug()) {
-            eventId = UUID.randomUUID().toString();
-        }
-
         Event event = new Event(eventId, Origin.APP_INSTALL_EVENT_CATEGORY);
         TalkableApi.createOrigin(event, new Callback2<Origin, Offer>() {
             @Override
diff --git a/sdk/src/main/java/com/talkable/sdk/TalkableDeepLinking.java b/sdk/src/main/java/com/talkable/sdk/TalkableDeepLinking.java
@@ -37,7 +37,7 @@ public static void track(Map<String, String> params) {
             return;
         }
         trackVisit(params.get(VISITOR_OFFER_KEY));
-        if (Talkable.getDebug() || !TalkablePreferencesStore.isAppInstallTracked()) {
+        if (!TalkablePreferencesStore.isAppInstallTracked()) {
             trackAppInstall(params.get(UUID_KEY));
         }
     }
@@ -99,9 +99,6 @@ private static void trackAppInstall(String uuid) {
         TalkablePreferencesStore.setAlternateUUID(uuid);
 
         String eventId = TalkablePreferencesStore.getAndroidId();
-        if (Talkable.getDebug()) {
-            eventId = UUID.randomUUID().toString();
-        }
         Event event = new Event(eventId, Origin.APP_INSTALL_EVENT_CATEGORY);
         TalkableApi.createOrigin(event, new Callback2<Origin, Offer>() {
             @Override
diff --git a/sdk/src/main/java/com/talkable/sdk/TalkablePreferencesStore.java b/sdk/src/main/java/com/talkable/sdk/TalkablePreferencesStore.java
@@ -11,6 +11,7 @@
 import com.talkable.sdk.utils.PreferencesStore;
 
 import java.util.Set;
+import java.util.UUID;
 
 public class TalkablePreferencesStore {
     private static final String SHARED_PREFERENCES_NAME = "TKBL_PREFERENCES";
@@ -29,11 +30,15 @@ public static void initialize(Context context) {
         if (isInitialized()) {
             return;
         }
-
-        setAndroidId(context);
         setPreferencesStore(context);
+        if (Talkable.getDebug()) {
+            preferencesStore.putBoolean(APP_INSTALLED_KEY, false);
+            setAndroidId(Talkable.getDebugDeviceId());
+        } else {
+            setAndroidId(context);
+        }
         cleanupOfferWebData();
-        if (getMainUUID() == null) {
+        if (Talkable.getDebug() || getMainUUID() == null) {
             generateMainUuid();
         }
     }
@@ -59,6 +64,10 @@ private static void setAndroidId(Context context) {
         androidId = Settings.Secure.getString(context.getContentResolver(), Settings.Secure.ANDROID_ID);
     }
 
+    private static void setAndroidId(String customAndroidId) {
+        androidId = customAndroidId;
+    }
+
     public static String getAndroidId() {
         return androidId;
     }
diff --git a/sdk/src/main/java/com/talkable/sdk/models/Reward.java b/sdk/src/main/java/com/talkable/sdk/models/Reward.java
@@ -16,4 +16,28 @@ public enum Status {
     Double amount;
     @SerializedName("coupon_code") String couponCode;
     Status status;
+
+    public String getReason() {
+        return reason;
+    }
+
+    public String getIncentiveType() {
+        return incentiveType;
+    }
+
+    public String getIncentiveDescription() {
+        return incentiveDescription;
+    }
+
+    public Double getAmount() {
+        return amount;
+    }
+
+    public String getCouponCode() {
+        return couponCode;
+    }
+
+    public Status getStatus() {
+        return status;
+    }
 }
diff --git a/sdk/src/test/java/com/talkable/sdk/TalkableApiUnitTest.java b/sdk/src/test/java/com/talkable/sdk/TalkableApiUnitTest.java
@@ -285,6 +285,9 @@ public void onSuccess(final SocialOfferShare createdShare, Reward reward) {
                                     @Override
                                     public void onSuccess(Reward[] rewards) {
                                         assertEquals(rewards.length, 1);
+                                        assertEquals(rewards[0].getCouponCode(), "AD_3_OFF");
+                                        assertEquals(rewards[0].getAmount(), 3, 0);
+                                        assertEquals(rewards[0].getReason(), "shared");
 
                                         r.done();
                                     }

Original file line number	Diff line number	Diff line change
`@@ -216,7 +216,6 @@ public void run() {`
`216`	`216`	`}`
`217`	`217`
`218`	`218`	`public void onDeepLinkingClick(View view) {`
`219`		`- Talkable.setDebug(true);`
`220`	`219`	`EditText webUuidText = findViewById(R.id.webUUIDText);`
`221`	`220`	`String webUuid = webUuidText.getText().toString();`
`222`	`221`	`EditText offerIdText = findViewById(R.id.offerIDText);`
`@@ -229,6 +228,5 @@ public void onDeepLinkingClick(View view) {`
`229`	`228`	`paramsMap.put(VISITOR_OFFER_KEY, offerId);`
`230`	`229`	`}`
`231`	`230`	`TalkableDeepLinking.track(paramsMap);`
`232`		`- Talkable.setDebug(false);`
`233`	`231`	`}`
`234`	`232`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public static void track(Map<String, String> params) {`
`37`	`37`	`return;`
`38`	`38`	`}`
`39`	`39`	`trackVisit(params.get(VISITOR_OFFER_KEY));`
`40`		`- if (Talkable.getDebug() \|\| !TalkablePreferencesStore.isAppInstallTracked()) {`
	`40`	`+ if (!TalkablePreferencesStore.isAppInstallTracked()) {`
`41`	`41`	`trackAppInstall(params.get(UUID_KEY));`
`42`	`42`	`}`
`43`	`43`	`}`
`@@ -99,9 +99,6 @@ private static void trackAppInstall(String uuid) {`
`99`	`99`	`TalkablePreferencesStore.setAlternateUUID(uuid);`
`100`	`100`
`101`	`101`	`String eventId = TalkablePreferencesStore.getAndroidId();`
`102`		`- if (Talkable.getDebug()) {`
`103`		`- eventId = UUID.randomUUID().toString();`
`104`		`- }`
`105`	`102`	`Event event = new Event(eventId, Origin.APP_INSTALL_EVENT_CATEGORY);`
`106`	`103`	`TalkableApi.createOrigin(event, new Callback2<Origin, Offer>() {`
`107`	`104`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -285,6 +285,9 @@ public void onSuccess(final SocialOfferShare createdShare, Reward reward) {`
`285`	`285`	`@Override`
`286`	`286`	`public void onSuccess(Reward[] rewards) {`
`287`	`287`	`assertEquals(rewards.length, 1);`
	`288`	`+ assertEquals(rewards[0].getCouponCode(), "AD_3_OFF");`
	`289`	`+ assertEquals(rewards[0].getAmount(), 3, 0);`
	`290`	`+ assertEquals(rewards[0].getReason(), "shared");`
`288`	`291`
`289`	`292`	`r.done();`
`290`	`293`	`}`