rack-google-analytics 0.14.0 → 1.0.0.pre1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTVmMWNmY2UxNjEzMzhiOTEyMjY1NzA1NWY2MDg4MjdjZDhlNDM0Mg==
+    OTMwMGRkYjg3MzcwMTFmZGRiZmJlMjMyZTM4OTdjNGE5N2UzOGRhZQ==
   data.tar.gz: !binary |-
-    ZTlhZmVkNGJmNWMyZjc5ODMwNzkyN2JlODc3NDdhYzMwOGU4NDlmOQ==
+    ZGZmMjU0YTg5MjFiM2Q1MWRmZjkxZjYwYmVkNTg5ZmE5YmMzOTQ0Mg==
 SHA512:
   metadata.gz: !binary |-
-    NDdiNDFmMTg5NDYxZjY0YzU0OTczMDZiMGNlOWJhYjI0OGE3ZWY4ZjYzOTc2
-    NjIwYTdmODIzZjcyOWVhN2ViZDdjOGM2NmVkMzlkYjIzZjYxZDNhN2Q2ZjE4
-    ZTgyYzRkZDljODg5MGViNjdiMGJiYWE4ODcwNDg5ZDdlNTY4MmM=
+    NjEyMjI2YjMxYTdiMTZmNGQ3ODdlZTQ2YjU0OGFmMmNmNTEwZGM1MjZiY2Zj
+    YTYwM2E0MTg0MGRjYWVjMDU3OWM3NDFkYzRjMTc1NDEzMmE3NTBmNGJmZDBl
+    ZjVmMzFlMzBkNTRjM2ZkNzZhMjFkZGY2ZWVlZWM3YmRkNzZiM2U=
   data.tar.gz: !binary |-
-    NzllNjIxZTEyNmE3OTYyNjBiMmYyZDc0MjMwOTQzMzZjMmI4OGI2ZDdjMmFi
-    OGUyM2JjZjE4N2UxNjUzNzExNjZkOGQzNGQ3N2MwOWJlZTA1MjZlOGVhODQz
-    M2JhZmQ0ZTI4NDAzMmI2Mjg0Y2RiNTI5MTJmMzc5OWQ1NDkzNWM=
+    YmFhNjg0YTA1YTk5YjQ0MDFlZGZjZDQ4NmJlNTNjMDhhMDBhODljMmMwZjlm
+    MDhhM2M3YjU2ODJmMDI5ZTYzMDNkNjBmNGY0NzYwMzFkYmM3YWNjN2Q3OGEw
+    ZTMxZmVhZGY5NzBlMmY5ZDg5YWMxMzRhOGM0ZDk5YmQxMjdmMDI=

data/README.md

@@ -1,10 +1,10 @@
 # Rack google Analytics
 
