bacchanalytics 0.1.9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,11 @@
+rvm:
+  - 1.8.7-p352
+  - 1.9.2-p290
+script: "bundle exec rake"
+gemfile:
+  - gemfiles/2.3.gemfile
+  - gemfiles/3.0.gemfile
+  - gemfiles/3.1.gemfile
+branches:
+  only:
+    - master

data/Appraisals

@@ -0,0 +1,14 @@
+appraise "2.3" do
+  gem "activesupport", "~> 2.3"
+  gem "rack", "~> 1.1.0"
+end
+
+appraise "3.0" do
+  gem "activesupport", "~> 3.0"
+  gem "rack", "~> 1.2.1"
+end
+
+appraise "3.1" do
+  gem "activesupport", "~> 3.1"
+  gem "rack", "~> 1.3.2"
+end

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+0.1.9
+-----
+
+* Build the gem
+* Scope middlewares in Bacchanalytics scope
+
+0.1.8
+-----
+
+* Not load google analytics source multiple times (one for each middleware)
+* Added option to skip google analytics source code
+
+0.1.7
+-----
+
+* Fixed bug with multiple middlewares (like newrelic 3.2.0) and different response styles (Array or String)
+
+0.1.6
+-----
+
+* Added support for multiple tests with the same goal
+
+0.1.5
+-----
+
+* Added support for rails 3
+
+
+0.1.3
+-----
+
+* Added "ignored organic" features
+
+
+(Unreleased)
+------------
+
+* FIX Bacchanalytics should be able to set the domain name
+
+0.1.2
+-----
+
+* Added WebSite Optimizer tracking features
+
+0.1.1
+----
+
+* Basic testing added (rack/test and nokogiri are used for testing).
+
+0.1.0
+----
+
+* Rack middleware that simply inserts the GATC.

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,94 @@
+# Bacchanalytics
+
+Bacchanalytics is a rack middleware that inserts the Asynchronous Google Analytics
+Tracking Code in your application.
+
+## <a name="installation">Installation</a>
+    gem install bacchanalytics
+
+## <a name="ci">Continuous Integration</a>
+[![Build Status](https://secure.travis-ci.org/aspgems/bacchanalytics.png)](http://travis-ci.org/aspgems/bacchanalytics)
+
+## Usage in a Rails Application
+
+Add the following line in your config/environment.rb:
+
+````ruby
+  config.middleware.use "Bacchanalytics::Analytics", :web_property_id => "UA-XXXXX-X"
+````
+
+You have to replace "UA-XXXXX-X" with the Google Analytics property ID of your site.
+You can find more information on the Google Analytics property ID in
+http://code.google.com/apis/analytics/docs/concepts/gaConceptsAccounts.html#accountID
+
+You are able to set the domain name of your site.
+
+````ruby
+  config.middleware.use "Bacchanalytics::Analytics", :web_property_id => "UA-XXXXX-X"
+                                                     :domain_name => ".facturagem.com"
+````
+
+
+You can also use "ignored organic" features in your pages with:
+
+````ruby
+config.middleware.use "Bacchanalytics::Analytics", :web_property_id => "UA-XXXXXXX-X",
+                                                   :ignored_organic => ["yoursite",
+                                                                        "yoursite.com",
+                                                                        "www.yoursite.com",
+                                                                        "http://www.yoursite.com",
+                                                                        "http://yoursite.com"]
+````
+
+
+
+## Google Website Optimizer
+
+In order to use A/B tests, just add the following lines to your config/environment.rb:
+
+````ruby
+config.middleware.use "Bacchanalytics::WebsiteOptimizer", :account_id => 'UA-XXXXXXXX-X',
+                                                          :ab => { 'NNNNNNNNNN' => {:a => ["/", "/public/index"],
+                                                                                    :b => "/home2",
+                                                                                    :goal => "/public/signup"}
+                                                          }
+````
+
+where 'UA-XXXXXXXX-X' is the ID of the Website Optimizer account and 'NNNNNNNNNN' is the track page id, a key provided in the Website Optimizer javascript. The 'ab' hash contains the A (origin) pages, the B (variations) pages and the goal pages.
+
+The embeded javascript looks like:
+
+````javascript
+      <!-- Google Website Optimizer Tracking Script -->
+      <script type="text/javascript">
+        var _gaq = _gaq || [];
+        _gaq.push(['gwo._setAccount', 'UA-XXXXXXXX-X']);
+        _gaq.push(['gwo._trackPageview', '/3203696384/test']);
+        (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';
+          var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+        })();
+      </script>
+      <!-- End of Google Website Optimizer Tracking Script -->
+````
+
+As you can see, the 'NNNNNNNNNN' is the '3203696384' track page ID.
+
+
+## Google Adwords Conversions
+
+````ruby
+config.middleware.use "Bacchanalytics::AdwordsConversion", [
+                                                            {:id => 'NNNNNNNNNN',
+                                                             :label => 'oIiDCJe__QEQqcrF-gM',
+                                                             :language => 'es',
+                                                             :format => 3,
+                                                             :value => 3.5,
+                                                             :description => '',
+                                                             :pages=>[ "/welcome", "/en/welcome", "/es/welcome", "/ca/welcome", "/eu/welcome"]
+                                                            }
+                                                           ]
+````
+
+Copyright (c) 2011 ASPgems, released under the MIT license

data/Rakefile

@@ -0,0 +1,17 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'appraisal'
+
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the bacchanalytics gem'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/bacchanalytics.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/bacchanalytics/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Pérez", "Paco Guzman", "Javier Vidal", "ASPgems developers"]
+  gem.email         = ["dperez@aspgems.com", "fjguzman@aspgems.com", "javier.vidal@aspgems.com", "developers@aspgems.com"]
+  gem.description   = %q{Bacchanalytics is a rack middleware that inserts the Asynchronous Google Analytics
+  Tracking Code in your application.}
+  gem.summary       = %q{Bacchanalytics is a rack middleware that inserts the Asynchronous Google Analytics
+  Tracking Code in your application.}
+  gem.homepage      = "https://github.com/aspgems/bacchanalytics"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "bacchanalytics"
+  gem.require_paths = ["lib"]
+  gem.version       = Bacchanalytics::VERSION
+
+  gem.add_runtime_dependency "rack", ">= 1.1"
+  gem.add_runtime_dependency "activesupport", ">= 2"
+
+  gem.add_development_dependency "appraisal", "~> 0.3.8"
+  gem.add_development_dependency "rack-test", "~> 0.6"
+  gem.add_development_dependency "nokogiri", "~> 1.5"
+  gem.add_development_dependency "rake",    "~> 0.9"
+end

data/gemfiles/2.3.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rack", "~> 1.1.0"
+gem "activesupport", "~> 2.3"
+
+gemspec :path=>"../"

data/gemfiles/2.3.gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: /home/pacoguzman/dev/github_aspgems/bacchanalytics
+  specs:
+    bacchanalytics (0.1.9)
+      activesupport (>= 2)
+      rack (>= 1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (2.3.14)
+    appraisal (0.3.8)
+      bundler
+      rake
+    nokogiri (1.5.0)
+    rack (1.1.2)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 2.3)
+  appraisal (~> 0.3.8)
+  bacchanalytics!
+  nokogiri (~> 1.5)
+  rack (~> 1.1.0)
+  rack-test (~> 0.6)
+  rake (~> 0.9)

data/gemfiles/3.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rack", "~> 1.2.1"
+gem "activesupport", "~> 3.0"
+
+gemspec :path=>"../"

data/gemfiles/3.0.gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: /home/pacoguzman/dev/github_aspgems/bacchanalytics
+  specs:
+    bacchanalytics (0.1.9)
+      activesupport (>= 2)
+      rack (>= 1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    appraisal (0.3.8)
+      bundler
+      rake
+    multi_json (1.0.3)
+    nokogiri (1.5.0)
+    rack (1.2.4)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.0)
+  appraisal (~> 0.3.8)
+  bacchanalytics!
+  nokogiri (~> 1.5)
+  rack (~> 1.2.1)
+  rack-test (~> 0.6)
+  rake (~> 0.9)

data/gemfiles/3.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rack", "~> 1.3.2"
+gem "activesupport", "~> 3.1"
+
+gemspec :path=>"../"

data/gemfiles/3.1.gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: /home/pacoguzman/dev/github_aspgems/bacchanalytics
+  specs:
+    bacchanalytics (0.1.9)
+      activesupport (>= 2)
+      rack (>= 1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    appraisal (0.3.8)
+      bundler
+      rake
+    multi_json (1.0.3)
+    nokogiri (1.5.0)
+    rack (1.3.5)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.1)
+  appraisal (~> 0.3.8)
+  bacchanalytics!
+  nokogiri (~> 1.5)
+  rack (~> 1.3.2)
+  rack-test (~> 0.6)
+  rake (~> 0.9)

data/init.rb

@@ -0,0 +1 @@
+require "bacchanalytics"

data/install.rb

@@ -0,0 +1 @@
+require "bacchanalytics"

data/lib/bacchanalytics.rb

@@ -0,0 +1,5 @@
+require "bacchanalytics/version"
+require "bacchanalytics/google_analytics"
+require "bacchanalytics/analytics"
+require "bacchanalytics/adwords_conversion"
+require "bacchanalytics/website_optimizer"

data/lib/bacchanalytics/adwords_conversion.rb

@@ -0,0 +1,95 @@
+module Bacchanalytics
+
+  module AdwordsConversionTrackingCode
+
+    # Construct the Adwords conversion tracking code.
+    def adwords_tracking_code(page, conversions=[])
+      return if page.blank?
+
+      tracking_code = ""
+      conversions.each do |conversion|
+        begin
+          next unless valid_conversion?(conversion)
+
+          # Check the requested page, to include the A, B or goal tracking code.
+          if conversion[:pages].include?(page)
+            cid = conversion[:id]
+            label = conversion[:label]
+
+            description = conversion[:description] || 'adwords conversion'
+            language = conversion[:language] || 'en'
+            format = conversion[:format] || 3
+            value = conversion[:value] || 0
+
+            tracking_code = conversion_code(cid, label, language, format, value, description)
+            break
+          end
+        rescue
+          tracking_code = ""
+        end
+      end
+      tracking_code
+    end
+
+    private
+
+    def valid_conversion?(conversion)
+      !(conversion[:id].blank? || conversion[:label].blank? || conversion[:pages].empty?)
+    end
+
+    def conversion_code(cid, label, language, format, value, description)
+      <<-SCRIPT
+      <!-- Google Code for #{description} Conversion Page -->
+      <script type="text/javascript">
+        /* <![CDATA[ */
+        var google_conversion_id = #{cid};
+        var google_conversion_language = "#{language}";
+        var google_conversion_format = "#{format}";
+        var google_conversion_color = "ffffff";
+        var google_conversion_label = "#{label}";
+        var google_conversion_value = 0;
+        if (#{value}) {
+          google_conversion_value = #{value};
+        }
+      /* ]]> */
+      </script>
+      <script type="text/javascript" src="https://www.googleadservices.com/pagead/conversion.js">
+      </script>
+      <noscript>
+        <div style="display:inline;">
+        <img height="1" width="1" style="border-style:none;" alt="" src="https://www.googleadservices.com/pagead/conversion/#{cid}/?value=#{value}&amp;label=#{label}&amp;guid=ON&amp;script=0"/>
+        </div>
+      </noscript>
+      SCRIPT
+    end
+  end
+
+
+  class AdwordsConversion
+    include GoogleAnalytics::Base
+    include AdwordsConversionTrackingCode
+
+    def initialize(app, conversions = [])
+      @app = app
+      @conversions = conversions
+    end
+
+    def call(env)
+      status, headers, response = @app.call(env)
+
+      if should_instrument?(headers) && (source = response_source(response))
+        page = env['REQUEST_URI']
+        page.gsub!(/\?.*/, '') if page #remove url parameters
+
+        tracking_code = adwords_tracking_code(page, @conversions)
+        return [status, headers, response] if tracking_code.to_s == ""
+
+        new_body = source.sub /<\/[bB][oO][dY][yY]\s*>/, "#{tracking_code}\n</body>"
+        headers["Content-Length"] = new_body.length.to_s
+        Rack::Response.new(new_body, status, headers).finish
+      else
+        [status, headers, response]
+      end
+    end
+  end
+end