RubyGems - rack-google_analytics - Versions diffs - 1.0.1 → 1.0.2 - Mend

rack-google_analytics 1.0.1 → 1.0.2

Files changed (11) hide show

data/README.rdoc +7 -2
data/lib/rack-google_analytics.rb +1 -0
data/lib/rack/google_analytics.rb +24 -9
data/test/rack/google_analytics_test.rb +42 -8
metadata +23 -20
data/.document +0 -5
data/.gitignore +0 -5
data/Rakefile +0 -57
data/VERSION +0 -1
data/rack-google_analytics.gemspec +0 -50
data/test/test_helper.rb +0 -7

data/README.rdoc CHANGED Viewed

@@ -13,7 +13,12 @@ Rack middleware to embed Google Analytics tracking code.
 == Configuring for a Rails App
-  config.gem "ambethia-rack-google_analytics", :lib => "rack/google_analytics", :source => "http://gems.github.com"
+In your `Gemfile`:
+  gem 'rack-google_analytics'
+In your `config/application.rb`
   config.middleware.use "Rack::GoogleAnalytics", :web_property_id => "UA-0000000-1"
 == TODO and Motivations
@@ -39,4 +44,4 @@ fixes for these deficiencies.
 == Copyright
-Copyright (c) 2009 Jason L Perry. See LICENSE for details.
+Copyright (c) 2011 Jason L Perry. See LICENSE for details.

data/lib/rack-google_analytics.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ require 'rack/google_analytics'

data/lib/rack/google_analytics.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 module Rack #:nodoc:
   class GoogleAnalytics < Struct.new :app, :options
-    def call env
+    def call(env)
       status, headers, response = app.call(env)
       if headers["Content-Type"] =~ /text\/html|application\/xhtml\+xml/
@@ -18,23 +18,38 @@ module Rack #:nodoc:
       [status, headers, response]
     end
-    private
+    protected
       # Returns JS to be embeded. This takes one argument, a Web Property ID
       # (aka UA number).
-      def tracking_code web_property_id
-        return <<-EOF
+      def tracking_code(web_property_id)
+        returning_value = <<-EOF
 <script type="text/javascript">
-var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
-document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+if (typeof gaJsHost == 'undefined') {
+  var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+  document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+}
 </script>
 <script type="text/javascript">
 try {
-var pageTracker = _gat._getTracker("#{web_property_id}");
-pageTracker._trackPageview();
+var #{options[:prefix]}pageTracker = _gat._getTracker("#{web_property_id}");
+EOF
+        if options[:multiple_top_level_domains]
+          returning_value << <<-EOF
+#{options[:prefix]}pageTracker._setDomainName("none");
+#{options[:prefix]}pageTracker._setAllowLinker(true);
+EOF
+        elsif options[:domain_name]
+                returning_value << <<-EOF
+      #{options[:prefix]}pageTracker._setDomainName("#{options[:domain_name]}");
+      EOF
+        end
+        returning_value << <<-EOF
+#{options[:prefix]}pageTracker._trackPageview();
 } catch(err) {}</script>
 EOF
+      returning_value
       end
   end
 end

data/test/rack/google_analytics_test.rb CHANGED Viewed

@@ -1,6 +1,8 @@
-require 'test_helper'
+require 'test/unit'
 require 'rack/mock'
+require 'rack/google_analytics'
 class Rack::GoogleAnalyticsTest < Test::Unit::TestCase
   def test_embed_tracking_code_at_the_end_of_html_body
@@ -19,11 +21,38 @@ class Rack::GoogleAnalyticsTest < Test::Unit::TestCase
     assert_nothing_raised { request(:body => ["<html></html>"]) }
   end
