Standardise API for Tracker and Subject Builders (close #302)

For PR #350

* Add builder method to Tracker

* Add builder method to Subject

* Remove unused import

Author: mscwilson

examples/simple-console/src/main/java/com/snowplowanalytics/Main.java

@@ -49,7 +49,7 @@ public static void main(String[] args) throws InterruptedException {
                 .build();
 
         // now we have the emitter, we need a tracker to turn our events into something a Snowplow collector can understand
-        final Tracker tracker = new Tracker.TrackerBuilder(emitter, namespace, appId)
+        final Tracker tracker = Tracker.builder(emitter, namespace, appId)
             .base64(true)
             .platform(DevicePlatform.ServerSideApp)
             .build();
@@ -64,7 +64,7 @@ public static void main(String[] args) throws InterruptedException {
                 Collections.singletonMap("foo", "bar")));
 
         // This is an example of a eventSubject for adding user data
-        Subject eventSubject = new Subject.SubjectBuilder().build();
+        Subject eventSubject = Subject.builder().build();
         eventSubject.setUserId("[email protected]");
         eventSubject.setLanguage("EN");
 

src/main/java/com/snowplowanalytics/snowplow/tracker/Subject.java

@@ -55,6 +55,10 @@ public Subject(Subject subject){
       this.standardPairs.putAll(subject.getSubject());
     }
 
+    public static SubjectBuilder builder() {
+        return new SubjectBuilder();
+    }
+
     /**
      * Builder for the Subject
      */

src/main/java/com/snowplowanalytics/snowplow/tracker/Tracker.java

@@ -55,6 +55,10 @@ private Tracker(TrackerBuilder builder) {
 
     }
 
+    public static TrackerBuilder builder(Emitter emitter, String namespace, String appId) {
+        return new TrackerBuilder(emitter, namespace, appId);
+    }
+
     /**
      * Builder for the Tracker
      */

src/test/java/com/snowplowanalytics/snowplow/tracker/SubjectTest.java

@@ -24,84 +24,84 @@ public class SubjectTest {
 
     @Test
     public void testSetUserId() {
-        Subject subject = new Subject.SubjectBuilder().build();
+        Subject subject = Subject.builder().build();
         subject.setUserId("user1");
         assertEquals("user1", subject.getSubject().get("uid"));
     }
 
     @Test
     public void testSetScreenResolution() {
-        Subject subject = new Subject.SubjectBuilder().build();
+        Subject subject = Subject.builder().build();
         subject.setScreenResolution(100, 150);
         assertEquals("100x150", subject.getSubject().get("res"));
     }
 
     @Test
     public void testSetViewPort() {
-        Subject subject = new Subject.SubjectBuilder().build();
+        Subject subject = Subject.builder().build();
         subject.setViewPort(150, 100);
         assertEquals("150x100", subject.getSubject().get("vp"));
     }
 
     @Test
     public void testSetColorDepth() {
-        Subject subject = new Subject.SubjectBuilder().build();
+        Subject subject = Subject.builder().build();
         subject.setColorDepth(10);
         assertEquals("10", subject.getSubject().get("cd"));
     }
 
     @Test
     public void testSetTimezone2() {
-        Subject subject = new Subject.SubjectBuilder().build();
+        Subject subject = Subject.builder().build();
         subject.setTimezone("America/Toronto");
         assertEquals("America/Toronto", subject.getSubject().get("tz"));
     }
 
     @Test
     public void testSetLanguage() {
-        Subject subject = new Subject.SubjectBuilder().build();
+        Subject subject = Subject.builder().build();
         subject.setLanguage("EN");
         assertEquals("EN", subject.getSubject().get("lang"));
     }
 
     @Test
     public void testSetIpAddress() {
-        Subject subject = new Subject.SubjectBuilder().build();
+        Subject subject = Subject.builder().build();
         subject.setIpAddress("127.0.0.1");
         assertEquals("127.0.0.1", subject.getSubject().get("ip"));
     }
 
     @Test
     public void testSetUseragent() {
-        Subject subject = new Subject.SubjectBuilder().build();
+        Subject subject = Subject.builder().build();
         subject.setUseragent("useragent");
         assertEquals("useragent", subject.getSubject().get("ua"));
     }
 
     @Test
     public void testSetDomainUserId() {
-        Subject subject = new Subject.SubjectBuilder().build();
+        Subject subject = Subject.builder().build();
         subject.setDomainUserId("duid");
         assertEquals("duid", subject.getSubject().get("duid"));
     }
 
     @Test
     public void testSetNetworkUserId() {
-        Subject subject = new Subject.SubjectBuilder().build();
+        Subject subject = Subject.builder().build();
         subject.setNetworkUserId("nuid");
         assertEquals("nuid", subject.getSubject().get("tnuid"));
     }
 
     @Test
     public void testSetDomainSessionId() {
-        Subject subject = new Subject.SubjectBuilder().build();
+        Subject subject = Subject.builder().build();
         subject.setDomainSessionId("sessionid");
         assertEquals("sessionid", subject.getSubject().get("sid"));
     }
 
     @Test
     public void testGetSubject() {
-        Subject subject = new Subject.SubjectBuilder().build();
+        Subject subject = Subject.builder().build();
         Map<String, String> expected = new HashMap<>();
         subject.setTimezone("America/Toronto");
         subject.setUserId("user1");

src/test/java/com/snowplowanalytics/snowplow/tracker/TrackerTest.java

@@ -53,8 +53,8 @@ public void flushBuffer() {}
     @Before
     public void setUp() {
         mockEmitter = new MockEmitter();
-        tracker = new Tracker.TrackerBuilder(mockEmitter, "AF003", "cloudfront")
-                .subject(new Subject.SubjectBuilder().build())
+        tracker = Tracker.builder(mockEmitter, "AF003", "cloudfront")
+                .subject(Subject.builder().build())
                 .base64(false)
                 .build();
         tracker.getSubject().setTimezone("Etc/UTC");
@@ -100,7 +100,7 @@ public void flushBuffer() {}
             public List<TrackerPayload> getBuffer() { return null; }
         }
         FailingMockEmitter failingMockEmitter = new FailingMockEmitter();
-        tracker = new Tracker.TrackerBuilder(failingMockEmitter, "AF003", "cloudfront").build();
+        tracker = Tracker.builder(failingMockEmitter, "AF003", "cloudfront").build();
 
         List<String> result = tracker.track(SelfDescribing.builder()
                 .eventData(new SelfDescribingJson(
@@ -321,8 +321,8 @@ public void testSelfDescribingEventWithoutTrueTimestamp() throws InterruptedExce
 
     @Test
     public void testTrackPageView() throws InterruptedException {
-        tracker = new Tracker.TrackerBuilder(mockEmitter, "AF003", "cloudfront")
-                .subject(new Subject.SubjectBuilder().build())
+        tracker = Tracker.builder(mockEmitter, "AF003", "cloudfront")
+                .subject(Subject.builder().build())
                 .base64(false)
                 .build();
         tracker.getSubject().setTimezone("Etc/UTC");
@@ -524,7 +524,7 @@ public void testTrackTiming() throws InterruptedException {
     @Test
     public void testTrackTimingWithSubject() throws InterruptedException {
         // Make Subject
-        Subject s1 = new Subject.SubjectBuilder().build();
+        Subject s1 = Subject.builder().build();
         s1.setIpAddress("127.0.0.1");
         s1.setTimezone("Etc/UTC");
 
@@ -563,13 +563,13 @@ public void testTrackTimingWithSubject() throws InterruptedException {
 
     @Test
     public void testGetTrackerVersion() {
-        Tracker tracker = new Tracker.TrackerBuilder(mockEmitter, "namespace", "an-app-id").build();
+        Tracker tracker = Tracker.builder(mockEmitter, "namespace", "an-app-id").build();
         assertEquals("java-0.12.2", tracker.getTrackerVersion());
     }
 
     @Test
     public void testSetDefaultPlatform() {
-        Tracker tracker = new Tracker.TrackerBuilder(mockEmitter, "AF003", "cloudfront")
+        Tracker tracker = Tracker.builder(mockEmitter, "AF003", "cloudfront")
                 .platform(DevicePlatform.Desktop)
                 .build();
         assertEquals(DevicePlatform.Desktop, tracker.getPlatform());
@@ -580,13 +580,13 @@ public void testSetSubject() {
         // Subject objects always have timezone set
         TimeZone.setDefault(TimeZone.getTimeZone("Etc/UTC"));
 
-        Subject s1 = new Subject.SubjectBuilder().build();
+        Subject s1 = Subject.builder().build();
         s1.setLanguage("EN");
-        Tracker tracker = new Tracker.TrackerBuilder(mockEmitter, "AF003", "cloudfront")
+        Tracker tracker = Tracker.builder(mockEmitter, "AF003", "cloudfront")
                 .subject(s1)
                 .build();
 
-        Subject s2 = new Subject.SubjectBuilder().build();
+        Subject s2 = Subject.builder().build();
         s2.setColorDepth(24);
         tracker.setSubject(s2);
 
@@ -599,21 +599,21 @@ public void testSetSubject() {
 
     @Test
     public void testSetBase64Encoded() {
-        Tracker tracker = new Tracker.TrackerBuilder(mockEmitter, "AF003", "cloudfront")
+        Tracker tracker = Tracker.builder(mockEmitter, "AF003", "cloudfront")
                 .base64(false)
                 .build();
         assertFalse(tracker.getBase64Encoded());
     }
 
     @Test
     public void testSetAppId() {
-        Tracker tracker = new Tracker.TrackerBuilder(mockEmitter, "AF003", "an-app-id").build();
+        Tracker tracker = Tracker.builder(mockEmitter, "AF003", "an-app-id").build();
         assertEquals("an-app-id", tracker.getAppId());
     }
 
     @Test
     public void testSetNamespace() {
-        Tracker tracker = new Tracker.TrackerBuilder(mockEmitter, "namespace", "an-app-id").build();
+        Tracker tracker = Tracker.builder(mockEmitter, "namespace", "an-app-id").build();
         assertEquals("namespace", tracker.getNamespace());
     }
 }