rack-google-analytics 0.6.1 → 0.9.0

data/{README.rdoc → README.md}

@@ -1,4 +1,4 @@
-= rack-google-analytics
+# rack-google-analytics
 
 Simple Rack middleware to help injecting the google analytics tracking code into the footer of your websites.
 
@@ -10,7 +10,7 @@ As of `0.2.0` there are no tests as I have not had chance to do this right.
 
 Version 0.2.0 implements the default code to be the asynchronous google code (see: http://bit.ly/async-analytics ).
 
-== Usage
+## Usage
 
   require 'rack-google-analytics'
   use Rack::GoogleAnalytics, :tracker => 'UA-xxxxxx-x'
@@ -22,30 +22,17 @@ Note: since 0.2.0 this will use the asynchronous google tracker code, for the tr
 
 If you are not sure what's best, go with the defaults, and read here if you should opt-out 
 
-== Environments
-
-There is a Rails-only (send a patch!) feature for only enabling this in certain environments, you can specify which by sending the `:env => 'some-env'` option when initializing the code. (Right now this conditionally requires the `Rails` constant.) The default is `production`.
-
-== Thread Safety
+## Thread Safety
 
 This middleware *should* be thread safe. Although my experience in such areas is limited, having taken the advice of those with more experience; I defer the call to a shallow copy of the environment, if this is of consequence to you please review the implementation.
 
-== Caveats
-
-I'm not aware of any, except that I remove the `Content-Length` header; this may interfere with your caching, e-tags and other mechanisms, if you are aware of any problems, please report them via Github issue's system.
-
-== Bugs & Feedback
-
-More than welcome, of course please see the notes below for contributor's tips, otherwise drop me a mail or open an issue.
-
-This was of course software to scratch my itch; but I'd love to build on it and learn from the experiences of others using it.
-
-== Change Log
+## Change Log
 
+* 22-07-2010 Major re-write from Arthur Chiu, now correctly writes the Content-Length leader, and comes with tests (High five to @achiu) - this patch also backs-out the changes from @cimm - but they were un-tested (I intend to bring these back as soon as possible; this will probably constitute a 1.0 release when it happens)
 * 19-01-2010 Second Release, patch from github.com/ralph - makes the default snippet the async version from google. Use regular synchronous code with: `:async => false`
 * 27-12-2009 First Release, extracted from the Capistrano-Website project and packaged with Jeweler.
 
-== Note on Patches/Pull Requests
+## Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -55,7 +42,7 @@ This was of course software to scratch my itch; but I'd love to build on it and
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Copyright
+## Copyright
 
 Copyright (c) 2009 Lee Hambley. See LICENSE for details.
-With thanks to Ralph von der Heyden http://github.com/ralph/ and Simon `cimm` Schoeters http://github.com/cimm/
+With thanks to Ralph von der Heyden http://github.com/ralph/ and Simon `cimm` Schoeters http://github.com/cimm/ - And the biggest hand to Arthur `achiu` Chiu for the huge work that went into the massive 0.9 re-factor.

data/Rakefile

@@ -1,24 +1,6 @@
 require 'rubygems'
 require 'rake'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "rack-google-analytics"
-    gem.summary = %Q{Rack middleware to insert google analytics tracking code into the footer of HTML documents as served}
-    gem.description = %Q{A simple Rack middleware compatible with Rails, Merb, Sinatra, etc. Easily installed inserts the google tracking code directly before the </body> of your Content-Type="*html" documents}
-    gem.email = "lee.hambley@gmail.com"
-    gem.homepage = "http://github.com/leehambley/rack-google-analytics"
-    gem.authors = ["Lee Hambley"]
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
-    gem.add_development_dependency "yard", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
@@ -39,8 +21,6 @@ rescue LoadError
   end
 end
 
-task :test => :check_dependencies
-
 task :default => :test
 
 begin

metadata

@@ -4,66 +4,33 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 1
-  version: 0.6.1
+  - 9
+  - 0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Lee Hambley
+- Arthur Chiu
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-07-06 00:00:00 +02:00
+date: 2010-07-22 00:00:00 +02:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: yard
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id002
+dependencies: []
+
 description: A simple Rack middleware compatible with Rails, Merb, Sinatra, etc. Easily installed inserts the google tracking code directly before the </body> of your Content-Type="*html" documents
-email: lee.hambley@gmail.com
+email: lee.hambley@gmail.com, Mr.Arthur.Chiu@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- ._README.rdoc
-- .document
-- .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
-- VERSION
-- lib/._rack-google-analytics.rb
-- lib/rack-google-analytics.rb
-- test/helper.rb
-- test/test_rack-google-analytics.rb
 has_rdoc: true
 homepage: http://github.com/leehambley/rack-google-analytics
 licenses: []
@@ -96,6 +63,5 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Rack middleware to insert google analytics tracking code into the footer of HTML documents as served
-test_files: 
-- test/helper.rb
-- test/test_rack-google-analytics.rb
+test_files: []
+

data/.document

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

data/.gitignore

@@ -1,25 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC
-._*
-*.gem
-pkg/*
-rack-google-analytics.gemspec

data/VERSION

@@ -1 +0,0 @@
-0.6.1

data/lib/rack-google-analytics.rb

@@ -1,68 +0,0 @@
-module Rack
-
-  class GoogleAnalytics
-
-    TRACKER_CODE = <<-EOTC
-    <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"));
-    </script>
-    <script type="text/javascript">
-    try{
-    var pageTracker = _gat._getTracker("UA-xxxxxx-x");
-    pageTracker._trackPageview();
-    } catch(err) {}</script>
-    EOTC
-
-    ASYNC_TRACKER_CODE = <<-EOTC
-    <script type="text/javascript">
-
-      var _gaq = _gaq || [];
-      _gaq.push(['_setAccount', 'UA-xxxxxx-x']);
-      _gaq.push(['_trackPageview']);
-
-      (function() {
-        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
-        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
-        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(ga);
-      })();
-
-    </script>
-    EOTC
-
-    def initialize(app, options = {})
-      raise ArgumentError, "Tracker must be set!" unless options[:tracker] and !options[:tracker].empty?
-      @app     = app
-      @tracker = options[:tracker]
-      @async   = options[:async]
-      @async   = true if options[:async].nil?
-      @env     = options[:env] || "production"
-    end
-
-    def call(env)
-      dup._call(env)
-    end
-
-    def _call(env)
-      @status, @headers, @response = @app.call(env)
-      return [@status, @headers, @response] unless @headers['Content-Type'] =~ /html/ && defined?(Rails) && Rails.env.casecmp(@env) == 0
-      @headers.delete('Content-Length')
-      response = Rack::Response.new([], @status, @headers)
-      @response.each do |fragment|
-        response.write(inject_tracker(fragment))
-      end
-      response.finish
-    end
-
-    def inject_tracker(response)
-      if @async
-        tracker_code = ASYNC_TRACKER_CODE.sub(/UA-xxxxxx-x/, @tracker)
-      else
-        tracker_code = TRACKER_CODE.sub(/UA-xxxxxx-x/, @tracker)
-      end
-      response.sub!(/<\/body>/, "\n#{tracker_code}\n</body>") rescue response
-    end
-
-  end
-
-end

data/test/helper.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rack-google-analytics'
-
-class Test::Unit::TestCase
-end

data/test/test_rack-google-analytics.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestRackGoogleAnalytics < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end