-  def test_shoud_buff_content_length_by_the_size_of_tracker_code
-    assert_equal HTML_DOC.length + 406, request.content_length
+  def test_should_buff_content_length_by_the_size_of_tracker_code
+    request do |app, req|
+      assert_equal HTML_DOC.length + app.send(:tracking_code, WEB_PROPERTY_ID).length, req.content_length
+    end
+  end
+  def test_should_include_pageTracker_definition
+    assert_match( /#{Regexp.escape('var pageTracker = _gat.')}/, request.body)
+  end
+  def test_should_append_prefix_to_pageTracker_definition
+    assert_match( /#{Regexp.escape('var conductor_pageTracker = _gat.')}/, request(:prefix => 'conductor_').body)
+  end
+  def test_should_allow_multiple_top_level_domains
+    assert_match( /#{Regexp.escape('pageTracker._setDomainName("none")')}/, request(:multiple_top_level_domains => true).body)
+    assert_match( /#{Regexp.escape('pageTracker._setAllowLinker(true)')}/, request(:multiple_top_level_domains => true).body)
+  end
+  def test_multiple_top_level_domains_should_supercede_domain_name
+    request(:multiple_top_level_domains => true, :domain_name => '.test.com') do |app, req|
+      assert_match( /#{Regexp.escape('pageTracker._setDomainName("none")')}/, req.body)
+      assert_no_match( /#{Regexp.escape('pageTracker._setDomainName(".test.com")')}/, req.body)
+    end
+  end
+  def test_should_allow_domain_name
+    assert_match( /#{Regexp.escape('pageTracker._setDomainName(".test.com")')}/, request(:domain_name => '.test.com').body)
   end
   private
+    WEB_PROPERTY_ID = "UA-0000000-1"
     TRACKER_EXPECT = /<script.*pageTracker.*<\/script>\s?<\/body>/m
@@ -47,15 +76,20 @@ class Rack::GoogleAnalyticsTest < Test::Unit::TestCase
     </poem>
     EOF
-    def request opts = {}
-      Rack::MockRequest.new(app(opts)).get("/")
+    def request(opts = {})
+      @application = app(opts)
+      @request = Rack::MockRequest.new(@application).get("/")
+      yield(@application, @request) if block_given?
+      @request
     end
-    def app opts = {}
+    def app(opts = {})
+      opts = opts.clone
       opts[:content_type] ||= "text/html"
       opts[:body]         ||= [HTML_DOC]
-      rack_app = lambda { |env| [200, { 'Content-Type' => opts[:content_type] }, opts[:body]] }
-      Rack::GoogleAnalytics.new(rack_app, :web_property_id => "UA-0000000-1")
+      rack_app = lambda { |env| [200, { 'Content-Type' => opts.delete(:content_type) }, opts.delete(:body)] }
+      opts[:web_property_id] ||= WEB_PROPERTY_ID
+      Rack::GoogleAnalytics.new(rack_app, opts)
     end
 end

metadata CHANGED Viewed

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: rack-google_analytics
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  prerelease:
+  version: 1.0.2
 platform: ruby
 authors:
 - Jason L Perry
@@ -9,11 +10,20 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-10-14 00:00:00 -04:00
-default_executable:
-dependencies: []
-description: Embeds GA tracking code in the bottom of HTML documents
+date: 2011-08-18 00:00:00 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Embeds Google Analytics tracking code in the bottom of HTML documents
 email: jasper@ambethia.com
 executables: []
@@ -23,44 +33,37 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files:
-- .document
-- .gitignore
-- LICENSE
 - README.rdoc
-- Rakefile
-- VERSION
+- lib/rack-google_analytics.rb
 - lib/rack/google_analytics.rb
-- rack-google_analytics.gemspec
+- LICENSE
 - test/rack/google_analytics_test.rb
-- test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/ambethia/rack-google_analytics
 licenses: []
 post_install_message:
-rdoc_options:
-- --charset=UTF-8
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: "0"
-  version:
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: "0"
-  version:
 requirements: []
 rubyforge_project:
-rubygems_version: 1.3.5
+rubygems_version: 1.8.5
 signing_key:
 specification_version: 3
 summary: Google Analytics for Rack applications
 test_files:
 - test/rack/google_analytics_test.rb
-- test/test_helper.rb

data/.document DELETED Viewed

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

data/.gitignore DELETED Viewed

@@ -1,5 +0,0 @@
-*.sw?
-.DS_Store
-coverage
-rdoc
-pkg

data/Rakefile DELETED Viewed

@@ -1,57 +0,0 @@
-require 'rubygems'
-require 'rake'
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "rack-google_analytics"
-    gem.summary = %Q{Google Analytics for Rack applications}
-    gem.description = %Q{Embeds GA tracking code in the bottom of HTML documents}
-    gem.email = "jasper@ambethia.com"
-    gem.homepage = "http://github.com/ambethia/rack-google_analytics"
-    gem.authors = ["Jason L Perry"]
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-    test.rcov_opts << "--exclude 'var/*,gems/*'"
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install relevance-rcov"
-  end
-end
-task :test => :check_dependencies
-task :default => :test
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "rack-google_analytics #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc .options << "--all"
-end

data/VERSION DELETED Viewed

	@@ -1 +0,0 @@
1	- 1.0.1

data/rack-google_analytics.gemspec DELETED Viewed

@@ -1,50 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
-# -*- encoding: utf-8 -*-
-Gem::Specification.new do |s|
-  s.name = %q{rack-google_analytics}
-  s.version = "1.0.1"
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jason L Perry"]
-  s.date = %q{2009-10-14}
-  s.description = %q{Embeds GA tracking code in the bottom of HTML documents}
-  s.email = %q{jasper@ambethia.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/rack/google_analytics.rb",
-     "rack-google_analytics.gemspec",
-     "test/rack/google_analytics_test.rb",
-     "test/test_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/ambethia/rack-google_analytics}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Google Analytics for Rack applications}
-  s.test_files = [
-    "test/rack/google_analytics_test.rb",
-     "test/test_helper.rb"
-  ]
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end

data/test/test_helper.rb DELETED Viewed

@@ -1,7 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rack/google_analytics'