jonathannelson-woopra_analytics 1.1

data/README

@@ -0,0 +1,57 @@
+WoopraAnalytics
+===============
+
+This module will easily enable Woopra Analytics support for 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 the following to your `config/environment.rb`:
+
+    JonathanNelson::WoopraAnalytics.run
+
+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_woopra_analytics_code
+
+If you are running rails 2.1 or above add install this by adding:
+    
+    config.gem 'jonathannelson-woopra_analytics', :lib => 'jonathannelsoon/woopra_analytics', :source => 'http://gems.github.com'
+    
+and run:
+
+    rake gems:install
+
+That's it!
+
+USING LOCAL COPIES OF THE WOOPRA ANALYTICS JAVASCRIPT FILES
+
+Under certain circumstances you might find it valuable to serve a copy of the Analytics JavaScript directly from your server to your visitors, and not directly from Woopra. If your visitors are geographically very far from Woopra, or if they have low quality international bandwidth, the loading time for the Analytics JS might kill the user experience and force you to remove the valuable tracking code from your site.
+
+This plugin now supports local copies Woopra JavaScript files, updated via a rake task and served courtesy of the Rails AssetTagHelper methods. So even if you use asset hosts, the JS will be served from the correct source and under the correct protocol (HTTP/HTTPS).
+
+To enable cached copies and the following to your initialization code:
+
+    JonathanNelson::WoopraAnalytics.local_javascript = true
+
+Use the following rake task to update the local copy of the JavaScript file:
+
+    rake woopra_analytics:updates
+
+To keep the file updated you can add the following to your Capistrano configuration:
+
+    after "deploy:symlink", "deploy:woopra_analytics"
+
+    namespace :deploy do
+      desc "Update local Woopra Analytics files"
+      task :woopra_analytics, :role => :web do
+        run "cd #{current_path} && rake woopra_analytics:update RAILS_ENV=#{ENV['RAILS_ENV']}"
+      end
+    end
+
+The above Capistrano recipe will almost certainly need some adjustments based on how you run your deployments, but you should get the idea.
+
+OVERRIDE APPLICATION-WIDE VALUES
+
+If you're using one Rails application to serve pages across multiple domains, you may wish to override the domain and tracker ID values on a controller-by-controller or view-by-view basis. You can do this by setting the override_domain_name properties. These properties are automatically reset after each use, so the values you set for domain_name (usually in an initializer) will apply to all other requests.
+
+before_filter :local_analytics
+
+def local_analytics
+  JonathanNelson::WoopraAnalytics.override_domain_name  = 'foo.com'
+end

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 woopra_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 woopra_analytics plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'WoopraAnalytics'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/jonathannelson/woopra_analytics.rb

