gabbara 0.0.2

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    gabbara (0.0.2)
+      activesupport
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    addressable (2.2.2)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    rack (1.2.1)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    webmock (1.6.1)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  gabbara!
+  rack
+  rspec
+  webmock

data/README

@@ -0,0 +1,14 @@
+== Simple class to send custom server-side events to Google Analytics
+
+Heavily influenced by the http://code.google.com/p/serversidegoogleanalytics
+
+Based on deadprogrammer's gabba (https://github.com/hybridgroup/gabba)
+
+HOW TO USE:
+
+- Track page views
+Gabbara::Gabba.new("UT-1234", "mydomain.com").page_view("something", "track/me")
+
+- Track custom events
+Gabbara::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/gabbara.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "gabbara/version"
+
+Gem::Specification.new do |s|
+  s.name        = "gabbara"
+  s.version     = Gabbara::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michael Reinsch", "Ron Evans"]
+  s.email       = ["michael@mobalean.com", "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 = "gabbara"
+
+  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"]
+
+  s.add_dependency("activesupport")
+end

data/lib/gabbara.rb

@@ -0,0 +1,2 @@
+require 'gabbara/version'
+require 'gabbara/gabba'

data/lib/gabbara/gabba.rb

@@ -0,0 +1,114 @@
+# yo, easy server-side tracking for Google Analytics... hey!
+require "uri"
+require "net/http"
+require 'cgi'
+require 'ipaddr'
+require 'active_support/core_ext/array/extract_options'
+
+module Gabbara
+
+  class GoogleAnalyticsSetupError < RuntimeError; end
+  class GoogleAnalyticsNetworkError < RuntimeError; end
+
+  class Gabba
+    GOOGLE_HOST = "www.google-analytics.com"
+    BEACON_PATH = "/__utm.gif"
+    USER_AGENT = "Gabbara #{VERSION} Agent"
+
+    attr_accessor :logger, :utmwv, :utmn, :utmhn, :utmcs, :utmul, :utmp, :utmac, :utmt, :utmcc, :utmr, :utmip, :user_agent
+
+    # create with:
+    #  ga_acct, domain
+    # or
+    #  ga_acct, :request => request
+    def initialize(ga_acct, *args)
+      @utmwv = "4.4sh" # GA version
+      @utmcs = "UTF-8" # charset
+      @utmul = "en-us" # language
+      @utmn = rand(8999999999) + 1000000000
+      @user_agent = Gabba::USER_AGENT
+
+      @utmac = ga_acct
+      opts = args.extract_options!
+      @utmhn = args.shift
+      opts.each {|key, value| self.send("#{key}=", value) }
+    end
+
+    def request=(request)
+      @user_agent = request.env["HTTP_USER_AGENT"] || Gabba::USER_AGENT
+      @utmhn ||= request.env["SERVER_NAME"] || ""
+      @utmr = request.params['utmr'].blank? ? (request.env['HTTP_REFERER'].blank? ? "-" : request.env['HTTP_REFERER']) : request.params[:utmr]
+      @utmp = request.params['utmp'].blank? ? (request.env['REQUEST_URI'] || "") : request.params['utmp']
+      # the last octect of the IP address is removed to anonymize the user.
+      @utmip = IPAddr.new(request.env["REMOTE_ADDR"]).mask(24).to_s
+    end
+
+    # parameters:
+    #  title, page, :utmvid => visitor_id
+    # or
+    #  title, :utmvid => visitor_id
+    # if page is obmitted, it is taken from the request
+    def page_view(title, *args)
+      check_account_params
+      opts = args.extract_options!
+      opts[:utmdt] = title
+      opts[:utmp] = args.shift || @utmp
+      hey(opts)
+    end
+
+    # parameters:
+    #  category, action, label = nil, value = nil, :utmvid => visitor_id
+    def event(*args)
+      check_account_params
+      opts = args.extract_options!
+      opts[:utmt] = 'event'
+      opts[:utme] = event_data(*args)
+      hey(opts)
+    end
+
+    private
+
+    def default_params
+      { :utmwv => @utmwv,
+        :utmn => @utmn,
+        :utmhn => @utmhn,
+        :utmcs => @utmcs,
+        :utmul => @utmul,
+        :utmhid => rand(8999999999) + 1000000000,
+        :utmac => @utmac,
+        :utmcc => @utmcc || cookie_params,
+        :utmr => @utmr,
+        :utmp => @utmp,
+        :utmip => @utmip }
+    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 GoogleAnalyticsSetupError, "no account" if @utmac.blank?
+      raise GoogleAnalyticsSetupError, "no domain" if @utmhn.blank?
+    end
+
+    # makes the tracking call to Google Analytics
+    def hey(params)
+      headers = {"User-Agent" => URI.escape(user_agent)}
+      params = default_params.merge(params).reject{|k,v| v.blank? }
+      logger.info("GA: #{params.inspect}") if logger
+      query = params.map {|k,v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')
+      req = Net::HTTP::Get.new("#{BEACON_PATH}?#{query}", headers)
+      res = Net::HTTP.start(GOOGLE_HOST) do |http|
+        http.request(req)
+      end
+      raise GoogleAnalyticsNetworkError unless res.code == "200"
+    end
+  end
+end

data/lib/gabbara/version.rb

@@ -0,0 +1,3 @@
+module Gabbara
+  VERSION = '0.0.2'
+end

data/spec/gabba_spec.rb

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Gabbara::Gabba do
+
+  describe "parameter checking" do
+    it "must require GA account for page_view" do
+      expect {Gabbara::Gabba.new(nil, nil).page_view("thing", "thing")}.to raise_error(Gabbara::GoogleAnalyticsSetupError)
+    end
+    it "must require GA domain for page_view" do
+      expect {Gabbara::Gabba.new("abs", nil).page_view("thing", "thing")}.to raise_error(Gabbara::GoogleAnalyticsSetupError)
+    end
+    it "must require GA account for event" do
+      expect {Gabbara::Gabba.new(nil, nil).event("cat1", "act1", "lab1", "val1")}.to raise_error(Gabbara::GoogleAnalyticsSetupError)
+    end
+    it "must require GA domain for event" do
+      expect {Gabbara::Gabba.new("abs", nil).event("cat1", "act1", "lab1", "val1")}.to raise_error(Gabbara::GoogleAnalyticsSetupError)
+    end
+  end
+
+  describe "when tracking page views" do
+    before do
+      stub_analytics "utmdt"=>"title", "utmp"=>"/page/path"
+      @gabba = Gabbara::Gabba.new("UC-123", "domain", :utmn => "1009731272", :utmcc => '')
+    end
+
+    it "must do a request to google" do
+      @gabba.page_view("title", "/page/path", :utmhid => "6783939397")
+    end
+  end
+
+  describe "when tracking page views from request" do
+    before do
+      stub_analytics "DoCoMo", "utmdt"=>"title", "utmhn"=>"test.local", "utmp"=>"/test", "utmip"=>"127.0.0.0", "utmr"=>"-"
+      @gabba = Gabbara::Gabba.new("UC-123", :request => test_request, :utmn => "1009731272", :utmcc => '')
+    end
+
+    it "must to a request to google" do
+      @gabba.page_view("title", :utmhid => "6783939397")
+    end
+  end
+
+  describe "when tracking page views from request with visitor_id" do
+    before do
+      stub_analytics "DoCoMo", "utmdt"=>"title", "utmhn"=>"test.local", "utmp"=>"/test", "utmip"=>"127.0.0.0", "utmr"=>"-", "utmvid" => "0x16741532543"
+      @gabba = Gabbara::Gabba.new("UC-123", :request => test_request, :utmn => "1009731272", :utmcc => '')
+    end
+
+    it "must to a request to google" do
+      @gabba.page_view("title", :utmhid => "6783939397", :utmvid => "0x16741532543")
+    end
+  end
+
+  describe "when tracking custom events" do
+    before do
+      stub_analytics "utme"=>"5(cat1*action*lab1)(val1)", "utmt"=>"event"
+      @gabba = Gabbara::Gabba.new("UC-123", "domain", :utmn => "1009731272", :utmcc => '')
+    end
+
+    it "must do a request to google" do
+      @gabba.event("cat1", "act1", "lab1", "val1", :utmhid => "6783939397")
+    end
+  end
+
+  def stub_analytics(*args)
+    expected_params = args.extract_options!
+    user_agent = args.shift || "Gabbara%20#{Gabbara::VERSION}%20Agent"
+    expected_params = { "utmac"=>"UC-123", "utmcs"=>"UTF-8", "utmhid"=>"6783939397", "utmhn"=>"domain", "utmn"=>"1009731272", "utmul"=>"en-us", "utmwv"=>"4.4sh" }.merge(expected_params).reject{|k,v| v.blank? }
+    query = expected_params.map {|k,v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')
+    s = stub_request(:get, "http://www.google-analytics.com:80/__utm.gif?#{query}").
+      with(:headers => {'Accept'=>'*/*', 'User-Agent'=>user_agent}).
+      to_return(:status => 200, :body => "", :headers => {})
+    #puts s.request_pattern
+  end
+
+  def test_request(params = {})
+    params = {"REMOTE_ADDR" => "127.0.0.1", "HTTP_USER_AGENT" => "DoCoMo"}.merge(params)
+    Rack::Request.new(Rack::MockRequest.env_for("http://test.local/utm.gif?utmp=/test", params))
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'webmock/rspec'
+require 'rack'
+require 'gabbara'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: gabbara
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Michael Reinsch
+- Ron Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-20 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Easy server-side tracking for Google Analytics
+email: 
+- michael@mobalean.com
+- ron dot evans at gmail dot com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- gabbara.gemspec
+- lib/gabbara.rb
+- lib/gabbara/gabba.rb
+- lib/gabbara/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: gabbara
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Easy server-side tracking for Google Analytics
+test_files: []
+