RubyGems - bacchanalytics - Versions diffs - 0.1.9 - Mend

bacchanalytics 0.1.9

Files changed (29) hide show

data/.gitignore +17 -0
data/.travis.yml +11 -0
data/Appraisals +14 -0
data/CHANGELOG.md +53 -0
data/Gemfile +3 -0
data/MIT-LICENSE +20 -0
data/README.md +94 -0
data/Rakefile +17 -0
data/bacchanalytics.gemspec +27 -0
data/gemfiles/2.3.gemfile +8 -0
data/gemfiles/2.3.gemfile.lock +31 -0
data/gemfiles/3.0.gemfile +8 -0
data/gemfiles/3.0.gemfile.lock +33 -0
data/gemfiles/3.1.gemfile +8 -0
data/gemfiles/3.1.gemfile.lock +33 -0
data/init.rb +1 -0
data/install.rb +1 -0
data/lib/bacchanalytics.rb +5 -0
data/lib/bacchanalytics/adwords_conversion.rb +95 -0
data/lib/bacchanalytics/analytics.rb +62 -0
data/lib/bacchanalytics/google_analytics.rb +74 -0
data/lib/bacchanalytics/version.rb +3 -0
data/lib/bacchanalytics/website_optimizer.rb +204 -0
data/test/integration/bacchanalytics_integration_test.rb +64 -0
data/test/test_helper.rb +8 -0
data/test/unit/adwords_conversion_test.rb +96 -0
data/test/unit/bacchanalytics_test.rb +70 -0
data/test/unit/website_optimizer_test.rb +63 -0
metadata +190 -0

data/lib/bacchanalytics/analytics.rb ADDED

@@ -0,0 +1,62 @@
+module Bacchanalytics
+  class Analytics
+    include GoogleAnalytics::Base
+    include GoogleAnalytics::TrackingCode
+    def initialize(app, options = {})
+      @app = app
+      @web_property_id = options[:web_property_id] || "UA-XXXXX-X"
+      @domain_name = options[:domain_name]
+      @ignored_organic = options[:ignored_organic]
+      @skip_ga_src = options[:skip_ga_src] || false
+    end
+    def call(env)
+      status, headers, response = @app.call(env)
+      if should_instrument?(headers) && (source = response_source(response))
+        @skip_ga_src = true if env["bacchanlytics.loaded_ga_src"]
+        tracking_code = google_analytics_tracking_code(@web_property_id, @domain_name)
+        env["bacchanalytics.loaded_ga_src"] = true
+        new_body = source.sub /<[hH][eE][aA][dD]\s*>/, "<head>\n\n#{tracking_code}"
+        headers["Content-Length"] = new_body.length.to_s
+        Rack::Response.new(new_body, status, headers).finish
+      else
+        [status, headers, response]
+      end
+    end
+    def self.track_page_view_code(page)
+      "_gaq.push(['_trackPageview', '#{page}'])"
+    end
+    def self.track_page_view_script(page)
+      <<-SCRIPT
+      <script type="text/javascript">
+      #{track_page_view_code(page)};
+      </script>
+      SCRIPT
+    end
+    def self.track_event(category, action, opt_label = nil, opt_value = nil, options = {})
+      if opt_label.blank? || opt_value.blank?
+        track_event_code = "_gaq.push(['_trackEvent', '#{category}', '#{action}'])"
+      else
+        track_event_code = "_gaq.push(['_trackEvent', '#{category}', '#{action}', '#{opt_label}', '#{opt_value}'])"
+      end
+      timeout = options[:timeout] rescue nil
+      if timeout
+        "#{track_event_code};setTimeout('void(0)', #{timeout});"
+      else
+        track_event_code
+      end
+    end
+    private
+    def load_ga_src
+      @skip_ga_src ? "" : super
+    end
+  end
+end

data/lib/bacchanalytics/google_analytics.rb ADDED