@@ -0,0 +1,137 @@
+module JonathanNelson # :nodoc:
+  module WoopraAnalyticsMixin
+    def woopra_analytics_code
+      WoopraAnalytics.woopra_analytics_code(request.ssl?) if WoopraAnalytics.enabled?(request.format)
+    end
+    
+    # An after_filter to automatically add the analytics code.
+    def add_woopra_analytics_code
+      if WoopraAnalytics.defer_load
+        response.body.sub! '</body>', "#{woopra_analytics_code}</body>" if response.body.respond_to?(:sub!)
+      else
+        response.body.sub! '<body>', "<body>#{woopra_analytics_code}" if response.body.respond_to?(:sub!)
+      end
+    end
+  end
+
+  class WoopraAnalyticsConfigurationError < StandardError; end
+
+  # The core functionality to connect a Rails application
+  # to a Woopra Analytics installation.
+  #
+  # * domain_name
+  #
+  # Specify a different domain name from the default. See the Woopra Analytics documentation for more
+  # information.
+  #
+  # * analytics_url
+  #
+  # I can't see why you'd want to do this, but you can always change the
+  # Woopra Analytics URL.
+  #
+  # * analytics_ssl_url
+  #
+  # I can't see why you'd want to do this, but you can always change the
+  # Woopra Analytics URL (ssl version).
+  #
+  # * environments
+  #
+  # The environments in which to enable the Woopra Analytics code. Defaults
+  # to 'production' only. Supply an array of environment names to change this.
+  #
+  # * formats
+  #
+  # The formats for which to add.  Defaults to +:html+ only. Supply an array
+  # of formats to change this.
+  #
+  # * defer_load
+  #
+  # Set this to true (the default) if you want to load the Analytics javascript at 
+  # the bottom of page. Set this to false if you want to load the Analytics 
+  # javascript at the top of the page. The page will render faster if you set this to
+  # true.
+  #
+  # * local_javascript
+  #
+  # Set this to true to use a local copy of the woopra.js (or /js/woopra.js) file.
+  # This gives you the added benefit of serving the JS directly from your
+  # server, which in case of a big geographical difference between your server
+  # and Woopra's can speed things up for your visitors. Use the 
+  # 'woopra_analytics:update' rake task to update the local JS copies.
+  #
+  # * override_domain_name
+  #
+  # Set this to override the initialized domain name for a single render. Useful
+  # when you're serving to multiple hosts from a single codebase. Typically you'd 
+  # set up a before filter in the appropriate controller:
+  #    before_filter :override_domain_name
+  #    def override_domain_name
+  #      JonathanNelson::WoopraAnalytics.override_domain_name  = 'foo.com'
+  #   end
+  #
+  #      ...
+  class WoopraAnalytics
+    @@domain_name = nil
+    cattr_accessor :domain_name
+    
+    @@analytics_url = 'http://static.woopra.com/js/woopra.js'
+    cattr_accessor :analytics_url
+
+    @@analytics_ssl_url = 'https://sec1.woopra.com/js/woopra.js'
+    cattr_accessor :analytics_ssl_url
+
+    @@environments = ['production']
+    cattr_accessor :environments
+    
+    @@formats = [:html]
+    cattr_accessor :formats
+
+    @@defer_load = true
+    cattr_accessor :defer_load
+    
+    @@local_javascript = false
+    cattr_accessor :local_javascript
+    
+    cattr_accessor :override_domain_name
+    
+    # Return true if the Woopra Analytics system is enabled and configured
+    # correctly for the specified format
+    def self.enabled?(format)
+      raise JonathanNelson::WoopraAnalyticsConfigurationError if analytics_url.blank?
+      environments.include?(RAILS_ENV) && formats.include?(format.to_sym)
+    end
+    
+    # Construct the javascript code to be inserted on the calling page.
+    def self.woopra_analytics_code(ssl = false)
+
+      extra_code = domain_name.blank? ? nil : "pageTracker._setDomainName(\"#{domain_name}\");"
+      if !override_domain_name.blank?
+        extra_code = "pageTracker._setDomainName(\"#{override_domain_name}\");"
+        self.override_domain_name = nil
+      end
+      
+      code = if local_javascript
+        <<-HTML
+        <script src="#{LocalAssetTagHelper.new.javascript_path( '/js/woopra.js' )}" type="text/javascript">
+        </script>
+        HTML
+      else
+        <<-HTML
+      <!-- Woopra Code Start -->  
+      <script type="text/javascript">
+      var _wh = ((document.location.protocol=="https:") ? "https://sec1.woopra.com" : "http://static.woopra.com");
+      document.write(unescape("%3Cscript src='" + _wh + "woopra.com/js/woopra.js' type='text/javascript'%3E%3C/script%3E"));
+      </script>
+      <!-- Woopra Code End -->
+        HTML
+      end
+
+    end
+
+  end
+
+  class LocalAssetTagHelper # :nodoc:
+    # For helping with local javascripts
+    include ActionView::Helpers::AssetTagHelper
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+require 'jonathannelson/woopra_analytics'
+ActionController::Base.send :include, JonathanNelson::WoopraAnalyticsMixin
+ActionController::Base.send :after_filter, :add_woopra_analytics_code

data/tasks/woopra_analytics.rake

@@ -0,0 +1,61 @@
+namespace :woopra_analytics do
+  
+  desc "Update local copy of Woopra Analytics JS"
+  task :update => :environment do
+    File.open( File.join( RAILS_ROOT, 'public', 'javascripts', file ), 'w+' ) do |f|
+      res = Net::HTTP.get_response( 'static.woopra.com', '/' + file )
+      f.write( res.plain_body )
+    end
+  end
+end
+
+# Intended to extend the Net::HTTP response object
+# and adds support for decoding gzip and deflate encoded pages
+#
+# Author: Jason Stirk <http://griffin.oobleyboo.com>
+# Home: http://griffin.oobleyboo.com/projects/http_encoding_helper
+# Created: 5 September 2007
+# Last Updated: 23 November 2007
+#
+# Usage:
+#
+# require 'net/http'
+# require 'http_encoding_helper'
+# headers={'Accept-Encoding' => 'gzip, deflate' }
+# http = Net::HTTP.new('griffin.oobleyboo.com', 80)
+# http.start do |h|
+#   request = Net::HTTP::Get.new('/', headers)
+#   response = http.request(request)
+#   content=response.plain_body     # Method from our library
+#   puts "Transferred: #{response.body.length} bytes"
+#   puts "Compression: #{response['content-encoding']}"
+#   puts "Extracted: #{response.plain_body.length} bytes"  
+# end
+#	
+
+require 'net/http'
+require 'zlib'
+require 'stringio'
+
+class Net::HTTPResponse
+  # Return the uncompressed content
+  def plain_body
+    encoding=self['content-encoding']
+    content=nil
+    if encoding then
+      case encoding
+        when 'gzip'
+          i=Zlib::GzipReader.new(StringIO.new(self.body))
+          content=i.read
+        when 'deflate'
+          i=Zlib::Inflate.new
+          content=i.inflate(self.body)
+        else
+          raise "Unknown encoding - #{encoding}"
+      end
+    else
+      content=self.body
+    end
+    return content
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+require 'test/unit'
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+#config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+db_adapter = ENV['DB']

