gabba 0.3.0 → 0.4.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gabba (0.2.0)
+    gabba (0.4.1)
 
 GEM
   remote: http://rubygems.org/

data/Rakefile

@@ -3,6 +3,8 @@ Bundler::GemHelper.install_tasks
 
 task :default => :spec
 
+task :test => :spec
+
 task :spec do
   ruby "spec/gabba_spec.rb"
 end

data/Readme.md

@@ -0,0 +1,67 @@
+# Gabba
+
+Simple class to send custom server-side events to Google Analytics
+
+Heavily influenced by the http://code.google.com/p/serversidegoogleanalytics
+
+## Examples
+
+### Track page views
+
+```ruby
+Gabba::Gabba.new("UT-1234", "mydomain.com").page_view("something", "track/me")
+```
+
+### Track custom events
+
+```ruby
+Gabba::Gabba.new("UT-1234", "mydomain.com").event("Videos", "Play", "ID", "123", true)
+```
+
+### Works with existing client-side Google Analytics cookies
+
+```ruby
+gabba = Gabba::Gabba.new("UT-1234", "mydomain.com")
+
+# grab the __utma and (optionally) __utmz unique identifiers
+gabba.identify_user(cookies[:__utma], cookies[:__utmz])
+
+# trigger actions as normal
+gabba.page_view("something", "track/me")
+```
+
+### Setting custom vars
+
+```ruby
+# Index: 1 through 5
+index = 1
+
+# Scope: VISITOR, SESSION or PAGE
+scope = Gabba::Gabba::VISITOR
+
+# Set var
+gabba.set_custom_var(index, 'Name', 'Value', scope)
+
+# Track the event (all vars will be included)
+gabba.event(...)
+
+# Track the page view (all vars will be included)
+gabba.page_view(...)
+```
+
+### Removing custom vars
+
+```ruby
+# Index: 1 through 5
+index = 1
+
+# Delete var with this index
+gabba.delete_custom_var index
+```
+
+### Track ecommerce transactions
+
+```ruby
+g = Gabba::Gabba.new("UT-6666", "myawesomeshop.net")
+g.transaction("123456789", "1000.00", 'Acme Clothing', '1.29', '5.00', 'Los Angeles', 'California', 'USA')
+```

data/lib/gabba/gabba.rb

@@ -22,7 +22,7 @@ module Gabba
 
     ESCAPES = %w{ ' ! * ) }
 
-    attr_accessor :utmwv, :utmn, :utmhn, :utmcs, :utmul, :utmdt, :utmp, :utmac, :utmt, :utmcc, :user_agent
+    attr_accessor :utmwv, :utmn, :utmhn, :utmcs, :utmul, :utmdt, :utmp, :utmac, :utmt, :utmcc, :user_agent, :utma, :utmz
 
     # Public: Initialize Gabba Google Analytics Tracking Object.
     #
@@ -279,25 +279,26 @@ module Gabba
       }
     end
 
-    # Public: provide the user's __utma attribute from analytics cookie, allowing
+    # Public: provide the user's __utma and __utmz attributes from analytics cookie, allowing
     # better tracking of user flows
     #
     # Called before page_view etc
     #
     # Examples:
     #   g = Gabba::Gabba.new("UT-1234", "mydomain.com")
-    #   g.identify_user(cookies[:__utma])
+    #   g.identify_user(cookies[:__utma], cookies[:__utmz])
     #   g.page_view("something", "track/me")
     #
-    def identify_user(utma)
+    def identify_user(utma, utmz=nil)
       @utma = utma
+      @utmz = utmz
     end
 
     # create magical cookie params used by GA for its own nefarious purposes
     def cookie_params(utma1 = random_id, utma2 = rand(1147483647) + 1000000000, today = Time.now)
-      utma = @utma
-      utma ||= "1.#{utma1}00145214523.#{utma2}.#{today.to_i}.#{today.to_i}.15"
-      "__utma=#{utma};+__utmz=1.#{today.to_i}.1.1.utmcsr=(direct)|utmccn=(direct)|utmcmd=(none);"
+      @utma ||= "1.#{utma1}00145214523.#{utma2}.#{today.to_i}.#{today.to_i}.15"
+      @utmz ||= "1.#{today.to_i}.1.1.utmcsr=(direct)|utmccn=(direct)|utmcmd=(none)"
+      "__utma=#{@utma};+__utmz=#{@utmz};"
     end
 
     # sanity check that we have needed params to even call GA

