analytics_goo 0.1.2

data/.gitignore

@@ -0,0 +1,7 @@
+coverage
+pkg
+rdoc
+tags
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG

@@ -0,0 +1,44 @@
+[3b07757 | Tue Jun 02 19:39:50 UTC 2009] Rob Christie <robchristie@gmail.com>
+
+ * More changes to support rails environments.
+
+[3452913 | Tue Jun 02 18:39:51 UTC 2009] Rob Christie <robchristie@gmail.com>
+
+ * Changed configuration to optionally allow mixins to Rails core classes. Changed to the use of markdown for my readme.
+
+[e75017f | Tue Jun 02 07:18:37 UTC 2009] Rob Christie <robchristie@gmail.com>
+
+ * Migrating to a gem installation.
+
+[5b7698f | Tue Jun 02 06:00:49 UTC 2009] Rob Christie <robchristie@gmail.com>
+
+ * Updated name of project.
+
+[00a001f | Tue Jun 02 05:16:40 UTC 2009] Rob Christie <robchristie@gmail.com>
+
+ * Updated based on naming and configuration changes.
+
+[17529a1 | Mon Jun 01 20:10:51 UTC 2009] Rob Christie <robchristie@gmail.com>
+
+ * Updated class so that random values are changed on each call to track_page_view.
+
+[e0d96e7 | Mon Jun 01 19:14:54 UTC 2009] Rob Christie <robchristie@gmail.com>
+
+ * Updated changelog.
+
+[b6ec97c | Mon Jun 01 19:12:50 UTC 2009] Rob Christie <robchristie@gmail.com>
+
+ * Renamed #track_it to #track_page_view, so you can eventually add other Analytics supported methods like #track_event.
+
+[99e5798 | Mon Jun 01 18:55:32 UTC 2009] Rob Christie <robchristie@gmail.com>
+
+ * Updated CHANGELOG after running script to pull and format messages from git.
+
+[bbc664d | Mon Jun 01 18:48:16 UTC 2009] Rob Christie <robchristie@gmail.com>
+
+ * Remove the AnalyticsConfig object and we now pass in a hash of initialization values. Also added support for passing in multiple hashes of initialization values.
+
+[81ce0f8 | Wed May 20 14:29:06 UTC 2009] Rob Christie <robchristie@gmail.com>
+
+ * initial commit
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.markdown

