Merge pull request #4 from circleci/bostonaholic/update-segment

bostonaholic · web-flow · commit a47fb67057f8 · 2019-01-27T19:50:29.000-07:00
update segment 2.0.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+Version 0.6.0 (Unreleased)
+==========================
+
+* [ADDED](https://github.com/circleci/analytics-clj/pull/4): Allow sending a custom message ID.
+* Support for Segment 2.0.0
+
 Version 0.5.0 (January 24, 2019)
 ================================
 
diff --git a/docs/circleci.analytics-clj.core.html b/docs/circleci.analytics-clj.core.html
@@ -2,7 +2,7 @@
     "">
 <html><head><meta charset="UTF-8" /><title>circleci.analytics-clj.core documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Analytics-clj</span> <span class="project-version">0.5.0</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 current"><a href="circleci.analytics-clj.core.html"><div class="inner"><span>circleci.analytics-clj.core</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-alias"><div class="inner"><span>alias</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-common-fields"><div class="inner"><span>common-fields</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-enqueue"><div class="inner"><span>enqueue</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-flush"><div class="inner"><span>flush</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-group"><div class="inner"><span>group</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-identify"><div class="inner"><span>identify</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-initialize"><div class="inner"><span>initialize</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-page"><div class="inner"><span>page</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-screen"><div class="inner"><span>screen</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-shutdown"><div class="inner"><span>shutdown</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-track"><div class="inner"><span>track</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">circleci.analytics-clj.core</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-alias"><h3>alias</h3><h4 class="added">added in 0.4.0</h4><div class="usage"><code>(alias analytics previous-id user-id)</code><code>(alias analytics previous-id user-id options)</code></div><div class="doc"><pre class="plaintext">`alias` is how you associate one identity with another.
 This is an advanced method, but it is required to manage
-user identities successfully in some of our integrations.</pre></div></div><div class="public anchor" id="var-common-fields"><h3>common-fields</h3><h4 class="added">added in 0.4.0</h4><div class="usage"><code>(common-fields message-builder {:keys [anonymous-id context integration-options integrations timestamp user-id]})</code></div><div class="doc"><pre class="plaintext">The `MessageBuilder` interface has a set of fields common to all messages.
+user identities successfully in some of our integrations.</pre></div></div><div class="public anchor" id="var-common-fields"><h3>common-fields</h3><h4 class="added">added in 0.4.0</h4><div class="usage"><code>(common-fields message-builder {:keys [anonymous-id context integration-options integrations timestamp message-id user-id]})</code></div><div class="doc"><pre class="plaintext">The `MessageBuilder` interface has a set of fields common to all messages.
 
 <a href="https://segment.com/docs/spec/common/">https://segment.com/docs/spec/common/</a></pre></div></div><div class="public anchor" id="var-enqueue"><h3>enqueue</h3><h4 class="added">added in 0.4.0</h4><div class="usage"><code>(enqueue analytics message-builder)</code></div><div class="doc"><pre class="plaintext">Top-level `enqueue` function to allow for extensibility in the future.
 </pre></div></div><div class="public anchor" id="var-flush"><h3>flush</h3><h4 class="added">added in 0.4.0</h4><div class="usage"><code>(flush analytics)</code></div><div class="doc"><pre class="plaintext">Flush events in the message queue.
diff --git a/project.clj b/project.clj
@@ -4,7 +4,7 @@
   :license {:name "Eclipse Public License"
             :url "http://www.eclipse.org/legal/epl-v10.html"}
   :dependencies [[org.clojure/clojure "1.8.0"]
-                 [com.segment.analytics.java/analytics "2.0.0-RC7"]]
+                 [com.segment.analytics.java/analytics "2.0.0"]]
   :profiles {:dev {:dependencies [[bond "0.2.6"]]}}
   :plugins [[lein-codox "0.10.5"]]
   :codox {:output-path "docs"
diff --git a/src/circleci/analytics_clj/core.clj b/src/circleci/analytics_clj/core.clj
@@ -63,7 +63,7 @@
 
   {:added "0.4.0"}
 
-  [message-builder {:keys [anonymous-id context integration-options integrations timestamp user-id]}]
+  [message-builder {:keys [anonymous-id context integration-options integrations timestamp message-id user-id]}]
   (letfn [(enable-integrations [message-builder integrations]
             (doseq [[integration enable?] integrations]
               (enable-integration* message-builder integration enable?)))
@@ -87,6 +87,9 @@
       (cond-> (not (nil? timestamp))
         (timestamp* timestamp))
 
+      (cond-> (not (nil? message-id))
+        (message-id* message-id))
+
       (cond-> (not (nil? user-id))
         (user-id* user-id)))))
 
