google-analytics-rails 0.0.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c2e23eb0911637dd83f62ec98c1c03256f43a5a
-  data.tar.gz: 497a0afcd20fe6656b448f861fe73550996ac6bb
+  metadata.gz: 70b6e1110fba9b2d091febdb2d912910f21ccc5d
+  data.tar.gz: 5035c20f6adb7e9b8b26e8910cc3bc11eb042b58
 SHA512:
-  metadata.gz: 66edf6112899995ec356fd7ae78549a95ab85f40874a2e189eaf9ba90401b3c31f2b2f56b0516395d1f548219cc01eb5de9933b927e41f934c282b20e8d14456
-  data.tar.gz: 74fe46cefabd308f2bd9f7252121537948b170a1f700dd7cceba51427616d509568d23b345fa597808976de816049db8e9bdd1fc67206514f1b5a063641ae6c7
+  metadata.gz: e335e89f26431aa80ca0f0343625c5fe9a7bab1ee118455fbf9bd5212d2a09b1ed40082735d91185c1384d8807f6cd9c432e411a11106f27009f8de3e21e5b61
+  data.tar.gz: 14afca1b8c06c2813c679f80083f8413934b7d3d51408d5960bbf2dd80bec15f3b4d45881bf15386f61e5d34f15a810c824bad7a18826d1720ec33f5dc693909

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 .yardoc
 doc
+.DS_Store

data/Gemfile

@@ -2,6 +2,7 @@ source "http://rubygems.org"
 
 gem 'rake'
 gem 'yard'
+gem 'i18n', '< 0.7.0'
 gem 'activesupport', "~> 3.0"
 
 group :development do

data/README.markdown