@@ -0,0 +1,74 @@
+module Bacchanalytics
+  module GoogleAnalytics
+    module Base
+      # Return the javascript code used to load google analytics code
+      def load_ga_src
+        <<-SCRIPT
+    (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
+      # headers["Content-Type"] will be nil if the status of the response is 304 (Not Modified)
+      # From the HTTP Status Code Definitions:
+      # If the client has performed a conditional GET request and access is allowed,
+      # but the document has not been modified, the server SHOULD respond with this status code.
+      # http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
+      def should_instrument?(headers)
+        !headers["Content-Type"].nil? && (headers["Content-Type"].include? "text/html")
+      end
+      def response_source(response)
+        source = nil
+        response.each { |fragment| (source) ? (source << fragment) : (source = fragment) }
+        source
+      end
+    end
+    module TrackingCode
+      # Construct the new asynchronous version of the Google Analytics code.
+      # http://code.google.com/apis/analytics/docs/tracking/asyncTracking.html
+      def google_analytics_tracking_code(web_property_id, domain_name = nil)
+        <<-SCRIPT
+    <script type="text/javascript">
+    var _gaq = _gaq || [];
+    _gaq.push(['_setAccount', '#{web_property_id}']);
+    if ('#{domain_name}' !== ''){
+      _gaq.push(['_setDomainName', '#{domain_name}']);
+    }
+    #{ignored_organic_script}
+    _gaq.push(['_trackPageview']);
+    #{load_ga_src}
+    </script>
+        SCRIPT
+      end
+      def ignored_organic_script
+        script = ""
+        begin
+          if @ignored_organic.is_a?(Array)
+            @ignored_organic.each { |item|
+              script << <<-CODE
+        _gaq.push(['_addIgnoredOrganic', '#{item}']);
+              CODE
+            }
+          elsif @ignored_organic.is_a?(String)
+            script << <<-CODE
+        _gaq.push(['_addIgnoredOrganic', '#{@ignored_organic}']);
+            CODE
+          end
+        rescue
+        end
+        script
+      end
+    end
+  end
+end

data/lib/bacchanalytics/version.rb ADDED

@@ -0,0 +1,3 @@
+module Bacchanalytics
+  VERSION = "0.1.9"
+end

data/lib/bacchanalytics/website_optimizer.rb ADDED

@@ -0,0 +1,204 @@
+module Bacchanalytics
+  module WebsiteOptimizerTrackingCode
+    # Construct the Google WebSite Optimizer tracking code.
+    def website_optimizer_tracking_code(page, account_id, ab)
+      if page.blank? || account_id.blank? || !ab_options_valid?(ab)
+        return ""
+      end
+      gotc = ""
+      begin
+        goal_keys = [] # Multiple tests and the same goal
+        for key in ab.keys do
+          value = ab[key]
+          next unless value[:locales].nil? || [value[:locales]].flatten.map(&:to_s).include?(I18n.locale.to_s)
+          a = value[:a].to_a
+          b = value[:b].to_a
+          g = value[:goal].to_a
+          # Check the requested page, to include the A, B or goal tracking code.
+          if a.include?(page)
+            gotc = a_tracking_code(account_id, key)
+            break
+          elsif b.include?(page)
+            gotc = b_tracking_code(account_id, key)
+            break
+          elsif g.include?(page)
+            goal_keys << key
+          end
+        end
+        if gotc.blank?
+          gotc = goal_tracking_code(account_id, goal_keys)
+        end
+      rescue Exception => e
+        logger.debug "#{e.message}"
+        gotc = ""
+      end
+      gotc
+    end
+    private
+    # Returns the A (original page) website optimizer code. Look at the html comments before
+    # the javascript code: use them to pass W3C validations.
+    def a_tracking_code(account_id, track_page_id)
+      result = <<-SCRIPT
+        <!-- Google Website Optimizer Control Script -->
+        <script type="text/javascript">
+  <!--
+          function utmx_section(){}function utmx(){}
+          (function(){var k='#{track_page_id}',d=document,l=d.location,c=d.cookie;function f(n){
+          if(c){var i=c.indexOf(n+'=');if(i>-1){var j=c.indexOf(';',i);return escape(c.substring(i+n.
+          length+1,j<0?c.length:j))}}}var x=f('__utmx'),xx=f('__utmxx'),h=l.hash;
+          d.write('<sc'+'ript src="'+
+          'http'+(l.protocol=='https:'?'s://ssl':'://www')+'.google-analytics.com'
+          +'/siteopt.js?v=1&utmxkey='+k+'&utmx='+(x?x:'')+'&utmxx='+(xx?xx:'')+'&utmxtime='
+          +new Date().valueOf()+(h?'&utmxhash='+escape(h.substr(1)):'')+
+          '" type="text/javascript" charset="utf-8"></sc'+'ript>')})();
+  -->
+        </script>
+        <script type="text/javascript">utmx("url",'A/B');</script>
+        <!-- End of Google Website Optimizer Control Script -->
+        <!-- Google Website Optimizer Tracking Script -->
+        <script type="text/javascript">
+          var _gaq = _gaq || [];
+          _gaq.push(['gwo._setAccount', '#{account_id}']);
+          _gaq.push(['gwo._trackPageview', '/#{track_page_id}/test']);
+          #{load_ga_src}
+        </script>
+        <!-- End of Google Website Optimizer Tracking Script -->
+      SCRIPT
+      return result
+    end
+    # Returns the B (variation page) website optimizer code.
+    def b_tracking_code(account_id, track_page_id)
+      <<-SCRIPT
+        <!-- Google Website Optimizer Tracking Script -->
+        <script type="text/javascript">
+          var _gaq = _gaq || [];
+          _gaq.push(['gwo._setAccount', '#{account_id}']);
+          _gaq.push(['gwo._trackPageview', '/#{track_page_id}/test']);
+          #{load_ga_src}
+        </script>
+        <!-- End of Google Website Optimizer Tracking Script -->
+      SCRIPT
+    end
+    # Returns the goal (conversion page) website optimizer code.
+    def goal_tracking_code(account_id, track_page_ids = [])
+      track_page_ids = Array(track_page_ids)
+      <<-SCRIPT
+        <!-- Google Website Optimizer Tracking Script -->
+        <script type="text/javascript">
+          var _gaq = _gaq || [];
+          _gaq.push(['gwo._setAccount', '#{account_id}']);
+          #{track_page_ids.map { |id| "_gaq.push(['gwo._trackPageview', '/#{id}/goal']);" }.join("\n")}
+      #{load_ga_src}
+        </script>
+        <!-- End of Google Website Optimizer Tracking Script -->
+      SCRIPT
+    end
+    # Are the options of the tests valid?
+    def ab_options_valid?(ab_options = {})
+      return false if ab_options.empty?
+      unless ab_options_is_complete?(ab_options)
+        logger.info "**********************************************************************************************************"
+        logger.info "[Bachanalytics] You need to specify the :a, b: and :goal options for your WebSiteOptimizer tests, aborting"
+        logger.info "**********************************************************************************************************"
+        return false
+      end
+      unless uniq_goals?(ab_options)
+        logger.info "**************************************************************************************************"
+        logger.info "[Bachanalytics] You can't specify a :goal as part of the your WebSiteOptimizer tests, not applying"
+        logger.info "**************************************************************************************************"
+        return false
+      end
+      true
+    end
+    # Each A/B test need at least: :a, :b and :goal keys
+    def ab_options_is_complete?(ab_options = {})
+      result = true
+      ab_options.values.each do |value|
+        # Has :a, :b and :goal options
+        result = value.keys.size >= 3 && value.key?(:a) && value.key?(:b) && value.key?(:goal)
+        break if result == false
+      end
+      result
+    end
+    # One goal option must not be an a or b option
+    # A conversion (goal) option can't ba an a or b option (a original or test option)
+    def uniq_goals?(ab_options = {})
+      uniq_goals, test_pages = [], []
+      ab_options.values.each do |value|
+        uniq_goals << value[:goal]
+        test_pages << value[:a]
+        test_pages << value[:b]
+      end
+      uniq_goals.flatten!.uniq!
+      test_pages.flatten!.uniq!
+      (uniq_goals & test_pages).size == 0
+    end
+  end
+  class WebsiteOptimizer
+    include GoogleAnalytics::Base
+    include WebsiteOptimizerTrackingCode
+    def initialize(app, options = {})
+      @app = app
+      @account_id = options[:account_id] || "UA-XXXXX-X"
+      @ab = options[:ab] || {}
+      @skip_ga_src = options[:skip_ga_src] || false
+    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
+        @skip_ga_src = true if env["bacchanalytics.loaded_ga_src"]
+        tracking_code = website_optimizer_tracking_code(page, @account_id, @ab)
+        return [status, headers, response] if tracking_code.to_s == ""
+        env["bacchanalytics.loaded_ga_src"] = true
+        new_body = source.sub /<[hH][eE][aA][dD]\s*>/, "<head>\n\n#{tracking_code}"
+        headers["Content-Length"] = new_body.length.to_s
+        Rack::Response.new(new_body, status, headers).finish
+      else
+        [status, headers, response]
+      end
+    end
+    private
+    def logger
+      defined?(Rails.logger) ? Rails.logger : Logger.new($stderr)
+    end
+    def load_ga_src
+      @skip_ga_src ? "" : super
+    end
+  end
+end

data/test/integration/bacchanalytics_integration_test.rb ADDED

@@ -0,0 +1,64 @@
+require 'test_helper'
+require 'bacchanalytics'
+ENV['RACK_ENV'] = 'test'
+class BacchanalyticsIntegrationTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+  include Bacchanalytics::GoogleAnalytics::Base
+  def app
+    response = Rack::Response.new(HTML_DOCUMENT)
+    mock_app = lambda do |env|
+      [200, {'Content-Type' => 'text/html'}, response]
+    end
+    Rack::Builder.new do
+      use Bacchanalytics::WebsiteOptimizer, {:account_id => 'UA-20891683-1',
+                                             :ab => {'1924712694' => {:a => ["/"],
+                                                                      :b => ["/home"],
+                                                                      :goal => ["/welcome"]}}
+      }
+      use Bacchanalytics::Analytics, :web_property_id => "UA-12345-6"
+      run mock_app
+    end
+  end
+  def test_must_include_google_analytics_src_only_once
+    get "/", {}, {"REQUEST_URI" => "/"}
+    times = 0
+    last_response.body.gsub(load_ga_src){|m| times += 1}
+    assert_equal 1, times
+  end
+  HTML_DOCUMENT = <<-HTML
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>Listing things</title>
+</head>
+<body>
+<h1>Listing things</h1>
+<table>
+  <tr>
+    <th>Name</th>
+  </tr>
+  <tr>
+    <td>Thing 1</td>
+  </tr>
+  <tr>
+    <td>Thing 2</td>
+  </tr>
+</table>
+</body>
+</html>
+  HTML
+end

data/test/test_helper.rb ADDED

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'test/unit'
+require 'rack/test'
+require 'nokogiri'

data/test/unit/adwords_conversion_test.rb ADDED

@@ -0,0 +1,96 @@
+require 'test_helper'
+require 'bacchanalytics'
+ENV['RACK_ENV'] = 'test'
+class AdwordsConversionTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+  WEB_PROPERTY_ID = "UA-12345-6"
+  def app
+    response = Rack::Response.new(HTML_DOCUMENT)
+    mock_app = lambda do |env|
+      [200, {'Content-Type' => 'text/html'}, response]
+    end
+    @options ||= [
+        {:id => '1062298921', :label=>'oIiDCJe__QEQqcrF-gM', :language=>'es', :format=>3, :value=>3.5, :description=>'',
+         :pages=>["/welcome", "/en/welcome", "/es/welcome", "/ca/welcome", "/eu/welcome"]
+        }
+    ]
+    Bacchanalytics::AdwordsConversion.new(mock_app, @options)
+  end
+  def test_must_not_include_any_code_if_no_page
+    get "/", {}, {'REQUEST_URI' => nil}
+    assert_equal last_response.body, HTML_DOCUMENT
+  end
+  def test_must_not_include_any_code_if_the_page_is_not_a_goal
+    get "/", {}, {'REQUEST_URI' => nil}
+    assert_equal last_response.body, HTML_DOCUMENT
+  end
+  def test_must_include_conversion_code_if_the_page_is_a_goal
+    get "/welcome", {}, {'REQUEST_URI' => "/welcome"}
+    assert last_response.body.include?("Google Code for  Conversion Page "), last_response.body
+  end
+  def test_must_include_conversion_values_in_the_code
+    get "/welcome", {}, {'REQUEST_URI' => "/welcome"}
+    conversion = @options.first
+    assert last_response.body.include?("google_conversion_id = #{conversion[:id]}"), last_response.body
+    assert last_response.body.include?("google_conversion_language = \"#{conversion[:language]}\""), last_response.body
+    assert last_response.body.include?("google_conversion_format = \"#{conversion[:format]}\""), last_response.body
+    assert last_response.body.include?("google_conversion_label = \"#{conversion[:label]}\""), last_response.body
+    assert last_response.body.include?("google_conversion_value = #{conversion[:value]}"), last_response.body
+  end
+  def text_must_not_include_any_code_if_not_a_valid_conversion
+    invalid_conversion = {}
+    @options = [invalid_conversion]
+    get "/", {}, {'REQUEST_URI' => "/request_uri"}
+    assert_equal last_response.body, HTML_DOCUMENT
+  end
+  def test_must_not_include_any_code_if_no_conversion
+    @options = []
+    get "/", {}, {'REQUEST_URI' => "/request_uri"}
+    assert_equal last_response.body, HTML_DOCUMENT
+  end
+  HTML_DOCUMENT = <<-HTML
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>Listing things</title>
+</head>
+<body>
+<h1>Listing things</h1>
+<table>
+  <tr>
+    <th>Name</th>
+  </tr>
+  <tr>
+    <td>Thing 1</td>
+  </tr>
+  <tr>
+    <td>Thing 2</td>
+  </tr>
+</table>
+</body>
+</html>
+  HTML
+end