staccato 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1de9ca3518d24e4139fc2311de9ff15aa79d18a2
-  data.tar.gz: bccdd80d9c617e2303ce2290ceddcd06828d888d
+  metadata.gz: 3b939560977963d95eee659f167c7a8d5815c1e3
+  data.tar.gz: 02ac189ce8e4bfae7e3748750a7472b28e8d64b8
 SHA512:
-  metadata.gz: fde81fda9b06a81f5c45cea7ed60cfe51fd4942ff7f104227817e2424666654976ab6ad935efb27a114e5d2b6ae1840bc5cdde33bd451770a1e92cd15a5eba70
-  data.tar.gz: 58e26c6147b312c0a8ed846d39b36edd416d6a8a7f20c60f6a5eb048c8a8417fe21a387924145da2e9e5560e088920444838edefb005c2209ceb4e669e59e9ef
+  metadata.gz: 1eb4c798052ac93e811cb1ff6996c0288e7246f9ad95d00deb01293452bad88a596570a34f120c1bd99eb0990f03697341073178955e67e1c03c3d77ceb30e8a
+  data.tar.gz: 3941be84e6f0fd6dc632ff0b19d1094e3fa199f18eb95d971f5e2f6e54bee58718ddf613064ccc86cb8e09d362d3fc68920849f737adc1a5613db65630a764f7

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Staccato 0.4.0 ##
+
+*   UDP Adapter for use with Staccato::Proxy
+
+    *Tony Pitale <@tpitale>*
+
 ## Staccato 0.3.1 ##
 
 *   Add customer dimensions and metrics to Product and ProductImpression measurements

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/README.md

@@ -31,7 +31,7 @@ Or install it yourself as:
 tracker = Staccato.tracker('UA-XXXX-Y') # REQUIRED, your Google Analytics Tracking ID
 ```
 
-`#tracker` optionally takes a second param for the `client_id` value
+`#tracker` optionally takes a second param for the `client_id` value.
 By default, the `client_id` is set to a random UUID with `SecureRandom.uuid`
 
 ### Track some data ###
@@ -136,7 +136,8 @@ Staccato::Hit::GLOBAL_OPTIONS.keys # =>
  :experiment_variant,
  :product_action,
  :product_action_list,
- :promotion_action]
+ :promotion_action,
+ :geographical_id]
 ```
 
 Boolean options like `anonymize_ip` will be converted from `true`/`false` into `1`/`0` as per the tracking API docs.
@@ -176,7 +177,7 @@ tracker.pageview(path: '/blog', start_session: true)
 tracker.pageview(path: '/blog', end_session: true)
 ```
 
-Other options are acceptable to start and end a session: `session_start`, `sessoin_end`, and `stop_session`.
+Other options are acceptable to start and end a session: `session_start`, `session_end`, and `stop_session`.
 
 #### Content Experiment ####
 
@@ -466,6 +467,36 @@ tracker = Staccato.tracker('UA-XXXX-Y') do |c|
 end
 ```
 
+### Validation Adapter ###
+
+The validation adapter sends hits to the debug endpoint, which responds with information about the validity of the hit.
+
+```ruby
+tracker = Staccato.tracker('UA-XXXX-Y') do |c|
+  c.adapter = Staccato::Adapter::Validate.new
+end
+```
+
+By default, the staccato `default_adapter` is used to send validation hits, but a different adapter can be used (e.g. `Faraday` or `Net::HTTP`).
+
+```ruby
+tracker = Staccato.tracker('UA-XXXX-Y') do |c|
+  c.adapter = Staccato::Adapter::Validate.new(Staccato::Adapter::HTTP)
+end
+```
+
+### UDP Adapter for Staccato::Proxy ###
+
+If you're using [Staccato::Proxy](https://github.com/tpitale/staccato-proxy), you can point Staccato at it using the UDP adapter.
+
+```ruby
+tracker = Staccato.tracker('UA-XXXX-Y') do |c|
+  c.adapter = Staccato::Adapter::UDP.new(URI('udp://127.0.0.1:3003'))
+end
+```
+
+Be sure to set the ip or host and port to wherever you have configured Staccato::Proxy to run.
+
 ## Contributing ##
 
 1. Fork it

data/lib/staccato.rb

@@ -1,6 +1,7 @@
 require 'ostruct'
 require 'forwardable'
 require 'securerandom'
+require 'uri'
 
 require "staccato/version"
 
@@ -38,6 +39,12 @@ module Staccato
     url = (ssl ? 'https://ssl' : 'http://www') + '.google-analytics.com/collect'
     URI(url)
   end
+
+  # The default adapter to use for sending hits
+  def self.default_adapter
+    require 'staccato/adapter/net_http'
+    Staccato::Adapter::Net::HTTP
+  end
 end
 
 require 'staccato/boolean_helpers'

data/lib/staccato/adapter/udp.rb

@@ -0,0 +1,23 @@
+require 'uri'
+require 'socket'
+
+module Staccato
+  module Adapter
+    class UDP
+      # Takes a URI with host/port
+      #   e.g.: URI('udp://127.0.0.1:3001')
+      def initialize(uri)
+        @host = uri.host
+        @port = uri.port
+
+        @socket = UDPSocket.new
+      end
+
+      def post(params)
+        body = URI.encode_www_form(params)
+
+        @socket.send(body, 0, @host, @port)
+      end
+    end
+  end
+end

data/lib/staccato/adapter/validate.rb

@@ -0,0 +1,13 @@
+module Staccato
+  module Adapter
+    class Validate
+      def initialize(adapter = Staccato.default_adapter)
+        @adapter = adapter.new URI('https://www.google-analytics.com/debug/collect')
+      end
+
+      def post(params)
+        @adapter.post(params).body
+      end
+    end
+  end
+end

data/lib/staccato/hit.rb

@@ -71,7 +71,10 @@ module Staccato
       product_action_list: 'pal',
 
       # Promotion
-      promotion_action: 'promoa'
+      promotion_action: 'promoa',
+
+      # Location
+      geographical_id: 'geoid'
     }.freeze
 
     # Fields which should be converted to boolean for google

data/lib/staccato/tracker.rb

@@ -118,16 +118,30 @@ module Staccato
       Staccato::Timing.new(self, options).track!(&block)
     end
 
+    # Build an ecommerce transaction
+    #
+    # @return [Transaction]
+    def build_transaction(options = {})
+      Staccato::Transaction.new(self, options)
+    end
+
     # Track an ecommerce transaction
     # @return [<Net::HTTPOK] the GA `/collect` endpoint always returns a 200
     def transaction(options = {})
-      Staccato::Transaction.new(self, options).track!
+      build_transaction(options).track!
+    end
+
+    # Build an item in an ecommerce transaction
+    #
+    # @return [TransactionItem]
+    def build_transaction_item(options = {})
+      Staccato::TransactionItem.new(self, options)
     end
 
     # Track an item in an ecommerce transaction
     # @return [<Net::HTTPOK] the GA `/collect` endpoint always returns a 200
     def transaction_item(options = {})
-      Staccato::TransactionItem.new(self, options).track!
+      build_transaction_item(options).track!
     end
 
     # post the hit to GA collection endpoint
@@ -144,11 +158,7 @@ module Staccato
     end
 
     def adapter
-      @adapter ||= begin
-        require 'staccato/adapter/net_http'
-
-        Staccato::Adapter::Net::HTTP.new(Staccato.ga_collection_uri)
-      end
+      @adapter ||= Staccato.default_adapter.new(Staccato.ga_collection_uri)
     end
   end
 

data/lib/staccato/version.rb

@@ -1,4 +1,4 @@
 module Staccato
   # The current Staccato VERSION
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: staccato
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-18 00:00:00.000000000 Z
+date: 2015-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,6 +106,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -114,6 +115,8 @@ files:
 - lib/staccato/adapter/faraday.rb
 - lib/staccato/adapter/http.rb
 - lib/staccato/adapter/net_http.rb
+- lib/staccato/adapter/udp.rb
+- lib/staccato/adapter/validate.rb
 - lib/staccato/boolean_helpers.rb
 - lib/staccato/event.rb
 - lib/staccato/exception.rb