garu 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mathieu Davy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= garu
+
+A gem to send google analytics tracker requests from server side ruby code.
+
+== Contributing to garu
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Mathieu Davy. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "garu"
+  gem.homepage = "http://github.com/ekynoxe/garu"
+  gem.license = "MIT"
+  gem.summary = %Q{Garu! Google Analytics from Ruby.}
+  gem.description = %Q{A gem to send google analytics tracker requests from server side ruby code.}
+  gem.email = "matt@ekynoxe.com"
+  gem.authors = ["Mathieu Davy"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "garu #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/garu.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{garu}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mathieu Davy"]
+  s.date = %q{2011-11-15}
+  s.description = %q{A gem to send google analytics tracker requests from server side ruby code.}
+  s.email = %q{matt@ekynoxe.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "garu.gemspec",
+    "lib/garu.rb",
+    "test/helper.rb",
+    "test/test_garu.rb"
+  ]
+  s.homepage = %q{http://github.com/ekynoxe/garu}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.0}
+  s.summary = %q{Garu! Google Analytics from Ruby.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/garu.rb

@@ -0,0 +1,195 @@
+# GARU
+#
+# => A Ruby gem to place server side calls to google
+# => analytics. Based on google analytics for mobile found
+# => at http://code.google.com/mobile/analytics/
+# => @Author: Mathieu Davy - ekynoxe http://ekynoxe.com
+# => November 2011
+
+require 'digest/md5'
+require 'net/http'
+
+class Garu
+  attr_accessor :account, :request
+
+  # Tracker version. (Kept from the google tools for mobile
+  # => as it's using the same parameters)
+  VERSION = "4.4sh"
+  
+  COOKIE_NAME = "__utmmobile"
+  # The path the cookie will be available to, edit this to
+  # => use a different cookie path.
+  COOKIE_PATH = "/"
+  # Two years in seconds.
+  COOKIE_USER_PERSISTENCE = 63072000
+  
+  #Google URL called to record the tracker hit
+  UTMGIFLOCATION = "http://www.google-analytics.com/__utm.gif"
+  
+  # 1x1 transparent GIF to be sent back in the response body
+  GIF_DATA = [
+      0x47.chr, 0x49.chr, 0x46.chr, 0x38.chr, 0x39.chr, 0x61.chr,
+      0x01.chr, 0x00.chr, 0x01.chr, 0x00.chr, 0x80.chr, 0xff.chr,
+      0x00.chr, 0xff.chr, 0xff.chr, 0xff.chr, 0x00.chr, 0x00.chr,
+      0x00.chr, 0x2c.chr, 0x00.chr, 0x00.chr, 0x00.chr, 0x00.chr,
+      0x01.chr, 0x00.chr, 0x01.chr, 0x00.chr, 0x00.chr, 0x02.chr,
+      0x02.chr, 0x44.chr, 0x01.chr, 0x00.chr, 0x3b.chr
+  ]
+  
+  def initialize (account, request)
+    @request = request
+    @account = account
+  end
+  
+  # Get a random number string.
+  def getRandomNumber
+    return rand(0x7fffffff).to_s
+  end
+  
+  # The last octect of the IP address is removed to
+  # => anonymize the user.
+  def getIP (remoteAddress=nil)
+    if remoteAddress.nil?
+      remoteAddress = @request.env['REMOTE_ADDR'].split(',').first
+    end
+    matches = /^([^.]+\.[^.]+\.[^.]+\.).*/.match(remoteAddress)
+    if !matches[1].nil?
+      remoteAddress = matches[1]+"0"
+    else
+      remoteAddress = ""
+    end
+    
+    remoteAddress
+  end
+  
+  # Generate a visitor id for this hit.
+  # => If there is a visitor id in the cookie, use
+  # => that, otherwise use the guid if we have one,
+  # => otherwise use a random number.
+  def getVisitorId(guid, account, userAgent, cookie)
+    # If there is a value in the cookie, don't change it.
+    if (!cookie.nil?)
+      return cookie
+    end
+    
+    message = ""
+    
+    if (!guid.nil?)
+      # Create the visitor id using the guid.
+      message = guid + account
+    else
+      # Otherwise this is a new user, create a new
+      # => random id.
+      message = userAgent + getRandomNumber
+    end
+    
+    md5String = Digest::MD5.hexdigest(message)
+    
+    return "0x" + md5String[0..16]
+  end
+  
+  # Make a tracking request to Google Analytics
+  # => from this server.
+  # => Copies the headers from the original
+  # => request to the new one.
+  def sendRequestToGoogleAnalytics(utmUrl)
+    uri = URI.parse(utmUrl)
+    req = Net::HTTP::Get.new(uri.request_uri)
+    req['user_agent'] = @request.env["HTTP_USER_AGENT"]
+    req['Accepts-Language:'] = @request.env["HTTP_ACCEPT_LANGUAGE"]
+    
+    res = Net::HTTP.start(uri.host, uri.port) {|http|
+      http.request(req)
+    }
+    res
+  end
+  
+  # Track a page view, updates all the cookies
+  # => and campaign tracker, makes a server side
+  # => request to Google Analytics and writes the
+  # => transparent gif byte data to the response.
+  def trackPageView()
+    timeStamp = Time.now.getutc.to_i
+    domainName = @request.host
+    
+    if domainName.nil?
+      domainName = ""
+    end
+    
+    # Get the referrer from the utmr parameter,
+    # => this is the referrer to the page that
+    # => contains the tracking pixel, not the
+    # => referrer for tracking pixel.
+    documentReferer = @request.env["HTTP_REFERER"]
+    
+    if (documentReferer.nil? && documentReferer != "0")
+      documentReferer = "-"
+    else
+      documentReferer = URI.unescape(documentReferer)
+    end
+    
+    documentPath = @request.path
+    if documentPath.nil?
+      documentPath = ""
+    else
+      documentPath = URI.unescape(documentPath)
+    end
+    
+    account = @account
+    userAgent = @request.env["HTTP_USER_AGENT"]
+    if userAgent.nil?
+      userAgent = ""
+    end
+    
+    # Try and get visitor cookie from the request.
+    cookie = @request.cookies[Garu::COOKIE_NAME]
+    
+    visitorId = getVisitorId(@request.env["HTTP_X_DCMGUID"], account, userAgent, cookie)
+    
+    # Construct the gif hit url.
+    utmUrl = Garu::UTMGIFLOCATION + "?" +
+        "utmwv=" + Garu::VERSION +
+        "&utmn=" + getRandomNumber +
+        "&utmhn=" + URI.escape(domainName) +
+        "&utmr=" + URI.escape(documentReferer) +
+        "&utmp=" + URI.escape(documentPath) +
+        "&utmac=" + account.to_s +
+        "&utmcc=__utma%3D999.999.999.999.999.1%3B" +
+        "&utmvid=" + visitorId +
+        "&utmip=" + getIP(@request.env["REMOTE_ADDR"])
+    
+    gaResponse = sendRequestToGoogleAnalytics(utmUrl)
+    
+    response = {
+      'headers' => {
+          'Content-Type'  => "image/gif",
+          'Cache-Control' => "private, no-cache, no-cache=Set-Cookie, proxy-revalidate",
+          'Pragma'        => "no-cache",
+          'Expires'       => "Wed, 17 Sep 1975 21:32:10 GMT"
+      },
+      'body' => GIF_DATA.join
+    }
+    
+    # If the debug parameter is on, add a header
+    # => to the response that contains the url
+    # => that was used to contact Google Analytics.
+    if !@request.params["utmdebug"].nil?
+      response["headers"].merge!({"X-GA-MOBILE-URL" => utmUrl})
+    end
+    
+    # If no cookie was passed with the request,
+    # => a new one has been created and therefore
+    # => needs to be sent back in the response from Garu
+    if !cookie
+      response.merge!({'cookie' => {
+        'name'     => COOKIE_NAME,
+        'value'    => visitorId,
+        'path'     => COOKIE_PATH,
+        'domain'   => domainName,
+        'expires'  => Time.at(timeStamp + COOKIE_USER_PERSISTENCE)
+      }})
+    end
+
+    response
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'garu'
+
+class Test::Unit::TestCase
+end

data/test/test_garu.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestGaru < Test::Unit::TestCase
+  should "remove the last block of an IP address" do
+    return true
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: garu
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mathieu Davy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-15 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: A gem to send google analytics tracker requests from server side ruby code.
+email: matt@ekynoxe.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- garu.gemspec
+- lib/garu.rb
+- test/helper.rb
+- test/test_garu.rb
+has_rdoc: true
+homepage: http://github.com/ekynoxe/garu
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 4023332570823800525
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Garu! Google Analytics from Ruby.
+test_files: []
+