Add event tags to track API (#97)

Author: mikeproeng37

CHANGELOG.md

@@ -1,4 +1,11 @@
 # Optimizely Android X SDK Changelog
+### 1.2.0
+March 20, 2017
+
+- Add event tags to the `track` API
+- Deprecated `eventValue` parameter from the `track` API. Use event tags to pass in event value instead
+- Update to java-core 1.6.0 (https://github.com/optimizely/java-sdk/blob/master/CHANGELOG.md#160)
+
 ### 1.1.0
 February 17, 2017
 

android-sdk/src/main/java/com/optimizely/ab/android/sdk/OptimizelyClient.java

@@ -134,6 +134,27 @@ public void track(@NonNull String eventName,
      * Track an event for a user
      * @param eventName the name of the event
      * @param userId the user id
+     * @param attributes a map of attributes about the user
+     * @param eventTags a map of metadata associated with the event
+     */
+    public void track(@NonNull String eventName,
+                      @NonNull String userId,
+                      @NonNull Map<String, String> attributes,
+                      @NonNull Map<String, ?> eventTags) throws UnknownEventTypeException {
+        if (optimizely != null) {
+            optimizely.track(eventName, userId, attributes, eventTags);
+
+        } else {
+            logger.warn("Optimizely is not initialized, could not track event {} for user {}" +
+                    " with attributes and event tags", eventName, userId);
+        }
+    }
+
+    /**
+     * Track an event for a user
+     * @deprecated see {@link Optimizely#track(String, String, Map, Map)} and pass in revenue values as event tags instead.
+     * @param eventName the name of the event
+     * @param userId the user id
      * @param eventValue a value to tie to the event
      */
     public void track(@NonNull String eventName,
@@ -150,6 +171,7 @@ public void track(@NonNull String eventName,
     /**
      * Track an event for a user with attributes and a value
      * @see Optimizely#track(String, String, Map, Long)
+     * @deprecated see {@link Optimizely#track(String, String, Map, Map)} and pass in revenue values as event tags instead.
      * @param eventName the String name of the event
      * @param userId the String user id
      * @param attributes the attributes of the event

android-sdk/src/test/java/com/optimizely/ab/android/sdk/OptimizelyClientTest.java

@@ -139,6 +139,17 @@ public void testBadTrack4() {
                 "with value {} and attributes", "event1", "1", 1L);
     }
 
+    @Test
+    public void testTrackWithEventTags() {
+        OptimizelyClient optimizelyClient = new OptimizelyClient(optimizely, logger);
+        final HashMap<String, String> attributes = new HashMap<>();
+        attributes.put("foo", "bar");
+        final HashMap<String, Object> eventTags = new HashMap<>();
+        eventTags.put("foo", 843);
+        optimizelyClient.track("event1", "1", attributes, eventTags);
+        verify(optimizely).track("event1", "1", attributes, eventTags);
+    }
+
     @Test
     public void testGoodGetVariation1() {
         OptimizelyClient optimizelyClient = new OptimizelyClient(optimizely, logger);

build.gradle

@@ -52,7 +52,7 @@ ext {
     min_sdk_version = 10
     target_sdk_version = 24
 
-    java_core_ver = "1.5.0"
+    java_core_ver = "1.6.0"
     android_logger_ver = "1.3.1"
     support_annotations_ver = "24.2.1"
     junit_ver = "4.12"