snowplow-tracker 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmI4MjYwZDE5ZGEyNjA0MTJkNTA1ZTdkYWU3MDRlOWNjZjEyNGI1NQ==
+    MTZkNTg1MGZiZTIyNzY0NmY4ZTk2ZDYxMjVkMTU3ZmJkZDllODlkMA==
   data.tar.gz: !binary |-
-    MjhiYjIxZWY4OGVhMmI2ODEzODY0NzQzYThhODNhMDY1YzE2Y2IwMA==
+    YTQ5ZDhhYTFiNmJlODI4YTMyNTg1YWIwODQ3ZWJmMzNkZDk4MmE1YQ==
 SHA512:
   metadata.gz: !binary |-
-    M2Q0MzY5MzUyZjRhZGJkOTc2YzYyYTNmYmEzZDc5YjY1OTQyZjRjOTc5M2Q4
-    NTViOGZjOTUxZmVlMDI4NTJkOTFmZmVjMmQyYjE5NjdiZTc2NzZlZTY3YmUx
-    NjUwNTg4ZjNmYzQxMGUwOTE4YWE4NTEzMDM0ZDBlODJhOWI3M2E=
+    ODhmY2ZmMmNjMTA2MzNmZTg2OGEzNDRhODVkZjc3YjY0NGI5NzAyZjUwNjc2
+    MDFmYzZhYjNmZjg4ZmIwZTA4MmFlOTI5NmZlODljYjAwNWQ1OGVlZGFmOTFl
+    ZjhhOTVjNGE3NzY2ZTViMjE2OTI0YmUzYTg1Zjg2OWJkZWJkNjU=
   data.tar.gz: !binary |-
-    ZWRjZWRmNjRkZDlkMjNjMjlmNDU4ZWY0NzBmM2Q0OGM0NDZmNDU2YjRiOTA0
-    NjZlYTE2N2M5NWU4MjE1MzkyYzE2NzhiYmE1OGZjMTQ5NTNlZjZjOGZmNjk4
-    NDQ5NzRiYTAxNDVmOWNkOTJhMDIwNmE3MzdlY2I4Y2E3ZmQ1MzM=
+    Y2UyMTIwOWRhNWYxNTkxZTAxYjgxMTFhMjMzMWMxYjc0MDYyNTNkMTZiYmNk
+    MGU2MjQ0MzU2ODAyNGZhZjk0YmIxYTNhOWI5MjhhNzFmNGYyMTdmZGM4Mzlh
+    OTg4MDUyZTNiY2NmN2Q1MjZjNmEwMGM0MDQ1YTQ3MWEyMzJkM2Q=

data/README.md

@@ -30,9 +30,9 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 
-[ruby]: xxx
-[rails]: xxx
-[rubygems]: xxx
+[ruby]: https://www.ruby-lang.org/en/
+[rails]: http://rubyonrails.org/
+[rubygems]: https://rubygems.org/
 
 [snowplow]: http://snowplowanalytics.com
 

data/lib/snowplow-tracker/payload.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2014 SnowPlow Analytics Ltd. All rights reserved.
+# Copyright (c) 2013-2014 Snowplow Analytics Ltd. All rights reserved.
 #
 # This program is licensed to you under the Apache License Version 2.0,
 # and you may not use this file except in compliance with the Apache License Version 2.0.
@@ -10,7 +10,7 @@
 # See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
 
 # Author:: Alex Dean, Fred Blundun (mailto:support@snowplowanalytics.com)
-# Copyright:: Copyright (c) 2013-2014 SnowPlow Analytics Ltd
+# Copyright:: Copyright (c) 2013-2014 Snowplow Analytics Ltd
 # License:: Apache License Version 2.0
 
 require 'base64'

data/lib/snowplow-tracker/tracker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2014 SnowPlow Analytics Ltd. All rights reserved.
+# Copyright (c) 2013-2014 Snowplow Analytics Ltd. All rights reserved.
 #
 # This program is licensed to you under the Apache License Version 2.0,
 # and you may not use this file except in compliance with the Apache License Version 2.0.
@@ -10,7 +10,7 @@
 # See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
 
 # Author:: Alex Dean, Fred Blundun (mailto:support@snowplowanalytics.com)
