markcatley-google_analytics 1.0.1

data/README

@@ -0,0 +1,27 @@
+GoogleAnalytics
+===============
+
+This is a quick 'n' dirty module to easily enable Google Analytics support
+in your application.  By default it'll output the analytics code for every
+single page automatically, if it's configured correctly.  This is done by
+adding:
+
+    Rubaidh::GoogleAnalytics.tracker_id = 'UA-12345-67'
+
+to your `config/environment.rb`, inserting your own tracker id. This can be
+discovered by looking at the value assigned to +_uacct+ in the Javascript
+code.
+
+If you want to disable the code insertion for particular pages, add the following to controllers that don't want it:
+
+    skip_after_filter :add_google_analytics_code
+
+If you are running rails 2.1 or above add install this by adding:
+    
+    config.gem 'markcatley-google_analytics', :lib => 'rubaidh/google_analytics', :source => 'http://gems.github.com'
+
+and run:
+
+    rake gems:install
+
+Simple. :-)

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the google_analytics plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the google_analytics plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GoogleAnalytics'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/rubaidh/google_analytics.rb

@@ -0,0 +1,70 @@
+module Rubaidh # :nodoc:
+  module GoogleAnalyticsMixin
+    def google_analytics_code(request = nil)
+      return unless GoogleAnalytics.enabled?
+      GoogleAnalytics.google_analytics_code(request)
+    end
+    
+    # An after_filter to automatically add the analytics code.
+    def add_google_analytics_code
+      code = google_analytics_code(request)
+      return if code.blank?
+      response.body.gsub! '</body>', code + '</body>' if response.body.respond_to?(:gsub!)
+    end
+  end
+
+  class GoogleAnalytics
+    # Specify the Google Analytics ID for this web site.  This can be found
+    # as the value of +_uacct+ in the Javascript excerpt
+    @@tracker_id = nil
+    cattr_accessor :tracker_id
+
+    # Specify a different domain name from the default.  You'll want to use
+    # this if you have several subdomains that you want to combine into
+    # one report.  See the Google Analytics documentation for more
+    # information.
+    @@domain_name = nil
+    cattr_accessor :domain_name
+    
+    # I can't see why you'd want to do this, but you can always change the
+    # analytics URL.
+    @@analytics_url = 'http://www.google-analytics.com/urchin.js'
+    cattr_accessor :analytics_url
+
+    # I can't see why you'd want to do this, but you can always change the
+    # analytics URL (ssl version).
+    @@analytics_ssl_url = 'https://ssl.google-analytics.com/urchin.js'
+    cattr_accessor :analytics_ssl_url
+
+    # The environments in which to enable the Google Analytics code.  Defaults
+    # to 'production' only.
+    @@environments = ['production']
+    cattr_accessor :environments
+
+    # Return true if the Google Analytics system is enabled and configured
+    # correctly.
+    def self.enabled?
+      (environments.include?(RAILS_ENV) and
+        not tracker_id.blank? and
+        not analytics_url.blank?)
+    end
+    
+    def self.google_analytics_code(request = nil)
+      extra_code = domain_name.blank? ? nil : "_udn = \"#{domain_name}\";"
+      url = (not request.blank? and request.ssl?) ? analytics_ssl_url : analytics_url
+
+      # OK, I'm not very bright -- I tried to turn this into a partial and
+      # failed miserably!  So it'll have to live here for now.
+      code = <<-HTML
+      <script src="#{url}" type="text/javascript">
+      </script>
+      <script type="text/javascript">
+      _uacct = "#{tracker_id}";
+      #{extra_code}
+      urchinTracker();
+      </script>
+      HTML
+      code
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+require 'rubaidh/google_analytics'
+ActionController::Base.send :include, Rubaidh::GoogleAnalyticsMixin
+ActionController::Base.send :after_filter, :add_google_analytics_code

data/test/google_analytics_test.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class GoogleAnalyticsTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: markcatley-google_analytics
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Graeme Mathieson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-08 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "By default this gem will output google analytics code forevery page automatically, if it's configured correctly.This is done by adding: Rubaidh::GoogleAnalytics.tracker_id = 'UA-12345-67'"
+email: mathie@rubaidh.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- Rakefile
+- rails/init.rb
+- test/google_analytics_test.rb
+- lib/rubaidh/google_analytics.rb
+has_rdoc: false
+homepage: http://github.com/rubaidh/google_analytics/tree/master
+post_install_message: 
+rdoc_options: []
+
+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.2.0
+signing_key: 
+specification_version: 2
+summary: "[Rails] This is a quick 'n' dirty module to easily enableGoogle Analytics support in your application."
+test_files: []
+