[MOB-1482] Add Device Attributes methods

Adding methods to add custom device attributes, remove device attributes. Integrated it with existing push registration and test methods.

Author: Ayyanchira

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

@@ -22,6 +22,7 @@
 import org.json.JSONObject;
 
 import java.util.Arrays;
+import java.util.HashMap;
 import java.util.List;
 import java.util.UUID;
 
@@ -52,6 +53,7 @@ public class IterableApi {
 
     private IterableInAppManager inAppManager;
     private String inboxSessionId;
+    private HashMap<String, String> deviceAttributes = new HashMap<>();
 
 //---------------------------------------------------------------------------------------
 //endregion
@@ -201,6 +203,18 @@ void setNotificationData(IterableNotificationData data) {
             setAttributionInfo(new IterableAttributionInfo(data.getCampaignId(), data.getTemplateId(), data.getMessageId()));
         }
     }
+
+    HashMap getDeviceAttributes() {
+        return deviceAttributes;
+    }
+
+    public void setDeviceAttribute(String key, String value) {
+        deviceAttributes.put(key, value);
+    }
+
+    public void removeFromDeviceAttribute(String key) {
+        deviceAttributes.remove(key);
+    }
 //---------------------------------------------------------------------------------------
 //endregion
 
@@ -363,14 +377,14 @@ public boolean isIterableIntent(@Nullable Intent intent) {
      * @param token Push token obtained from GCM or FCM
      */
     public void registerDeviceToken(@NonNull String token) {
-        registerDeviceToken(_email, _userId, getPushIntegrationName(), token);
+        registerDeviceToken(_email, _userId, getPushIntegrationName(), token, deviceAttributes);
     }
 
-    protected void registerDeviceToken(final @Nullable String email, final @Nullable String userId, final @NonNull String applicationName, final @NonNull String token) {
+    protected void registerDeviceToken(final @Nullable String email, final @Nullable String userId, final @NonNull String applicationName, final @NonNull String token, final HashMap<String, String> deviceAttributes) {
         if (token != null) {
             final Thread registrationThread = new Thread(new Runnable() {
                 public void run() {
-                    registerDeviceToken(email, userId, applicationName, token, null);
+                    registerDeviceToken(email, userId, applicationName, token, null, deviceAttributes);
                 }
             });
             registrationThread.start();
@@ -1093,7 +1107,7 @@ protected void disableToken(@Nullable String email, @Nullable String userId, @No
      * @param token
      * @param dataFields
      */
-    protected void registerDeviceToken(@Nullable String email, @Nullable String userId, @NonNull String applicationName, @NonNull String token, @Nullable JSONObject dataFields) {
+    protected void registerDeviceToken(@Nullable String email, @Nullable String userId, @NonNull String applicationName, @NonNull String token, @Nullable JSONObject dataFields, @Nullable HashMap<String, String> deviceAttributes) {
         if (!checkSDKInitialization()) {
             return;
         }
@@ -1114,6 +1128,13 @@ protected void registerDeviceToken(@Nullable String email, @Nullable String user
             if (dataFields == null) {
                 dataFields = new JSONObject();
             }
+
+            if (deviceAttributes != null) {
+                for (HashMap.Entry<String, String> entry : deviceAttributes.entrySet()) {
+                    dataFields.put(entry.getKey(), entry.getValue());
+                }
+            }
+
             dataFields.put(IterableConstants.FIREBASE_TOKEN_TYPE, IterableConstants.MESSAGING_PLATFORM_FIREBASE);
             dataFields.put(IterableConstants.FIREBASE_COMPATIBLE, true);
             dataFields.put(IterableConstants.DEVICE_BRAND, Build.BRAND); //brand: google

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

@@ -3,6 +3,7 @@
 import android.content.Context;
 import android.content.SharedPreferences;
 import android.os.AsyncTask;
+
 import androidx.annotation.NonNull;
 
 import com.google.firebase.iid.FirebaseInstanceId;
@@ -33,7 +34,8 @@ protected Void doInBackground(IterablePushRegistrationData... params) {
                             iterablePushRegistrationData.email,
                             iterablePushRegistrationData.userId,
                             iterablePushRegistrationData.pushIntegrationName,
-                            pushRegistrationObject.token);
+                            pushRegistrationObject.token,
+                            IterableApi.getInstance().getDeviceAttributes());
 
                 } else if (iterablePushRegistrationData.pushRegistrationAction == IterablePushRegistrationData.PushRegistrationAction.DISABLE) {
                     IterableApi.sharedInstance.disableToken(

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

@@ -10,6 +10,8 @@
 import org.robolectric.RuntimeEnvironment;
 import org.robolectric.shadows.ShadowApplication;
 
+import java.util.HashMap;
+
 import okhttp3.mockwebserver.MockWebServer;
 
 import static com.iterable.iterableapi.IterableTestUtils.stubAnyRequestReturningStatusCode;
@@ -33,12 +35,15 @@ public class IterablePushRegistrationTest extends BaseTest {
     private static final String OLD_TOKEN = "oldToken";
     private static final String GCM_SENDER_ID = "1234567890";
     public static final String INTEGRATION_NAME = "integrationName";
+    public static final String DEVICE_ATTRIBUTES_KEY = "SDK";
+    public static final String DEVICE_ATTRIBUTES_VALUE = "ReactNative 2.3.4";
 
     private MockWebServer server;
     private IterableApi originalApi;
     private IterableApi apiMock;
     private IterablePushRegistration.Util.UtilImpl originalPushRegistrationUtil;
     private IterablePushRegistration.Util.UtilImpl pushRegistrationUtilMock;
+    private HashMap<String, String> deviceAttributes = new HashMap<String, String>();
 
     @Before
     public void setUp() throws Exception {
@@ -73,7 +78,8 @@ public void testEnableDevice() throws Exception {
         IterablePushRegistrationData data = new IterablePushRegistrationData(IterableTestUtils.userEmail, null, INTEGRATION_NAME, IterablePushRegistrationData.PushRegistrationAction.ENABLE);
         new IterablePushRegistration().execute(data);
 
-        verify(apiMock, timeout(100)).registerDeviceToken(eq(IterableTestUtils.userEmail), nullable(String.class), eq(INTEGRATION_NAME), eq(TEST_TOKEN));
+        verify(apiMock, timeout(100)).registerDeviceToken(eq(IterableTestUtils.userEmail), nullable(String.class), eq(INTEGRATION_NAME), eq(TEST_TOKEN), eq(deviceAttributes));
+
         verify(apiMock, never()).disableToken(eq(IterableTestUtils.userEmail), nullable(String.class), any(String.class), nullable(IterableHelper.SuccessHandler.class), nullable(IterableHelper.FailureHandler.class));
     }
 
@@ -98,19 +104,21 @@ public void testDisableOldGcmToken() throws Exception {
         when(pushRegistrationUtilMock.getFirebaseToken(eq(GCM_SENDER_ID), eq(IterableConstants.MESSAGING_PLATFORM_GOOGLE))).thenReturn(OLD_TOKEN);
 
         IterablePushRegistrationData data = new IterablePushRegistrationData(IterableTestUtils.userEmail, null, INTEGRATION_NAME, IterablePushRegistrationData.PushRegistrationAction.ENABLE);
+        IterableApi.getInstance().setDeviceAttribute(DEVICE_ATTRIBUTES_KEY, DEVICE_ATTRIBUTES_VALUE);
         new IterablePushRegistration().execute(data);
+        deviceAttributes.put(DEVICE_ATTRIBUTES_KEY, DEVICE_ATTRIBUTES_VALUE);
 
         ArgumentCaptor<IterableHelper.SuccessHandler> successHandlerCaptor = ArgumentCaptor.forClass(IterableHelper.SuccessHandler.class);
-        verify(apiMock).registerDeviceToken(eq(IterableTestUtils.userEmail), isNull(String.class), eq(INTEGRATION_NAME), eq(NEW_TOKEN));
+        verify(apiMock).registerDeviceToken(eq(IterableTestUtils.userEmail), isNull(String.class), eq(INTEGRATION_NAME), eq(NEW_TOKEN), eq(deviceAttributes));
         verify(apiMock, times(1)).disableToken(eq(IterableTestUtils.userEmail), isNull(String.class), eq(OLD_TOKEN), successHandlerCaptor.capture(), nullable(IterableHelper.FailureHandler.class));
         successHandlerCaptor.getValue().onSuccess(new JSONObject());
 
         reset(apiMock);
 
         new IterablePushRegistration().execute(data);
 
-        verify(apiMock).registerDeviceToken(eq(IterableTestUtils.userEmail), isNull(String.class), eq(INTEGRATION_NAME), eq(NEW_TOKEN));
+        verify(apiMock).registerDeviceToken(eq(IterableTestUtils.userEmail), isNull(String.class), eq(INTEGRATION_NAME), eq(NEW_TOKEN), eq(deviceAttributes));
         verify(apiMock, never()).disableToken(eq(IterableTestUtils.userEmail), isNull(String.class), any(String.class), nullable(IterableHelper.SuccessHandler.class), nullable(IterableHelper.FailureHandler.class));
     }
 
-}
+}