staccato 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a69dc443e3cf0db9064a59a292c15d06d1a7cdc8
-  data.tar.gz: 972bfd289296b857df802c4435d290f0900cc5a4
+  metadata.gz: e2d6f5770af7d7943f46b23efc57306323adb0d6
+  data.tar.gz: 7ff04c7449bd69f91c7ada112147fe9b2b7a56b3
 SHA512:
-  metadata.gz: 0f1415a7a402b8dc46005161f289b1b6e07c59e81362095b300a738d0c0a83fd932623b42966b2457e31ff55daa589a4db04aff2cf17077233238137444ccb10
-  data.tar.gz: d3f447d6fe02bdc9926ac8c5ecc37c792d3acd965a9e962b6892a95d506c897835446c13f5c92929e80e1c3f9321f6a1cdae8657deaf374eebb9feea37be8a92
+  metadata.gz: 3c95ea93ade152acf5db7cd1341c9d75f77b51bcd0eb9d9724608f0d86cda03d73a76cdb3c983473997bae3425a24bb8d37c36b40acc493594582530030ad1f3
+  data.tar.gz: 8d86f20f834f4389f5a5ed4a42fd565ff97b2ea9880bee4cf53261c18dd32e30a57c667382281a20329085f6ded983450f77661e53a23f5290c6e6845caf3dea

data/CHANGELOG.md

@@ -1,44 +1,50 @@
+## Staccato 0.4.4 ##
+
+*   Adds `Staccato.as_url` to generate a url from a hit, useful for image urls in emails to track opens into GA
+
+    *Tony Pitale - @tpitale*
+
 ## Staccato 0.4.3 ##
 
 *   Adds `data_source` as global option
 
-    *Matt Thomson <@matt-thomson>*
+    *Matt Thomson - @matt-thomson*
 
 ## Staccato 0.4.2 ##
 
 *   Logger adapter for development
 
-    *Tony Pitale <@tpitale>*
+    *Tony Pitale - @tpitale*
 
 ## Staccato 0.4.1 ##
 
 *   Screenview hit type
 
-    *Tony Pitale <@tpitale>*
+    *Tony Pitale - @tpitale*
 
 ## Staccato 0.4.0 ##
 
 *   UDP Adapter for use with Staccato::Proxy
 
-    *Tony Pitale <@tpitale>*
+    *Tony Pitale - @tpitale*
 
 ## Staccato 0.3.1 ##
 
 *   Add customer dimensions and metrics to Product and ProductImpression measurements
 
-    *Agustin Cavilliotti <@cavi21>*
+    *Agustin Cavilliotti - @cavi21*
 
 ## Staccato 0.3.0 ##
 
 *   HTTP Adapters for HTTP, net/http, and Faraday
 
-    *Tony Pitale <@tpitale>*
+    *Tony Pitale - @tpitale*
 
 ## Staccato 0.2.1 ##
 
 *   Fix product impression prefix
 
-    *Ricky Hanna <@rickyhanna>*
+    *Ricky Hanna - @rickyhanna*
 
 ## Staccato 0.2.0 ##
 
@@ -46,7 +52,7 @@
 *   Measurable module for further extension of hits
 *   New global hit options for ecommerce
 
-    *Tony Pitale <@tpitale>*
+    *Tony Pitale - @tpitale*
 
 ## Staccato 0.1.1 ##
 

data/CODE_OF_CONDUCT.md

@@ -11,12 +11,14 @@ Examples of unacceptable behavior by participants include:
 * 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.
+* 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.
+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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+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.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident.
 
-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/)
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.3.0, available at [http://contributor-covenant.org/version/1/3/0/](http://contributor-covenant.org/version/1/3/0/)

data/README.md

@@ -534,6 +534,34 @@ If you would prefer to log to a file (default is STDOUT), you can pass in an ins
 
 If you would like to format the params hash as something other than `k=v` in your logs, you can pass in anything that responds to `call` and format as a string. The default should be consumable by Splunk and other logging software.
 
+## Image URL for Email Open Tracking ##
+
+As per [google's docs](https://developers.google.com/analytics/devguides/collection/protocol/v1/email) an `Event` hit type (suggested) may be used to generate an image tag in an email (e.g., as sent by Rails' mailers). This is useful for tracking open stats alongside your other analytics.
+
+Things to keep in mind from Google's suggestions:
+
+1. Hit type should be Event
+2. category should be 'email'
+3. action should be 'open'
+4. document path should be the type of email, e.g., 'welcome' or 'invite', etc must start with a '/' and is advised to include some scope such as '/email' to make it easier to find
+5. document title should be the subject of the email
+6. set the user id, if it is known; NEVER set the user's email
+7. system info fields may be included if known
+
+To create a url for a hit:
+
+```ruby
+event = tracker.build_event({
+  category: 'email',
+  action: 'open',
+  document_path: '/email/welcome',
+  document_title: 'Welcome to Our Website!'
+})
+
+# use the image url in your rails template in an image tag
+image_url = Staccato.as_url(event)
+```
+
 ## Contributing ##
 
 1. Fork it

data/lib/staccato.rb

@@ -16,7 +16,7 @@ module Staccato
   # @param id [String, nil] the id provided by google, i.e., `UA-XXXXXX-Y`
   # @param client_id [String, Integer, nil] a unique id to track the session of
   #   an individual user
-  # @params hit_options [Hash] options for use in all hits from this tracker
+  # @param hit_options [Hash] options for use in all hits from this tracker
   # @yield [Staccato::Tracker] the new tracker
   # @return [Staccato::Tracker] a new tracker is returned
   def self.tracker(id, client_id = nil, hit_options = {})
@@ -45,6 +45,16 @@ module Staccato
     require 'staccato/adapter/net_http'
     Staccato::Adapter::Net::HTTP
   end
+
+  # Build a url string from any hit type
+  # 
+  # @param hit [Hit] anything that returns a hash for #params
+  # @param uri [URI]
+  # @return String
+  def self.as_url(hit, uri = Staccato.ga_collection_uri)
+    uri.query = URI.encode_www_form(hit.params)
+    uri.to_s
+  end
 end
 
 require 'staccato/boolean_helpers'

data/lib/staccato/adapter/net_http.rb

@@ -14,4 +14,4 @@ module Staccato
       end
     end
   end
-end
+end

data/lib/staccato/version.rb

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

data/spec/lib/stacatto_spec.rb

@@ -16,6 +16,29 @@ describe Staccato do
       expect(tracker.client_id).to eq('a-uuid')
     end
 
+    context 'given a hit' do
+      let(:tracker) {Staccato.tracker('UA-XXXX-Y')}
+
+      let(:event) {
+        tracker.build_event({
+          category: 'email',
+          action: 'open',
+          label: 'welcome',
+          value: 1
+        })
+      }
+
+      before(:each) do
+        SecureRandom.stubs(:uuid).returns("a-uuid")
+      end
+
+      it 'turns a hit into a URL string' do
+        url = "http://www.google-analytics.com/collect?v=1&tid=UA-XXXX-Y&cid=a-uuid&t=event&ec=email&ea=open&el=welcome&ev=1"
+
+        expect(Staccato.as_url(event)).to eq(url)
+      end
+    end
+
   end
 
 end

metadata

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