-# Copyright:: Copyright (c) 2013-2014 SnowPlow Analytics Ltd
+# Copyright:: Copyright (c) 2013-2014 Snowplow Analytics Ltd
 # License:: Apache License Version 2.0
 
 require 'net/http'
@@ -18,13 +18,15 @@ require 'contracts'
 require 'set'
 include Contracts
 
+require 'uuid'
+
 module SnowplowTracker
 
   class Tracker
 
     @@required_transaction_keys =   Set.new(%w(order_id total_value))
     @@recognised_transaction_keys = Set.new(%w(order_id total_value affiliation tax_value shipping city state country currency))
-    
+
     @@Transaction = lambda { |x|
       return false unless x.class == Hash
       transaction_keys = Set.new(x.keys)
@@ -42,8 +44,8 @@ module SnowplowTracker
         item_keys.subset? @@recognised_item_keys
     }
 
-    @@required_augmented_item_keys =   Set.new(%w(sku price quantity tstamp tid order_id))
-    @@recognised_augmented_item_keys = Set.new(%w(sku price quantity name category context tstamp tid order_id currency))
+    @@required_augmented_item_keys =   Set.new(%w(sku price quantity tstamp order_id))
+    @@recognised_augmented_item_keys = Set.new(%w(sku price quantity name category context tstamp order_id currency))
 
     @@AugmentedItem = lambda { |x|
       return false unless x.class == Hash
@@ -52,17 +54,31 @@ module SnowplowTracker
         augmented_item_keys.subset? @@recognised_augmented_item_keys
     }
 
+    @@SelfDescribingJson = Or[{
+      schema: String,
+      data: Any
+    }, {
+      'schema' => String,
+      'data' => Any
+    }]
+
+    @@ContextsInput = ArrayOf[@@SelfDescribingJson]
+
     @@version = TRACKER_VERSION
     @@default_encode_base64 = true
     @@default_platform = 'pc'
-    @@default_vendor = 'com.snowplowanalytics'
     @@supported_platforms = ['pc', 'tv', 'mob', 'cnsl', 'iot']
     @@http_errors = ['host not found',
                      'No address associated with name',
                      'No address associated with hostname']
 
-    Contract String, Maybe[String], Maybe[String], Maybe[String], Bool => Tracker
-    def initialize(endpoint, namespace=nil, app_id=nil, context_vendor=nil, encode_base64=@@default_encode_base64)
+    @@base_schema_path = "iglu:com.snowplowanalytics.snowplow"
+    @@schema_tag = "jsonschema"
+    @@context_schema = "#{@@base_schema_path}/contexts/#{@@schema_tag}/1-0-0"
+    @@unstruct_event_schema = "#{@@base_schema_path}/unstruct_event/#{@@schema_tag}/1-0-0"
+
+    Contract String, Maybe[String], Maybe[String], Bool => Tracker
+    def initialize(endpoint, namespace=nil, app_id=nil, encode_base64=@@default_encode_base64)
       @collector_uri = as_collector_uri(endpoint)
       @standard_nv_pairs = {
         'tna' => namespace,
@@ -71,9 +87,9 @@ module SnowplowTracker
         'aid' => app_id
       }
       @config = {
-        'context_vendor' => context_vendor,
         'encode_base64' => encode_base64
       }
+      @uuid = UUID.new
       self
     end
 
@@ -84,11 +100,10 @@ module SnowplowTracker
       "http://#{host}/i"
     end
 
-    # Randomly generates a hopefully unique internal transaction ID for each event
-    #
-    Contract nil => Num
-    def get_transaction_id
-      rand(100000..999999)
+    # Generates a type-4 UUID to identify this event
+    Contract nil => String
+    def get_event_id()
+      @uuid.generate
     end
 
     # Generates the timestamp (in milliseconds) to be attached to each event
@@ -98,6 +113,16 @@ module SnowplowTracker
       (Time.now.to_f * 1000).to_i
     end
 
+    # Builds a self-describing JSON from an array of custom contexts
+    #
+    Contract @@ContextsInput => @@SelfDescribingJson
+    def build_context(context)
+      {
+        schema: @@context_schema,
+        data: context
+      }
+    end
+
     # Send request
     #
     Contract Payload => [Bool, Num]