data/lib/gabba/version.rb

@@ -1,5 +1,5 @@
 module Gabba
   unless const_defined?('VERSION')
-    VERSION = "0.3.0"
+    VERSION = "0.4.1"
   end
 end

data/spec/gabba_spec.rb

@@ -113,7 +113,14 @@ describe Gabba::Gabba do
       # This is how the Google cookie is named
       cookies = { :__utma => "long_code"}
       @gabba.identify_user(cookies[:__utma])
-      @gabba.cookie_params.must_match /utma=long_code;/
+      @gabba.cookie_params.must_match(/utma=long_code;/)
+      @gabba.cookie_params.must_match(/utmz=.*direct.*;/)
+    end
+    it "must use the optionally supplied utmz in cookie_params" do
+      cookies = { :__utma => "long_code", :__utmz => "utmz_code" }
+      @gabba.identify_user(cookies[:__utma], cookies[:__utmz])
+      @gabba.cookie_params.must_match(/utma=long_code;/)
+      @gabba.cookie_params.must_match(/utmz=utmz_code;/)
     end
   end
 

metadata

@@ -1,58 +1,77 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: gabba
-version: !ruby/object:Gem::Version
-  version: 0.3.0
+version: !ruby/object:Gem::Version 
+  hash: 13
   prerelease: 
+  segments: 
+  - 0
+  - 4
+  - 1
+  version: 0.4.1
 platform: ruby
-authors:
+authors: 
 - Ron Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-02 00:00:00.000000000Z
+
+date: 2012-10-20 00:00:00 Z
 dependencies: []
+
 description: Easy server-side tracking for Google Analytics
-email:
+email: 
 - ron dot evans at gmail dot com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - Gemfile.lock
-- README
 - Rakefile
+- Readme.md
 - gabba.gemspec
 - lib/gabba.rb
 - lib/gabba/gabba.rb
 - lib/gabba/version.rb
 - spec/gabba_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: ""
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: gabba
-rubygems_version: 1.8.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Easy server-side tracking for Google Analytics
-test_files:
+test_files: 
 - spec/gabba_spec.rb
 - spec/spec_helper.rb

data/README

@@ -1,56 +0,0 @@
-Simple class to send custom server-side events to Google Analytics
-==================================================================
-
-Heavily influenced by the http://code.google.com/p/serversidegoogleanalytics
-
-HOW TO USE:
------------
-
-* Track page views
-
-        Gabba::Gabba.new("UT-1234", "mydomain.com").page_view("something", "track/me")
-
-* Track custom events
-
-        Gabba::Gabba.new("UT-1234", "mydomain.com").event("Videos", "Play", "ID", "123", true)
-
-* Works with existing client-side Google Analytics cookies
-
-        gabba = Gabba::Gabba.new("UT-1234", "mydomain.com")
-
-        # grab the __utma unique identifier
-        gabba.identify_user(cookies[:__utma])
-
-        # trigger actions as normal
-        gabba.page_view("something", "track/me")
-
-* Setting custom vars
-
-        # Index: 1 through 5
-        index = 1
-
-        # Scope: VISITOR, SESSION or PAGE
-        scope = Gabba::Gabba::VISITOR
-
-        # Set var
-        gabba.set_custom_var(index, 'Name', 'Value', scope)
-
-        # Track the event (all vars will be included)
-        gabba.event(...)
-
-        # Track the page view (all vars will be included)
-        gabba.page_view(...)
-
-* Removing custom vars
-
-        # Index: 1 through 5
-        index = 1
-
-        # Delete var with this index
-        gabba.delete_custom_var index- Track a non-interactive custom event
-
-* Track ecommerce transactions
-
-        g = Gabba::Gabba.new("UT-6666", "myawesomeshop.net")
-        g.transaction("123456789", "1000.00", 'Acme Clothing', '1.29', '5.00', 'Los Angeles', 'California', 'USA')
-