gabba 0.4.2 → 1.0.1

data/Gemfile

@@ -3,5 +3,6 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in gabba.gemspec
 gemspec
 
+gem 'rake'
 gem 'minitest'
 gem 'webmock'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gabba (0.4.2)
+    gabba (1.0.1)
 
 GEM
   remote: http://rubygems.org/
@@ -9,6 +9,7 @@ GEM
     addressable (2.2.2)
     crack (0.1.8)
     minitest (2.0.0)
+    rake (0.9.2.2)
     webmock (1.6.1)
       addressable (>= 2.2.2)
       crack (>= 0.1.7)
@@ -19,4 +20,5 @@ PLATFORMS
 DEPENDENCIES
   gabba!
   minitest
+  rake
   webmock

data/gabba.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Ron Evans"]
   s.email       = ["ron dot evans at gmail dot com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/hybridgroup/gabba"
   s.summary     = %q{Easy server-side tracking for Google Analytics}
   s.description = %q{Easy server-side tracking for Google Analytics}
 

data/lib/gabba/gabba.rb

@@ -1,6 +1,7 @@
 # yo, easy server-side tracking for Google Analytics... hey!
-require "uri"
-require "net/http"
+require 'uri'
+require 'net/http'
+require 'ipaddr'
 require 'cgi'
 require File.dirname(__FILE__) + '/version'
 
@@ -22,7 +23,7 @@ module Gabba
 
     ESCAPES = %w{ ' ! * ) }
 
-    attr_accessor :utmwv, :utmn, :utmhn, :utmcs, :utmul, :utmdt, :utmp, :utmac, :utmt, :utmcc, :user_agent, :utma, :utmz
+    attr_accessor :utmwv, :utmn, :utmhn, :utmcs, :utmul, :utmdt, :utmp, :utmac, :utmt, :utmcc, :user_agent, :utma, :utmz, :utmr, :utmip
 
     # Public: Initialize Gabba Google Analytics Tracking Object.
     #
@@ -45,7 +46,7 @@ module Gabba
 
       @utmac = ga_acct
       @utmhn = domain
-      @user_agent = agent
+      @user_agent =  (agent && agent.length > 0) ? agent : Gabba::USER_AGENT
 
       @custom_vars = []
     end
@@ -137,7 +138,9 @@ module Gabba
         :utmhid => utmhid,
         :utmp => page,
         :utmac => @utmac,
-        :utmcc => @utmcc || cookie_params
+        :utmcc => @utmcc || cookie_params,
+        :utmr => @utmr,
+        :utmip => @utmip
       }
 
       # Add custom vars if present
@@ -182,7 +185,9 @@ module Gabba
         :utmul => @utmul,
         :utmhid => utmhid,
         :utmac => @utmac,
-        :utmcc => @utmcc || cookie_params
+        :utmcc => @utmcc || cookie_params,
+        :utmr => @utmr,
+        :utmip => @utmip
       }
     end
 
@@ -240,7 +245,9 @@ module Gabba
         :utmtsp => shipping,
         :utmtci => city,
         :utmtrg => region,
-        :utmtco => country
+        :utmtco => country,
+        :utmr => @utmr,
+        :utmip => @utmip
       }
     end
 
@@ -275,7 +282,9 @@ module Gabba
         :utmipn => name,
         :utmiva => category,
         :utmipr => price,
-        :utmiqt => quantity
+        :utmiqt => quantity,
+        :utmr => @utmr,
+        :utmip => @utmip
       }
     end
 
@@ -292,6 +301,35 @@ module Gabba
     def identify_user(utma, utmz=nil)
       @utma = utma
       @utmz = utmz
+      self
+    end
+
+    # Public: provide the utmr attribute, allowing for referral tracking
+    #
+    # Called before page_view etc
+    #
+    # Examples:
+    #   g = Gabba::Gabba.new("UT-1234", "mydomain.com")
+    #   g.referer(request.env['HTTP_REFERER'])
+    #   g.page_view("something", "track/me")
+    #
+    def referer(utmr)
+      @utmr = utmr
+      self
+    end
+
+    # Public: provide the utmip attribute, allowing for IP address tracking
+    #
+    # Called before page_view etc
+    #
+    # Examples:
+    #   g = Gabba::Gabba.new("UT-1234", "mydomain.com")
+    #   g.ip(request.env["REMOTE_ADDR"])
+    #   g.page_view("something", "track/me")
+    #
+    def ip(utmip)
+      @utmip = ::IPAddr.new(utmip).mask(24).to_s
+      self
     end
 
     # create magical cookie params used by GA for its own nefarious purposes

