Merge pull request #10 from circleci/bostonaholic/privatize-fn

bostonaholic · web-flow · commit 66ddeecabd34 · 2019-01-27T21:25:06.000-07:00
Privatize circleci.analytics-clj.core/common-fields
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+Version 0.8.0 (Unreleased)
+==========================
+
+* [REMOVED](https://github.com/circleci/analytics-clj/pull/10): Privatize circleci.analytics-clj.core/common-fields
+
 Version 0.7.1 (January 27, 2019)
 ================================
 
diff --git a/docs/circleci.analytics-clj.core.html b/docs/circleci.analytics-clj.core.html
@@ -1,10 +1,8 @@
 <!DOCTYPE html PUBLIC ""
     "">
-<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.7.1</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.
+<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.7.1</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-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 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.
+user identities successfully in some of our integrations.</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.
 </pre></div></div><div class="public anchor" id="var-group"><h3>group</h3><h4 class="added">added in 0.4.0</h4><div class="usage"><code>(group analytics user-id group-id)</code><code>(group analytics user-id group-id traits)</code><code>(group analytics user-id group-id traits options)</code></div><div class="doc"><pre class="plaintext">`group` lets you associate an identified user with
 a group. A group could be a company, organization, account,
diff --git a/docs/index.html b/docs/index.html
@@ -1,3 +1,3 @@
 <!DOCTYPE html PUBLIC ""
     "">
-<html><head><meta charset="UTF-8" /><title>Analytics-clj 0.7.1</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.7.1</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 current"><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 "><a href="circleci.analytics-clj.core.html"><div class="inner"><span>circleci.analytics-clj.core</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Analytics-clj</span> <span class="project-version">0.7.1</span></span></h1><h5 class="license">Released under the <a href="http://www.eclipse.org/legal/epl-v10.html">Eclipse Public License</a></h5><div class="doc"><p>Idiomatic Clojure wrapper for the Segment.io 2.x Java client.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[circleci/analytics-clj "0.7.1"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="circleci.analytics-clj.core.html">circleci.analytics-clj.core</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="circleci.analytics-clj.core.html#var-alias">alias</a> </li><li> <a href="circleci.analytics-clj.core.html#var-common-fields">common-fields</a> </li><li> <a href="circleci.analytics-clj.core.html#var-enqueue">enqueue</a> </li><li> <a href="circleci.analytics-clj.core.html#var-flush">flush</a> </li><li> <a href="circleci.analytics-clj.core.html#var-group">group</a> </li><li> <a href="circleci.analytics-clj.core.html#var-identify">identify</a> </li><li> <a href="circleci.analytics-clj.core.html#var-initialize">initialize</a> </li><li> <a href="circleci.analytics-clj.core.html#var-page">page</a> </li><li> <a href="circleci.analytics-clj.core.html#var-screen">screen</a> </li><li> <a href="circleci.analytics-clj.core.html#var-shutdown">shutdown</a> </li><li> <a href="circleci.analytics-clj.core.html#var-track">track</a> </li></ul></div></div></div></body></html>
+<html><head><meta charset="UTF-8" /><title>Analytics-clj 0.7.1</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.7.1</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 current"><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 "><a href="circleci.analytics-clj.core.html"><div class="inner"><span>circleci.analytics-clj.core</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Analytics-clj</span> <span class="project-version">0.7.1</span></span></h1><h5 class="license">Released under the <a href="http://www.eclipse.org/legal/epl-v10.html">Eclipse Public License</a></h5><div class="doc"><p>Idiomatic Clojure wrapper for the Segment.io 2.x Java client.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[circleci/analytics-clj "0.7.1"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="circleci.analytics-clj.core.html">circleci.analytics-clj.core</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="circleci.analytics-clj.core.html#var-alias">alias</a> </li><li> <a href="circleci.analytics-clj.core.html#var-enqueue">enqueue</a> </li><li> <a href="circleci.analytics-clj.core.html#var-flush">flush</a> </li><li> <a href="circleci.analytics-clj.core.html#var-group">group</a> </li><li> <a href="circleci.analytics-clj.core.html#var-identify">identify</a> </li><li> <a href="circleci.analytics-clj.core.html#var-initialize">initialize</a> </li><li> <a href="circleci.analytics-clj.core.html#var-page">page</a> </li><li> <a href="circleci.analytics-clj.core.html#var-screen">screen</a> </li><li> <a href="circleci.analytics-clj.core.html#var-shutdown">shutdown</a> </li><li> <a href="circleci.analytics-clj.core.html#var-track">track</a> </li></ul></div></div></div></body></html>
diff --git a/src/circleci/analytics_clj/common.clj b/src/circleci/analytics_clj/common.clj
@@ -0,0 +1,43 @@
+(ns circleci.analytics-clj.common
+  (:require [circleci.analytics-clj.external :refer :all]
+            [circleci.analytics-clj.utils :refer [string-keys]]))
+
+(def ^:private ctx {"library" {"name" "analytics-clj"
+                               "version" "0.7.1"}})
+
+(defn common-fields
+  "The `MessageBuilder` interface has a set of fields common to all messages.
+
+  https://segment.com/docs/spec/common/"
+
+  {:added "0.4.0"}
+
+  [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?)))
+
+          (enable-integration-options [message-builder integration-options]
+            (doseq [[integration options] integration-options]
+              (integration-options* message-builder integration (string-keys options))))]
+
+    (doto message-builder
+      (context* (merge ctx (string-keys context)))
+
+      (cond-> (not (nil? anonymous-id))
+        (anonymous-id* anonymous-id))
+
+      (cond-> (not (nil? integration-options))
+        (enable-integration-options integration-options))
+
+      (cond-> (not (nil? integrations))
+        (enable-integrations integrations))
+
+      (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/core.clj b/src/circleci/analytics_clj/core.clj
@@ -1,6 +1,7 @@
 (ns circleci.analytics-clj.core
   (:refer-clojure :exclude [alias flush])
-  (:require [circleci.analytics-clj.external :refer :all]
+  (:require [circleci.analytics-clj.common :as common]
+            [circleci.analytics-clj.external :refer :all]
             [circleci.analytics-clj.utils :refer [string-keys]])
   (:import (com.segment.analytics Analytics)
            (com.segment.analytics.messages AliasMessage
@@ -10,9 +11,6 @@
                                            ScreenMessage
                                            TrackMessage)))
 
-(def ^:private ctx {"library" {"name" "analytics-clj"
-                               "version" "0.7.1"}})
-
 (defn initialize
   "Start building an Analytics instance."
 
@@ -59,43 +57,6 @@
   [^Analytics analytics]
   (.shutdown analytics))
 
-(defn common-fields
-  "The `MessageBuilder` interface has a set of fields common to all messages.
-
-  https://segment.com/docs/spec/common/"
-
-  {:added "0.4.0"}
-
-  [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?)))
-
-          (enable-integration-options [message-builder integration-options]
-            (doseq [[integration options] integration-options]
-              (integration-options* message-builder integration (string-keys options))))]
-
-    (doto message-builder
-      (context* (merge ctx (string-keys context)))
-
-      (cond-> (not (nil? anonymous-id))
-        (anonymous-id* anonymous-id))
-
-      (cond-> (not (nil? integration-options))
-        (enable-integration-options integration-options))
-
-      (cond-> (not (nil? integrations))
-        (enable-integrations integrations))
-
-      (cond-> (not (nil? timestamp))
-        (timestamp* timestamp))
-
-      (cond-> (not (nil? message-id))
-        (message-id* message-id))
-
-      (cond-> (not (nil? user-id))
-        (user-id* user-id)))))
-
 (defn identify
   "`identify` lets you tie a user to their actions and
   record traits about them. It includes a unique User ID
@@ -111,7 +72,7 @@
 
   ([^Analytics analytics user-id traits options]
    (enqueue analytics (doto (IdentifyMessage/builder)
-                        (common-fields (merge {:user-id user-id} options))
+                        (common/common-fields (merge {:user-id user-id} options))
                         (cond-> (not (nil? traits)) (traits* (string-keys traits)))))))
 
 (defn track
@@ -129,7 +90,7 @@
 
   ([^Analytics analytics user-id event properties options]
    (enqueue analytics (doto (TrackMessage/builder event)
-                        (common-fields (merge {:user-id user-id} options))
+                        (common/common-fields (merge {:user-id user-id} options))
                         (cond-> (not (nil? properties)) (properties* (string-keys properties)))))))
 
 (defn screen
@@ -147,7 +108,7 @@
 
   ([^Analytics analytics user-id name properties options]
    (enqueue analytics (doto (ScreenMessage/builder name)
-                        (common-fields (merge {:user-id user-id} options))
+                        (common/common-fields (merge {:user-id user-id} options))
                         (cond-> (not (nil? properties)) (properties* (string-keys properties)))))))
 
 (defn page
@@ -165,7 +126,7 @@
 
   ([^Analytics analytics user-id name properties options]
    (enqueue analytics (doto (PageMessage/builder name)
-                        (common-fields (merge {:user-id user-id} options))
+                        (common/common-fields (merge {:user-id user-id} options))
                         (cond-> (not (nil? properties)) (properties* (string-keys properties)))))))
 
 (defn group
@@ -184,7 +145,7 @@
 
   ([^Analytics analytics user-id group-id traits options]
    (enqueue analytics (doto (GroupMessage/builder group-id)
-                        (common-fields (merge {:user-id user-id} options))
+                        (common/common-fields (merge {:user-id user-id} options))
                         (cond-> (not (nil? traits)) (traits* (string-keys traits)))))))
 
 (defn alias
@@ -199,4 +160,4 @@
 
   ([^Analytics analytics previous-id user-id options]
    (enqueue analytics (doto (AliasMessage/builder previous-id)
-                        (common-fields (merge {:user-id user-id} options))))))
+                        (common/common-fields (merge {:user-id user-id} options))))))
