snowplow-tracker 0.5.2 → 0.6.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTVhZTY2ODI0YjMxNjJlNGYyYjE4NzZjZmM0NzZiMjNkNWYwZjM5Mg==
-  data.tar.gz: !binary |-
-    Mjc0YjdhNmJmOGFiZTk5MjljZDNjMzJlMmMzNWRjY2JjY2UzMTQzYQ==
+SHA1:
+  metadata.gz: 09edf5a160b319e2e293ca4583bfeac466991990
+  data.tar.gz: abe2cba4c1adfe3c1924c62d06c5f77ac0e9164a
 SHA512:
-  metadata.gz: !binary |-
-    MGFiM2I4ZGFjMjAwNmQ4ODQ1Mjc0YTNhMDk5MWMyZWQyODE3NTJlYWViMWYy
-    MzZmMWEzNzNiODAyNGViYjFiYTQyNTg2ZjZiZTRjMDY2ZGQzNjdjNWIyNTVj
-    N2IxZmNhNzEwZjhkZmVmOGRiOWQ1MTlmMDYzNTU3NWMzMTA1Mjg=
-  data.tar.gz: !binary |-
-    ODk2OWI5MzBmMjRkMjdmOWJhMTMwOWVkNTA1MmFhNWEzNTBlM2MzOTExMmZk
-    NGY0ZGVmMzIxNzU2ZjRkMTkwMzZiN2MzZDM5NjU0MjRmODIwZWY1YzRlZjg4
-    MjNiZDc4YjJmNjUxMzdlYjg0NjUyNTU2MmM3ZGQwZGFmNGI4MGY=
+  metadata.gz: 69808182a038139f1fdf3c032b1603b405ba3883ebdee3fcc694e4dd0796a7ba2ba60a45ecedb132861bdca05ad09825be20a44b327047ca4ede9650c7b60bb3
+  data.tar.gz: 3159420b1dba13915f3cf8a7debf165b320a3b6d1141792f4d6984c2343c49d7ae93b7eb98c53466e3de60d8541e8f6dd2a94febe7cabbca643c3c0323e0760f

data/lib/snowplow-tracker.rb

@@ -19,4 +19,6 @@ require 'snowplow-tracker/self_describing_json.rb'
 require 'snowplow-tracker/payload.rb'
 require 'snowplow-tracker/subject.rb'
 require 'snowplow-tracker/emitters.rb'
+require 'snowplow-tracker/timestamp.rb'
 require 'snowplow-tracker/tracker.rb'
+

data/lib/snowplow-tracker/emitters.rb

@@ -113,6 +113,10 @@ module SnowplowTracker
       end
       LOGGER.info("Attempting to send #{evts.size} request#{evts.size == 1 ? '' : 's'}")
 
+      evts.each do |event|
+        event['stm'] = (Time.now.to_f * 1000).to_i # add the sent timestamp, overwrite if already exists
+      end
+
       if @method == 'post'
         post_succeeded = false
         begin

data/lib/snowplow-tracker/timestamp.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2016 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.
+# You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the Apache License Version 2.0 is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+
+# Author:: Alex Dean, Fred Blundun, Ed Lewis (mailto:support@snowplowanalytics.com)
+# Copyright:: Copyright (c) 2016 Snowplow Analytics Ltd
+# License:: Apache License Version 2.0
+
+module SnowplowTracker
+
+    class Timestamp
+
+        attr_reader :type
+        attr_reader :value
+
+        def initialize(type, value)
+            @type = type
+            @value = value
+        end
+
+    end
+
+    class TrueTimestamp < Timestamp
+
+        def initialize(value) 
+            super 'ttm', value
+        end
+
+    end
+
+    class DeviceTimestamp < Timestamp
+
+        def initialize(value) 
+            super 'dtm', value
+        end
+
+    end
+
+end

data/lib/snowplow-tracker/tracker.rb

@@ -133,23 +133,33 @@ module SnowplowTracker
       nil
     end
 
+    # Log a visit to this page with an inserted device timestamp
+    #
+    Contract String, Maybe[String], Maybe[String], Maybe[@@ContextsInput], Maybe[Num] => Tracker
+    def track_page_view(page_url, page_title=nil, referrer=nil, context=nil, tstamp=nil)
+      if tstamp.nil?
+        tstamp = get_timestamp
+      end
+
+      track_page_view(page_url, page_title, referrer, context, DeviceTimestamp.new(tstamp))  
+    end
+
     # Log a visit to this page
     #
-    Contract String, Maybe[String], Maybe[String], Maybe[@@ContextsInput] => Tracker
+    Contract String, Maybe[String], Maybe[String], Maybe[@@ContextsInput], SnowplowTracker::Timestamp => Tracker
     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)
+
       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)
+      pb.add(tstamp.type, tstamp.value)
+
       track(pb)
 
       self
@@ -172,15 +182,29 @@ module SnowplowTracker
       unless argmap['context'].nil?
         pb.add_json(build_context(argmap['context']), @config['encode_base64'], 'cx', 'co')
       end
-      pb.add('dtm', argmap['tstamp'])
+      pb.add(argmap['tstamp'].type, argmap['tstamp'].value)
       track(pb)
 
       self
     end
 
     # Track an ecommerce transaction and all the items in it
-    #
+    # Set the timestamp as the device timestamp
     Contract @@Transaction, ArrayOf[@@Item], Maybe[@@ContextsInput], Maybe[Num] => Tracker