@@ -116,7 +141,7 @@ module SnowplowTracker
     # Setter methods
 
     # Specify the platform
-    # 
+    #
     Contract String => String
     def set_platform(value)
       if @@supported_platforms.include?(value)
@@ -141,7 +166,7 @@ module SnowplowTracker
     end
 
     # Set the dimensions of the current viewport
-    # 
+    #
     Contract Num, Num => String
     def set_viewport(width, height)
       @standard_nv_pairs['vp'] = "#{width}x#{height}"
@@ -176,25 +201,24 @@ module SnowplowTracker
     Contract Payload => [Bool, Num]
     def track(pb)
       pb.add_dict(@standard_nv_pairs)
-      if pb.context.key? 'co' or pb.context.key? 'cx'
-        pb.add('cv', @config['context_vendor'])
-      end
+      pb.add('eid', get_event_id())
+
       http_get(pb)
     end
 
     # Log a visit to this page
     #
-    Contract String, Maybe[String], Maybe[String], Maybe[Hash] => [Bool, Num]
+    Contract String, Maybe[String], Maybe[String], Maybe[@@ContextsInput] => [Bool, Num]
     def track_page_view(page_url, page_title=nil, referrer=nil, context=nil, tstamp=nil)
       pb = Payload.new
       pb.add('e', 'pv')
       pb.add('url', page_url)
       pb.add('page', page_title)
       pb.add('refr', referrer)
-      pb.add('evn', @@default_vendor)
-      pb.add_json(context, @config['encode_base64'], 'cx', 'co')
-      tid = get_transaction_id
-      pb.add('tid', tid)
+      unless context.nil?
+        pb.add_json(build_context(context), @config['encode_base64'], 'cx', 'co')
+      end
+
       if tstamp.nil?
         tstamp = get_timestamp
       end
@@ -216,16 +240,16 @@ module SnowplowTracker
       pb.add('ti_nm', argmap['name'])
       pb.add('ti_ca', argmap['category'])
       pb.add('ti_cu', argmap['currency'])
-      pb.add('evn', @default_vendor)
-      pb.add_json(argmap['context'], @config['encode_base64'], 'cx', 'co')
-      pb.add('tid', argmap['tid'])
+      unless argmap['context'].nil?
+        pb.add_json(build_context(argmap['context']), @config['encode_base64'], 'cx', 'co')
+      end
       pb.add('dtm', argmap['tstamp'])
       track(pb)
     end
 
     # Track an ecommerce transaction and all the items in it
     #
-    Contract @@Transaction, ArrayOf[@@Item], Maybe[Hash], Maybe[Num] => ({'transaction_result' => [Bool, Num], 'item_results' => ArrayOf[[Bool, Num]]})
+    Contract @@Transaction, ArrayOf[@@Item], Maybe[@@ContextsInput], Maybe[Num] => ({'transaction_result' => [Bool, Num], 'item_results' => ArrayOf[[Bool, Num]]})
     def track_ecommerce_transaction(transaction, items,
                                     context=nil, tstamp=nil)
       pb = Payload.new
@@ -239,10 +263,10 @@ module SnowplowTracker
       pb.add('tr_st', transaction['state'])
       pb.add('tr_co', transaction['country'])
       pb.add('tr_cu', transaction['currency'])
-      pb.add('evn', @@default_vendor)
-      pb.add_json(context, @config['encode_base64'], 'cx', 'co')
-      tid = get_transaction_id
-      pb.add('tid', tid)
+      unless context.nil?
+        pb.add_json(build_context(context), @config['encode_base64'], 'cx', 'co')
+      end
+
       if tstamp.nil?
         tstamp = get_timestamp
       end
@@ -253,7 +277,6 @@ module SnowplowTracker
 
       for item in items
         item['tstamp'] = tstamp
-        item['tid'] = tid
         item['order_id'] = transaction['order_id']
         item['currency'] = transaction['currency']
         item_results.push(track_ecommerce_transaction_item(item))
@@ -264,7 +287,7 @@ module SnowplowTracker
 
     # Track a structured event
     #