@@ -1,18 +1,43 @@
-Fast Google Analytics setup for Rails 3. This gem is mostly intended for small to medium websites with a simple analytics strategy.
+Fast Universal Google Analytics setup for Rails. This gem is mostly intended for small to medium websites with a simple analytics strategy.
 
 [![Build Status](https://travis-ci.org/bgarret/google-analytics-rails.png?branch=master)](https://travis-ci.org/bgarret/google-analytics-rails)
 
+_if you require older analytics, use `0.0.6`_
+
 Installation
 ============
 
 Add the following to your `Gemfile`:
 
-    gem 'google-analytics-rails'
+    gem 'google-analytics-rails', '1.0.0'
 
 Then run:
 
     bundle install
 
+Upgrade Notes
+============
+
+__Upgrading this gem from 0.0.6?__
+
+Use `analytics_init` to send submissions to Analytics if you are using multiple trackers. You can supply a name to tracker by passing `:name` option.
+
+**GoogleAnalytics::Events::SetAllowLinker** is no longer supported as an external variable being set. You can submit as normal in the `:add_events` array, but using the new `:setup` config is preferable so no extra array searching has to happen.
+
+**GoogleAnalytics::Events::SetCustomVar** is no longer supported by Universal Analytics. These have been changed to SetCustomDimension & SetCustomMetric. By default if you use SetCustomVar, it applies as a Dimension
+
+**GoogleAnalytics::Events::DeleteCustomVar** has been removed
+
+**Added Event Helpers**
+
+  - GoogleAnalytics::Events::ExperimentId
+  - GoogleAnalytics::Events::ExperimentVariation
+
+**TODO:** Add Double Click Snippet Support
+While the code is there, and it looks like it is simply changing the end path to the JS, this feature has not been tested.
+
+
+
 Documentation
 =============
 

data/lib/google-analytics-rails.rb

@@ -12,8 +12,8 @@ module GoogleAnalytics
   #
   # @private
   SCRIPT_SOURCES = {
-    :default     => "('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'",
-    :doubleclick => "('https:' == document.location.protocol ? 'https://' : 'http://') + 'stats.g.doubleclick.net/dc.js'",
+    :default     => "'//www.google-analytics.com/analytics.js'",
+    :doubleclick => "'//stats.g.doubleclick.net/dc.js'",
   }
 
   # Get the current tracker id (*UA-xxxxxx-x*).

data/lib/google-analytics/async_tracking_queue.rb

@@ -5,7 +5,7 @@ module GoogleAnalytics
     def initialize
       @events = []
     end
-    
+
     def <<(event)
       push(event)
     end
@@ -17,21 +17,20 @@ module GoogleAnalytics
     def to_s
 <<-JAVASCRIPT
 <script type="text/javascript">
-var _gaq = _gaq || [];
+(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',#{GoogleAnalytics.script_source},'ga');
 #{@events.map { |event| event.to_s }.join("\n")}
-(function() {
-var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
-ga.src = #{GoogleAnalytics.script_source};
-var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
-})();
 </script>
 JAVASCRIPT
     end
-    
+
     private
-    
+
     def renderer_for_event(event, tracker_id)
       case event
+      when SingleEvent then EventRenderer.new(event, tracker_id)
       when Event then EventRenderer.new(event, tracker_id)
       when EventCollection then EventCollectionRenderer.new(event, tracker_id)
       end

data/lib/google-analytics/events/event.rb

@@ -2,11 +2,26 @@
 
 module GoogleAnalytics
   class Event
-    attr_reader :name, :params
-    
-    def initialize(name, *params)
+    attr_reader :action, :name, :params
+
+    def initialize(action, name, *params)
+      @action = action
       @name = name
       @params = params
     end
+
+    def single_event?
+      false
+    end
+  end
+  class SingleEvent
+    attr_reader :action, :name, :params
+    def initialize(action, *params)
+      @action = action
+      @params = params
+    end
+    def single_event?
+      true
+    end
   end
 end

data/lib/google-analytics/events/event_collection.rb

@@ -15,7 +15,7 @@ module GoogleAnalytics
     end
     
     def <<(event)
-      raise InvalidEventError.new(event) unless event.is_a?(Event)
+      raise InvalidEventError.new(event) unless event.is_a?(Event) || event.is_a?(SingleEvent)
 
       @events << event
     end

data/lib/google-analytics/events/event_renderer.rb

@@ -10,13 +10,19 @@ module GoogleAnalytics
     end
 
     def to_s
-      "_gaq.push(#{array_to_json([@tracker_id ? "#{@tracker_id}.#{@event.name}" : @event.name, *@event.params])});"
+      if @event.class.name == 'GoogleAnalytics::Events::SetupAnalytics'
+        "ga('#{@event.action}',#{array_to_json([@event.name, *@event.params])});"
+      elsif @event.single_event?
+        "ga('#{@tracker_id ? [@tracker_id, @event.action].join('.') : @event.action}');"
+      else
+        "ga('#{@tracker_id ? [@tracker_id, @event.action].join('.') : @event.action}',#{array_to_json([@event.name, *@event.params])});"
+      end
     end
 
     private
 
     def array_to_json(array)
-      "[" << array.map {|string| string_to_json(string) } .join(',') << "]"
+      array.map {|string| string_to_json(string) } .join(',')
     end
 
     def string_to_json(string)

data/lib/google-analytics/events/events.rb

@@ -2,68 +2,143 @@
 
 module GoogleAnalytics
   module Events
-    class SetAccount < Event
+    class SetupAnalytics < Event
+
+      def initialize(account_id, opts={})
+        if ['auto','none'].include?(opts) || opts.empty?
+          super('create', account_id, opts.empty? ? 'auto' : opts)
+        elsif opts.is_a?(Hash)
+          super('create', account_id, attributes_hash(opts))
+        else
+          super('create', account_id, {:cookieDomain => opts})
+        end
+      end
+
+    private
+      def attributes_hash(opts={})
+        {
+          :cookieDomain => opts.delete(:cookieDomain) || 'auto',
+          :allowLinker => opts.delete(:allowLinker),
+          :cookieName => opts.delete(:cookieName),
+          :cookieExpires => opts.delete(:cookieExpires),
+          :sampleRate => opts.delete(:sampleRate),
+          :siteSpeedSampleRate => opts.delete(:siteSpeedSampleRate),
+          :name => opts.delete(:name)
+        }.reject{|k,v| !v }
+      end
+    end
+
+    class SetAccount
       def initialize(account_id)
-        super('_setAccount', account_id)
+        warn "[REMOVED] `SetAccount` is being removed. Universal Analytics does not support this any longer. Please see GoogleAnalytics::Events::SetupAnalytics"
       end
     end
 
-    class SetDomainName < Event
+    class SetDomainName
       def initialize(domain_name)
-        super('_setDomainName', domain_name)
+        warn "[REMOVED] `SetDomainName` is being removed. Universal Analytics does not support this any longer. Please see GoogleAnalytics::Events::SetupAnalytics"
       end
     end
 
-    class SetAllowLinker < Event
+    class SetAllowLinker
       def initialize(allow)
-        super('_setAllowLinker', allow)
+        warn "[REMOVED] `SetAllowLinker` is being removed. Universal Analytics does not support this any longer. Please see GoogleAnalytics::Events::SetupAnalytics"
       end
     end
 
     class Require < Event
-      def initialize(name, url)
-        super('_require', name, url)
+      def initialize(name, url=nil)
+        if url
+          super('require', name, url)
+        else
+          super('require', name)
+        end
       end
     end
 
-    class SetSiteSpeedSampleRate < Event
+    class SetSiteSpeedSampleRate
       # @param sample_rate [Integer] the percentage of page views that should be used
       #   for page speed metrics - defaults to 1 (aka 1%) if the event is missing.
-      # @see http://code.google.com/apis/analytics/docs/gaJS/gaJSApiBasicConfiguration.html#_gat.GA_Tracker_._setSiteSpeedSampleRate
+      attr_accessor :sample_rate
       def initialize(sample_rate)
-        super('_setSiteSpeedSampleRate', sample_rate)
+        @sample_rate = sample_rate
+        warn "[REMOVED] `SetSiteSpeedSampleRate` is being removed. Universal Analytics does not support this any longer. Please see GoogleAnalytics::Events::SetupAnalytics"
       end
     end
 
+    # http://misterphilip.com/universal-analytics/migration/basics
     class TrackPageview < Event
       # @param page [String] optional virtual pageview tracking
       # @see http://code.google.com/apis/analytics/docs/tracking/asyncMigrationExamples.html#VirtualPageviews
-      def initialize(page = nil)
-        page && page != '' ? super('_trackPageview', page) : super('_trackPageview')
+      def initialize(opts = {})
+        # Just use default pageview if no page was given
+        if opts.is_a?(Hash) && opts.fetch(:page, nil) == nil
+          super('send', 'pageview')
+        # Provide only the page string if a title was not given but a page was
+        elsif opts.is_a?(Hash) && opts.fetch(:page, false)
+          super('send', 'pageview', opts.fetch(:title, false) ? opts : opts[:page])
+        # Print out a JSON Value for the pageview
+        else
+          super('send', 'pageview', opts)
+        end
       end
     end
 
     class TrackEvent < Event
       def initialize(category, action, label = nil, value = nil)
         if label || value
-          super('_trackEvent', category.to_s, action.to_s, label ? label.to_s : nil, value ? value.to_i : nil)
+          super('send', 'event', category.to_s, action.to_s, label ? label.to_s : nil, value ? value.to_i : nil)
         else
-          super('_trackEvent', category.to_s, action.to_s)
+          super('send', 'event', category.to_s, action.to_s)
         end
       end
     end
 
+    class ExperimentId < Event
+      def initialize(id)
+        super('set', 'expId', id.to_s)
+      end
+    end
+
+    class ExperimentVariation < Event
+      def initialize(variation_id)
+        super('set', 'expVar', variation_id.to_i)
+      end
+    end
+
+    # Custom Vars no longer exist in Universal Analytics
+    # Transfer to dimensions & metrics
+    # ga('set', 'dimension1', 953);
+    # ga('set', 'metric5', 953);
+    #
+
+    # Deprecated: Please use `SetCustomDimension` or `SetCustomMetric` instead
+    #
     class SetCustomVar < Event
       def initialize(index, name, value, opt_scope)
         raise ArgumentError, "The index has to be between 1 and 5" unless (1..5).include?(index.to_i)
-        super('_setCustomVar', index.to_i, name.to_s, value.to_s, opt_scope.to_i)
+        warn "[DEPRECATION] `SetCustomVar` is deprecated.  Please use `SetCustomDimension` or `SetCustomMetric` instead"
+        super('set', "dimension#{index}", value.to_s)
+      end
+    end
+
+    class SetCustomDimension < Event
+      def initialize(index, value)
+        raise ArgumentError, "The index has to be between 1 and 5" unless (1..5).include?(index.to_i)
+        super('set', "dimension#{index}", value.to_s)
+      end
+    end
+    class SetCustomMetric < Event
+      def initialize(index, value)
+        raise ArgumentError, "The index has to be between 1 and 5" unless (1..5).include?(index.to_i)
+        super('set', "metric#{index}", value.to_s)
       end
     end
 
+    # Removed: There are no longer Custom Variables
     class DeleteCustomVar < Event
       def initialize(index)
-        raise ArgumentError, "The index has to be between 1 and 5" unless (1..5).include?(index.to_i)
-        super('_deleteCustomVar', index.to_i)
+        warn "[REMOVED] `DeleteCustomVar` is being removed. Universal Analytics does not support Custom Variables."
       end
     end
 
@@ -77,11 +152,11 @@ module GoogleAnalytics
     #
     # JavaScript equivalent:
     #
-    #     _gaq.push(['_gat._anonymizeIp']);
+    #     ga('set', 'anonymizeIp', true);
     #
     class AnonymizeIp < Event
       def initialize
-        super('_gat._anonymizeIp')
+        super('set', 'anonymizeIp', true)
       end
     end
 
@@ -89,20 +164,26 @@ module GoogleAnalytics
     module Ecommerce
       # JavaScript equivalent:
       #
-      #     _gaq.push(['_addTrans',
-      #       '1234',           // order ID - required
-      #       'Acme Clothing',  // affiliation or store name
-      #       '11.99',          // total - required
-      #       '1.29',           // tax
-      #       '5',              // shipping
-      #       'San Jose',       // city
-      #       'California',     // state or province
-      #       'USA'             // country
-      #     ]);
+      # ga('ecommerce:addTransaction', {
+      #   'id': '1234',
+      #   'affiliation': 'Acme Clothing',
+      #   'revenue': '11.99',
+      #   'shipping': '5',
+      #   'tax': '1.29',
+      #   'currency': 'EUR'  // local currency code.
+      # });
       #
       class AddTransaction < Event
-        def initialize(order_id, store_name, total, tax, shipping, city, state_or_province, country)
-          super('_addTrans', order_id.to_s, store_name.to_s, total.to_s, tax.to_s, shipping.to_s, city.to_s, state_or_province.to_s, country.to_s)
+        def initialize(order_id, store_name, total, tax, shipping, city=nil, state_or_province=nil, country=nil)
+          # city.to_s, state_or_province.to_s, country.to_s
+
+          super('ecommerce:addTransaction', {
+            :id => order_id.to_s,
+            :affiliation => store_name.to_s,
+            :revenue => total.to_s,
+            :tax => tax.to_s,
+            :shipping => shipping.to_s
+          })
         end
       end
 
@@ -119,18 +200,29 @@ module GoogleAnalytics
       #
       class AddItem < Event
         def initialize(order_id, product_id, product_name, product_variation, unit_price, quantity)
-          super('_addItem', order_id.to_s, product_id.to_s, product_name.to_s, product_variation.to_s, unit_price.to_s, quantity.to_s)
+          super('ecommerce:addItem', {
+            :id => order_id.to_s,
+            :sku => product_id.to_s,
+            :name => product_name.to_s,
+            :category => product_variation.to_s,
+            :price => unit_price.to_s,
+            :quantity => quantity.to_s
+          })
         end
-
       end
 
       # JavaScript equivalent:
       #
-      #     _gaq.push(['_trackTrans']);
+      #     ga('ecommerce:send');
       #
-      class TrackTransaction < Event
+      class TrackTransaction < SingleEvent
+        def initialize
+          super('ecommerce:send')
+        end
+      end
+      class ClearTransaction < SingleEvent
         def initialize
-          super('_trackTrans')
+          super('ecommerce:clear')
         end
       end
     end

data/lib/google-analytics/rails/view_helpers.rb

@@ -28,10 +28,7 @@ module GoogleAnalytics::Rails
   #       'Acme Clothing',  # affiliation or store name
   #       '11.99',          # total - required
   #       '1.29',           # tax
-  #       '5',              # shipping
-  #       'San Jose',       # city
-  #       'California',     # state or province
-  #       'USA'             # country
+  #       '5'               # shipping
   #     )
   #
   #     # add an item to the transaction
@@ -51,12 +48,20 @@ module GoogleAnalytics::Rails
     # Initializes the Analytics javascript. Put it in the `<head>` tag.
     #
     # @param options [Hash]
+    # @option options [String] :name
+    #   The name of the Universal Analytics Tracker
+    # @option options [Hash] :setup
+    #   Options for the initial Setup {GoogleAnalytics::Events::SetupAnalytics}
     # @option options [Boolean] :local (false) Sets the local development mode.
     #   See {http://www.google.com/support/forum/p/Google%20Analytics/thread?tid=741739888e14c07a&hl=en}
     # @option options [Array, GoogleAnalytics::Event] :add_events ([])
     #   The page views are tracked by default, additional events can be added here.
+    # @option options [Boolean] :skip_pageview
+    #   Turn off pageview tracking
     # @option options [String] :page
     #   The optional virtual page view to track through {GoogleAnalytics::Events::TrackPageview}
+    # @option options [String] :title
+    #   The optional virtual page view to track through {GoogleAnalytics::Events::TrackPageview}
     # @option options [String] :tracker
     #   The tracker to use instead of the default {GoogleAnalytics.tracker}
     # @option options [String] :domain
@@ -68,7 +73,7 @@ module GoogleAnalytics::Rails
     # @option options [Boolean] :enhanced_link_attribution
     #   See separate information for multiple links on a page that all have the same destination,
     #   see {https://support.google.com/analytics/answer/2558867}.
-    # @option options [Array, GoogleAnalytics::Events::SetCustomVar] :custom_vars ([])
+    # @option options [Array, GoogleAnalytics::Events::SetCustomDimension, GoogleAnalytics::Events::SetCustomMetric] :custom_vars ([])
     #
     # @example Set the local bit in development mode
     #   analytics_init :local => Rails.env.development?
@@ -85,36 +90,68 @@ module GoogleAnalytics::Rails
       end
 
       local = options.delete(:local) || false
+      setup = options.delete(:setup) || {}
+      tracker_name = options.delete(:name) || setup.fetch(:name, nil)
+
+      # Determine Name
+      setup[:name] ||= tracker_name if tracker_name
+
+      domain = options.delete(:domain) || (local ? "none" : "auto")
+
+      skip_pageview = options.delete(:skip_pageview) || false
       anonymize = options.delete(:anonymize) || false
       custom_vars = options.delete(:custom_vars) || []
       custom_vars = [custom_vars] unless custom_vars.is_a?(Array)
+
       link_attribution = options.delete(:enhanced_link_attribution) || false
-      domain = options.delete(:domain) || (local ? "none" : "auto")
+
+
       events = options.delete(:add_events) || []
       events = [events] unless events.is_a?(Array)
 
-      queue = GAQ.new
+      # Convert older classes when we can
+      if events.any?{|x| x.class.name == 'GoogleAnalytics::Events::SetAllowLinker' }
+        setup[:allowLinker] = !!events.any?{|x| x.class.name == 'GoogleAnalytics::Events::SetAllowLinker' }
+        events.delete_if{|x| x.class.name == 'GoogleAnalytics::Events::SetAllowLinker' }
+      end
+
+      if events.any?{|x| x.class.name == 'GoogleAnalytics::Events::SetSiteSpeedSampleRate' }
+        setup[:siteSpeedSampleRate] = events.select{|x| x.class.name == 'GoogleAnalytics::Events::SetSiteSpeedSampleRate' }.first.sample_rate
+        events.delete_if{|x| x.class.name == 'GoogleAnalytics::Events::SetSiteSpeedSampleRate' }
+      end
 
+      queue = GAQ.new
       # unshift => reverse order
-      events.unshift GA::Events::TrackPageview.new(options[:page])
+      events.unshift GA::Events::TrackPageview.new({:page => options[:page], :title => options[:title]}) unless skip_pageview
       # anonymize if needed before tracking the page view
       events.unshift GA::Events::AnonymizeIp.new if anonymize
       # custom_var if needed before tracking the page view
       custom_vars.each do |custom_var|
         events.unshift custom_var
       end
-      events.unshift GA::Events::SetDomainName.new(domain)
+
+      events.unshift GA::Events::Require.new('linkid') if link_attribution
+
+      # If this is 'local' env, give the cookieDomain none, and allow linker
       if local
-        events.unshift GA::Events::SetAllowLinker.new(true)
+        events.unshift GA::Events::SetupAnalytics.new(tracker, setup.merge({
+          :cookieDomain => 'none',
+          :allowLinker => true
+        }))
+      # If we have any configs, we'll merge the cookieDomain in
+      elsif setup.any?
+        events.unshift GA::Events::SetupAnalytics.new(tracker, setup.merge({ :cookieDomain => domain }))
+      # Just a normal request
+      else
+        events.unshift GA::Events::SetupAnalytics.new(tracker, domain)
       end
-      events.unshift GA::Events::SetAccount.new(tracker)
-      events.unshift GA::Events::Require.new(
-        'inpage_linkid',
-        '//www.google-analytics.com/plugins/ga/inpage_linkid.js'
-      ) if link_attribution
-
-      events.each do |event|
-        queue << event
+
+      events.each do |evt|
+        if evt.class.name == 'GoogleAnalytics::Events::SetupAnalytics'
+          queue.push(evt)
+        else
+          queue.push(evt, tracker_name)
+        end
       end
 
       queue.to_s.html_safe
@@ -145,6 +182,7 @@ module GoogleAnalytics::Rails
     # Track an ecommerce transaction
     # @see http://code.google.com/apis/analytics/docs/tracking/gaTrackingEcommerce.html
     def analytics_add_transaction(order_id, store_name, total, tax, shipping, city, state_or_province, country)
+      analytics_render_event(GA::Events::Require.new('ecommerce','ecommerce.js'))
       analytics_render_event(GA::Events::Ecommerce::AddTransaction.new(order_id, store_name, total, tax, shipping, city, state_or_province, country))
     end