ga_cookie_parser 0.1.0 → 0.2.0

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in ga_cookie_parser.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ga_cookie_parser (0.0.1)
+    ga_cookie_parser (0.1.0)
 
 GEM
   remote: http://rubygems.org/

data/README.rdoc

@@ -1,44 +1,58 @@
 = Google Analytics Cookie Parser
 
-Simple ruby library for parsing the __umtz and __umta cookies which Google Analytics uses to track referrers and visitors.
+Simple ruby library for parsing the __umtz, __umtb and __umta cookies which Google Analytics uses to track referrers and visitors.
 
 You may wish to use this library to integrate data from Google Analytics into your internal CRM or sales tracking application.
 
+== Installation
+
+The library is available as a gem.
+
+    gem install ga_cookie_parser
+
 == Usage
 
 Create an instance, or use the convenience method GaCookieParser.parse, providing a hash with keys :umtz and/or :umtz as argument.
 
-	utmz = cookies["__utmz"] # in a rails controller context
-	utma = cookies["__utma"]
-	
-	@data = GaCookieParser::GaCookieParser.new(:utmz => utmz, :utma => utma)
-
-Then, @data provides #utmz_hash and #utma_hash methods which return hashes as follows:
-
-	# @data.utmz_hash
-	# note that not all of these will be present, and some are mutually exclusive
-	{
-		:domain_hash => '12979384',
-		:timestamp   => '1294887021',	# unix timestamp
-		:session_counter => '1',
-		:campaign_number => '1',
-		:utmcsr => 'google', 			# source
-		:utmccn => '(organic)',			# campaign name
-		:utmcmd => 'organic',			# medium
-		:utmctr => 'search term',		# term(s)
-		:utmcct => '/ref.php,			# content (referring page in case of referrals)
-		:utmgclid => 'CI7wh8C6tKYCFU2DpAod7z97IQ'	# gclid, linking referral back to adwords
-	}
-
-	# @data.utma_hash
-	{
-		:domain_hash => '12979384',
-		:visitor_id =>  '1392679796',		# a random number
-		:initial_visit_at =>  '1289844797',	# unix timestamp
-		:previous_visit_at => '1294798990',	# unix timestamp
-		:current_visit_at => '1294866800',	# unix timestamp
-		:session_counter => '1' 
-	}
+    utmz = cookies["__utmz"] # in a rails controller context
+    utmb = cookies["__utmb"]
+    utma = cookies["__utma"]
+    @data = GaCookieParser::GaCookieParser.new(:utmz => utmz, :utmb => utmb, :utma => utma)
+
+Then, @data provides #utmz_hash, #utmb_hash and #utma_hash methods which return hashes as follows:
+
+    # @data.utmz_hash
+    # note that not all of these will be present, and some are mutually exclusive
+    {
+      :domain_hash => '12979384',
+      :timestamp   => '1294887021',  # unix timestamp
+      :session_counter => '1',
+      :campaign_number => '1',
+      :utmcsr => 'google',       # source
+      :utmccn => '(organic)',      # campaign name
+      :utmcmd => 'organic',      # medium
+      :utmctr => 'search term',    # term(s)
+      :utmcct => '/ref.php,      # content (referring page in case of referrals)
+      :utmgclid => 'CI7wh8C6tKYCFU2DpAod7z97IQ'  # gclid, linking referral back to adwords
+    }
+  
+    # @data.utma_hash
+    {
+      :domain_hash => '12979384',
+      :visitor_id =>  '1392679796',    # a random number
+      :initial_visit_at =>  '1289844797',  # unix timestamp
+      :previous_visit_at => '1294798990',  # unix timestamp
+      :current_visit_at => '1294866800',  # unix timestamp
+      :session_counter => '1' 
+    }
+    
+    # @data.utmb_hash
+    {
+      :domain_hash => '12979384',
+      :pageview =>  '3',    # pageview count in this 30 min session
+      :outbound_click =>  '10',  # number of outbound links clicked counting down from 10
+      :timestamp => '1294866800'  # current timestamp
+    }
 
 == Notes
 
@@ -49,6 +63,14 @@ Documentation on these cookies is somewhat sparse. Here are the main resources u
 * {UPDATED: Integrating Google Analytics with a CRM}[http://cutroni.com/blog/2009/03/18/updated-integrating-google-analytics-with-a-crm/] blog post by Justin Cutroni
 * {GA Basics: The Structure of Cookie Values}[http://blog.vkistudios.com/index.cfm/2010/8/31/GA-Basics-The-Structure-of-Cookie-Values] blog post by VKI Studios
 * {Python Google Analytics Cookie Parser}[https://github.com/RyOnLife/Python-Google-Analytics-Cookie-Parser] (from which I borrowed some variable names)
+* {Google Analytics Cookies (utma, utmb, utmz)}[http://www.webtrafficexchange.com/google-analytics-cookies-utma-utmb-utmz] (includes utmb structure)
+
+=== UTMB
+
+Was harder to find documentation on this (thanks to dominikform for the PR). The final link above contains the following details, copied here in case they disappear:
+
+  The content of the cookie include domain hash, pageview, number of outbound link click
+  counting down from 10, and current time stamp
 
 == Copyright
 

data/ga_cookie_parser.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["shrobson@gmail.com"]
   s.homepage    = ""
   s.summary     = %q{Google Analytics Cookie Parsing Gem}
-  s.description = %q{Gem to parse the utmz and utma tracking coockies used by Google Analytics.}
+  s.description = %q{Gem to parse the utmz, utmb and utma tracking coockies used by Google Analytics.}
 
   s.rubyforge_project = "ga_cookie_parser"
   

data/lib/ga_cookie_parser.rb

@@ -7,10 +7,11 @@ module GaCookieParser
   
   class GaCookieParser
     
-    attr_reader :utmz, :utma, :utmz_hash, :utma_hash
+    attr_reader :utmz, :utmb, :utma, :utmz_hash, :utmb_hash, :utma_hash
     
     def initialize(cookies = {})
       @utmz = cookies[:utmz]
+      @utmb = cookies[:utmb]
       @utma = cookies[:utma]
       parse_cookies
     end
@@ -19,12 +20,17 @@ module GaCookieParser
       !(@utmz.nil? || @utmz.empty?)
     end
     
+    def utmb?
+      !(@utmb.nil? || @utmb.empty?)
+    end
+    
     def utma?
       !(@utma.nil? || @utma.empty?)
     end
     
     def parse_cookies
       parse_utmz
+      parse_utmb
       parse_utma
     end
     
@@ -45,6 +51,12 @@ module GaCookieParser
        
     end
     
+    def parse_utmb
+      return if (@utmb.nil? || @utmb.empty?)
+      @utmb_hash = h = {}
+      h[:domain_hash], h[:pageview], h[:outbound_click], h[:timestamp] = @utmb.split(".")
+    end
+    
     def parse_utma
       return if (@utma.nil? || @utma.empty?)
       @utma_hash = h = {}

data/lib/ga_cookie_parser/version.rb

@@ -1,3 +1,3 @@
 module GaCookieParser
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/ga_cookie_parser_test.rb

@@ -5,6 +5,7 @@ class GaCookieParserTest < Test::Unit::TestCase
   
   def setup
     @utmz = "12979384.1294887021.1.2.utmcsr=google|utmccn=(organic)|utmcmd=organic|utmctr=test terms"
+    @utmb = "12979384.2.10.1294866800"
     @utma = "12979384.1392679796.1289844797.1294798990.1294866800.4"
   end
 
@@ -14,25 +15,28 @@ class GaCookieParserTest < Test::Unit::TestCase
       @result = GaCookieParser.new
     end
     
-    should "result in nil values for utmz and utma" do
+    should "result in nil values for utmz, utmb and utma" do
       assert_nil @result.utma
+      assert_nil @result.utmb
       assert_nil @result.utmz
     end
   end
   
   context "creating a parser with a hash of raw cookie values" do
     setup do
-      @result = GaCookieParser.new(:utmz => @utmz, :utma => @utma)
+      @result = GaCookieParser.new(:utmz => @utmz, :utmb => @utmb, :utma => @utma)
     end
     
-    should "provide access to the raw values through utmz and utma" do
+    should "provide access to the raw values through utmz, utmb and utma" do
       assert !@result.utmz.nil?
       assert_equal @utma, @result.utma
+      assert_equal @utmb, @result.utmb
       assert_equal @utmz, @result.utmz
     end
     
-    should "provide access to the parsed cookie hashes through utmz_hash and utma_hash" do
+    should "provide access to the parsed cookie hashes through utmz_hash, utmb_hash and utma_hash" do
       assert_not_nil @result.utmz_hash
+      assert_not_nil @result.utmb_hash
       assert_not_nil @result.utma_hash
     end
     
@@ -50,6 +54,14 @@ class GaCookieParserTest < Test::Unit::TestCase
       assert_nil @p[:utmgclid]
     end
     
+    should "accurately parse the utmb cookie" do
+      @p = @result.utmb_hash
+      assert_equal '12979384', @p[:domain_hash]
+      assert_equal '2', @p[:pageview]
+      assert_equal '10', @p[:outbound_click]
+      assert_equal '1294866800', @p[:timestamp]
+    end
+    
     should "accurately parse the utma cookie" do
       @p = @result.utma_hash
       assert_equal '12979384', @p[:domain_hash]
@@ -64,21 +76,29 @@ class GaCookieParserTest < Test::Unit::TestCase
   
   context "creating a parser with some cookie values missing" do
     setup do
-      @missing_utmz = GaCookieParser.new(:utma => @utma)
-      @missing_utma = GaCookieParser.new(:utmz => @utmz)
+      @missing_utmz = GaCookieParser.new(:utma => @utma, :utmb => @utmb)
+      @missing_utma = GaCookieParser.new(:utmb => @utmb, :utmz => @utmz)
+      @missing_utmb = GaCookieParser.new(:utma => @utma, :utmz => @utmz)
     end
     
     should "return nil for the parsed hashes of those cookies" do
       assert_nil  @missing_utmz.utmz_hash
+      assert_nil  @missing_utmb.utmb_hash
       assert_nil  @missing_utma.utma_hash
     end
     
     should "indicate the values are not present" do
       assert !@missing_utmz.utmz?
-      assert  @missing_utmz.utma?
+      assert @missing_utmz.utma?
+      assert @missing_utmz.utmb?
       
       assert !@missing_utma.utma?
       assert @missing_utma.utmz?
+      assert @missing_utma.utmb?
+      
+      assert !@missing_utmb.utmb?
+      assert @missing_utmb.utmz?
+      assert @missing_utmb.utma?
     end
   end
   
@@ -105,12 +125,13 @@ class GaCookieParserTest < Test::Unit::TestCase
   
   context "calling the parse method on the module" do
     setup do
-      @result = ::GaCookieParser.parse(:utmz => @utmz, :utma => @utma)
+      @result = ::GaCookieParser.parse(:utmz => @utmz, :utmb => @utmb, :utma => @utma)
     end
     
     should "return a GaCookieParser instance correctly initialized" do
       assert @result.is_a?(::GaCookieParser::GaCookieParser)
       assert_not_nil @result.utmz_hash
+      assert_not_nil @result.utmb_hash
       assert_not_nil @result.utma_hash
     end
     
@@ -118,7 +139,7 @@ class GaCookieParserTest < Test::Unit::TestCase
   
   context "parsing a bad cookie" do
     setup do
-      @result = GaCookieParser.new(:utmz => "123XXX", :utma => "\"jk.,./l;o.mnhhlk")
+      @result = GaCookieParser.new(:utmz => "123XXX", :utmb => "lkvlveef", :utma => "\"jk.,./l;o.mnhhlk")
     end
       
     should "not throw an error" do

metadata

@@ -1,44 +1,40 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ga_cookie_parser
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Simon Robson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-16 00:00:00 +07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: shoulda
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-description: Gem to parse the utmz and utma tracking coockies used by Google Analytics.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem to parse the utmz, utmb and utma tracking coockies used by Google
+  Analytics.
+email:
 - shrobson@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
@@ -50,36 +46,30 @@ files:
 - lib/ga_cookie_parser/version.rb
 - test/ga_cookie_parser_test.rb
 - test/test_helper.rb
-has_rdoc: true
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: ga_cookie_parser
-rubygems_version: 1.3.6
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Google Analytics Cookie Parsing Gem
-test_files: 
+test_files:
 - test/ga_cookie_parser_test.rb
 - test/test_helper.rb