Merge pull request #10 from AdevintaSpain/fix_logpurchase

Log purchases for each product individually

Author: ivngrz

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

@@ -22,6 +22,7 @@
 import com.segment.analytics.integrations.Integration;
 import com.segment.analytics.integrations.Logger;
 import com.segment.analytics.integrations.TrackPayload;
+import com.segment.analytics.internal.Utils;
 import java.math.BigDecimal;
 import java.util.Arrays;
 import java.util.Calendar;
@@ -45,9 +46,9 @@ public class AppboyIntegration extends Integration<Appboy> {
   private static final String REVENUE_KEY = "revenue";
   private static final String CURRENCY_KEY = "currency";
   private static final String AUTOMATIC_IN_APP_MESSAGE_REGISTRATION_ENABLED =
-          "automatic_in_app_message_registration_enabled";
+      "automatic_in_app_message_registration_enabled";
   private static final List<String> RESERVED_KEYS = Arrays.asList("birthday", "email", "firstName",
-    "lastName", "gender", "phone", "address", "avatar");
+      "lastName", "gender", "phone", "address", "avatar");
 
   public static final Factory FACTORY = factory(AppboyIntegrationOptions.builder().build());
 
@@ -300,32 +301,81 @@ public void track(TrackPayload track) {
       mLogger.verbose("This Install Attributed event is not in the proper format and cannot be"
           + " logged. The exception is %s.", exception);
     }
+
     if (properties == null || properties.size() == 0) {
       mLogger.verbose("Calling appboy.logCustomEvent for event %s with no properties.", event);
       mAppboy.logCustomEvent(event);
       return;
     }
+
+    if (event.equals("Order Completed") || properties.containsKey("revenue")) {
+      String currency = StringUtils.isNullOrBlank(properties.currency())
+          ? DEFAULT_CURRENCY_CODE
+          : properties.currency();
+
+      List<Properties.Product> products = properties.products();
+
+      if (Utils.isNullOrEmpty(products)) {
+        logPurchase(event, currency, properties);
+      } else {
+        for (Properties.Product product : products) {
+          logProductPurchase(event, currency, product);
+        }
+      }
+
+      return;
+    }
+
     JSONObject propertiesJson = properties.toJsonObject();
+
+    mLogger.verbose("Calling appboy.logCustomEvent for event %s with properties %s.",
+        event, propertiesJson.toString());
+    mAppboy.logCustomEvent(event, new AppboyProperties(propertiesJson));
+  }
+
+  private void logPurchase(String event, String currency, Properties properties) {
     double revenue = properties.revenue();
+
     if (revenue != 0) {
-      String currencyCode = StringUtils.isNullOrBlank(properties.currency()) ? DEFAULT_CURRENCY_CODE
-          : properties.currency();
+      JSONObject propertiesJson = properties.toJsonObject();
+
       propertiesJson.remove(REVENUE_KEY);
       propertiesJson.remove(CURRENCY_KEY);
+
       if (propertiesJson.length() == 0) {
         mLogger.verbose("Calling appboy.logPurchase for purchase %s for %.02f %s with no"
-            + " properties.", event, revenue, currencyCode);
-        mAppboy.logPurchase(event, currencyCode, new BigDecimal(revenue));
+            + " properties.", event, revenue, currency);
+        mAppboy.logPurchase(event, currency, new BigDecimal(revenue));
       } else {
         mLogger.verbose("Calling appboy.logPurchase for purchase %s for %.02f %s with properties"
-            + " %s.", event, revenue, currencyCode, propertiesJson.toString());
-        mAppboy.logPurchase(event, currencyCode, new BigDecimal(revenue),
+            + " %s.", event, revenue, currency, propertiesJson.toString());
+        mAppboy.logPurchase(event, currency, new BigDecimal(revenue),
             new AppboyProperties(propertiesJson));
       }
+    }
+  }
+
+  private void logProductPurchase(String event, String currency, Properties.Product product) {
+    String productId = product.id();
+    BigDecimal price = new BigDecimal(product.price());
+
+    AppboyProperties appboyProperties = new AppboyProperties();
+
+    for (Map.Entry<String, Object> entry : product.entrySet()) {
+      if (entry.getKey().equalsIgnoreCase("id")) continue;
+      if (entry.getKey().equalsIgnoreCase("price")) continue;
+
+      appboyProperties.addProperty(entry.getKey(), entry.getValue().toString());
+    }
+
+    if (appboyProperties.size() > 0) {
+      mLogger.verbose("Calling appboy.logPurchase for purchase %s for %.02f %s with properties"
+          + " %s.", event, price, currency, appboyProperties);
+      mAppboy.logPurchase(productId, currency, price, appboyProperties);
     } else {
-      mLogger.verbose("Calling appboy.logCustomEvent for event %s with properties %s.",
-          event, propertiesJson.toString());
-      mAppboy.logCustomEvent(event, new AppboyProperties(propertiesJson));
+      mLogger.verbose("Calling appboy.logPurchase for purchase %s for %.02f %s with no"
+          + " properties.", event, price, currency);
+      mAppboy.logPurchase(productId, currency, price);
     }
   }
 

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

@@ -74,7 +74,7 @@ public void setUp() {
     when(mAnalytics.logger("Appboy")).thenReturn(mLogger);
     when(mAnalytics.getApplication()).thenReturn(mContext);
     mIntegration = new AppboyIntegration(
-        mContext, mAppboy, "foo", mLogger, true, true, null);
+        mContext, mAppboy, "foo", mLogger, true, false, null);
   }
 
   @Test
@@ -177,7 +177,6 @@ public void testIdentifyFields() {
     verify(mAppboyUser).setCustomUserAttribute("string", "value");
     //verifyNoMoreAppboyUserInteractions();
     verify(mAppboy, Mockito.times(1)).changeUser("userId");
-    verify(mAppboy, Mockito.times(15)).getCurrentUser();
     //verifyNoMoreAppboyInteractions();
   }
 
@@ -220,7 +219,7 @@ public void testIdentifyGenderOnBadInputs() {
     traits.putGender("female_1");
     identifyPayload = new IdentifyPayloadBuilder().traits(traits).build();
     mIntegration.identify(identifyPayload);
-    verify(mAppboy, Mockito.times(1)).changeUser("userId");
+    verify(mAppboy, Mockito.times(2)).changeUser("userId");
     //verifyNoMoreAppboyUserInteractions();
     //verifyNoMoreAppboyInteractions();
   }
@@ -258,6 +257,24 @@ public void testTrackLogsAPurchaseWithoutPropertiesWithCustomCurrency() {
     verifyNoMoreAppboyInteractions();
   }
 
+  @Test
+  public void testTrackLogsAPurchaseForEachProduct() {
+    Properties purchaseProperties = new Properties();
+    purchaseProperties.putCurrency("EUR");
+    purchaseProperties.putProducts(
+        new Properties.Product("product_1", "sku.product.1", 10.99F),
+        new Properties.Product("product_2", "sku.product.2", 20.99F)
+    );
+
+    TrackPayload trackPayload = new TrackPayloadBuilder().event("Order Completed").properties(purchaseProperties).build();
+
+    mIntegration.track(trackPayload);
+
+    verify(mAppboy).logPurchase("product_1", "EUR", new BigDecimal(10.99F));
+    verify(mAppboy).logPurchase("product_2", "EUR", new BigDecimal(20.99F));
+    verifyNoMoreAppboyInteractions();
+  }
+
   @Test
   public void testScreenDoesNotCallAppboy() {
     mIntegration.screen(new ScreenPayloadBuilder().name("foo").build());