rack-google-analytics 0.11.0 → 0.12.0

data/README.md

@@ -34,11 +34,20 @@ config.gem 'rack-google-analytics', :lib => 'rack/google-analytics'
 config.middleware.use Rack::GoogleAnalytics, :tracker => 'UA-xxxxxx-x'
 ```
 
+#### Rails 3.X
+
+```ruby
+## application.rb:
+config.middleware.use Rack::GoogleAnalytics, :tracker => 'UA-xxxxxx-x'
+```
+
 ### Options
 
 * `:async`      -  sets to use asynchronous tracker
 * `:multiple`   -  sets track for multiple subdomains. (must also set :domain)
 * `:top_level`  -  sets tracker for multiple top-level domains. (must also set :domain)
+* `:anonymize_ip` -  sets the tracker to remove the last octet from all IP addresses, see https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApi_gat?hl=de#_gat._anonymizeIp for details.
+* `:site_speed_sample_rate` - Defines a new sample set size for Site Speed data collection, see https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApiBasicConfiguration?hl=de#_gat.GA_Tracker_._setSiteSpeedSampleRate
 
 Note: since 0.2.0 this will use the asynchronous Google Analytics tracking code, for the traditional behaviour please use:
 
@@ -48,6 +57,35 @@ use Rack::GoogleAnalytics, :tracker => 'UA-xxxxxx-x', :async => false
 
 If you are not sure what's best, go with the defaults, and read here if you should opt-out.
 
+## Custom Variable Tracking
+
+In your application controller, you may track a custom variable. For example:
+
+```ruby
+set_ga_custom_var(1, "LoggedIn", value, GoogleAnalytics::CustomVar::SESSION_LEVEL)
+```
+
+See https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingCustomVariables for details.
+
+## Event Tracking
+
+In your application controller, you may track an event. For example:
+
+```ruby
+track_ga_event("Users", "Login", "Standard")
+```
+
+See https://developers.google.com/analytics/devguides/collection/gajs/eventTrackerGuide
+
+## Custom Push
+
+In your application controller, you may push arbritrary data. For example:
+
+```ruby
+ga_push("_addItem", "ID", "SKU")
+```
+
+
 ## 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.

data/lib/google-analytics/instance_methods.rb

@@ -0,0 +1,54 @@
+# This module holds all instance methods to be
+# included into ActionController::Base class
+# for enabling google analytics var tracking in a Rails app.
+#
+require "erb"
+
+module GoogleAnalytics
+  module InstanceMethods
+
+    private
+
+    def ga_custom_vars
+      self.env["google_analytics.custom_vars"] ||= []
+    end
+
+    def ga_events
+      self.env["google_analytics.event_tracking"] ||= []
+    end
+
+    protected
+
+    # Sets a custom variable on a page load
+    #
+    # e.g. writes
+    # _gaq.push(['_setCustomVar',
+    #      2,                   // This custom var is set to slot #2.  Required parameter.
+    #      'Shopping Attempts', // The name of the custom variable.  Required parameter.
+    #      'Yes',               // The value of the custom variable.  Required parameter.
+    #                           //  (you might set this value by default to No)
+    #      2                    // Sets the scope to session-level.  Optional parameter.
+    #   ]);
+    def set_ga_custom_var(slot, name, value, scope = nil)
+      var = GoogleAnalytics::CustomVar.new(slot, name, value, scope)
+
+      ga_custom_vars.push(var)
+    end
+
+    # Tracks an event or goal on a page load
+    #
+    # e.g. writes
+    # _gaq.push(['_trackEvent', 'Videos', 'Play', 'Gone With the Wind']);
+    #
+    def track_ga_event(category, action, label = nil, value = nil, noninteraction = nil)
+      var = GoogleAnalytics::Event.new(category, action, label, value, noninteraction)
+      ga_events.push(var)
+    end
+
+    def ga_push(*attributes)
+      var = GoogleAnalytics::Push.new(attributes)
+      ga_events.push(var)
+    end
+
+  end
+end

data/lib/rack-google-analytics.rb

@@ -1 +1,11 @@
+require "active_support/json"
+
 require 'rack/google-analytics'
+
+require "tracking/custom_var"
+require "tracking/event"
+require "tracking/push"
+
+require "google-analytics/instance_methods"
+
+ActionController::Base.send(:include, GoogleAnalytics::InstanceMethods) if defined?(ActionController::Base)

data/lib/rack/google-analytics.rb

@@ -5,6 +5,8 @@ module Rack
 
   class GoogleAnalytics
 
+    EVENT_TRACKING_KEY = "google_analytics.event_tracking"
+    
     DEFAULT = { :async => true }
 
     def initialize(app, options = {})
@@ -18,9 +20,24 @@ module Rack
       @status, @headers, @body = @app.call(env)
       return [@status, @headers, @body] unless html?
       response = Rack::Response.new([], @status, @headers)
+      @options[:tracker_vars] = env["google_analytics.custom_vars"] || []
+
+      if response.ok?
+        # Write out the events now
+        @options[:tracker_vars] += (env[EVENT_TRACKING_KEY]) unless env[EVENT_TRACKING_KEY].nil?
+
+        # Get any stored events from a redirection
+        session = env["rack.session"]
+        stored_events = session.delete(EVENT_TRACKING_KEY) if session
+        @options[:tracker_vars] += stored_events unless stored_events.nil?
+      elsif response.redirection?
+        # Store the events until next time
+        env["rack.session"][EVENT_TRACKING_KEY] = env[EVENT_TRACKING_KEY]
+      end
+
       @body.each { |fragment| response.write inject(fragment) }
       @body.close if @body.respond_to?(:close)
-
+      
       response.finish
     end
 
@@ -30,6 +47,7 @@ module Rack
 
     def inject(response)
       file = @options[:async] ? 'async' : 'sync'
+
       @template ||= ::ERB.new ::File.read ::File.expand_path("../templates/#{file}.erb",__FILE__)
       if @options[:async]
         response.gsub(%r{</head>}, @template.result(binding) + "</head>")

data/lib/rack/google-analytics/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class GoogleAnalytics
-    VERSION = '0.11.0'
+    VERSION = '0.12.0'
   end
 end

data/lib/rack/templates/async.erb

@@ -9,8 +9,21 @@
   _gaq.push(['_setDomainName', 'none']);
   _gaq.push(['_setAllowLinker', true]);
 <% end %>
+<% if @options[:anonymize_ip] %>
+  _gaq.push(['_gat._anonymizeIp']);
+<% end %>
+<% if @options[:site_speed_sample_rate] %>
+  _gaq.push(['_setSiteSpeedSampleRate', <%= @options[:site_speed_sample_rate].to_i %>]);
+<% end %>
+
+<% if @options[:tracker_vars]
+        @options[:tracker_vars].each do |var|
+%>
+    _gaq.push(<%= var.write() %>);
+<% end
+  end
+   %>
   _gaq.push(['_trackPageview']);
-  _gaq.push(['_trackPageLoadTime']);
 
   (function() {
     var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;

data/lib/rack/templates/sync.erb

@@ -5,5 +5,8 @@ document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.
 <script type="text/javascript">
 try{
 var pageTracker = _gat._getTracker(<%= @options[:tracker].inspect %>);
+<% if @options[:anonymize_ip] %>
+_gat._anonymizeIp();
+<% end %>
 pageTracker._trackPageview();
 } catch(err) {}</script>

data/lib/rack/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class GoogleAnalytics
-    VERSION = '0.11.0'
+    VERSION = '0.12.0'
   end
 end

data/lib/tracking/custom_var.rb

@@ -0,0 +1,14 @@
+module GoogleAnalytics
+
+  # A Struct that mirrors the structure of a custom var defined in Google Analytics
+  # see https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingCustomVariables
+  class CustomVar < Struct.new(:index, :name, :value, :opt_scope)
+    VISITOR_LEVEL = 1
+    SESSION_LEVEL = 2
+    PAGE_LEVEL = 3
+
+    def write
+      ['_setCustomVar', self.index, self.name, self.value,self.opt_scope].to_json
+    end
+  end
+end

data/lib/tracking/event.rb

@@ -0,0 +1,13 @@
+require "active_support/json"
+
+module GoogleAnalytics
+
+  # A Struct that mirrors the structure of a custom var defined in Google Analytics
+  # see https://developers.google.com/analytics/devguides/collection/gajs/eventTrackerGuide
+  class Event < Struct.new(:category, :action, :label, :value, :noninteraction)
+
+    def write
+      ['_trackEvent', self.category, self.action, self.label,self.value, self.noninteraction].to_json
+    end
+  end
+end

data/lib/tracking/push.rb

@@ -0,0 +1,14 @@
+require "active_support/json"
+
+module GoogleAnalytics
+  class Push
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def write
+      @attributes.to_json
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-google-analytics
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-17 00:00:00.000000000 Z
+date: 2013-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -27,6 +27,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -100,12 +132,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/google-analytics/instance_methods.rb
 - lib/rack/google-analytics/version.rb
 - lib/rack/google-analytics.rb
 - lib/rack/templates/async.erb
 - lib/rack/templates/sync.erb
 - lib/rack/version.rb
 - lib/rack-google-analytics.rb
+- lib/tracking/custom_var.rb
+- lib/tracking/event.rb
+- lib/tracking/push.rb
 - README.md
 - LICENSE
 homepage: https://github.com/leehambley/rack-google-analytics
@@ -120,15 +156,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4292920950575174798
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4292920950575174798
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Rack middleware to inject the Google Analytics tracking code into outgoing