-    Contract String, String, Maybe[String], Maybe[String], Maybe[Num], Maybe[Hash], Maybe[Num] => [Bool, Num]
+    Contract String, String, Maybe[String], Maybe[String], Maybe[Num], Maybe[@@ContextsInput], Maybe[Num] => [Bool, Num]
     def track_struct_event(category, action, label=nil, property=nil, value=nil, context=nil, tstamp=nil)
       pb = Payload.new
       pb.add('e', 'se')
@@ -273,9 +296,9 @@ module SnowplowTracker
       pb.add('se_la', label)
       pb.add('se_pr', property)
       pb.add('se_va', value)
-      pb.add_json(context, @config['encode_base64'], 'cx', 'co')
-      tid = get_transaction_id
-      pb.add('tid', tid)
+      unless context.nil?
+        pb.add_json(build_context(context), @config['encode_base64'], 'cx', 'co')
+      end
       if tstamp.nil?
         tstamp = get_timestamp
       end
@@ -285,33 +308,46 @@ module SnowplowTracker
 
     # Track a screen view event
     #
-    Contract String, Maybe[String],  Maybe[Hash], Maybe[Num] => [Bool, Num]
+    Contract String, Maybe[String],  Maybe[@@ContextsInput], Maybe[Num] => [Bool, Num]
     def track_screen_view(name, id=nil, context=nil, tstamp=nil)
-      self.track_unstruct_event('screen_view', {'name' => name, 'id' => id}, @@default_vendor, context, tstamp)
+      screen_view_properties = {'name' => name}
+      unless id.nil? 
+        screen_view_properties['id'] = id
+      end
+      screen_view_schema = "#{@@base_schema_path}/screen_view/#{@@schema_tag}/1-0-0"
+      event_json = {schema: screen_view_schema, data: screen_view_properties}
+
+      self.track_unstruct_event(event_json, context, tstamp)
     end
 
     # Track an unstructured event
     #
-    Contract String, Hash, Maybe[String], Maybe[Hash], Maybe[Num] => [Bool, Num]
-    def track_unstruct_event(event_name, dict, event_vendor=nil, context=nil, tstamp=nil)
+    Contract @@SelfDescribingJson, Maybe[@@ContextsInput], Maybe[Num] => [Bool, Num]
+    def track_unstruct_event(event_json, context=nil, tstamp=nil)
       pb = Payload.new
       pb.add('e', 'ue')
-      pb.add('ue_na', event_name)
-      pb.add_json(dict, @config['encode_base64'], 'ue_px', 'ue_pr')
-      pb.add('evn', event_vendor)
-      pb.add_json(context, @config['encode_base64'], 'cx', 'co')
-      tid = get_transaction_id
-      pb.add('tid', tid)
+      
+      envelope = {
+        schema: @@unstruct_event_schema,
+        data: event_json
+      }
+      pb.add_json(envelope, @config['encode_base64'], 'ue_px', 'ue_pr')
+
+      unless context.nil?
+        pb.add_json(build_context(context), @config['encode_base64'], 'cx', 'co')
+      end
+
       if tstamp.nil?
         tstamp = get_timestamp
       end
       pb.add('dtm', tstamp)
+
       track(pb)
     end
 
     private :as_collector_uri,
-            :get_transaction_id,
             :get_timestamp,
+            :build_context,
             :http_get,
             :track,
             :track_ecommerce_transaction_item

data/lib/snowplow-tracker/version.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2014 SnowPlow Analytics Ltd. All rights reserved.
+# Copyright (c) 2013-2014 Snowplow Analytics Ltd. All rights reserved.
 #
 # This program is licensed to you under the Apache License Version 2.0,
 # and you may not use this file except in compliance with the Apache License Version 2.0.
@@ -10,10 +10,10 @@
 # See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
 
 # Author:: Alex Dean, Fred Blundun (mailto:support@snowplowanalytics.com)
-# Copyright:: Copyright (c) 2013-2014 SnowPlow Analytics Ltd
+# Copyright:: Copyright (c) 2013-2014 Snowplow Analytics Ltd
 # License:: Apache License Version 2.0
 
 module SnowplowTracker
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
   TRACKER_VERSION = "rb-#{VERSION}"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snowplow-tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexander Dean
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contracts
@@ -25,6 +25,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.7
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement