staccato 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e9fb805954cebe8f6334573603ad141a54a0799
-  data.tar.gz: 40489db42cf2874a45a22ada4232d2c84b618ac9
+  metadata.gz: a69dc443e3cf0db9064a59a292c15d06d1a7cdc8
+  data.tar.gz: 972bfd289296b857df802c4435d290f0900cc5a4
 SHA512:
-  metadata.gz: d606349f6b90ffa8e2c96c072f3549311daf437c74ad6b97216c3d720ca0c384cc0850c32862817a49b751e88b79250a986ba02f641cdf305576ea0de0df130b
-  data.tar.gz: 5d1d3ccc1000191700ee1b3559fa5db18e24c60b4098f5633bb8851444275827584e1e1dfe692c78573a70cff22a0ec2b047b08ae6934d1eb5de22de4ea70a51
+  metadata.gz: 0f1415a7a402b8dc46005161f289b1b6e07c59e81362095b300a738d0c0a83fd932623b42966b2457e31ff55daa589a4db04aff2cf17077233238137444ccb10
+  data.tar.gz: d3f447d6fe02bdc9926ac8c5ecc37c792d3acd965a9e962b6892a95d506c897835446c13f5c92929e80e1c3f9321f6a1cdae8657deaf374eebb9feea37be8a92

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Staccato 0.4.3 ##
+
+*   Adds `data_source` as global option
+
+    *Matt Thomson <@matt-thomson>*
+
 ## Staccato 0.4.2 ##
 
 *   Logger adapter for development

data/README.md

@@ -103,6 +103,7 @@ Staccato::Hit::GLOBAL_OPTIONS.keys # =>
 
 [:anonymize_ip,
  :queue_time,
+ :data_source,
  :cache_buster,
  :user_id,
  :user_ip,
@@ -142,6 +143,8 @@ Staccato::Hit::GLOBAL_OPTIONS.keys # =>
 
 Boolean options like `anonymize_ip` will be converted from `true`/`false` into `1`/`0` as per the tracking API docs.
 
+The `data_source` option can take any value, but note that hits sent from other Google tools will have specific values.  Hits sent from analytics.js will have `data_source` set to `web`, and hits sent from one of the mobile SDKs will have `data_source` set to `app`.
+
 #### Custom Dimensions and Metrics ####
 
 ```ruby
@@ -415,6 +418,7 @@ pageview.track!
 tracker.screenview({
   screen_name: 'user1'
 })
+```
 
 ## Google Documentation ##
 
@@ -422,13 +426,19 @@ https://developers.google.com/analytics/devguides/collection/protocol/v1/devguid
 https://developers.google.com/analytics/devguides/collection/protocol/v1/reference
 https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
 
-## HTTP Adapters ##
+## Adapters ##
+
+Staccato provides a variety of adapters for sending or debugging requests being made. To use them, first require the adapter by name: `require 'staccato/adapter/#{chosen-adapter-name}'`
+
+### HTTP Adapters ###
 
 Staccato provides a number of basic adapters to different ruby http libraries. By default, Staccato uses `net/http` when you create a new tracker. If you are using Faraday or [The Ruby HTTP library](https://github.com/httprb/http.rb) Staccato provides adapters.
 
 ```ruby
+require 'staccato/adapter/faraday' # Faraday gem must be installed
+
 tracker = Staccato.tracker('UA-XXXX-Y') do |c|
-  c.adapter = Staccato::Adapter::Faraday.new(Stacatto.ga_collection_uri) do |faraday|
+  c.adapter = Staccato::Adapter::Faraday.new(Staccato.ga_collection_uri) do |faraday|
     # further faraday configuration here
   end
 end
@@ -470,7 +480,7 @@ Which would be used like:
 
 ```ruby
 tracker = Staccato.tracker('UA-XXXX-Y') do |c|
-  c.adapter = CustomAdapter.new(Stacatto.ga_collection_uri, read_timeout: 1, open_time: 1)
+  c.adapter = CustomAdapter.new(Staccato.ga_collection_uri, read_timeout: 1, open_time: 1)
 end
 ```
 
@@ -479,6 +489,8 @@ end
 The validation adapter sends hits to the debug endpoint, which responds with information about the validity of the hit.
 
 ```ruby
+require 'staccato/adapter/validate'
+
 tracker = Staccato.tracker('UA-XXXX-Y') do |c|
   c.adapter = Staccato::Adapter::Validate.new
 end
@@ -497,6 +509,8 @@ end
 If you're using [Staccato::Proxy](https://github.com/tpitale/staccato-proxy), you can point Staccato at it using the UDP adapter.
 
 ```ruby
+require 'staccato/adapter/udp'
+
 tracker = Staccato.tracker('UA-XXXX-Y') do |c|
   c.adapter = Staccato::Adapter::UDP.new(URI('udp://127.0.0.1:3003'))
 end
@@ -509,8 +523,10 @@ Be sure to set the ip or host and port to wherever you have configured Staccato:
 If you're running in development and simply want to make sure Staccato is being called where you expect it to be. Or, if you want to compare the parameters staccato sends with the Google Analytics documentation.
 
 ```ruby
+require 'staccato/adapter/logger'
+
 tracker = Staccato.tracker('UA-XXXX-Y') do |c|
-  c.adapter = Staccato::Adapter::Logger.new(Stacatto.ga_collection_uri, Logger.new(STDOUT), lambda {|params| JSON.dump(params)})
+  c.adapter = Staccato::Adapter::Logger.new(Staccato.ga_collection_uri, Logger.new(STDOUT), lambda {|params| JSON.dump(params)})
 end
 ```
 

data/lib/staccato/hit.rb

@@ -22,6 +22,7 @@ module Staccato
     GLOBAL_OPTIONS = {
       anonymize_ip: 'aip', # boolean
       queue_time: 'qt', # integer
+      data_source: 'ds',
       cache_buster: 'z',
       user_id: 'uid', # a known user's id
 

data/lib/staccato/version.rb

@@ -1,4 +1,4 @@
 module Staccato
   # The current Staccato VERSION
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: staccato
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-15 00:00:00.000000000 Z
+date: 2015-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler