ga_cookie_parser 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,16 @@
+PATH
+  remote: .
+  specs:
+    ga_cookie_parser (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ga_cookie_parser!
+  shoulda

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Simon Robson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,55 @@
+= Google Analytics Cookie Parser
+
+Simple ruby library for parsing the __umtz 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.
+
+== 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' 
+	}
+
+== Notes
+
+Documentation on these cookies is somewhat sparse. Here are the main resources used in putting this library together:
+
+* {Google documentation}[http://code.google.com/apis/analytics/docs/concepts/gaConceptsCookies.html] on the Google Analytics cookies
+* {Integrating Google Analytics With a CRM}[http://cutroni.com/blog/2007/10/29/integrating-google-analytics-with-a-crm/] blog post by Justin Cutroni
+* {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)
+
+== Copyright
+
+Copyright (c) 2011 Simon Robson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |test|
+  test.libs      << 'lib' << 'test'
+  test.pattern   = 'test/**/*_test.rb'
+  test.verbose   = true
+end

data/ga_cookie_parser.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ga_cookie_parser/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ga_cookie_parser"
+  s.version     = GaCookieParser::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Simon Robson"]
+  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.rubyforge_project = "ga_cookie_parser"
+  
+  s.add_development_dependency "shoulda"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/ga_cookie_parser/version.rb

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

data/lib/ga_cookie_parser.rb

@@ -0,0 +1,57 @@
+module GaCookieParser
+  
+  def self.parse(*args)
+    GaCookieParser.new(*args)
+  end
+  
+  
+  class GaCookieParser
+    
+    attr_reader :utmz, :utma, :utmz_hash, :utma_hash
+    
+    def initialize(cookies = {})
+      @utmz = cookies[:utmz]
+      @utma = cookies[:utma]
+      parse_cookies
+    end
+    
+    def utmz?
+      !(@utmz.nil? || @utmz.empty?)
+    end
+    
+    def utma?
+      !(@utma.nil? || @utma.empty?)
+    end
+    
+    def parse_cookies
+      parse_utmz
+      parse_utma
+    end
+    
+    def parse_utmz
+       return if (@utmz.nil? || @utmz.empty?)
+       @utmz_hash = h = {}
+       h[:domain_hash], h[:timestamp], h[:session_counter], h[:campaign_number], kv_pairs = @utmz.split(".", 5)
+       
+       kv_pairs && kv_pairs.split("|").each do |pair|
+         k, v = pair.split("=")
+         h[k.to_sym] = v if k && v
+       end
+       
+       if h[:utmgclid]
+         h[:utmcsr] = 'google'
+         h[:utmcmd] = 'cpc'
+       end
+       
+    end
+    
+    def parse_utma
+      return if (@utma.nil? || @utma.empty?)
+      @utma_hash = h = {}
+      h[:domain_hash], h[:visitor_id], h[:initial_visit_at], h[:previous_visit_at], h[:current_visit_at], h[:session_counter] = @utma.split(".")
+    end
+    
+  end
+  
+  
+end

data/test/ga_cookie_parser_test.rb

@@ -0,0 +1,130 @@
+require('test_helper')
+
+class GaCookieParserTest < Test::Unit::TestCase
+  include GaCookieParser
+  
+  def setup
+    @utmz = "12979384.1294887021.1.2.utmcsr=google|utmccn=(organic)|utmcmd=organic|utmctr=test terms"
+    @utma = "12979384.1392679796.1289844797.1294798990.1294866800.4"
+  end
+
+
+  context "calling the constructor with no arguments" do
+    setup do
+      @result = GaCookieParser.new
+    end
+    
+    should "result in nil values for utmz and utma" do
+      assert_nil @result.utma
+      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)
+    end
+    
+    should "provide access to the raw values through utmz and utma" do
+      assert !@result.utmz.nil?
+      assert_equal @utma, @result.utma
+      assert_equal @utmz, @result.utmz
+    end
+    
+    should "provide access to the parsed cookie hashes through utmz_hash and utma_hash" do
+      assert_not_nil @result.utmz_hash
+      assert_not_nil @result.utma_hash
+    end
+    
+    should "accurately parse the utmz cookie" do
+      @p = @result.utmz_hash
+      assert_equal '12979384', @p[:domain_hash]
+      assert_equal '1294887021', @p[:timestamp]
+      assert_equal '1', @p[:session_counter]
+      assert_equal '2', @p[:campaign_number]
+      assert_equal 'google', @p[:utmcsr]
+      assert_equal '(organic)', @p[:utmccn]
+      assert_equal 'organic', @p[:utmcmd]
+      assert_equal 'test terms', @p[:utmctr]
+      assert_nil @p[:utmcct]
+      assert_nil @p[:utmgclid]
+    end
+    
+    should "accurately parse the utma cookie" do
+      @p = @result.utma_hash
+      assert_equal '12979384', @p[:domain_hash]
+      assert_equal '1392679796', @p[:visitor_id]
+      assert_equal '1289844797', @p[:initial_visit_at]
+      assert_equal '1294798990', @p[:previous_visit_at]
+      assert_equal '1294866800', @p[:current_visit_at]
+      assert_equal '4', @p[:session_counter]
+    end
+    
+  end
+  
+  context "creating a parser with some cookie values missing" do
+    setup do
+      @missing_utmz = GaCookieParser.new(:utma => @utma)
+      @missing_utma = GaCookieParser.new(:utmz => @utmz)
+    end
+    
+    should "return nil for the parsed hashes of those cookies" do
+      assert_nil  @missing_utmz.utmz_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_utma.utma?
+      assert @missing_utma.utmz?
+    end
+  end
+  
+  context "parsing an adwords-linked cookie" do
+    setup do
+      @search = GaCookieParser.new(:utmz => "57979384.1294829655.1.1.utmgclid=CL_EqKvAtKYCFU80pAodyGj_IA|utmccn=(not set)|utmcmd=(not set)|utmctr=lolcats")
+      @content_network = GaCookieParser.new(:utmz => "23979724.1294828059.1.1.utmgclid=CI7wh8C6tKYCFU2DpAod7z97IQ|utmccn=(not set)|utmcmd=(not set)")
+    end
+      
+    should "record the gclid" do
+      assert_equal "CL_EqKvAtKYCFU80pAodyGj_IA", @search.utmz_hash[:utmgclid]
+      assert_equal "CI7wh8C6tKYCFU2DpAod7z97IQ", @content_network.utmz_hash[:utmgclid]
+    end
+    
+    should "set the utmcsr to 'google' and utmcmd to 'cpc'" do
+      assert_equal "google", @search.utmz_hash[:utmcsr]
+      assert_equal "cpc", @search.utmz_hash[:utmcmd]
+      assert_equal "google", @content_network.utmz_hash[:utmcsr]
+      assert_equal "cpc", @content_network.utmz_hash[:utmcmd]
+    end
+
+
+  end
+  
+  context "calling the parse method on the module" do
+    setup do
+      @result = ::GaCookieParser.parse(:utmz => @utmz, :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.utma_hash
+    end
+    
+  end
+  
+  context "parsing a bad cookie" do
+    setup do
+      @result = GaCookieParser.new(:utmz => "123XXX", :utma => "\"jk.,./l;o.mnhhlk")
+    end
+      
+    should "not throw an error" do
+      assert @result
+    end
+  end
+  
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require('rubygems')
+require('shoulda')
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/ga_cookie_parser')

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: ga_cookie_parser
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Simon Robson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-16 00:00:00 +07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Gem to parse the utmz and utma tracking coockies used by Google Analytics.
+email: 
+- shrobson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- ga_cookie_parser.gemspec
+- lib/ga_cookie_parser.rb
+- lib/ga_cookie_parser/version.rb
+- test/ga_cookie_parser_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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"
+requirements: []
+
+rubyforge_project: ga_cookie_parser
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Google Analytics Cookie Parsing Gem
+test_files: 
+- test/ga_cookie_parser_test.rb
+- test/test_helper.rb