+    def track_ecommerce_transaction(transaction, 
+                                    items,
+                                    context=nil,
+                                    tstamp=nil)      
+      if tstamp.nil?
+        tstamp = get_timestamp
+      end
+
+      track_ecommerce_transaction(transaction, items, context, DeviceTimestamp.new(tstamp))
+    end
+
+    # Track an ecommerce transaction and all the items in it
+    #
+    Contract @@Transaction, ArrayOf[@@Item], Maybe[@@ContextsInput], Timestamp => Tracker
     def track_ecommerce_transaction(transaction, items,
                                     context=nil, tstamp=nil)
       pb = Payload.new
@@ -198,10 +222,7 @@ module SnowplowTracker
         pb.add_json(build_context(context), @config['encode_base64'], 'cx', 'co')
       end
 
-      if tstamp.nil?
-        tstamp = get_timestamp
-      end
-      pb.add('dtm', tstamp)
+      pb.add(tstamp.type, tstamp.value)
 
       track(pb)
 
@@ -216,8 +237,18 @@ module SnowplowTracker
     end
 
     # Track a structured event
-    #
+    # set the timestamp to the device timestamp
     Contract String, String, Maybe[String], Maybe[String], Maybe[Num], Maybe[@@ContextsInput], Maybe[Num] => Tracker
+    def track_struct_event(category, action, label=nil, property=nil, value=nil, context=nil, tstamp=nil)
+      if tstamp.nil?
+        tstamp = get_timestamp
+      end
+
+      track_struct_event(category, action, label, property, value, context, DeviceTimestamp.new(tstamp))
+    end
+    # Track a structured event
+    #
+    Contract String, String, Maybe[String], Maybe[String], Maybe[Num], Maybe[@@ContextsInput], Timestamp => Tracker
     def track_struct_event(category, action, label=nil, property=nil, value=nil, context=nil, tstamp=nil)
       pb = Payload.new
       pb.add('e', 'se')
@@ -229,10 +260,8 @@ module SnowplowTracker
       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)
+
+      pb.add(tstamp.type, tstamp.value)
       track(pb)
 
       self
@@ -240,7 +269,7 @@ module SnowplowTracker
 
     # Track a screen view event
     #
-    Contract Maybe[String], Maybe[String],  Maybe[@@ContextsInput], Maybe[Num] => Tracker
+    Contract Maybe[String], Maybe[String],  Maybe[@@ContextsInput], Or[Timestamp, Num, nil] => Tracker
     def track_screen_view(name=nil, id=nil, context=nil, tstamp=nil)
       screen_view_properties = {}
       unless name.nil? 
@@ -258,9 +287,34 @@ module SnowplowTracker
       self
     end
 
-    # Track an unstructured event
+    # Better name for track unstruct event
     #
+    Contract SelfDescribingJson, Maybe[@@ContextsInput], Timestamp => Tracker
+    def track_self_describing_event(event_json, context=nil, tstamp=nil)
+      track_unstruct_event(event_json, context, tstamp)
+    end
+
+    # Better name for track unstruct event
+    # set the timestamp to the device timestamp
+    Contract SelfDescribingJson, Maybe[@@ContextsInput], Maybe[Num] => Tracker
+    def track_self_describing_event(event_json, context=nil, tstamp=nil)
+      track_unstruct_event(event_json, context, tstamp)
+    end
+
+    # Track an unstructured event
+    # set the timestamp to the device timstamp
     Contract SelfDescribingJson, Maybe[@@ContextsInput], Maybe[Num] => Tracker
+    def track_unstruct_event(event_json, context=nil, tstamp=nil)
+      if tstamp.nil?
+        tstamp = get_timestamp
+      end
+
+      track_unstruct_event(event_json, context, DeviceTimestamp.new(tstamp))
+    end
+
+    # Track an unstructured event
+    #
+    Contract SelfDescribingJson, Maybe[@@ContextsInput], Timestamp => Tracker
     def track_unstruct_event(event_json, context=nil, tstamp=nil)
       pb = Payload.new
       pb.add('e', 'ue')
@@ -273,10 +327,7 @@ module SnowplowTracker
         pb.add_json(build_context(context), @config['encode_base64'], 'cx', 'co')
       end
 
-      if tstamp.nil?
-        tstamp = get_timestamp
-      end
-      pb.add('dtm', tstamp)
+      pb.add(tstamp.type, tstamp.value)
 
       track(pb)
 

data/lib/snowplow-tracker/version.rb

@@ -14,6 +14,6 @@
 # License:: Apache License Version 2.0
 
 module SnowplowTracker
-  VERSION = '0.5.2'
+  VERSION = '0.6.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.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Alexander Dean
@@ -9,54 +9,54 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-07 00:00:00.000000000 Z
+date: 2016-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contracts
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
-    - - <=
+    - - "<="
       - !ruby/object:Gem::Version
         version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
-    - - <=
+    - - "<="
       - !ruby/object:Gem::Version
         version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.17.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.17.4
 description: With this tracker you can collect event data from your Ruby applications,
@@ -74,6 +74,7 @@ files:
 - lib/snowplow-tracker/payload.rb
 - lib/snowplow-tracker/self_describing_json.rb
 - lib/snowplow-tracker/subject.rb
+- lib/snowplow-tracker/timestamp.rb
 - lib/snowplow-tracker/tracker.rb
 - lib/snowplow-tracker/version.rb
 homepage: http://github.com/snowplow/snowplow-ruby-tracker
@@ -86,17 +87,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Ruby Analytics for Snowplow