data/test/view_helpers_test.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+include ActionView::Helpers::UrlHelper
+include ActionView::Helpers::TagHelper
+
+class ViewHelpersTest < Test::Unit::TestCase
+  
+  def setup
+    JonathanNelson::WoopraAnalytics.defer_load = false
+  end
+  
+end

data/test/woopra_analytics_test.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+
+class WoopraAnalyticsTest < Test::Unit::TestCase
+  def setup
+    @wa = JonathanNelson::WoopraAnalytics.new
+  end
+  
+  def test_createable
+    assert_not_nil(@wa)
+  end
+  
+  def test_domain_name_defaults_to_nil
+    assert_nil(@wa.domain_name)
+  end
+  
+  def test_default_environments
+    assert_equal(false, @wa.environments.include?('test'))
+    assert_equal(false, @wa.environments.include?('development'))
+    assert_equal(true, @wa.environments.include?('production'))
+  end
+  
+  def test_default_formats
+    assert_equal(false, @wa.formats.include?(:xml))
+    assert_equal(true, @wa.formats.include?(:html))
+  end
+
+  def test_defer_load_defaults_to_true
+    assert_equal(true, @wa.defer_load)
+  end
+  
+  def test_local_javascript_defaults_to_false
+    assert_equal(false, @wa.local_javascript)
+  end
+  
+  # test self.enabled
+  def test_enabled_requires_analytics_url
+    JonathanNelson::WoopraAnalytics.stubs(:analytics_url).returns(nil)
+    assert_raise(JonathanNelson::WoopraAnalyticsConfigurationError) { JonathanNelson::WoopraAnalytics.enabled?(:html) }
+  end
+  
+  def test_enabled_returns_false_if_current_environment_not_enabled
+    assert_equal(false, JonathanNelson::WoopraAnalytics.enabled?(:html))
+  end
+  
+  def test_enabled_with_default_format
+    JonathanNelson::WoopraAnalytics.stubs(:environments).returns(['test'])
+    assert_equal(true, JonathanNelson::WoopraAnalytics.enabled?(:html))
+  end
+  
+  def test_enabled_with_not_included_format
+    JonathanNelson::WoopraAnalytics.stubs(:environments).returns(['test'])
+    assert_equal(false, JonathanNelson::WoopraAnalytics.enabled?(:xml))
+  end
+  
+  def test_enabled_with_added_format
+    JonathanNelson::WoopraAnalytics.stubs(:environments).returns(['test'])
+    JonathanNelson::WoopraAnalytics.stubs(:formats).returns([:xml])
+    assert_equal(true, JonathanNelson::WoopraAnalytics.enabled?(:xml))
+  end
+  
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: jonathannelson-woopra_analytics
+version: !ruby/object:Gem::Version 
+  version: "1.1"
+platform: ruby
+authors: 
+- Jonathan Nelson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-01 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 Woopra code forevery page automatically, if it's configured correctly.This is done by adding: JonathanNelson::WoopraAnalytics.run"
+email: nelsojona@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- Rakefile
+- rails/init.rb
+- test/woopra_analytics_test.rb
+- test/test_helper.rb
+- test/view_helpers_test.rb
+- lib/jonathannelson/woopra_analytics.rb
+- tasks/woopra_analytics.rake
+has_rdoc: true
+homepage: http://github.com/jonathannelson/woopra_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: woopra_analytics
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: "[Rails] This is a quick 'n' dirty module to easily enableWoopra Analytics support in your application."
+test_files: []
+