diff --git a/src/circleci/analytics_clj/external.clj b/src/circleci/analytics_clj/external.clj
@@ -3,23 +3,23 @@
 
 ;;; com.segment.analytics.Analytics$Builder
 
-(defn client* [analytics-builder client]
+(defn client* [^com.segment.analytics.Analytics$Builder analytics-builder client]
   (doto analytics-builder
     (.client client)))
 
-(defn log* [analytics-builder log]
+(defn log* [^com.segment.analytics.Analytics$Builder analytics-builder log]
   (doto analytics-builder
     (.log log)))
 
-(defn endpoint* [analytics-builder endpoint]
+(defn endpoint* [^com.segment.analytics.Analytics$Builder analytics-builder endpoint]
   (doto analytics-builder
     (.endpoint endpoint)))
 
-(defn network-executor* [analytics-builder network-executor]
+(defn network-executor* [^com.segment.analytics.Analytics$Builder analytics-builder network-executor]
   (doto analytics-builder
     (.networkExecutor network-executor)))
 
-(defn callback* [analytics-builder callback]
+(defn callback* [^com.segment.analytics.Analytics$Builder analytics-builder callback]
   (doto analytics-builder
     (.callback callback)))
 
@@ -41,18 +41,22 @@
   (doto message-builder
     (.integrationOptions integration options)))
 
-(defn properties* [^MessageBuilder message-builder properties]
-  (doto message-builder
-    (.properties properties)))
-
 (defn timestamp* [^MessageBuilder message-builder timestamp]
   (doto message-builder
     (.timestamp timestamp)))
 
-(defn traits* [^MessageBuilder message-builder traits]
+(defn message-id* [^MessageBuilder message-builder message-id]
   (doto message-builder
-    (.traits traits)))
+    (.messageId message-id)))
 
 (defn user-id* [^MessageBuilder message-builder user-id]
   (doto message-builder
     (.userId user-id)))
+
+(defn properties* [message-builder properties]
+  (doto message-builder
+    (.properties properties)))
+
+(defn traits* [message-builder traits]
+  (doto message-builder
+    (.traits traits)))
diff --git a/test/circleci/analytics_clj/core_test.clj b/test/circleci/analytics_clj/core_test.clj
@@ -85,7 +85,14 @@
       (bond/with-spy [e/timestamp*]
         (a/track analytics "1234" "signup" {"company" "Acme Inc."} {:timestamp timestamp})
         (is (= 1 (-> e/timestamp* bond/calls count)))
-        (is (= timestamp (-> e/timestamp* bond/calls first :args second)))))))
+        (is (= timestamp (-> e/timestamp* bond/calls first :args second))))))
+
+  (testing "sending a custom message ID"
+    (let [message-id (java.util.UUID/randomUUID)]
+      (bond/with-spy [e/message-id*]
+        (a/track analytics "1234" "signup" {"company" "Acme Inc."} {:message-id message-id})
+        (is (= 1 (-> e/message-id* bond/calls count)))
+        (is (= message-id (-> e/message-id* bond/calls first :args second)))))))
 
 (deftest test-screen
   (testing "a simple screen call"