data/lib/gabba/version.rb

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

data/spec/gabba_spec.rb

@@ -25,6 +25,18 @@ describe Gabba::Gabba do
     it "must do page view request to google" do
       @gabba.page_view("title", "/page/path", "6783939397").code.must_equal("200")
     end
+
+    it "should use Gabba user agent if none is specified" do
+      @gabba.user_agent.must_equal(Gabba::Gabba::USER_AGENT)
+    end
+
+    it "should use Gabba user agent if nil is specified" do
+      Gabba::Gabba.new("abc","123",nil).user_agent.must_equal(Gabba::Gabba::USER_AGENT)
+    end
+
+    it "should use Gabba user agent if blank is specified" do
+      Gabba::Gabba.new("abc","123","").user_agent.must_equal(Gabba::Gabba::USER_AGENT)
+    end
   end
 
   describe "when tracking custom events" do
@@ -124,6 +136,47 @@ describe Gabba::Gabba do
     end
   end
 
+  describe "when using referer" do
+    referer = "http://www.someurl.com/blah/blah"
+    before do
+      @gabba = Gabba::Gabba.new("abc", "123")
+      @gabba.referer(referer)
+    end
+    it "must use the specified referer in page_view_params" do
+      @gabba.page_view_params("whocares","doesntmatter")[:utmr].must_equal(referer)
+    end
+    it "must use the specified referer in event_params" do
+      @gabba.event_params("whocares","doesntmatter")[:utmr].must_equal(referer)
+    end
+    it "must use the specified referer in transaction_params" do
+      @gabba.transaction_params('order_id', 'total', 'store_name', 'tax', 'shipping', 'city', 'region', 'country', 'utmhid')[:utmr].must_equal(referer)
+    end
+    it "must use the specified referer in item_params" do
+      @gabba.item_params('order_id', 'item_sku', 'name', 'category', 'price', 'quantity', 'utmhid')[:utmr].must_equal(referer)
+    end
+  end
+
+  describe "when using ip" do
+    ip = "123.123.123.123"
+    masked_ip = "123.123.123.0"
+    before do
+      @gabba = Gabba::Gabba.new("abc", "123")
+      @gabba.ip(ip)
+    end
+    it "must use the specified referer in page_view_params" do
+      @gabba.page_view_params("whocares","doesntmatter")[:utmip].must_equal(masked_ip)
+    end
+    it "must use the specified referer in event_params" do
+      @gabba.event_params("whocares","doesntmatter")[:utmip].must_equal(masked_ip)
+    end
+    it "must use the specified referer in transaction_params" do
+      @gabba.transaction_params('order_id', 'total', 'store_name', 'tax', 'shipping', 'city', 'region', 'country', 'utmhid')[:utmip].must_equal(masked_ip)
+    end
+    it "must use the specified referer in item_params" do
+      @gabba.item_params('order_id', 'item_sku', 'name', 'category', 'price', 'quantity', 'utmhid')[:utmip].must_equal(masked_ip)
+    end
+  end
+
   describe "setting a custom var" do
     before do
       @gabba = Gabba::Gabba.new("abc", "123")

metadata

@@ -1,33 +1,23 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: gabba
-version: !ruby/object:Gem::Version 
-  hash: 11
+version: !ruby/object:Gem::Version
+  version: 1.0.1
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 2
-  version: 0.4.2
 platform: ruby
-authors: 
+authors:
 - Ron Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-20 00:00:00 Z
+date: 2012-11-08 00:00:00.000000000 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
@@ -39,39 +29,36 @@ files:
 - lib/gabba/version.rb
 - spec/gabba_spec.rb
 - spec/spec_helper.rb
-homepage: ""
+homepage: https://github.com/hybridgroup/gabba
 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 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -242928597146007543
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -242928597146007543
 requirements: []
-
 rubyforge_project: gabba
 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