gabba 0.0.3 → 0.1.1

data/Gemfile.lock

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

data/lib/gabba/gabba.rb

@@ -22,25 +22,20 @@ module Gabba
       @utmcs = "UTF-8" # charset
       @utmul = "en-us" # language
        
-      @utmn = rand(8999999999) + 1000000000
-      @utmhid = rand(8999999999) + 1000000000
+      @utmn = random_id
+      @utmhid = random_id
       
       @utmac = ga_acct
       @utmhn = domain
       @user_agent = agent
     end
   
-    def page_view(title, page, utmhid = rand(8999999999) + 1000000000)
+    def page_view(title, page, utmhid = random_id)
       check_account_params
       hey(page_view_params(title, page, utmhid))
     end
-  
-    def event(category, action, label = nil, value = nil, utmhid = rand(8999999999) + 1000000000)
-      check_account_params
-      hey(event_params(category, action, label, value, utmhid))
-    end
-    
-    def page_view_params(title, page, utmhid = rand(8999999999) + 1000000000)
+
+    def page_view_params(title, page, utmhid = random_id)
       {
         :utmwv => @utmwv,
         :utmn => @utmn,
@@ -54,8 +49,13 @@ module Gabba
         :utmcc => @utmcc || cookie_params
       }
     end
-    
-    def event_params(category, action, label = nil, value = nil, utmhid = rand(8999999999) + 1000000000)
+  
+    def event(category, action, label = nil, value = nil, utmhid = random_id)
+      check_account_params
+      hey(event_params(category, action, label, value, utmhid))
+    end
+
+    def event_params(category, action, label = nil, value = nil, utmhid = nil)
       {
         :utmwv => @utmwv,
         :utmn => @utmn,
@@ -75,9 +75,75 @@ module Gabba
       data += "(#{value})" if value
       data
     end
+    
+    def transaction(order_id, total, store_name = nil, tax = nil, shipping = nil, city = nil, region = nil, country = nil, utmhid = random_id)
+      check_account_params
+      hey(transaction_params(order_id, total, store_name, tax, shipping, city, region, country, utmhid))
+    end
+
+    def transaction_params(order_id, total, store_name, tax, shipping, city, region, country, utmhid)
+      # '1234',           // utmtid URL-encoded order ID - required
+      # 'Acme Clothing',  // utmtst affiliation or store name
+      # '11.99',          // utmtto total - required
+      # '1.29',           // utmttx tax
+      # '5',              // utmtsp shipping
+      # 'San Jose',       // utmtci city
+      # 'California',     // utmtrg state or province
+      # 'USA'             // utmtco country
+      {
+        :utmwv => @utmwv,
+        :utmn => @utmn,
+        :utmhn => @utmhn,
+        :utmt => 'tran',
+        :utmcs => @utmcs,
+        :utmul => @utmul,
+        :utmhid => utmhid,
+        :utmac => @utmac,
+        :utmcc => @utmcc || cookie_params,
+        :utmtid => order_id,
+        :utmtst => store_name,
+        :utmtto => total,
+        :utmttx => tax,
+        :utmtsp => shipping,
+        :utmtci => city,
+        :utmtrg => region,
+        :utmtco => country
+      }
+    end
+    
+    def add_item(order_id, item_sku, price, quantity, name = nil, category = nil, utmhid = random_id)
+      check_account_params
+      hey(item_params(order_id, item_sku, name, category, price, quantity, utmhid))
+    end
+    
+    def item_params(order_id, item_sku, name, category, price, quantity, utmhid)
+      # '1234',           // utmtid URL-encoded order ID - required
+      # 'DD44',           // utmipc SKU/code - required
+      # 'T-Shirt',        // utmipn product name
+      # 'Green Medium',   // utmiva category or variation
+      # '11.99',          // utmipr unit price - required
+      # '1'               // utmiqt quantity - required
+      {
+        :utmwv => @utmwv,
+        :utmn => @utmn,
+        :utmhn => @utmhn,
+        :utmt => 'item',
+        :utmcs => @utmcs,
+        :utmul => @utmul,
+        :utmhid => utmhid,
+        :utmac => @utmac,
+        :utmcc => @utmcc || cookie_params,
+        :utmtid => order_id,
+        :utmipc => item_sku,
+        :utmipn => name,
+        :utmiva => category,
+        :utmipr => price,
+        :utmiqt => quantity
+      }
+    end
   
     # create magical cookie params used by GA for its own nefarious purposes
-    def cookie_params(utma1 = rand(89999999) + 10000000, utma2 = rand(1147483647) + 1000000000, today = Time.now)
+    def cookie_params(utma1 = random_id, utma2 = rand(1147483647) + 1000000000, today = Time.now)
       "__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);"
     end
 
@@ -89,7 +155,7 @@ module Gabba
 
     # makes the tracking call to Google Analytics
     def hey(params)
-      query = params.map {|k,v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')
+      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)
@@ -100,6 +166,11 @@ module Gabba
       raise GoogleAnalyticsNetworkError unless response.code == "200"
       response
     end
-  end
+
+    def random_id
+      rand 8999999999 + 1000000000
+    end
+        
+  end # Gabba Class
 
 end

data/lib/gabba/version.rb

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

data/spec/gabba_spec.rb

@@ -56,6 +56,48 @@ describe Gabba::Gabba do
     end
 
   end
+  
+  describe "when tracking an item" do
+    before do
+      @gabba = Gabba::Gabba.new("abc", "123")
+      @gabba.utmn = "1009731272"
+      @gabba.utmcc = ''
+      stub_analytics @gabba.item_params("orderid", "1234", "widget", "widgets", "9.99", "1", "6783939397")
+    end
+    
+    it "must require GA account" do
+      lambda {Gabba::Gabba.new(nil, nil).add_item("orderid", "1234", "widget", "widgets", "9.99", "1", "6783939397")}.must_raise(Gabba::NoGoogleAnalyticsAccountError)
+    end
+
+    it "must require GA domain" do
+      lambda {Gabba::Gabba.new("abs", nil).add_item("orderid", "1234", "widget", "widgets", "9.99", "1", "6783939397")}.must_raise(Gabba::NoGoogleAnalyticsDomainError)
+    end
+    
+    it "must do add item request to google" do
+      @gabba.add_item("orderid", "1234", "widget", "widgets", "9.99", "1", "6783939397").code.must_equal("200")
+    end
+  end
+  
+  describe "when tracking a transaction" do
+    before do
+      @gabba = Gabba::Gabba.new("abc", "123")
+      @gabba.utmn = "1009731272"
+      @gabba.utmcc = ''
+      stub_analytics @gabba.transaction_params("orderid", "9.99", "acme stores", ".25", "1.00", "San Jose", "CA", "United States", "6783939397")
+    end
+    
+    it "must require GA account" do
+      lambda {Gabba::Gabba.new(nil, nil).transaction("orderid", "9.99", "acme stores", ".25", "1.00", "San Jose", "CA", "United States", "6783939397")}.must_raise(Gabba::NoGoogleAnalyticsAccountError)
+    end
+
+    it "must require GA domain" do
+      lambda {Gabba::Gabba.new("abs", nil).transaction("orderid", "9.99", "acme stores", ".25", "1.00", "San Jose", "CA", "United States", "6783939397")}.must_raise(Gabba::NoGoogleAnalyticsDomainError)
+    end
+    
+    it "must do transaction request to google" do
+      @gabba.transaction("orderid", "9.99", "acme stores", ".25", "1.00", "San Jose", "CA", "United States", "6783939397").code.must_equal("200")
+    end
+  end
 
   def stub_analytics(expected_params)
     s = stub_request(:get, /www.google-analytics.com\/__utm.gif\?utmac=#{expected_params[:utmac]}&.*/).

metadata

@@ -2,12 +2,12 @@
 name: gabba
 version: !ruby/object:Gem::Version 
   hash: 25
-  prerelease: false
+  prerelease: 
   segments: 
   - 0
-  - 0
-  - 3
-  version: 0.0.3
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Ron Evans
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-02 00:00:00 -08:00
+date: 2011-05-28 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gabba
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Easy server-side tracking for Google Analytics