@@ -0,0 +1,77 @@
+# AnalyticsGoo
+
+AnalyticsGoo is a gem (or plugin) that provides server side non-javascript tracking using google analytics. The original version tried to mock-up the tracking for use with the UA-* web property ids. The problem with going that route was that all tracking occurs under a single IP address. I have made changes so that it now support google's new MO-* mobile site tracking that allows you to pass the remote IP address via a parameter. The initial intent was to make this look like a logger object. With a single instance that can be used throughout the system; however that is no longer what is needed for our system. We actually need a new version for each request, so the code is still changing.
+
+## Install
+
+gem install eyestreet-analytics_goo
+
+
+## Newer usage pattern
+   Initially I made an adapter pattern thinking that we would support multiple analytics packages. So far I only need Google Analytics:
+
+      tracker =  AnalyticsGoo::GoogleAnalyticsAdapter.new(:analytics_id => "MO-11685745-3",
+                                                      :domain => "shor.tswit.ch",
+                                                      :remote_address => "75.103.6.17",
+                                                      :user_agent => "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2) Gecko/20100115 Firefox/3.6",
+                                                      :http_accept_language => "en-us,en;q=0.5")
+      tracker.track_page_view("/testFoo/myPage.html")
+
+
+
+
+## Example
+   The simple usage is the following:
+   
+        tracker = AnalyticsGoo.config(:google_analytics, 
+                                      :analytics_id => "MO-11685745-3", 
+                                      :domain => "demo.eyestreet.com")
+
+        tracker.track_page_view("/foo")
+
+The first parameter passed to the config initializes the desired analytics adapter. Currently we only support
+Google Analytics. The subsequent hash provide a name for the account, the analytics id, and a domain.
+
+## Rails Usage
+
+In your environment.rb add the following:
+
+  config.gem "analytics_goo", :lib => "analytics_goo"
+  
+
+You can call things  in the same way as above, or you can mix in some additional rails specific functionality that is shown below.
+In an intializer like config/initializers/analytics_goo.rb or in your appropriate environment.rb file
+
+        AnalyticsGoo.config(:google_analytics, :analytics_id => "MO-11685745-3", 
+                                               :domain => "demo.eyestreet.com", 
+                                               :rails_core_mixins => true, 
+                                               :environment => "production")
+
+* analytics type - Currently we only support :google_analytics
+
+The analytics option hash takes the following:
+
+* :analytics_id
+* :domain
+* :rails_core_mixins - Defaults to false. If set to true then you get an accessor method on rails core classes for analytics_goo
+* :environment - The RAILS_ENV environment that the analytics code should be called in. In all other environments it is a noop.
+
+Then in your models, controllers, and mailers you can do the following:
+
+    user = User.find(:first)
+    user.analytics_goo.track_page_view("/found_my_first_user")
+
+## Testing
+
+Check test/test_helper.rb to make sure you have the required gems installed.
+
+  rake test
+  or
+  autotest
+
+# Credits
+
+AnalyticsGoo is maintained by [Rob Christie](mailto:rob.christie@eyestreet.com) and is funded by [EyeStreet Software](http://www.eyestreet.com).
+
+
+Copyright (c) 2009 rwc9u, Eyestreet Software released under the MIT license

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "analytics_goo"
+    gem.summary = %Q{TODO}
+    gem.email = "robchristie@gmail.com"
+    gem.homepage = "http://github.com/eyestreet/analytics_goo"
+    gem.files.include "rails/**/*"
+    gem.authors = ["Rob Christie"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the analytics_goo plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the analytics_goo plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AnalyticsGoo'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,9 @@
+* Add javascript-less support for google analytics event tracking.
+
+* Allow an asynchronous operation mode so that tracking has the option of not being done synchronously.
+
+* Clean up tests.
+
+* Pass along additional header information to google in the image request so that items like browser can be specified.
+
+* Peak at the cookies that came in on the most recent request and then use those to build our utmcc.

data/VERSION

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

data/analytics_goo.gemspec

@@ -0,0 +1,58 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{analytics_goo}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rob Christie"]
+  s.date = %q{2010-03-08}
+  s.email = %q{robchristie@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "analytics_goo.gemspec",
+     "autotest/CHANGELOG",
+     "autotest/LICENSE",
+     "autotest/README.rdoc",
+     "autotest/discover.rb",
+     "autotest/railsplugin.rb",
+     "autotest/railsplugin_rspec.rb",
+     "init.rb",
+     "lib/analytics_goo.rb",
+     "lib/analytics_goo/google_analytics_adapter.rb",
+     "rails/init.rb",
+     "rails/init.rb",
+     "tasks/analytics_goo.rake",
+     "test/analytics_goo_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/eyestreet/analytics_goo}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{analytics_goo provides a ruby wrapper for performing Google Analytics tracking server side using their Mobile API.}
+  s.test_files = [
+    "test/analytics_goo_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/autotest/CHANGELOG

@@ -0,0 +1,7 @@
+
+Git Master
+
+  * Added RSpec support [Adam Meehan]
+  * Added path_to_classname so that failed tests that pass run the suite again. [Ken Collins]
+
+

data/autotest/LICENSE

@@ -0,0 +1,24 @@
+
+Copyright (c) 2008 Action Moniker LLC., http://www.actionmoniker.com/
+
+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/autotest/README.rdoc

@@ -0,0 +1,40 @@
+
+== Autotest::Railsplugin: Use autotest to develop your rails plugins!
+
+This is a work in progress. To date the mappings for this autotest class are working 
+very well for me. Please read the 'railsplugin.rb' file for details. The short story is 
+that default autotest does not map well to rails test naming and this class addresses 
+that. Works for test/unit and rspec.
+
+
+=== INSTALLATION
+
+* From your plugin root run this
+ 
+  git clone git://github.com/metaskills/autotest_railsplugin.git autotest
+
+* You can now use autotest.
+
+  $ autotest
+    loading autotest/railsplugin
+
+
+=== CUSTOMISATION
+
+If you need to customize the exceptions or mappings, create an .autotest file in the root
+of the plugin and place them in there. An example below of adding a custom exception
+
+  Autotest.add_hook :initialize do |at|
+    at.add_exception %r%^\./spec/dont_touch%
+  end
+
+
+=== HELPING OUT
+
+If you find that this class is not doing what you think it should. Perhaps when you 
+save a file it does not running the corresponding test and you want me to fix it, please 
+do the following.
+
+Email the directory structure of both the library file and the test file you expected it 
+to run to ken *[at]* metaskills.net
+

data/autotest/discover.rb

@@ -0,0 +1,6 @@
+
+Autotest.add_discovery do
+  'railsplugin'
+end
+
+

data/autotest/railsplugin.rb

@@ -0,0 +1,53 @@
+class Autotest::Railsplugin < Autotest
+  
+  def initialize
+    super
+    
+    # Default libs for autotest. So far they suit us just fine.
+    # self.libs = %w[. lib test].join(File::PATH_SEPARATOR)
+    
+    # Ignore these directories in the plugin.
+    add_exception %r%^\./(?:autotest|tasks)%
+    
+    # Ignore these ruby files in the root of the plugin folder.
+    add_exception %r%^\./(install|uninstall)\.rb$%
+    
+    # Ignore these misc files in the root of the plugin folder.
+    add_exception %r%^\./(.*LICENSE|Rakefile|README.*|CHANGELOG.*)$%i
+    
+    # Ignore any log file.
+    add_exception %r%.*\.log$%
+    
+    clear_mappings
+    
+    # Easy start. Any test file saved runs that file
+    self.add_mapping(%r%^test/.*_test.rb$%) do |filename, matchs|
+      filename
+    end
+    
+    # If any file in lib matches up to a file in the same directory structure of 
+    # the test directory, ofcourse having _test.rb at the end, will run that test. 
+    self.add_mapping(%r%^lib/(.*)\.rb$%) do |filename, matchs|
+      filename_path = matchs[1]
+      files_matching %r%^test/#{filename_path}_test\.rb$%
+    end
+    
+    # If any core test file like the helper, boot, database.yml change, then run 
+    # all matching .*_test.rb files in the test directory.
+    add_mapping %r%^test/(boot|helper|test_helper|factories)\.rb|database.yml% do
+      files_matching %r%^test/.*_test\.rb$%
+    end
+    
+  end
+  
+  def path_to_classname(s)
+    sep = File::SEPARATOR
+    f = s.sub(/^test#{sep}?/, '').sub(/\.rb$/, '').split(sep)
+    f = f.map { |path| path.split(/_/).map { |seg| seg.capitalize }.join }
+    # f = f.map { |path| path =~ /Test$/ ? path : "#{path}Test"  }
+    f.join('::')
+  end
+  
+  
+end
+

data/autotest/railsplugin_rspec.rb

@@ -0,0 +1,29 @@
+require 'autotest/rspec'
+
+class Autotest::RailspluginRspec < Autotest::Rspec
+
+  def initialize
+    super
+    
+    # Default libs for autospec. So far they suit us just fine.
+    # self.libs = %w[. lib spec].join(File::PATH_SEPARATOR)
+    
+    # Ignore these directories in the plugin.
+    add_exception %r%^\./(?:autotest|tasks)%
+    
+    # Ignore these ruby files in the root of the plugin folder.
+    add_exception %r%^\./(install|uninstall)\.rb$%
+    
+    # Ignore these misc files in the root of the plugin folder.
+    add_exception %r%^\./(.*LICENSE|Rakefile|README.*|CHANGELOG.*)$%i
+    
+    # Ignore any log file.
+    add_exception %r%.*\.log$%
+    
+    add_mapping %r%^spec/(boot|helper|factories)\.rb|database.yml% do
+      files_matching %r%^spec/.*_spec\.rb$%
+    end
+    
+  end
+  
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/lib/analytics_goo/google_analytics_adapter.rb

@@ -0,0 +1,214 @@
+
+# AnalyticsGoo
+# The following came from :
+#  http://code.google.com/apis/analytics/docs/tracking/gaTrackingTroubleshooting.html
+
+# The following parameters are currently not implemented but do not affect basic usage.
+# utme  X10 Data Parameter  Value is encoded.
+
+# utmipc
+#   Product Code. This is the sku code for a given product.
+#   utmipc=989898ajssi
+# utmipn
+#   Product Name, which is a URL-encoded string.  utmipn=tee%20shirt
+# utmipr
+#   Unit Price. Set at the item level. Value is set to numbers only in U.S. currency format.
+#   utmipr=17100.32
+# utmiqt
+#   Quantity.   utmiqt=4
+# utmiva
+#   Variations on an item. For example: large, medium, small, pink, white, black, green. String is URL-encoded.
+#   utmiva=red;
+# utmt
+#   A special type variable applied to events, transactions, items and user-defined variables.  utmt=Dog%20Owner
+# utmtci
+#   Billing City  utmtci=San%20Diego
+# utmtco
+#   Billing Country   utmtco=United%20Kingdom
+# utmtid
+#   Order ID, URL-encoded string.   utmtid=a2343898
+# utmtrg
+#   Billing region, URL-encoded string.   utmtrg=New%20Brunswick
+# utmtsp
+#   Shipping cost. Values as for unit and price.  utmtsp=23.95
+# utmtst
+#   Affiliation. Typically used for brick and mortar applications in ecommerce.   utmtst=google%20mtv%20store
+# utmtto
+#   Total. Values as for unit and price.  utmtto=334.56
+# utmttx
+#   Tax. Values as for unit and price.  utmttx=29.16
+
+module AnalyticsGoo
+  class GoogleAnalyticsAdapter
+    attr_accessor :domain, :analytics_id, :env, :noop, :page_title, :remote_address, :referrer, :user_agent, :http_accept_language
+    # utmdt
+    #   Page title, which is a URL-encoded string.  utmdt=analytics%20page%20test
+
+    def initialize(ac)
+      # sets the environment that this should be run in
+      @analytics_id = ac[:analytics_id]
+      @domain = ac[:domain]
+      @env = ac[:environment]
+      @noop = ac[:noop] || false
+      @page_title  = ac[:page_title] || ""
+      @referrer = ac[:referrer] || "-"
+      @remote_address = ac[:remote_address]
+      @user_agent = ac[:user_agent] || ""
+      @http_accept_language = ac[:http_accept_language] || ""
+    end
+
+    GA_DOMAIN = "www.google-analytics.com"
+    GA_IMAGE = "__utm.gif"
+
+    def urchin_url(ssl = false)
+      protocol = (ssl == true) ? "https":"http"
+      "#{protocol}://#{GA_DOMAIN}/#{GA_IMAGE}"
+    end
+
+    # utmac   Account String. Appears on all requests.    utmac=UA-2202604-2
+    def utmac
+      self.analytics_id
+    end
+
+    # utmhn
+    #   Host Name, which is a URL-encoded string.   utmhn=x343.gmodules.com
+    def utmhn
+      self.domain
+    end
+
+    # utmcs
+    #   Language encoding for the browser. Some browsers don't set this, in which case it is set to "-"
+    #   utmcs=ISO-8859-1
+    def utmcs
+      "UTF-8"
+    end
+
+    # utmje
+    #   Indicates if browser is Java-enabled. 1 is true.  utmje=1
+    def utmje
+      "1"
+    end
+
+    # utmn
+    #   Unique ID generated for each GIF request to prevent caching of the GIF image.   utmn=1142651215
+    def utmn
+      ActiveSupport::SecureRandom.random_number(9999999999).to_s
+    end
+
+    # utmsc
+    #   Screen color depth  utmsc=24-bit
+    def utmsc
+      "0-bit"
+    end
+
+    # utmsr
+    #   Screen resolution   utmsr=2400x1920&
+    def utmsr
+      "0x0"
+    end
+
+    # utmul
+    #   Browser language.   utmul=pt-br
+    def utmul
+      "en-us"
+    end
+
+    # utmwv
+    #   Tracking code version   utmwv=1
+    def utmwv
+      "4.4sj"
+    end
+
+    # utmp
+    #   Page request of the current page.   utmp=/testDirectory/myPage.html
+    #     def utmp
+    #       self.path
+    #     end
+
+    # utmr
+    #   Referral, complete URL.   utmr=http://www.example.com/aboutUs/index.php?var=selected
+    def utmr
+      self.referrer
+    end
+
+    # utmip
+    # Remote IP address
+    def utmip
+      return '' if self.remote_address.blank?
+      # Capture the first three octects of the IP address and replace the forth
+      # with 0, e.g. 124.455.3.123 becomes 124.455.3.0
+      ip = self.remote_address.to_s.gsub!(/([^.]+\.[^.]+\.[^.]+\.)[^.]+/,"\\1") + "0"
+      ip
+    end
+
+
+    # may not be needed
+
+    # utmcn   Starts a new campaign session. Either utmcn or utmcr is present on any given request. Changes the campaign tracking data; but does not start a new session
+    #   utmcn=1
+    def utmcn
+      "1"
+    end
+
+    # utmcr
+    #   Indicates a repeat campaign visit. This is set when any subsequent clicks occur on the same link. Either utmcn or utmcr is present on any given request.
+    #   utmcr=1
+    def utmcr
+      "1"
+    end
+
+    # utmcc
+    #   Cookie values. This request parameter sends all the cookies requested from the page.
+    #   utmcc=__utma%3D117243.1695285.22%3B%2B __utmz%3D117945243.1202416366.21.10. utmcsr%3Db%7C utmccn%3D(referral)%7C utmcmd%3Dreferral%7C utmcct%3D%252Fissue%3B%2B
+    def utmcc
+      "__utma%3D999.999.999.999.999.1%3B"
+    end
+
+    def utmdt
+      self.page_title
+    end
+
+    # send a request to get the image from google
+    def track_page_view(path)
+      res = ""
+      unless @noop == true
+        res = track_it(path)
+      end
+      res
+    end
+
+    protected
+    def track_it(path)
+#       puts "/__utm.gif?utmwv=#{self.utmwv}&utmn=#{self.utmn}&utmhn=#{self.utmhn}&utmcs=#{self.utmcs}&utmsr=#{self.utmsr}&utmsc=#{self.utmsc}&utmul=#{self.utmul}&utmje=#{self.utmje}&utmfl=#{URI::escape(self.utmfl)}&utmdt=#{URI::escape(self.utmdt)}&utmhid=#{utmhid}&utmr=#{self.utmr}&utmp=#{path}&utmac=#{self.utmac}&utmcc=#{self.utmcc} \n"
+      utm_uri = "/__utm.gif?" +
+                "utmwv="  + self.utmwv +
+                "&utmn="  + self.utmn +
+                "&utmhn=" + CGI.escape(self.utmhn) +
+                "&utmr="  + CGI.escape(self.utmr) +
+                "&utmp="  + CGI.escape(path) +
+                "&utmac=" + self.utmac +
+                "&utmcc=" + self.utmcc +
+                "&utmvid="+ self.utmvid +
+                "&utmip=" + self.utmip
+      Net::HTTP.start(GA_DOMAIN) {|http|
+        http.request_get(utm_uri, {"User-Agent" => self.user_agent, "Accept-Language" => self.http_accept_language})
+      }
+    end
+
+    def utmcc_cookie
+      ActiveSupport::SecureRandom.random_number(89999999) + 10000000
+    end
+
+    def utmcc_random
+      ActiveSupport::SecureRandom.random_number(1147483647) + 1000000000
+    end
+
+    def utmcc_time
+      Time.new.to_i
+    end
+
+    def utmvid
+      "0x" + ActiveSupport::SecureRandom.hex[0,16]
+    end
+  end
+end

data/lib/analytics_goo.rb

@@ -0,0 +1,67 @@
+require 'uri'
+require 'cgi'
+require 'net/http'
+require 'activesupport'
+require 'analytics_goo/google_analytics_adapter'
+
+module AnalyticsGoo
+  # generic adapter not found exception
+  class AnalyticsAdapterNotFound < StandardError
+  end
+
+
+  class AnalyticsAdapter
+    def initialize(adapter)
+      @adapter = adapter
+    end
+
+    def track_page_view(path)
+      @adapter.track_page_view(path)
+    end
+
+    def env
+      @adapter.env
+    end
+  end
+
+  # Factory for returning the appropriate analytics object. The <tt>type</tt> is
+  # a symbol that defines the type of analytics tracker you want to create. Currently,
+  # the only acceptable value is :google_analytics. The <tt>analytics</tt> hash holds
+  # the required keys of analytics_id and the domain of the adapter that you are configuring.
+  # Setting the key <tt>rails_core_mixins</tt> to
+  # true will mixin an accessor for this object into the core rails framework classes (active_record, action_controller and action_mailer). The default
+  # for this is false so that there are no rails dependencies on the gem. The key <tt>environment</tt> by default is set to "production". The
+  # rails mixin functionality checks this value against its RAILS_ENV then it calls out to the analytics only if the value is nil or matches.
+  def self.config(type, analytics = {})
+    begin
+      s = type.to_s + "_adapter"
+      adapter = "AnalyticsGoo::" + s.camelize
+      analytics[:environment] = "production" if analytics[:environment].nil?
+      if analytics[:rails_core_mixins] == true
+        analytics[:noop] = (RAILS_ENV != analytics[:environment])
+        tracker = adapter.constantize.new(analytics)
+        for framework in ([ :active_record, :action_controller, :action_mailer ])
+          framework.to_s.camelize.constantize.const_get("Base").send :include, AnalyticsGoo::InstanceMethods
+        end
+        silence_warnings { Object.const_set "ANALYTICS_TRACKER", AnalyticsGoo::AnalyticsAdapter.new(tracker) }
+      else
+        tracker = adapter.constantize.new(analytics)
+      end
+      AnalyticsGoo::AnalyticsAdapter.new(tracker)
+    rescue StandardError
+      raise AnalyticsAdapterNotFound
+    end
+  end
+
+  module InstanceMethods
+    # any methods here will apply to instances
+    def analytics_goo
+      if defined?(ANALYTICS_TRACKER)
+          ANALYTICS_TRACKER
+      else
+        nil
+      end
+    end
+  end
+end
+

data/rails/init.rb

@@ -0,0 +1,7 @@
+require "analytics_goo"
+
+# add our functionality to rails core classes
+# for framework in ([ :active_record, :action_controller, :action_mailer ])
+#   framework.to_s.camelize.constantize.const_get("Base").send :include, AnalyticsGoo::InstanceMethods
+# end
+

data/tasks/analytics_goo.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_analytics do
+#   # Task goes here
+# end

data/test/analytics_goo_test.rb

@@ -0,0 +1,156 @@
+require 'test_helper'
+require 'analytics_goo'
+
+class AnalyticsGooTest < ActiveSupport::TestCase
+
+  context "AnalyticsGoo " do
+    setup do
+      @analytics_config = { :analytics_id => "MO-11685745-3",:domain => "test.local" }
+    end
+    context "contains a GoogleAnalyticsAdapter which when passed initialization data" do
+      should "be a valid class" do
+        assert AnalyticsGoo::GoogleAnalyticsAdapter.new(@analytics_config)
+      end
+    end
+    context "contains a GoogleAnalyticsAdapter when instantiated with the config method" do
+      should "be a valid class" do
+        assert AnalyticsGoo.config(:google_analytics, @analytics_config)
+      end
+    end
+    should "raise an exception when instantiated with an invalid adapter" do
+      assert_raise AnalyticsGoo::AnalyticsAdapterNotFound do
+        AnalyticsGoo.config(:moogle_analytics, @analytics_config)
+      end
+    end
+    context "can pass along an environment variable that" do
+      setup do
+        @analytics_config[:environment] = "test"
+      end
+     should "be passed along to the instantiated class" do
+        assert_equal "test", AnalyticsGoo.config(:google_analytics, @analytics_config).env
+      end
+    end
+  end
+
+  context "AnalyticsGoo " do
+    setup do
+      @analytics_config = { :analytics_id => "MO-11685745-3",:domain => "test.local", :page_title => "This is the page title"}
+      @ga = AnalyticsGoo::GoogleAnalyticsAdapter.new(@analytics_config)
+    end
+    context "when initialized with an analytics id" do
+      should "return that id" do
+        assert_equal "MO-11685745-3", @ga.utmac
+      end
+    end
+    context "when initialized with a domain" do
+      should "return that domain" do
+        assert_equal "test.local", @ga.domain
+      end
+    end
+    context "that has been initialized" do
+      should "have an urchin url" do
+        assert_equal "http://www.google-analytics.com/__utm.gif", @ga.urchin_url
+      end
+    end
+    context "when included and told that the url needs to be ssl" do
+      should "have an https URL" do
+        assert_equal "https://www.google-analytics.com/__utm.gif", @ga.urchin_url(true)
+      end
+    end
+    context "creates an image URL that " do
+      should "have a utmac equal to the specified analytics id" do
+        assert_equal "MO-11685745-3", @ga.utmac
+      end
+      should "have a utmhn equal to the host name" do
+        assert_equal "test.local", @ga.domain
+      end
+      should "have a utmcs equal to the language encoding used for the browser." do
+        assert_equal "UTF-8", @ga.utmcs
+      end
+      should "have a utmdt equal to the Page Title of the page" do
+        assert_equal "This is the page title", @ga.utmdt
+      end
+      should "have a utmje equal to 1" do
+        assert_equal "1", @ga.utmje
+      end
+      should "have a utmn equal to a random number that is generated to prevent caching" do
+        assert @ga.utmn != @ga.utmn
+      end
+      should "have a utmsr equal to the screen resolution" do
+        assert_equal "0x0", @ga.utmsr
+      end
+      should "have a utmsc equal to the screen color depth" do
+        assert_equal "0-bit", @ga.utmsc
+      end
+      should "have a utmul equal to the browser language" do
+        assert_equal "en-us", @ga.utmul
+      end
+      should "have a utmwv equal to the tracking code version" do
+        assert_equal "4.4sj", @ga.utmwv
+      end
+      should "have a utmr equal to the referring page" do
+        assert_equal "-", @ga.utmr
+      end
+      should "have a utmcr set to 1" do
+        assert_equal "1", @ga.utmcr
+      end
+    end
+  end
+  context "Rails Analytics" do
+    setup do
+      @ga2 = AnalyticsGoo::GoogleAnalyticsAdapter.new(:analytics_id => "MO-11685745-3",:domain => "shor.tswit.ch", :remote_address => "75.103.6.17")
+      # @ga2.expects(:utmcc_cookie).times(2).returns(10000001)
+      # @ga2.expects(:utmcc_random).returns(1147483647)
+      # @now = Time.now.to_i
+      # @ga2.expects(:utmcc_time).times(4).returns(@now)
+    end
+    should "return a well formed utmcc cookie that is stubbed to the value provided in google analytic mobile tracker docs" do
+      assert_equal "__utma%3D999.999.999.999.999.1%3B", @ga2.utmcc
+    end
+  end
+  # TODO: mock this test. Currently it actually does do a request. Was using this to verify that it actually was working.
+  context "An analytics tracking event" do
+    setup do
+      @ga3 = AnalyticsGoo::GoogleAnalyticsAdapter.new(:analytics_id => "MO-11685745-3",
+                                                      :domain => "shor.tswit.ch",
+                                                      :remote_address => "75.103.6.17",
+                                                      :user_agent => "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2) Gecko/20100115 Firefox/3.6",
+                                                      :http_accept_language => "en-us,en;q=0.5")
+    end
+    context "makes a request for an image on the google analytics server" do
+      setup do
+        @resp = @ga3.track_page_view("/testFoo/myPage.html")
+      end
+      should "be a valid response" do
+        assert @resp.is_a?(Net::HTTPOK)
+      end
+    end
+  end
+  context "An analytics tracking event using the adapter class" do
+    setup do
+      @test_ad = AnalyticsGoo::GoogleAnalyticsAdapter.new(:analytics_id => "MO-11685745-3",
+                                                          :domain => "shor.tswit.ch",
+                                                          :remote_address => "127.0.0.1",
+                                                          :user_agent => "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2) Gecko/20100115 Firefox/3.6",
+                                                          :http_accept_language => "en-us,en;q=0.5")
+      @ga4 = AnalyticsGoo::AnalyticsAdapter.new(@test_ad)
+    end
+    context "makes a request for an image on the google analytics server" do
+      setup do
+        path = "/__utm.gif?utmwv=4.4sj&utmn=1277734430&utmhn=shor.tswit.ch&utmr=-&utmp=%2Fadmin%2F1&utmac=MO-11685745-3&utmcc=__utma%3D999.999.999.999.999.1%3B&utmvid=0x5719fb3b1e05e909&utmip=127.0.0.0"
+        header_hash =  {'User-Agent' => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2) Gecko/20100115 Firefox/3.6', 'Accept-Language' => 'en-us,en;q=0.5'}
+        @test_ad.expects(:utmn).returns("1277734430")
+        @test_ad.expects(:utmvid).returns("0x5719fb3b1e05e909")
+        # mock the underlying HTTP object
+        ht = Net::HTTP.new("127.0.0.1")
+        ht.expects(:request_get).with(path, header_hash)
+
+        Net::HTTP.expects(:start).with(AnalyticsGoo::GoogleAnalyticsAdapter::GA_DOMAIN).yields(ht).returns(Net::HTTPOK.new("1.2","OK",nil))
+        @resp = @ga4.track_page_view("/admin/1")
+      end
+      should "be a valid response" do
+        assert @resp.is_a?(Net::HTTPOK)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require 'active_support/test_case'
+gem 'thoughtbot-shoulda', ">= 2.10.1"
+require 'shoulda'
+require 'mocha'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: analytics_goo
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Rob Christie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-08 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: robchristie@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- CHANGELOG
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- TODO
+- VERSION
+- analytics_goo.gemspec
+- autotest/CHANGELOG
+- autotest/LICENSE
+- autotest/README.rdoc
+- autotest/discover.rb
+- autotest/railsplugin.rb
+- autotest/railsplugin_rspec.rb
+- init.rb
+- lib/analytics_goo.rb
+- lib/analytics_goo/google_analytics_adapter.rb
+- rails/init.rb
+- tasks/analytics_goo.rake
+- test/analytics_goo_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/eyestreet/analytics_goo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: analytics_goo provides a ruby wrapper for performing Google Analytics tracking server side using their Mobile API.
+test_files: 
+- test/analytics_goo_test.rb
+- test/test_helper.rb