snowplow-tracker 0.5.2 → 0.7.0.pre.alpha.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTVhZTY2ODI0YjMxNjJlNGYyYjE4NzZjZmM0NzZiMjNkNWYwZjM5Mg==
-  data.tar.gz: !binary |-
-    Mjc0YjdhNmJmOGFiZTk5MjljZDNjMzJlMmMzNWRjY2JjY2UzMTQzYQ==
+SHA256:
+  metadata.gz: debc2ab18310d2efcd5e57dc42e52a259876c2588b7e735183c07bba16c9ab3a
+  data.tar.gz: 11a596a2e96673312deff3a8ecdc664792e71aac503af33c826583c2a14f8edc
 SHA512:
-  metadata.gz: !binary |-
-    MGFiM2I4ZGFjMjAwNmQ4ODQ1Mjc0YTNhMDk5MWMyZWQyODE3NTJlYWViMWYy
-    MzZmMWEzNzNiODAyNGViYjFiYTQyNTg2ZjZiZTRjMDY2ZGQzNjdjNWIyNTVj
-    N2IxZmNhNzEwZjhkZmVmOGRiOWQ1MTlmMDYzNTU3NWMzMTA1Mjg=
-  data.tar.gz: !binary |-
-    ODk2OWI5MzBmMjRkMjdmOWJhMTMwOWVkNTA1MmFhNWEzNTBlM2MzOTExMmZk
-    NGY0ZGVmMzIxNzU2ZjRkMTkwMzZiN2MzZDM5NjU0MjRmODIwZWY1YzRlZjg4
-    MjNiZDc4YjJmNjUxMzdlYjg0NjUyNTU2MmM3ZGQwZGFmNGI4MGY=
+  metadata.gz: d95205012540b049b857b97ecfb2ff055ee7f786c3c83c375d89f6743bb568cb3577185196a90ed6e17dab788dbe63c6fe2d226df28d2a6acddd4ae2f79e3938
+  data.tar.gz: c09b603c6e633246b7e75e3b44dda70913b5476582cdab2bee87556a63780e8c1c1363e02342057d54c129d63632d9a921c62f6e26f880a237d87e77f06192ae

data/README.md

