snowplow-tracker 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmI4MjYwZDE5ZGEyNjA0MTJkNTA1ZTdkYWU3MDRlOWNjZjEyNGI1NQ==
+  data.tar.gz: !binary |-
+    MjhiYjIxZWY4OGVhMmI2ODEzODY0NzQzYThhODNhMDY1YzE2Y2IwMA==
+SHA512:
+  metadata.gz: !binary |-
+    M2Q0MzY5MzUyZjRhZGJkOTc2YzYyYTNmYmEzZDc5YjY1OTQyZjRjOTc5M2Q4
+    NTViOGZjOTUxZmVlMDI4NTJkOTFmZmVjMmQyYjE5NjdiZTc2NzZlZTY3YmUx
+    NjUwNTg4ZjNmYzQxMGUwOTE4YWE4NTEzMDM0ZDBlODJhOWI3M2E=
+  data.tar.gz: !binary |-
+    ZWRjZWRmNjRkZDlkMjNjMjlmNDU4ZWY0NzBmM2Q0OGM0NDZmNDU2YjRiOTA0
+    NjZlYTE2N2M5NWU4MjE1MzkyYzE2NzhiYmE1OGZjMTQ5NTNlZjZjOGZmNjk4
+    NDQ5NzRiYTAxNDVmOWNkOTJhMDIwNmE3MzdlY2I4Y2E3ZmQ1MzM=

data/LICENSE-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   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.

data/README.md

