gabba 0.1.1 → 0.2.0

data/.gitignore

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

data/README

@@ -1,12 +1,41 @@
-== Simple class to send custom server-side events to Google Analytics
+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 page views
 
-- Track custom events
-Gabba::Gabba.new("UT-1234", "mydomain.com").event("Videos", "Play", "ID", "123")
+        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)
+
+* 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
 

data/lib/gabba/gabba.rb

@@ -14,6 +14,13 @@ module Gabba
     GOOGLE_HOST = "www.google-analytics.com"
     BEACON_PATH = "/__utm.gif"
     USER_AGENT = "Gabba #{VERSION} Agent"
+
+    # Custom var levels
+    VISITOR = 1
+    SESSION = 2
+    PAGE    = 3
+
+    ESCAPES = %w{ ' ! * ) }
     
     attr_accessor :utmwv, :utmn, :utmhn, :utmcs, :utmul, :utmdt, :utmp, :utmac, :utmt, :utmcc, :user_agent
     
@@ -28,15 +35,48 @@ module Gabba
       @utmac = ga_acct
       @utmhn = domain
       @user_agent = agent
+
+      @custom_vars = []
     end
   
+    def set_custom_var(index, name, value, scope)
+      raise "Index must be between 1 and 5" unless (1..5).include?(index)
+      raise "Scope must be 1 (VISITOR), 2 (SESSION) or 3 (PAGE)" unless (1..3).include?(scope)
+      
+      @custom_vars[index] = [ name, value, scope ]
+    end
+    
+    def delete_custom_var(index)
+      raise "Index must be between 1 and 5" unless (1..5).include?(index)
+
+      @custom_vars.delete_at(index)
+    end
+    
+    def custom_var_data
+      names  = []
+      values = []
+      scopes = []
+      
+      idx = 1
+      @custom_vars.each_with_index do |(n, v, s), i|
+        next if !n || !v || (/\w/ !~ n) || (/\w/ !~ v)
+        prefix = "#{i}!" if idx != i
+        names  << "#{prefix}#{escape(n)}"
+        values << "#{prefix}#{escape(v)}"
+        scopes << "#{prefix}#{escape(s)}"
+        idx = i + 1
+      end
+      
+      names.empty? ? "" : "8(#{names.join('*')})9(#{values.join('*')})11(#{scopes.join('*')})"
+    end
+    
     def page_view(title, page, utmhid = random_id)
       check_account_params
       hey(page_view_params(title, page, utmhid))
     end
 
     def page_view_params(title, page, utmhid = random_id)
-      {
+      options = {
         :utmwv => @utmwv,
         :utmn => @utmn,
         :utmhn => @utmhn,
@@ -48,20 +88,28 @@ module Gabba
         :utmac => @utmac,
         :utmcc => @utmcc || cookie_params
       }
+
+      # Add custom vars if present
+      cvd = custom_var_data
+      options[:utme] = cvd if /\w/ =~ cvd
+
+      options
     end
   
-    def event(category, action, label = nil, value = nil, utmhid = random_id)
+    def event(category, action, label = nil, value = nil, utmni = false, utmhid = random_id)
       check_account_params
-      hey(event_params(category, action, label, value, utmhid))
+      hey(event_params(category, action, label, value, utmni, utmhid))
     end
 
-    def event_params(category, action, label = nil, value = nil, utmhid = nil)
+    def event_params(category, action, label = nil, value = nil, utmni = false, utmhid = false)
+      raise ArgumentError.new("utmni must be a boolean") if (utmni.class != TrueClass && utmni.class != FalseClass)
       {
         :utmwv => @utmwv,
         :utmn => @utmn,
         :utmhn => @utmhn,
+        :utmni => (1 if utmni), # 1 for non interactive event, excluded from bounce calcs
         :utmt => 'event',
-        :utme => event_data(category, action, label, value),
+        :utme => "#{event_data(category, action, label, value)}#{custom_var_data}",
         :utmcs => @utmcs,
         :utmul => @utmul,
         :utmhid => utmhid,
@@ -156,6 +204,7 @@ module Gabba
     # makes the tracking call to Google Analytics
     def hey(params)
       query = params.map {|k,v| "#{k}=#{URI.escape(v.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}" }.join('&')
+
       response = Net::HTTP.start(GOOGLE_HOST) do |http|
         request = Net::HTTP::Get.new("#{BEACON_PATH}?#{query}")
         request["User-Agent"] = URI.escape(user_agent)
@@ -171,6 +220,14 @@ module Gabba
       rand 8999999999 + 1000000000
     end
         
+    def escape(t)
+      return t if !t || (/\w/ !~ t.to_s)
+      
+      t.to_s.gsub(/[\*'!\)]/) do |m|
+        "'#{ESCAPES.index(m)}" 
+      end
+    end
+    
   end # Gabba Class
 
-end
+end

data/lib/gabba/version.rb

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

data/spec/gabba_spec.rb

@@ -32,7 +32,7 @@ describe Gabba::Gabba do
       @gabba = Gabba::Gabba.new("abc", "123")
       @gabba.utmn = "1009731272"
       @gabba.utmcc = ''
-      stub_analytics @gabba.event_params("cat1", "act1", "lab1", "val1", "6783939397")
+      stub_analytics @gabba.event_params("cat1", "act1", "lab1", "val1", false, "6783939397")
     end
     
     it "must require GA account" do
@@ -52,7 +52,11 @@ describe Gabba::Gabba do
     end
     
     it "must do event request to google" do
-      @gabba.event("cat1", "act1", "lab1", "val1", "6783939397").code.must_equal("200")
+      @gabba.event("cat1", "act1", "lab1", "val1", false, "6783939397").code.must_equal("200")
+    end
+
+    it "must be able to send non interactive events" do
+      @gabba.event("cat1", "act1", "lab1", "val1", true).code.must_equal("200")
     end
 
   end
@@ -99,6 +103,67 @@ describe Gabba::Gabba do
     end
   end
 
+  describe "setting a custom var" do
+    before do
+      @gabba = Gabba::Gabba.new("abc", "123")
+      @gabba.utmn = "1009731272"
+      @gabba.utmcc = ''
+    end
+    
+    it "must return data for a valid var" do
+      @gabba.set_custom_var 1, 'A (B*\'!)', 'Yes', Gabba::Gabba::SESSION
+      @gabba.custom_var_data.must_equal "8(A (B'2'0'1'3)9(Yes)11(2)"
+    end
+    
+    it "must return data for several valid vards" do
+      @gabba.set_custom_var 1, 'A', 'Yes', Gabba::Gabba::SESSION
+      @gabba.set_custom_var 2, 'B', 'No', Gabba::Gabba::VISITOR
+      @gabba.custom_var_data.must_equal "8(A*B)9(Yes*No)11(2*1)"
+    end
+    
+    it "must return an empty string if vars aren't set" do
+      @gabba.custom_var_data.must_equal ""
+    end
+    
+    it "must not include var with an empty value" do
+      @gabba.set_custom_var 1, 'A', 'Yes', Gabba::Gabba::SESSION
+      @gabba.set_custom_var 2, 'B', '',    Gabba::Gabba::VISITOR
+      @gabba.set_custom_var 3, 'C', ' ',   Gabba::Gabba::VISITOR
+      @gabba.set_custom_var 4, 'D', nil,   Gabba::Gabba::VISITOR
+      @gabba.custom_var_data.must_equal "8(A)9(Yes)11(2)"
+    end
+    
+    it "must mention index of the var if non sequential" do
+      @gabba.set_custom_var 2, 'A', 'Y', Gabba::Gabba::SESSION
+      @gabba.set_custom_var 4, 'D', 'N', Gabba::Gabba::VISITOR
+      @gabba.custom_var_data.must_equal "8(2!A*4!D)9(2!Y*4!N)11(2!2*4!1)"
+    end
+    
+    it "must raise an error if index is outside the 1-5 (incl) range" do
+      lambda { @gabba.set_custom_var(0, 'A', 'B', 1) }.must_raise(RuntimeError)
+      lambda { @gabba.set_custom_var(6, 'A', 'B', 1) }.must_raise(RuntimeError)
+    end
+    
+    it "must raise an error if scope is outside the 1-3 (incl) range" do
+      lambda { @gabba.set_custom_var(1, 'A', 'B', 0) }.must_raise(RuntimeError)
+      lambda { @gabba.set_custom_var(1, 'A', 'B', 4) }.must_raise(RuntimeError)
+    end
+  end
+
+  describe 'delete custom var' do
+    before do
+      @gabba = Gabba::Gabba.new("abc", "123")
+      @gabba.utmn = "1009731272"
+      @gabba.utmcc = ''
+    end
+    
+    it "must return data for a valid var" do
+      @gabba.set_custom_var 1, 'A (B*\'!)', 'Yes', Gabba::Gabba::SESSION
+      @gabba.delete_custom_var 1
+      @gabba.custom_var_data.must_equal ""
+    end
+  end
+  
   def stub_analytics(expected_params)
     s = stub_request(:get, /www.google-analytics.com\/__utm.gif\?utmac=#{expected_params[:utmac]}&.*/).
           to_return(:status => 200, :body => "", :headers => {})

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gabba
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ron Evans
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-28 00:00:00 -07:00
-default_executable: 
+date: 2012-03-23 00:00:00 Z
 dependencies: []
 
 description: Easy server-side tracking for Google Analytics
@@ -40,7 +39,6 @@ files:
 - lib/gabba/version.rb
 - spec/gabba_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: ""
 licenses: []
 
@@ -70,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gabba
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Easy server-side tracking for Google Analytics