bigbro 0.9

data/README.md

@@ -0,0 +1,62 @@
+BigBro: A Google Analytics plugin for Rails
+===========================================
+
+Installation
+------------
+
+    gem install bigbro
+
+Usage
+-----
+
+After the plugin has been loaded, you'll have an `analytics` helper to use
+in your views. It generates an optimized version of the Google Analytics
+code, and a `<noscript>` tag containing the direct path to the `__utm.gif`
+image, to track JS-disabled browsers as well.
+
+The `analytics` helper tracks the current page load by default, you can
+disable this behaviour by passing the `:track => false` option.
+
+Configuration
+-------------
+
+You must set your analytics account via the `BigBro.set()` method
+in your `config/environment.rb`:
+
+    BigBro.set(:account => 'UA-12345-67')
+
+In production mode, the `.set()` method will raise an `ArgumentError` if
+no account is provided, unless the `:disabled` option is set to `true`.
+
+We use these switches to allow the developer to run the application in
+production mode on `localhost` while not sending requests to Analytics.
+
+We know that the ga.js is empty if the `Referer` is `localhost`, but
+there are situations in which the referer is reset, thus a complete disable
+is necessary.
+
+In development mode the plugin is always disabled - unless you set an
+account via the `set` method.
+
+Testing
+-------
+
+A simple `assert_analytics()` helper is included in to aid verifying
+that the layouts include the `analytics` helper. Its usage is super
+simple:
+
+    class FooControllerTest < ActionController::TestCase
+      context "An user" do
+        should "be tracked by analytics" do
+          get :index
+          assert_analytics
+        end
+      end
+    end
+
+
+Compatibility
+-------------
+
+Tested with Rails 2.3.8 with the `rails_xss` plugin installed,
+running under Ruby 1.9.1-p378.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rake'
+require 'rake/rdoctask'
+
+require 'lib/bigbro'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name             = 'bigbro'
+
+    gemspec.summary          = 'A Google Analytics plugin for Rails'
+    gemspec.description      = 'BigBro provides view helpers to generate Analytics code '      \
+                               '(with the noscript counterpart), test helpers to assert your ' \
+                               'page contains the tracking code and a configuration method to '\
+                               'set your GA account from environment.rb'
+
+    gemspec.authors          = ['Marcello Barnaba']
+    gemspec.email            = 'vjt@openssl.it'
+    gemspec.homepage         = 'http://github.com/vjt/bigbro'
+
+    gemspec.files            = %w( README.md Rakefile rails/init.rb ) + Dir['lib/**/*']
+    gemspec.extra_rdoc_files = %w( README.md )
+    gemspec.has_rdoc         = true
+
+    gemspec.version          = BigBro::Version
+    gemspec.date             = '2010-11-23'
+
+    gemspec.require_path     = 'lib'
+
+    gemspec.add_dependency('rails', '~> 3.0')
+  end
+rescue LoadError
+  puts 'Jeweler not available. Install it with: gem install jeweler'
+end
+
+desc 'Generate the rdoc'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files.add %w( README.md lib/**/*.rb )
+
+  rdoc.main  = 'README.md'
+  rdoc.title = 'BigBro: A Google Analytics plugin for Rails'
+end
+
+desc 'Will someone help write tests?'
+task :default do
+  puts
+  puts 'Can you help in writing tests? Please do :-)'
+  puts
+end

data/lib/bigbro.rb

