gabba 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

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

data/README

@@ -0,0 +1,12 @@
+== 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 custom events
+Gabba::Gabba.new("UT-1234", "mydomain.com").event("Videos", "Play", "ID", "123")
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+task :spec do
+  ruby "spec/gabba_spec.rb"
+end

data/gabba.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "gabba/version"
+
+Gem::Specification.new do |s|
+  s.name        = "gabba"
+  s.version     = Gabba::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ron Evans"]
+  s.email       = ["ron dot evans at gmail dot com"]
+  s.homepage    = ""
+  s.summary     = %q{Easy server-side tracking for Google Analytics}
+  s.description = %q{Easy server-side tracking for Google Analytics}
+
+  s.rubyforge_project = "gabba"
+
+  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/gabba.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/gabba/gabba.rb'

data/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, utmhid = rand(8999999999) + 1000000000)
+      {
+        :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

data/lib/gabba/version.rb

@@ -0,0 +1,3 @@
+module Gabba
+  VERSION = "0.0.1"
+end

data/spec/gabba_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Gabba::Gabba do
+  
+  describe "when tracking page views" do
+    before do
+      @gabba = Gabba::Gabba.new("abc", "123")
+    end
+    
+    it "must require GA account" do
+      lambda {Gabba::Gabba.new(nil, nil).page_view("thing", "thing")}.must_raise(Gabba::NoGoogleAnalyticsAccountError)
+    end
+
+    it "must require GA domain" do
+      lambda {Gabba::Gabba.new("abs", nil).page_view("thing", "thing")}.must_raise(Gabba::NoGoogleAnalyticsDomainError)
+    end
+    
+    it "must be able to create page_view_params" do
+      @gabba.page_view_params("hiya", "/tracker/page")[:utmdt].must_equal("hiya")
+    end
+
+    it "must be able to create hash of page_view_params" do
+      @gabba.hash_to_querystring(@gabba.page_view_params("hiya", "/tracker/page")).wont_be_nil
+    end
+  end
+
+  describe "when tracking custom events" do
+    before do
+      @gabba = Gabba::Gabba.new("abc", "123")
+    end
+    
+    it "must require GA account" do
+      lambda {Gabba::Gabba.new(nil, nil).event("cat1", "act1", "lab1", "val1")}.must_raise(Gabba::NoGoogleAnalyticsAccountError)
+    end
+
+    it "must require GA domain" do
+      lambda {Gabba::Gabba.new("abs", nil).event("cat1", "act1", "lab1", "val1")}.must_raise(Gabba::NoGoogleAnalyticsDomainError)
+    end
+    
+    it "must be able to create event data" do
+      @gabba.event_data("cat1", "act1", "lab1", "val1").wont_be_nil
+    end
+    
+  end
+ 
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require File.dirname(__FILE__) + '/../lib/gabba/gabba'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: gabba
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ron Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-28 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Easy server-side tracking for Google Analytics
+email: 
+- ron dot evans at gmail dot com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- gabba.gemspec
+- lib/gabba.rb
+- lib/gabba/gabba.rb
+- lib/gabba/version.rb
+- spec/gabba_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: gabba
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Easy server-side tracking for Google Analytics
+test_files: 
+- spec/gabba_spec.rb
+- spec/spec_helper.rb