Now offering basic functionality

lib/gabba.rb

@@ -1,96 +1 @@
-# yo, easy server-side tracking for Google Analytics... hey!
-require "open-uri"
-
-module Gabba
-  class NoGoogleAnalyticsAccountError < RuntimeError; end
-  class NoGoogleAnalyticsDomainError < RuntimeError; end
-
-  class Gabba
-    BEACON_URL = "http://www.google-analytics.com/__utm.gif"
-    TRACKING_URL = "http://www.google-analytics.com/ga.js"
-    USER_AGENT = "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.0.7) Gecko/2009021910 Firefox/3.0.7 (.NET CLR 3.5.30729)"
-
-    attr_accessor :utmwv, :utmn, :utmhn, :utmcs, :utmul, :utmdt, :utmp, :utmac, :utmt, :utmcc, :user_agent
-
-    def initialize(ga_acct, domain, user_agent = USER_AGENT)
-      @utmwv = "4.3" # GA version
-      @utmcs = "UTF-8" # charset
-      @utmul = "en-us" # language
-
-      @utmn = rand(8999999999) + 1000000000
-      @utmhid = rand(8999999999) + 1000000000
-
-      @utmac = ga_acct
-      @utmhn = domain
-      @user_agent = user_agent
-    end
-
-    def page_view(title, page, utmhid = rand(8999999999) + 1000000000)
-      check_account_params
-      Gabba.hey(page_view_params(title, page, utmhid))
-    end
-
-    def event(category, action, label = nil, value = nil)
-      check_account_params
-      Gabba.hey(event_params(category, action, label, value))
-    end
-
-    def page_view_params(title, page, utmhid = rand(8999999999) + 1000000000)
-      {
-        :utmwv => @utmwv,
-        :utmn => @utmn,
-        :utmhn => @utmhn,
-        :utmcs => @utmcs,
-        :utmul => @utmul,
-        :utmdt => title,
-        :utmhid => utmhid,
-        :utmp => page,
-        :utmac => @utmac,
-        :utmcc => cookie_params
-      }
-    end
-
-    def event_params(category, action, label = nil, value = nil)
-      {
-        :utmwv => @utmwv,
-        :utmn => @utmn,
-        :utmhn => @utmhn,
-        :utmt => 'event',
-        :utme => event_data(category, action, label, value),
-        :utmcs => @utmcs,
-        :utmul => @utmul,
-        :utmhid => utmhid,
-        :utmac => @utmac,
-        :utmcc => cookie_params
-      }
-    end
-
-    def event_data(category, action, label = nil, value = nil)
-      data = "5(#{category}*action" + (label ? "*#{label})" : ")")      
-      data += "(#{value})" if value
-    end
-
-    def cookie_params(utma1 = rand(89999999) + 10000000, utma2 = rand(1147483647) + 1000000000, today = Time.now)
-      "__utma=1.#{utma1}00145214523.#{utma2}.#{today}.#{today}.15;+__utmz=1.#{today}.1.1.utmcsr=(direct)|utmccn=(direct)|utmcmd=(none);"
-    end
-
-    def check_account_params
-      raise NoGoogleAnalyticsAccountError unless @utmac
-      raise NoGoogleAnalyticsDomainError unless @utmhn
-    end
-
-    # makes the tracking call to Google Analytics
-    def self.hey(params, referer = "-")
-      open("#{BEACON_URL}?hash_to_querystring(params)",
-           "User-Agent" => @user_agent,
-           "Referer" => referer)
-    end
-
-    def self.hash_to_querystring(hash = {})
-      hash.keys.inject('') do |query_string, key|
-        query_string << '&' unless key == hash.keys.first
-        query_string << "#{URI.encode(key.to_s)}=#{URI.encode(hash[key].to_s)}"
-      end
-    end  
-  end
-end
+require File.dirname(__FILE__) + '/gabba/gabba.rb'

lib/gabba/gabba.rb