@@ -0,0 +1,158 @@
+require 'bigbro/railtie' if defined? Rails
+
+module BigBro
+  Version = '0.9'
+
+  module Helpers
+    # Embeds the optimized Analytics code and the noscript tag with
+    # the direct path to the __utm.gif image into the current page.
+    #
+    # If the `:track` option is set to false, the current page load
+    # is *not* automatically tracked: you should track it later via
+    # the JS API.
+    #
+    def analytics(options = {})
+      return if BigBro.disabled?
+
+      track = options.has_key?(:track) ? options[:track] : true
+
+      ga_host = BigBro.host_for(request)
+      ga_cmds = [['_setAccount', BigBro.account]]
+      ga_cmds.push ['_setDomainName', BigBro.domain] if BigBro.domain
+      ga_cmds.concat(options[:commands]) if options[:commands]
+      ga_cmds.push ['_trackPageview']    if track
+
+      code = ''
+      code.concat javascript_tag(%(
+        var _gaq = #{ga_cmds.to_json};
+        $(document).ready (function () { // Because of Opera and FF <= 3.5
+          try {
+            (function(d, t, a) {
+              var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
+              g[a]=a;g.src='#{ga_host}/ga.js';s.parentNode.insertBefore(g,s);
+            }) (document, 'script', 'async');
+          } catch (err) {}
+        });
+      ))
+
+      code.concat(content_tag(:noscript,
+        image_tag(BigBro.noscript_image_path_for(request, ga_host),
+                  :border => '0', :alt => '').html_safe
+      ))
+
+      return code.html_safe
+    end
+  end
+
+  class << self
+    attr_accessor :account, :domain, :disabled
+
+    # Sets the Analytics account and *enforces* it to be set
+    # in production mode.
+    #
+    # If you're developing and want to run your local copy
+    # in production mode, you can either pass an invalid
+    # account (e.g. to check how the JS code is generated)
+    # or pass the :disabled option set to true.
+    #
+    # In test mode, the account is always set to the dummy
+    # "UA-420-THEBRAIN" string.
+    #
+    # Sets the 'UA-12345-67' account:
+    #
+    #   BigBro.set(:account => 'UA-12345-67')
+    #
+    # Sets the 'UA-12345-67' account and the 'foo.com' domain:
+    #
+    #   BigBro.set(:account => 'UA-12345-67', :domain => 'foo.com')
+    #
+    # Disables analytics code generation:
+    #
+    #   BigBro.set(:disabled => true)
+    #
+    def set(options = {})
+      self.account, self.disabled, self.domain =
+        options.values_at(:account, :disabled, :domain)
+
+      if Rails.env.production?
+        if self.account.blank? && !self.disabled
+          raise ArgumentError, 'BigBro: analytics configuration missing'
+        end
+      elsif Rails.env.test?
+        self.account = 'UA-420-THEBRAIN'
+      end
+    end
+
+    # In development mode the Analytics code is always disabled,
+    # or it can be disabled manually via the configuration.
+    #
+    # If no account is set, the code disables itself. Maybe the
+    # check in the set() method should be moved here, we'll see.
+    #
+    def disabled?
+      self.disabled || self.account.blank? || Rails.env.development?
+    end
+
+    # Returns the analytics host for the given request (SSL or not)
+    #
+    def host_for(request)
+      (request.ssl? ? 'https://ssl' : 'http://www') + '.google-analytics.com'
+    end
+
+    # Returns the noscript image path for the given request and GA Host
+    #
+    def noscript_image_path_for(request, ga_host)
+      cookie = rand(   89_999_999) +    10_000_000
+      req_no = rand(8_999_999_999) + 1_000_000_000
+      random = rand(1_147_483_647) + 1_000_000_000
+      now    = Time.now.to_i
+
+      referer = request.referer.blank? ? '-' : CGI.escape(request.referer)
+      path    = request.path.blank?    ? '/' : CGI.escape(request.path)
+
+      utmcc =
+        "__utma%3D#{cookie}.#{random}.#{now}.#{now}.#{now}.2%3B%2B" \
+        "__utmz%3D#{cookie}.#{now}.2.2."                            \
+          "utmccn%3D(direct)%7C"       \
+          "utmcsr%3D(direct)%7C"       \
+          "utmcmd%3D(none)%3B%2B"      \
+       "__utmv%3D#{cookie}.noscript%3B"
+
+      "#{ga_host}/__utm.gif?"    \
+        "utmn=#{req_no}&"        \
+        "utmac=#{account}&"      \
+        "utmhn=#{request.host}&" \
+        "utmr=#{referer}&"       \
+        "utmp=#{path}&"          \
+        "utmcc=#{utmcc}&"        \
+        'utmwv=1&'               \
+        'utmje=0&'               \
+        'utmsr=-&'               \
+        'utmsc=-&'               \
+        'utmul=-&'               \
+        'utmfl=-&'               \
+        'utmdt=-'
+    end
+  end
+
+  module TestHelpers
+    # Asserts the GA <script> tag, with not much effort;
+    # Asserts the noscript tag with the descendant img.
+    #
+    def assert_analytics
+      host = BigBro.host_for(@request)
+
+      assert_tag :tag => 'script', :content => /#{host}\/ga.js/
+
+      assert_tag :tag => 'noscript',
+        :descendant => {
+          :tag => 'img',
+          :attributes => {
+            :src => /#{host}\/__utm.gif\?/,
+            :border => '0',
+            :alt => ''
+          }
+        }
+    end
+  end
+end

data/lib/bigbro/railtie.rb

@@ -0,0 +1,22 @@
+require 'bigbro'
+
+module BigBro
+
+  if defined? Rails::Railtie
+    class Railtie < Rails::Railtie
+      initializer 'bigbro.insert_into_action_view' do
+        ActiveSupport.on_load :action_view do
+          BigBro::Railtie.insert
+        end
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      ActionView::Base.instance_eval { include BigBro::Helpers }
+      ActiveSupport::TestCase.instance_eval { include BigBro::TestHelpers } if Rails.env.test?
+    end
+  end
+
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'bigbro/railtie'
+BigBro::Railtie.insert

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: bigbro
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  version: "0.9"
+platform: ruby
+authors: 
+- Marcello Barnaba
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-23 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+description: BigBro provides view helpers to generate Analytics code (with the noscript counterpart), test helpers to assert your page contains the tracking code and a configuration method to set your GA account from environment.rb
+email: vjt@openssl.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- lib/bigbro.rb
+- lib/bigbro/railtie.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/vjt/bigbro
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Google Analytics plugin for Rails
+test_files: []
+