@@ -0,0 +1,49 @@
+# Ruby Analytics for Snowplow 
+[![Gem Version](https://badge.fury.io/rb/snowplow-tracker.svg)](http://badge.fury.io/rb/snowplow-tracker)
+[![Build Status](https://travis-ci.org/snowplow/snowplow-ruby-tracker.png)](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)
+
+## Overview
+
+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].
+
+## 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]** |
+
+## Copyright and license
+
+The Snowplow Ruby Tracker is copyright 2013-2014 Snowplow Analytics Ltd.
+
+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
+distributed under the License is distributed on an "AS IS" BASIS,
+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
+
+[snowplow]: http://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
+
+[license]: http://www.apache.org/licenses/LICENSE-2.0

data/lib/snowplow-tracker/payload.rb

@@ -0,0 +1,72 @@
+# 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.
+# 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 (mailto:support@snowplowanalytics.com)
+# Copyright:: Copyright (c) 2013-2014 SnowPlow Analytics Ltd
+# License:: Apache License Version 2.0
+
+require 'base64'
+require 'json'
+require 'net/http'
+require 'contracts'
+include Contracts
+
+module SnowplowTracker
+
+  class Payload
+
+    attr_reader :context
+
+    Contract nil => Payload
+    def initialize
+      @context = {}
+      self
+    end
+
+    # Add a single name-value pair to @context
+    #
+    Contract String, Or[String, Bool, Num, nil] => Or[String, Bool, Num, nil]
+    def add(name, value)
+      if value != "" and not value.nil?
+        @context[name] = value
+      end
+    end
+    
+    # Add each name-value pair in dict to @context
+    #
+    Contract Hash => Hash
+    def add_dict(dict)
+      for f in dict
+        self.add(f[0], f[1])
+      end
+    end
+
+    # Stringify a JSON and add it to @context
+    #
+    Contract Maybe[Hash], Bool, String, String => Maybe[String]
+    def add_json(dict, encode_base64, type_when_encoded, type_when_not_encoded)
+      
+      if dict.nil?
+        return
+      end
+      
+      dict_string = JSON.generate(dict)
+
+      if encode_base64
+        self.add(type_when_encoded, Base64.strict_encode64(dict_string))
+      else
+        self.add(type_when_not_encoded, dict_string)
+      end
+
+    end
+
+  end
+end

data/lib/snowplow-tracker/tracker.rb

@@ -0,0 +1,321 @@
+# 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.
+# 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 (mailto:support@snowplowanalytics.com)
+# Copyright:: Copyright (c) 2013-2014 SnowPlow Analytics Ltd
+# License:: Apache License Version 2.0
+
+require 'net/http'
+require 'contracts'
+require 'set'
+include Contracts
+
+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)
+      @@required_transaction_keys.subset? transaction_keys and
+        transaction_keys.subset? @@recognised_transaction_keys
+    }
+
+    @@required_item_keys =   Set.new(%w(sku price quantity))
+    @@recognised_item_keys = Set.new(%w(sku price quantity name category context))
+
+    @@Item = lambda { |x|
+      return false unless x.class == Hash
+      item_keys = Set.new(x.keys)
+      @@required_item_keys.subset? item_keys and
+        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))
+
+    @@AugmentedItem = lambda { |x|
+      return false unless x.class == Hash
+      augmented_item_keys = Set.new(x.keys)
+      @@required_augmented_item_keys.subset? augmented_item_keys and
+        augmented_item_keys.subset? @@recognised_augmented_item_keys
+    }
+
+    @@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)
+      @collector_uri = as_collector_uri(endpoint)
+      @standard_nv_pairs = {
+        'tna' => namespace,
+        'tv'  => @@version,
+        'p'   => @@default_platform,
+        'aid' => app_id
+      }
+      @config = {
+        'context_vendor' => context_vendor,
+        'encode_base64' => encode_base64
+      }
+      self
+    end
+
+    # Adds the protocol to the fron of the collector URL, and /i to the end
+    #
+    Contract String => String
+    def as_collector_uri(host)
+      "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)
+    end
+
+    # Generates the timestamp (in milliseconds) to be attached to each event
+    #
+    Contract nil => Num
+    def get_timestamp
+      (Time.now.to_f * 1000).to_i
+    end
+
+    # Send request
+    #
+    Contract Payload => [Bool, Num]
+    def http_get(payload)
+      destination = URI(@collector_uri + '?' + URI.encode_www_form(payload.context))
+      r = Net::HTTP.get_response(destination)
+      if @@http_errors.include? r.code
+        return false, "Host [#{r.host}] not found (possible connectivity error)"
+      elsif r.code.to_i < 0 or 400 <= r.code.to_i
+        return false, r.code.to_i
+      else
+        return true, r.code.to_i
+      end
+    end
+
+    # Setter methods
+
+    # Specify the platform
+    # 
+    Contract String => String
+    def set_platform(value)
+      if @@supported_platforms.include?(value)
+        @standard_nv_pairs['p'] = value
+      else
+        raise "#{value} is not a supported platform"
+      end
+    end
+
+    # Set the business-defined user ID for a user
+    #
+    Contract String => String
+    def set_user_id(user_id)
+      @standard_nv_pairs['uid'] = user_id
+    end
+
+    # Set the screen resolution for a device
+    #
+    Contract Num, Num => String
+    def set_screen_resolution(width, height)
+      @standard_nv_pairs['res'] = "#{width}x#{height}"
+    end
+
+    # Set the dimensions of the current viewport
+    # 
+    Contract Num, Num => String
+    def set_viewport(width, height)
+      @standard_nv_pairs['vp'] = "#{width}x#{height}"
+    end
+
+    # Set the color depth of the device in bits per pixel
+    #
+    Contract Num => Num
+    def set_color_depth(depth)
+      @standard_nv_pairs['cd'] = depth
+    end
+
+    # Set the timezone field
+    #
+    Contract String => String
+    def set_timezone(timezone)
+      @standard_nv_pairs['tz'] = timezone
+    end
+
+    # Set the language field
+    #
+    Contract String => String
+    def set_lang(lang)
+      @standard_nv_pairs['lang'] = lang
+    end
+
+    # Tracking methods
+
+    # Attaches all the fields in @standard_nv_pairs to the request
+    #  Only attaches the context vendor if the event has a custom context
+    #
+    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
+      http_get(pb)
+    end
+
+    # Log a visit to this page
+    #
+    Contract String, Maybe[String], Maybe[String], Maybe[Hash] => [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)
+      if tstamp.nil?
+        tstamp = get_timestamp
+      end
+      pb.add('dtm', tstamp)
+      track(pb)
+    end
+
+    # Track a single item within an ecommerce transaction
+    #   Not part of the public API
+    #
+    Contract @@AugmentedItem => [Bool, Num]
+    def track_ecommerce_transaction_item(argmap)
+      pb = Payload.new
+      pb.add('e', 'ti')
+      pb.add('ti_id', argmap['order_id'])
+      pb.add('ti_sk', argmap['sku'])
+      pb.add('ti_pr', argmap['price'])
+      pb.add('ti_qu', argmap['quantity'])
+      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'])
+      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]]})
+    def track_ecommerce_transaction(transaction, items,
+                                    context=nil, tstamp=nil)
+      pb = Payload.new
+      pb.add('e', 'tr')
+      pb.add('tr_id', transaction['order_id'])
+      pb.add('tr_tt', transaction['total_value'])
+      pb.add('tr_af', transaction['affiliation'])
+      pb.add('tr_tx', transaction['tax_value'])
+      pb.add('tr_sh', transaction['shipping'])
+      pb.add('tr_ci', transaction['city'])
+      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)
+      if tstamp.nil?
+        tstamp = get_timestamp
+      end
+      pb.add('dtm', tstamp)
+
+      transaction_result = track(pb)
+      item_results = []
+
+      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))
+      end
+
+      {'transaction_result' => transaction_result, 'item_results' => item_results}
+    end
+
+    # Track a structured event
+    #
+    Contract String, String, Maybe[String], Maybe[String], Maybe[Num], Maybe[Hash], 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')
+      pb.add('se_ca', category)
+      pb.add('se_ac', action)
+      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)
+      if tstamp.nil?
+        tstamp = get_timestamp
+      end
+      pb.add('dtm', tstamp)
+      track(pb)
+    end
+
+    # Track a screen view event
+    #
+    Contract String, Maybe[String],  Maybe[Hash], 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)
+    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)
+      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)
+      if tstamp.nil?
+        tstamp = get_timestamp
+      end
+      pb.add('dtm', tstamp)
+      track(pb)
+    end
+
+    private :as_collector_uri,
+            :get_transaction_id,
+            :get_timestamp,
+            :http_get,
+            :track,
+            :track_ecommerce_transaction_item
+
+  end
+
+end

