Merge pull request #1 from AdevintaSpain/user_id_mapper

[IntegrationOptions] UserId mapper

Author: ivngrz

src/androidTest/java/com/segment/analytics/android/integrations/appboy/AppboyAndroidTest.java

@@ -33,7 +33,7 @@ public void testIdentifyCallsChangeUser() {
     Traits traits = createTraits(testUserId);
     IdentifyPayload identifyPayload = new IdentifyPayloadBuilder().traits(traits).build();
     Logger logger = Logger.with(Analytics.LogLevel.DEBUG);
-    AppboyIntegration integration = new AppboyIntegration(Appboy.getInstance(getContext()), "foo", logger, true);
+    AppboyIntegration integration = new AppboyIntegration(Appboy.getInstance(getContext()), "foo", logger, true, new DefaultUserIdMapper());
     integration.identify(identifyPayload);
 
     assertEquals(testUserId, Appboy.getInstance(getContext()).getCurrentUser().getUserId());

src/androidTest/java/com/segment/analytics/android/integrations/appboy/AppboyIntegrationOptionsAndroidTest.java

@@ -0,0 +1,52 @@
+package com.segment.analytics.android.integrations.appboy;
+
+import android.support.test.runner.AndroidJUnit4;
+import com.appboy.Appboy;
+import com.appboy.configuration.AppboyConfig;
+import com.segment.analytics.Analytics;
+import com.segment.analytics.Traits;
+import com.segment.analytics.integrations.IdentifyPayload;
+import com.segment.analytics.integrations.Logger;
+import com.segment.analytics.test.IdentifyPayloadBuilder;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import static android.support.test.InstrumentationRegistry.getContext;
+import static com.segment.analytics.Utils.createTraits;
+import static org.junit.Assert.assertEquals;
+
+@RunWith(AndroidJUnit4.class)
+public class AppboyIntegrationOptionsAndroidTest {
+
+  private static final String ORIGINAL_USER_ID = "testUser";
+  private static final String TRANSFORMED_USER_ID = "transformedUser";
+
+  @BeforeClass
+  public static void beforeClass() {
+    AppboyConfig appboyConfig = new AppboyConfig.Builder().setApiKey("testkey").build();
+    Appboy.configure(getContext(), appboyConfig);
+  }
+
+  @Test
+  public void testUserIdMapperTransformsAppboyUserId() {
+    Traits traits = createTraits(ORIGINAL_USER_ID);
+    IdentifyPayload identifyPayload = new IdentifyPayloadBuilder().traits(traits).build();
+
+    Logger logger = Logger.with(Analytics.LogLevel.DEBUG);
+
+    AppboyIntegration integration = new AppboyIntegration(Appboy.getInstance(getContext()), "foo", logger, true, new ReplaceUserIdMapper());
+
+    integration.identify(identifyPayload);
+
+    assertEquals(TRANSFORMED_USER_ID, Appboy.getInstance(getContext()).getCurrentUser().getUserId());
+  }
+
+  class ReplaceUserIdMapper implements UserIdMapper {
+    @Override
+    public String transformUserId(String segmentUserId) {
+      return segmentUserId.replaceFirst(ORIGINAL_USER_ID, TRANSFORMED_USER_ID);
+    }
+  }
+}
+

src/main/java/com/segment/analytics/android/integrations/appboy/AppboyIntegration.java

@@ -47,50 +47,63 @@ public class AppboyIntegration extends Integration<Appboy> {
   private static final List<String> RESERVED_KEYS = Arrays.asList("birthday", "email", "firstName",
     "lastName", "gender", "phone", "address");
 
-  public static final Factory FACTORY = new Factory() {
-    @Override
-    public Integration<?> create(ValueMap settings, Analytics analytics) {
-      Logger logger = analytics.logger(APPBOY_KEY);
-      String apiKey = settings.getString(API_KEY_KEY);
-      SdkFlavor flavor = SdkFlavor.SEGMENT;
-      boolean inAppMessageRegistrationEnabled =
-              settings.getBoolean(AUTOMATIC_IN_APP_MESSAGE_REGISTRATION_ENABLED, true);
-
-      if (StringUtils.isNullOrBlank(API_KEY_KEY)) {
-        logger.info("Appboy+Segment integration attempted to initialize without api key.");
-        return null;
-      }
-      String customEndpoint = settings.getString(CUSTOM_ENDPOINT_KEY);
-      AppboyConfig.Builder builder = new AppboyConfig.Builder()
-          .setApiKey(apiKey)
-          .setSdkFlavor(flavor);
-      if (!StringUtils.isNullOrBlank(customEndpoint)) {
-        builder.setCustomEndpoint(customEndpoint);
-      }
+  public static final Factory FACTORY = factory(AppboyIntegrationOptions.builder().build());
 
-      Appboy.configure(analytics.getApplication().getApplicationContext(), builder.build());
-      Appboy appboy = Appboy.getInstance(analytics.getApplication());
-      logger.verbose("Configured Appboy+Segment integration and initialized Appboy.");
-      return new AppboyIntegration(appboy, apiKey, logger, inAppMessageRegistrationEnabled);
-    }
+  public static Factory factory(final AppboyIntegrationOptions options) {
+    return new Factory() {
+      @Override
+      public Integration<?> create(ValueMap settings, Analytics analytics) {
+        Logger logger = analytics.logger(APPBOY_KEY);
+        String apiKey = settings.getString(API_KEY_KEY);
+        SdkFlavor flavor = SdkFlavor.SEGMENT;
+        boolean inAppMessageRegistrationEnabled =
+            settings.getBoolean(AUTOMATIC_IN_APP_MESSAGE_REGISTRATION_ENABLED, true);
 
-    @Override
-    public String key() {
-      return APPBOY_KEY;
-    }
-  };
+        if (StringUtils.isNullOrBlank(API_KEY_KEY)) {
+          logger.info("Appboy+Segment integration attempted to initialize without api key.");
+          return null;
+        }
+
+        String customEndpoint = settings.getString(CUSTOM_ENDPOINT_KEY);
+        AppboyConfig.Builder builder = new AppboyConfig.Builder()
+            .setApiKey(apiKey)
+            .setSdkFlavor(flavor);
+        if (!StringUtils.isNullOrBlank(customEndpoint)) {
+          builder.setCustomEndpoint(customEndpoint);
+        }
+
+        UserIdMapper userIdMapper = options.getUserIdMapper();
+        if (userIdMapper == null) {
+          userIdMapper = new DefaultUserIdMapper();
+        }
+
+        Appboy.configure(analytics.getApplication().getApplicationContext(), builder.build());
+        Appboy appboy = Appboy.getInstance(analytics.getApplication());
+        logger.verbose("Configured Appboy+Segment integration and initialized Appboy.");
+        return new AppboyIntegration(appboy, apiKey, logger, inAppMessageRegistrationEnabled, userIdMapper);
+      }
+
+      @Override
+      public String key() {
+        return APPBOY_KEY;
+      }
+    };
+  }
 
   private final Appboy mAppboy;
   private final String mToken;
   private final Logger mLogger;
   private final boolean mAutomaticInAppMessageRegistrationEnabled;
+  private final UserIdMapper mUserIdMapper;
 
   public AppboyIntegration(Appboy appboy, String token, Logger logger,
-                           boolean automaticInAppMessageRegistrationEnabled) {
+                           boolean automaticInAppMessageRegistrationEnabled,
+                           UserIdMapper userIdMapper) {
     mAppboy = appboy;
     mToken = token;
     mLogger = logger;
     mAutomaticInAppMessageRegistrationEnabled = automaticInAppMessageRegistrationEnabled;
+    mUserIdMapper = userIdMapper;
   }
 
   public String getToken() {
@@ -108,7 +121,7 @@ public void identify(IdentifyPayload identify) {
 
     String userId = identify.userId();
     if (!StringUtils.isNullOrBlank(userId)) {
-      mAppboy.changeUser(identify.userId());
+      mAppboy.changeUser(mUserIdMapper.transformUserId(userId));
     }
 
     Traits traits = identify.traits();

src/main/java/com/segment/analytics/android/integrations/appboy/AppboyIntegrationOptions.java

@@ -0,0 +1,31 @@
+package com.segment.analytics.android.integrations.appboy;
+
+public class AppboyIntegrationOptions {
+
+  private UserIdMapper userIdMapper;
+
+  public static Builder builder() {
+    return new Builder();
+  }
+
+  UserIdMapper getUserIdMapper() {
+    return userIdMapper;
+  }
+
+  private AppboyIntegrationOptions(UserIdMapper userIdMapper) {
+    this.userIdMapper = userIdMapper;
+  }
+
+  public static class Builder {
+    private UserIdMapper userIdMapper;
+
+    public Builder userIdMapper(UserIdMapper userIdMapper) {
+      this.userIdMapper = userIdMapper;
+      return this;
+    }
+
+    public AppboyIntegrationOptions build() {
+      return new AppboyIntegrationOptions(userIdMapper);
+    }
+  }
+}

src/main/java/com/segment/analytics/android/integrations/appboy/DefaultUserIdMapper.java

@@ -0,0 +1,12 @@
+package com.segment.analytics.android.integrations.appboy;
+
+import android.support.annotation.Nullable;
+
+public class DefaultUserIdMapper implements UserIdMapper {
+
+  @Override
+  @Nullable
+  public String transformUserId(@Nullable String segmentUserId) {
+    return segmentUserId;
+  }
+}

src/main/java/com/segment/analytics/android/integrations/appboy/UserIdMapper.java

@@ -0,0 +1,15 @@
+package com.segment.analytics.android.integrations.appboy;
+
+import android.support.annotation.NonNull;
+import com.appboy.Appboy;
+
+public interface UserIdMapper {
+
+  /**
+   * Defines a transformation for all userIds before being reported to the Braze SDK
+   *
+   * @param segmentUserId user id reported to segment in identify calls
+   * @return userId as should be reported to Braze in the {@link Appboy#changeUser(String)} method.
+   */
+  @NonNull String transformUserId(@NonNull String segmentUserId);
+}

src/test/java/com/segment/analytics/android/integrations/appboy/AppboyTest.java

@@ -73,7 +73,7 @@ public void setUp() {
     mLogger = Logger.with(Analytics.LogLevel.DEBUG);
     when(mAnalytics.logger("Appboy")).thenReturn(mLogger);
     when(mAnalytics.getApplication()).thenReturn(mContext);
-    mIntegration = new AppboyIntegration(mAppboy, "foo", mLogger, true);
+    mIntegration = new AppboyIntegration(mAppboy, "foo", mLogger, true, new DefaultUserIdMapper());
   }
 
   @Test