-[![Build Status](https://travis-ci.org/kangguru/rack-google-analytics.png?branch=master)](https://travis-ci.org/kangguru/rack-google-analytics)
+[![Build Status](https://travis-ci.org/kangguru/rack-google-analytics.png?branch=analytics-js)](https://travis-ci.org/kangguru/rack-google-analytics)
 
 Simple Rack middleware to help injecting the Google Analytics tracking code in your website.
 
-This middleware injects either the synchronous or asynchronous Google Analytics tracking code into the correct place of any request only when the response's `Content-Type` header contains `html` (therefore `text/html` and similar).
+This middleware injects the Google Analytics tracking code into the correct place of any request only when the response's `Content-Type` header contains `html` (therefore `text/html` and similar).
 
 ## Usage
 
@@ -28,15 +28,7 @@ use Rack::GoogleAnalytics, :tracker => 'UA-xxxxxx-x'
 use Rack::GoogleAnalytics, :tracker => 'UA-xxxxxx-x'
 ```
 
-#### Rails 2.X
-
-```ruby
-## environment.rb:
-config.gem 'rack-google-analytics', :lib => 'rack/google-analytics'
-config.middleware.use Rack::GoogleAnalytics, :tracker => 'UA-xxxxxx-x'
-```
-
-#### Rails 3.X and 4.X
+#### Rails 3.X and Rails 4.X
 
 ```ruby
 ## application.rb:
@@ -45,42 +37,23 @@ 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)
-* `:domain`     -  sets the domain name for the GATC cookies. Defaults to `auto`. (must also set :multiple)
-* `: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.
+* `:domain`     -  sets the domain name for the GATC cookies. Defaults to `auto`. (must also set :multiple)
 * `: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
-* `:adjusted_bounce_rate_timeouts` - An array of times in seconds that the tracker will use to set
-timeouts for adjusted bounce rate tracking. See http://analytics.blogspot.ca/2012/07/tracking-adjusted-bounce-rate-in-google.html for details.
-
-Note: since 0.2.0 this will use the asynchronous Google Analytics tracking code, for the traditional behaviour please use:
-
-```ruby
-use Rack::GoogleAnalytics, :tracker => 'UA-xxxxxx-x', :async => false
-```
+* `:enhanced_link_attribution` - Enable enhanced link attribution, see https://support.google.com/analytics/answer/2558867?hl=en
+* `:adjusted_bounce_rate_timeouts` - An array of times in seconds that the tracker will use to set timeouts for adjusted bounce rate tracking. See http://analytics.blogspot.ca/2012/07/tracking-adjusted-bounce-rate-in-google.html for details.
 
 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")
+ga_track_event("Users", "Login", "Standard")
 ```
 
-See https://developers.google.com/analytics/devguides/collection/gajs/eventTrackerGuide
+See https://developers.google.com/analytics/devguides/collection/analyticsjs/events
 
 ## Custom Push
 
@@ -101,6 +74,12 @@ config.middleware.use Rack::GoogleAnalytics, :tracker => lambda { |env|
 }
 ```
 
+## Special use case:  Event tracking only
+
+If you already set up your Google Analytics `analytics.js` tracker object with pageview tracking in your templates/frontend (inside the `<head>`), the only thing you might want to use the `rack-google-analytics` middleware for is to track server-side events which you can't properly track in the forntend.  In that case simply use the middleware without specifying the `:tracker` option, then it will only render the event tracking code (`ga('send', hitType: 'event', ..)`) and nothing else.
+
+    config.middleware.use Rack::GoogleAnalytics
+
 
 ## Thread Safety
 

data/lib/google-analytics/instance_methods.rb

@@ -19,30 +19,13 @@ module GoogleAnalytics
 
     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']);
+    # ga.('send', 'event', '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)
+    def ga_track_event(category, action, label = nil, value = nil)
+      ga_events.push(GoogleAnalytics::Event.new(category, action, label, value))
     end
 
     def ga_push(*attributes)

data/lib/rack-google-analytics.rb

@@ -1,8 +1,8 @@
 require "active_support/json"
+require "active_support/ordered_hash"
 
 require 'rack/google-analytics'
 
-require "tracking/custom_var"
 require "tracking/event"
 require "tracking/push"
 

data/lib/rack/google-analytics.rb

@@ -6,11 +6,9 @@ module Rack
   class GoogleAnalytics
 
     EVENT_TRACKING_KEY = "google_analytics.event_tracking"
-
-    DEFAULT = { :async => true, :advertising => false, :inpage_pageid => false }
+    DEFAULT = { async: true, enhanced_link_attribution: false }
 
     def initialize(app, options = {})
-      raise ArgumentError, "Tracker must be set!" unless valid_tracker?(options[:tracker])
       @app, @options = app, DEFAULT.merge(options)
     end
 
@@ -34,7 +32,8 @@ module Rack
         # Store the events until next time
         env["rack.session"][EVENT_TRACKING_KEY] = env[EVENT_TRACKING_KEY]
       end
-      @tracker = tracker(env, @options[:tracker])
+
+      @options[:tracker] = expand_tracker(env, @options[:tracker])
 
       @body.each { |fragment| response.write inject(fragment) }
       @body.close if @body.respond_to?(:close)
@@ -44,29 +43,17 @@ module Rack
 
     private
 
-    # tracker should be non-nil, non-empty string or a lambda
-    def valid_tracker?(tracker)
-      return false unless tracker
-      return (tracker.respond_to?(:call) && tracker.lambda?) || !tracker.empty?
-    end
-
     def html?; @headers['Content-Type'] =~ /html/; end
 
     def inject(response)
-      file = @options[:async] ? 'async' : 'sync'
+      @tracker_options = { cookieDomain: @options[:domain] }.select{|k,v| v }.to_json
+      @template ||= ::ERB.new ::File.read ::File.expand_path("../templates/async.erb",__FILE__)
 
-      @template ||= ::ERB.new ::File.read ::File.expand_path("../templates/#{file}.erb",__FILE__)
-      if @options[:async]
-        response.gsub(%r{</head>}, @template.result(binding) + "</head>")
-      else
-        response.gsub(%r{</body>}, @template.result(binding) + "</body>")
-      end
+      response.gsub(%r{</head>}, @template.result(binding) + "</head>")
     end
 
-    # obtain tracking code dynamically if it's a lambda, use the string directly otherwise
-    def tracker(env, tracker)
-      return tracker unless tracker.respond_to?(:call)
-      return tracker.call(env)
+    def expand_tracker(env, tracker)
+      tracker.respond_to?(:call) ? tracker.call(env) : tracker
     end
 
   end

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

@@ -1,5 +1,5 @@
 module Rack
   class GoogleAnalytics
-    VERSION = '0.14.0'
+    VERSION = '1.0.0.pre1'
   end
 end

data/lib/rack/templates/async.erb

@@ -1,46 +1,38 @@
 <script type="text/javascript">
 
-  var _gaq = _gaq || [];
-<% if @options[:inpage_pageid] %>
-  var pluginUrl = '//www.google-analytics.com/plugins/ga/inpage_linkid.js';
-  _gaq.push(['_require', 'inpage_linkid', pluginUrl]);
+<% if @options[:tracker] %>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+  ga('create', '<%= @options[:tracker] %>', <%= @tracker_options %>);
+
+<% if @options[:enhanced_link_attribution] %>
+  ga('require', 'linkid', 'linkid.js');
 <% end %>
-  _gaq.push(['_setAccount', <%= @tracker.inspect %>]);
-<% if @options[:multiple] %>
-  _gaq.push(['_setDomainName', <%= @options[:domain].inspect %>]);
+
+<% if @options[:anonymize_ip] %>
+  ga('set', 'anonymizeIp', true);
 <% end %>
-<% if @options[:top_level] %>
-  _gaq.push(['_setDomainName', 'none']);
-  _gaq.push(['_setAllowLinker', true]);
+
+<% if @options[:adjusted_bounce_rate_timeouts] %>
+<% @options[:adjusted_bounce_rate_timeouts].each do |timeout| %>
+    setTimeout(ga('send', 'event', '<%= "#{timeout.to_s}_seconds" %>', 'read'),<%= timeout*1000 %>);
 <% 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() %>);
+    ga('send', <%= var.write() %>);
 <% end
   end
    %>
-<% if @options[:adjusted_bounce_rate_timeouts] %>
-<% @options[:adjusted_bounce_rate_timeouts].each do |timeout| %>
-    setTimeout("_gaq.push(['_trackEvent', <%= "#{timeout.to_s}_seconds" %>, 'read'])",<%= timeout*1000 %>);
+<% if @options[:tracker] %>
+   ga('send', 'pageview');
 <% end %>
-<% end %>
-  _gaq.push(['_trackPageview']);
-
-  (function() {
-    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
-<% if @options[:advertising] %>
-    ga.src = ('https:' == document.location.protocol ? 'https://' : 'http://') + 'stats.g.doubleclick.net/dc.js';
-<% else %>
-    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
-<% end %>
-    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
-  })();
+
 </script>

data/lib/tracking/event.rb

@@ -1,13 +1,15 @@
 require "active_support/json"
+require "active_support/ordered_hash"
 
 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)
+  class Event < Struct.new(:category, :action, :label, :value)
 
     def write
-      ['_trackEvent', self.category, self.action, self.label,self.value, self.noninteraction].to_json
+      { hitType: 'event', eventCategory: self.category, eventAction: self.action, eventLabel: self.label, eventValue: self.value }.select{|k,v| v }.to_json
     end
+
   end
 end

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: rack-google-analytics
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 1.0.0.pre1
 platform: ruby
 authors:
 - Lee Hambley
+- Lars Brillert
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -113,6 +114,7 @@ description: Simple Rack middleware for implementing google analytics tracking i
   configurable load options.
 email:
 - lee.hambley@gmail.com
+- lars@railslove.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -121,14 +123,12 @@ files:
 - lib/rack/google-analytics/version.rb
 - lib/rack/google-analytics.rb
 - lib/rack/templates/async.erb
-- lib/rack/templates/sync.erb
 - 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
+homepage: https://github.com/kangguru/rack-google-analytics
 licenses:
 - MIT
 metadata: {}
@@ -143,9 +143,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.1.5

data/lib/rack/templates/sync.erb

@@ -1,12 +0,0 @@
-<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(<%= @tracker.inspect %>);
-<% if @options[:anonymize_ip] %>
-_gat._anonymizeIp();
-<% end %>
-pageTracker._trackPageview();
-} catch(err) {}</script>

data/lib/tracking/custom_var.rb

@@ -1,14 +0,0 @@
-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