data/lib/snowplow-tracker/version.rb

@@ -0,0 +1,19 @@
+# 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.
+# 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 (mailto:support@snowplowanalytics.com)
+# Copyright:: Copyright (c) 2013-2014 SnowPlow Analytics Ltd
+# License:: Apache License Version 2.0
+
+module SnowplowTracker
+  VERSION = '0.1.0'
+  TRACKER_VERSION = "rb-#{VERSION}"
+end

data/lib/snowplow-tracker.rb

@@ -0,0 +1,18 @@
+# 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.
+# 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 (mailto:snowplow-user@googlegroups.com)
+# Copyright:: Copyright (c) 2013-2014 Snowplow Analytics Ltd
+# License::   Apache License Version 2.0
+
+require 'snowplow-tracker/version.rb'
+require 'snowplow-tracker/payload.rb'
+require 'snowplow-tracker/tracker.rb'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: snowplow-tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Dean
+- Fred Blundun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: contracts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !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,
+  Ruby on Rails web applications and Ruby gems.
+email: support@snowplowanalytics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE-2.0.txt
+- README.md
+- lib/snowplow-tracker.rb
+- lib/snowplow-tracker/payload.rb
+- lib/snowplow-tracker/tracker.rb
+- lib/snowplow-tracker/version.rb
+homepage: http://github.com/snowplow/snowplow-ruby-tracker
+licenses:
+- Apache License 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby Analytics for Snowplow
+test_files: []