@@ -1,5 +1,7 @@
-# Ruby Analytics for Snowplow 
-[![Gem Version](https://badge.fury.io/rb/snowplow-tracker.svg)](http://badge.fury.io/rb/snowplow-tracker)
+# Ruby Analytics for Snowplow
+
+[![early-release]][tracker-classification]
+[![Gem Version](https://badge.fury.io/rb/snowplow-tracker.svg)](https://badge.fury.io/rb/snowplow-tracker)
 [![Build Status](https://travis-ci.org/snowplow/snowplow-ruby-tracker.png?branch=master)](https://travis-ci.org/snowplow/snowplow-ruby-tracker)
 [![Code Climate](https://codeclimate.com/github/snowplow/snowplow-ruby-tracker.png)](https://codeclimate.com/github/snowplow/snowplow-ruby-tracker)
 [![Coverage Status](https://coveralls.io/repos/snowplow/snowplow-ruby-tracker/badge.png)](https://coveralls.io/r/snowplow/snowplow-ruby-tracker)
@@ -7,42 +9,44 @@
 
 ## Overview
 
-Add analytics to your Ruby and Rails apps and gems with the **[Snowplow] [snowplow]** event tracker for **[Ruby] [ruby]**.
+Add analytics to your Ruby and Rails apps and gems with the **[Snowplow][snowplow]** event tracker for **[Ruby][ruby]**.
 
-With this tracker you can collect event data from your **[Ruby] [ruby]** applications, **[Ruby on Rails] [rails]** web applications and **[Ruby gems] [rubygems]**.
+With this tracker you can collect event data from your **[Ruby][ruby]** applications, **[Ruby on Rails][rails]** web applications and **[Ruby gems][rubygems]**.
 
-## Quickstart
+## Maintainer Quickstart
 
-Assuming git, **[Vagrant] [vagrant-install]** and **[VirtualBox] [virtualbox-install]** installed:
+Clone this repo and navigate into the cloned folder. To run the tests locally, you will need [Docker][docker] installed.
 
 ```bash
- host$ git clone https://github.com/snowplow/snowplow-ruby-tracker.git
- host$ cd snowplow-ruby-tracker
- host$ vagrant up && vagrant ssh
-guest$ cd /vagrant
-guest$ gem install bundler
-guest$ bundle install
-guest$ rspec
+docker build . -t ruby-tracker
+docker run -v "$(pwd)":"/code" ruby-tracker
 ```
 
-## Publishing
+The `-v` flag for `docker run` creates a bind mount for the project directory. This means that changes to the files will be automatically applied within the Docker image. However, if you modify the `Gemfile` or `snowplow-tracker.gemspec` files, the image must be rebuilt.
+
+Alternatively, test directly by installing Ruby 2.6+ and [Bundler][bundler]. Then run:
 
-```bash
- host$ vagrant push
 ```
+bundle install
+rspec
+```
+
+## Contributing
+
+Feedback and contributions are welcome - if you have identified a bug, please log an issue on this repo. For all other feedback, discussion or questions please open a thread on our [Discourse forum][discourse].
 
 ## Find out more
 
-| Technical Docs                  | Setup Guide               | Roadmap                 | Contributing                      |
-|---------------------------------|---------------------------|-------------------------|-----------------------------------|
-| ![i1] [techdocs-image]          | ![i2] [setup-image]       | ![i3] [roadmap-image]   | ![i4] [contributing-image]        |
-| **[Technical Docs] [techdocs]** | **[Setup Guide] [setup]** | **[Roadmap] [roadmap]** | **[Contributing] [contributing]** |
+| Technical Docs                 | Contributing                        |
+| ------------------------------ | ----------------------------------- |
+| ![i1][techdocs-image]          | ![i4][contributing-image]           |
+| **[Technical Docs][techdocs]** | **[Contributing](Contributing.md)** |
 
 ## Copyright and license
 
-The Snowplow Ruby Tracker is copyright 2013-2014 Snowplow Analytics Ltd.
+The Snowplow Ruby Tracker is copyright 2013-2016 Snowplow Analytics Ltd.
 
-Licensed under the **[Apache License, Version 2.0] [license]** (the "License");
+Licensed under the **[Apache License, Version 2.0][license]** (the "License");
 you may not use this software except in compliance with the License.
 
 Unless required by applicable law or agreed to in writing, software
@@ -51,24 +55,17 @@ 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.
 
-[license-image]: http://img.shields.io/badge/license-Apache--2-blue.svg?style=flat
-[license]: http://www.apache.org/licenses/LICENSE-2.0
-
+[license-image]: https://img.shields.io/badge/license-Apache--2-blue.svg?style=flat
+[license]: https://www.apache.org/licenses/LICENSE-2.0
 [ruby]: https://www.ruby-lang.org/en/
-[rails]: http://rubyonrails.org/
+[rails]: https://rubyonrails.org/
 [rubygems]: https://rubygems.org/
-
-[snowplow]: http://snowplowanalytics.com
-
-[vagrant-install]: http://docs.vagrantup.com/v2/installation/index.html
-[virtualbox-install]: https://www.virtualbox.org/wiki/Downloads
-
+[docker]: https://www.docker.com/
+[bundler]: https://bundler.io/
+[snowplow]: httpd://snowplowanalytics.com
+[discourse]: https://discourse.snowplowanalytics.com
 [techdocs-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/techdocs.png
-[setup-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/setup.png
-[roadmap-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/roadmap.png
 [contributing-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/contributing.png
-
-[techdocs]: https://github.com/snowplow/snowplow/wiki/Ruby-Tracker
-[setup]: https://github.com/snowplow/snowplow/wiki/Ruby-Tracker-Setup
-[roadmap]: https://github.com/snowplow/snowplow/wiki/Ruby-Tracker-Roadmap
-[contributing]: https://github.com/snowplow/snowplow/wiki/Ruby-Tracker-Contributing
+[techdocs]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/ruby-tracker/
+[tracker-classification]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/tracker-maintenance-classification/
+[early-release]: https://img.shields.io/static/v1?style=flat&label=Snowplow&message=Early%20Release&color=014477&labelColor=9ba0aa&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAeFBMVEVMaXGXANeYANeXANZbAJmXANeUANSQAM+XANeMAMpaAJhZAJeZANiXANaXANaOAM2WANVnAKWXANZ9ALtmAKVaAJmXANZaAJlXAJZdAJxaAJlZAJdbAJlbAJmQAM+UANKZANhhAJ+EAL+BAL9oAKZnAKVjAKF1ALNBd8J1AAAAKHRSTlMAa1hWXyteBTQJIEwRgUh2JjJon21wcBgNfmc+JlOBQjwezWF2l5dXzkW3/wAAAHpJREFUeNokhQOCA1EAxTL85hi7dXv/E5YPCYBq5DeN4pcqV1XbtW/xTVMIMAZE0cBHEaZhBmIQwCFofeprPUHqjmD/+7peztd62dWQRkvrQayXkn01f/gWp2CrxfjY7rcZ5V7DEMDQgmEozFpZqLUYDsNwOqbnMLwPAJEwCopZxKttAAAAAElFTkSuQmCC

data/lib/snowplow-tracker/emitters.rb

@@ -113,11 +113,15 @@ 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.to_s # add the sent timestamp, overwrite if already exists
+      end
+
       if @method == 'post'
         post_succeeded = false
         begin
           request = http_post(SelfDescribingJson.new(
-            'iglu:com.snowplowanalytics.snowplow/payload_data/jsonschema/1-0-2',
+            'iglu:com.snowplowanalytics.snowplow/payload_data/jsonschema/1-0-4',
             evts
           ).to_json)
           post_succeeded = is_good_status_code(request.code)

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.7.0-alpha.0'
   TRACKER_VERSION = "rb-#{VERSION}"
 end

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'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snowplow-tracker
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.7.0.pre.alpha.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: 2021-09-13 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,16 @@ 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'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Ruby Analytics for Snowplow