DAND-41-Fix: modify ComScoreIntegration.java for v6

Author: Kola Emiola

src/main/java/com/segment/analytics/android/integrations/comscore/ComScoreIntegration.java

@@ -1,9 +1,9 @@
 package com.segment.analytics.android.integrations.comscore;
 
 import static com.segment.analytics.internal.Utils.isNullOrEmpty;
-
+import com.comscore.streaming.AdvertisementMetadata;
+import com.comscore.streaming.ContentMetadata;
 import com.comscore.streaming.StreamingAnalytics;
-
 import com.segment.analytics.Properties;
 import com.segment.analytics.ValueMap;
 import com.segment.analytics.integrations.IdentifyPayload;
@@ -20,17 +20,17 @@
 public class ComScoreIntegration extends Integration<Void> {
   @SuppressWarnings("WeakerAccess")
   public static final Factory FACTORY =
-      new Factory() {
-        @Override
-        public Integration<?> create(ValueMap settings, com.segment.analytics.Analytics analytics) {
-          return new ComScoreIntegration(analytics, settings);
-        }
-
-        @Override
-        public String key() {
-          return COMSCORE_KEY;
-        }
-      };
+          new Factory() {
+            @Override
+            public Integration<?> create(ValueMap settings, com.segment.analytics.Analytics analytics) {
+              return new ComScoreIntegration(analytics, settings);
+            }
+
+            @Override
+            public String key() {
+              return COMSCORE_KEY;
+            }
+          };
 
   private final static String COMSCORE_KEY = "comScore";
   private final static String PARTNER_ID = "24186693";
@@ -46,26 +46,27 @@ public String key() {
   }
 
   ComScoreIntegration(
-      com.segment.analytics.Analytics analytics,
-      ValueMap destinationSettings,
-      ComScoreAnalytics comScoreAnalytics) {
+          com.segment.analytics.Analytics analytics,
+          ValueMap destinationSettings,
+          ComScoreAnalytics comScoreAnalytics) {
 
     this.comScoreAnalytics = comScoreAnalytics;
     this.settings = new Settings(destinationSettings);
     this.logger = analytics.logger(COMSCORE_KEY);
 
     comScoreAnalytics.start(analytics.getApplication(), PARTNER_ID, settings.toPublisherConfiguration());
+    settings.analyticsConfig();
   }
 
   /**
    * Store a value for {@param k} in {@param asset} by checking {@param comScoreOptions} first and
    * falling back to {@param properties}. Uses {@code "*null"} it not found in either.
    */
   private void setNullIfNotProvided(
-      Map<String, String> asset,
-      Map<String, ?> comScoreOptions,
-      Map<String, ?> stringProperties,
-      String key) {
+          Map<String, String> asset,
+          Map<String, ?> comScoreOptions,
+          Map<String, ?> stringProperties,
+          String key) {
     String option = getStringOrDefaultValue(comScoreOptions, key, null);
     if (option != null) {
       asset.put(key, option);
@@ -81,7 +82,7 @@ private void setNullIfNotProvided(
   }
 
   private Map<String, String> mapSpecialKeys(
-      Properties properties, Map<String, String> mapper) {
+          Properties properties, Map<String, String> mapper) {
     Map<String, String> asset = new LinkedHashMap<>(mapper.size());
 
     // Map special keys and preserve only the special keys.
@@ -98,9 +99,9 @@ private Map<String, String> mapSpecialKeys(
   }
 
   private Map<String, String> buildPlaybackAsset(
-      Properties properties,
-      Map<String, ?> options,
-      Map<String, String> mapper) {
+          Properties properties,
+          Map<String, ?> options,
+          Map<String, String> mapper) {
 
     Map<String, String> asset = mapSpecialKeys(properties, mapper);
 
@@ -118,9 +119,9 @@ private Map<String, String> buildPlaybackAsset(
   }
 
   private Map<String, String> buildContentAsset(
-      Properties properties,
-      Map<String, ?> options,
-      Map<String, String> mapper) {
+          Properties properties,
+          Map<String, ?> options,
+          Map<String, String> mapper) {
 
     Map<String, String> asset = mapSpecialKeys(properties, mapper);
 
@@ -157,9 +158,9 @@ private Map<String, String> buildContentAsset(
   }
 
   private Map<String, String> buildAdAsset(
-      Properties properties,
-      Map<String, ?> options,
-      Map<String, String> mapper) {
+          Properties properties,
+          Map<String, ?> options,
+          Map<String, String> mapper) {
 
     Map<String, String> asset = mapSpecialKeys(properties, mapper);
 
@@ -185,6 +186,7 @@ private Map<String, String> buildAdAsset(
       default:
         asset.put("ns_st_ad", "1");
     }
+
     setNullIfNotProvided(asset, options, properties, "c3");
     setNullIfNotProvided(asset, options, properties, "c4");
     setNullIfNotProvided(asset, options, properties, "c6");
@@ -199,7 +201,7 @@ private Map<String, String> buildAdAsset(
    * have a String representation.
    */
   private String getStringOrDefaultValue(
-      Map<String, ?> m, String key, String defaultValue) {
+          Map<String, ?> m, String key, String defaultValue) {
     Object value = m.get(key);
     if (value instanceof String) {
       return (String) value;
@@ -212,7 +214,7 @@ private String getStringOrDefaultValue(
   }
 
   private void trackVideoPlayback(
-      TrackPayload track, Properties properties, Map<String, Object> comScoreOptions) {
+          TrackPayload track, Properties properties, Map<String, Object> comScoreOptions) {
     String name = track.event();
     long playbackPosition = properties.getLong("playbackPosition", 0);
 
@@ -221,61 +223,66 @@ private void trackVideoPlayback(
     playbackMapper.put("sound", "ns_st_vo");
 
     Map<String, String> playbackAsset =
-        buildPlaybackAsset(properties, comScoreOptions, playbackMapper);
+            buildPlaybackAsset(properties, comScoreOptions, playbackMapper);
 
     if (name.equals("Video Playback Started")) {
       streamingAnalytics = comScoreAnalytics.createStreamingAnalytics();
       streamingAnalytics.createPlaybackSession();
-      streamingAnalytics.setLabels(playbackAsset);
+      streamingAnalytics.getConfiguration().addLabels(playbackAsset);
 
       // The label ns_st_ci must be set through a setAsset call
       Map<String, String> contentIdMapper = new LinkedHashMap<>();
       contentIdMapper.put("assetId", "ns_st_ci");
 
       Map<String, String> contentIdAsset = mapSpecialKeys(properties, contentIdMapper);
-      streamingAnalytics.getPlaybackSession().setAsset(contentIdAsset);
+
+      streamingAnalytics.setMetadata(getContentMetadata(contentIdAsset));
       return;
     }
 
     if (streamingAnalytics == null) {
       logger.verbose(
-          "streamingAnalytics instance not initialized correctly. Please call Video Playback Started to initialize.");
+              "streamingAnalytics instance not initialized correctly. Please call Video Playback Started to initialize.");
       return;
     }
-
-    streamingAnalytics.setLabels(playbackAsset);
+    streamingAnalytics.getConfiguration().addLabels(playbackAsset);
 
     switch (name) {
       case "Video Playback Paused":
       case "Video Playback Interrupted":
-        streamingAnalytics.notifyPause(playbackPosition);
+        streamingAnalytics.notifyPause();
         logger.verbose("streamingAnalytics.notifyPause(%s)", playbackPosition);
         break;
       case "Video Playback Buffer Started":
-        streamingAnalytics.notifyBufferStart(playbackPosition);
+        streamingAnalytics.startFromPosition(playbackPosition);
+        streamingAnalytics.notifyBufferStart();
         logger.verbose("streamingAnalytics.notifyBufferStart(%s)", playbackPosition);
         break;
       case "Video Playback Buffer Completed":
-        streamingAnalytics.notifyBufferStop(playbackPosition);
+        streamingAnalytics.startFromPosition(playbackPosition);
+        streamingAnalytics.notifyBufferStop();
         logger.verbose("streamingAnalytics.notifyBufferStop(%s)", playbackPosition);
         break;
       case "Video Playback Seek Started":
-        streamingAnalytics.notifySeekStart(playbackPosition);
+        streamingAnalytics.notifySeekStart();
         logger.verbose("streamingAnalytics.notifySeekStart(%s)", playbackPosition);
         break;
       case "Video Playback Seek Completed":
-        streamingAnalytics.notifyPlay(playbackPosition);
+        streamingAnalytics.startFromPosition(playbackPosition);
+        streamingAnalytics.notifyPlay();
         logger.verbose("streamingAnalytics.notifyEnd(%s)", playbackPosition);
         break;
       case "Video Playback Resumed":
-        streamingAnalytics.notifyPlay(playbackPosition);
+        streamingAnalytics.startFromPosition(playbackPosition);
+        streamingAnalytics.notifyPlay();
         logger.verbose("streamingAnalytics.notifyPlay(%s)", playbackPosition);
         break;
     }
   }
 
+
   private void trackVideoContent(
-      TrackPayload track, Properties properties, Map<String, Object> comScoreOptions) {
+          TrackPayload track, Properties properties, Map<String, Object> comScoreOptions) {
     String name = track.event();
     long playbackPosition = properties.getLong("playbackPosition", 0);
 
@@ -291,19 +298,20 @@ private void trackVideoContent(
     contentMapper.put("podId", "ns_st_pn");
 
     Map<String, String> contentAsset =
-        buildContentAsset(properties, comScoreOptions, contentMapper);
+            buildContentAsset(properties, comScoreOptions, contentMapper);
 
     if (streamingAnalytics == null) {
       logger.verbose(
-          "streamingAnalytics instance not initialized correctly. Please call Video Playback Started to initialize.");
+              "streamingAnalytics instance not initialized correctly. Please call Video Playback Started to initialize.");
       return;
     }
 
     switch (name) {
       case "Video Content Started":
-        streamingAnalytics.getPlaybackSession().setAsset(contentAsset);
-        logger.verbose("streamingAnalytics.getPlaybackSession().setAsset(%s)", contentAsset);
-        streamingAnalytics.notifyPlay(playbackPosition);
+        streamingAnalytics.setMetadata(getContentMetadata(contentAsset));
+        logger.verbose("streamingAnalytics.setMetadata(%s)", contentAsset);
+        streamingAnalytics.startFromPosition(playbackPosition);
+        streamingAnalytics.notifyPlay();
         logger.verbose("streamingAnalytics.notifyPlay(%s)", playbackPosition);
         break;
 
@@ -312,25 +320,25 @@ private void trackVideoContent(
         // we need to call setAsset with the content metadata.  If ns_st_ad is not present, that means the last
         // observed event was related to content, in which case a setAsset call should not be made (because asset
         // did not change).
-        if (streamingAnalytics.getPlaybackSession().getAsset().containsLabel("ns_st_ad")) {
-          streamingAnalytics.getPlaybackSession().setAsset(contentAsset);
-          logger.verbose("streamingAnalytics.getPlaybackSession().setAsset(%s)", contentAsset);
+        if(streamingAnalytics.getConfiguration().containsLabel("ns_st_ad")) {
+          streamingAnalytics.setMetadata(getContentMetadata(contentAsset));
+          logger.verbose("streamingAnalytics.setMetadata(%s)", contentAsset);
         }
 
-        streamingAnalytics.notifyPlay(playbackPosition);
+        streamingAnalytics.startFromPosition(playbackPosition);
+        streamingAnalytics.notifyPlay();
         logger.verbose("streamingAnalytics.notifyEnd(%s)", playbackPosition);
-
         break;
 
       case "Video Content Completed":
-        streamingAnalytics.notifyEnd(playbackPosition);
+        streamingAnalytics.notifyEnd();
         logger.verbose("streamingAnalytics.notifyEnd(%s)", playbackPosition);
         break;
     }
   }
 
   public void trackVideoAd(
-      TrackPayload track, Properties properties, Map<String, Object> comScoreOptions) {
+          TrackPayload track, Properties properties, Map<String, Object> comScoreOptions) {
     String name = track.event();
     long playbackPosition = properties.getLong("playbackPosition", 0);
 
@@ -343,7 +351,7 @@ public void trackVideoAd(
 
     if (streamingAnalytics == null) {
       logger.verbose(
-          "streamingAnalytics instance not initialized correctly. Please call Video Playback Started to initialize.");
+              "streamingAnalytics instance not initialized correctly. Please call Video Playback Started to initialize.");
       return;
     }
 
@@ -352,29 +360,41 @@ public void trackVideoAd(
         // The ID for content is not available on Ad Start events, however it will be available on the current
         // StreamingAnalytics's asset. This is because ns_st_ci will have already been set on Content Started
         // calls (if this is a mid or post-roll), or on Video Playback Started (if this is a pre-roll).
-        String contentId = streamingAnalytics.getPlaybackSession().getAsset().getLabel("ns_st_ci");
-
+        String contentId = streamingAnalytics.getConfiguration().getLabel("ns_st_ci");
         if (!isNullOrEmpty(contentId)) {
           adAsset.put("ns_st_ci", contentId);
         }
 
-        streamingAnalytics.getPlaybackSession().setAsset(adAsset);
-        logger.verbose("streamingAnalytics.getPlaybackSession().setAsset(%s)", adAsset);
-        streamingAnalytics.notifyPlay(playbackPosition);
+        streamingAnalytics.setMetadata(getAdvertisementMetadata(adAsset));
+        logger.verbose("streamingAnalytics.setMetadata(%s)", adAsset);
+        streamingAnalytics.startFromPosition(playbackPosition);
+        streamingAnalytics.notifyPlay();
         logger.verbose("streamingAnalytics.notifyPlay(%s)", playbackPosition);
         break;
 
       case "Video Ad Playing":
-        streamingAnalytics.notifyPlay(playbackPosition);
+        streamingAnalytics.startFromPosition(playbackPosition);
+        streamingAnalytics.notifyPlay();
         logger.verbose("streamingAnalytics.notifyPlay(%s)", playbackPosition);
         break;
 
       case "Video Ad Completed":
-        streamingAnalytics.notifyEnd(playbackPosition);
+        streamingAnalytics.notifyEnd();
         logger.verbose("streamingAnalytics.notifyEnd(%s)", playbackPosition);
         break;
     }
   }
+  private ContentMetadata getContentMetadata(Map<String, String> asset){
+    return new ContentMetadata.Builder()
+            .customLabels(asset)
+            .build();
+  }
+
+  private AdvertisementMetadata getAdvertisementMetadata(Map<String, String> adAsset){
+    return new AdvertisementMetadata.Builder()
+            .customLabels(adAsset)
+            .build();
+  }
 
   @Override
   public void track(TrackPayload track) {
@@ -430,8 +450,8 @@ public void screen(ScreenPayload screen) {
     String name = screen.name();
     String category = screen.category();
     HashMap<String, String> properties =
-        (HashMap<String, String>) //
-            screen.properties().toStringMap();
+            (HashMap<String, String>) //
+                    screen.properties().toStringMap();
     properties.put("name", name);
     properties.put("category", category);
     comScoreAnalytics.notifyViewEvent(properties);