@@ -0,0 +1,108 @@
+# yo, easy server-side tracking for Google Analytics... hey!
+require "uri"
+require "net/http"
+require 'cgi'
+require File.dirname(__FILE__) + '/version'
+
+module Gabba
+
+  class NoGoogleAnalyticsAccountError < RuntimeError; end
+  class NoGoogleAnalyticsDomainError < RuntimeError; end
+  class GoogleAnalyticsNetworkError < RuntimeError; end
+
+  class Gabba
+    GOOGLE_URL = "http://www.google-analytics.com"
+    TRACKING_URL = "/ga.js"
+    BEACON_URL = "/__utm.gif"
+    USER_AGENT = "Gabba #{VERSION} Agent"
+
+    attr_accessor :utmwv, :utmn, :utmhn, :utmcs, :utmul, :utmdt, :utmp, :utmac, :utmt, :utmcc, :user_agent
+
+    def initialize(ga_acct, domain, agent = Gabba::USER_AGENT)
+      @utmwv = "4.4sh" # GA version
+      @utmcs = "UTF-8" # charset
+      @utmul = "en-us" # language
+
+      @utmn = rand(8999999999) + 1000000000
+      @utmhid = rand(8999999999) + 1000000000
+
+      @utmac = ga_acct
+      @utmhn = domain
+      @user_agent = agent
+    end
+
+    def page_view(title, page, utmhid = rand(8999999999) + 1000000000)
+      check_account_params
+      hey(page_view_params(title, page, utmhid))
+    end
+
+    def event(category, action, label = nil, value = nil)
+      check_account_params
+      hey(event_params(category, action, label, value))
+    end
+
+    def page_view_params(title, page, utmhid = rand(8999999999) + 1000000000)
+      {
+        :utmwv => @utmwv,
+        :utmn => @utmn,
+        :utmhn => @utmhn,
+        :utmcs => @utmcs,
+        :utmul => @utmul,
+        :utmdt => title,
+        :utmhid => utmhid,
+        :utmp => page,
+        :utmac => @utmac,
+        :utmcc => cookie_params
+      }
+    end
+
+    def event_params(category, action, label = nil, value = nil)
+      {
+        :utmwv => @utmwv,
+        :utmn => @utmn,
+        :utmhn => @utmhn,
+        :utmt => 'event',
+        :utme => event_data(category, action, label, value),
+        :utmcs => @utmcs,
+        :utmul => @utmul,
+        :utmhid => utmhid,
+        :utmac => @utmac,
+        :utmcc => cookie_params
+      }
+    end
+
+    def event_data(category, action, label = nil, value = nil)
+      data = "5(#{category}*action" + (label ? "*#{label})" : ")")      
+      data += "(#{value})" if value
+    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)
+      "__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
+
+    # sanity check that we have needed params to even call GA
+    def check_account_params
+      raise NoGoogleAnalyticsAccountError unless @utmac
+      raise NoGoogleAnalyticsDomainError unless @utmhn
+    end
+
+    # makes the tracking call to Google Analytics
+    def hey(params, referer = "-")
+      uri = URI.parse("#{GOOGLE_URL}#{BEACON_URL}?#{hash_to_querystring(params)}")
+      req = Net::HTTP::Get.new(uri.path, {"User-Agent" => URI.escape(user_agent)})
+      res = Net::HTTP.start(uri.host, uri.port) do |http|
+        http.request(req)
+      end
+      raise GoogleAnalyticsNetworkError unless res.code == 200
+    end
+
+    # convert params hash to query string
+    def hash_to_querystring(hash = {})
+      hash.keys.inject('') do |query_string, key|
+        query_string << '&' unless key == hash.keys.first
+        query_string << "#{URI.encode(key.to_s)}=#{URI.encode(hash[key].to_s)}"
+      end
+    end  
+  end
+end

spec/gabba_spec.rb

@@ -20,7 +20,7 @@
     end
 
     it "must be able to create hash of page_view_params" do
-      Gabba::Gabba.hash_to_querystring(@gabba.page_view_params("hiya", "/tracker/page")).wont_be_nil
+      @gabba.hash_to_querystring(@gabba.page_view_params("hiya", "/tracker/page")).wont_be_nil
     end
   end
 

spec/spec_helper.rb

@@ -3,4 +3,4 @@
 require 'minitest/autorun'
 require 'minitest/pride'
 
-require File.dirname(__FILE__) + '/../lib/gabba'
+require File.dirname(__FILE__) + '/../lib/gabba/gabba'