ua-google-analytics-rails 1.0.0

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

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+require 'json'
+
+module GoogleAnalytics
+  class EventRenderer
+    def initialize(event, tracker_id)
+      @event = event
+      @tracker_id = tracker_id
+    end
+
+    def to_s
+      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(',')
+    end
+
+    def string_to_json(string)
+      # replace double quotes with single ones
+      string.to_json.gsub(/^"/, "'").gsub(/"$/, "'")
+    end
+  end
+end

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

@@ -0,0 +1,230 @@
+# coding: utf-8
+
+module GoogleAnalytics
+  module Events
+    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)
+        warn "[REMOVED] `SetAccount` is being removed. Universal Analytics does not support this any longer. Please see GoogleAnalytics::Events::SetupAnalytics"
+      end
+    end
+
+    class SetDomainName
+      def initialize(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
+      def initialize(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=nil)
+        if url
+          super('require', name, url)
+        else
+          super('require', name)
+        end
+      end
+    end
+
+    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.
+      attr_accessor :sample_rate
+      def initialize(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(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('send', 'event', category.to_s, action.to_s, label ? label.to_s : nil, value ? value.to_i : nil)
+        else
+          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)
+        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)
+        warn "[REMOVED] `DeleteCustomVar` is being removed. Universal Analytics does not support Custom Variables."
+      end
+    end
+
+    # @see https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApi_gat#_gat._anonymizeIp
+    #
+    # Anonymize the visitor IP address. This seems to be mandatory for European websites and actively enforced
+    # for German ones.
+    #
+    # See the following comment by Roland Moriz for more information:
+    # https://github.com/bgarret/google-analytics-rails/pull/6#issuecomment-5946066
+    #
+    # JavaScript equivalent:
+    #
+    #     ga('set', 'anonymizeIp', true);
+    #
+    class AnonymizeIp < Event
+      def initialize
+        super('set', 'anonymizeIp', true)
+      end
+    end
+
+    # @see http://code.google.com/apis/analytics/docs/tracking/gaTrackingEcommerce.html
+    module Ecommerce
+      # JavaScript equivalent:
+      #
+      # 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=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
+
+      # JavaScript equivalent:
+      #
+      #     _gaq.push(['_addItem',
+      #       '1234',           // order ID - required
+      #       'DD44',           // SKU/code - required
+      #       'T-Shirt',        // product name
+      #       'Green Medium',   // category or variation
+      #       '11.99',          // unit price - required
+      #       '1'               // quantity - required
+      #     ]);
+      #
+      class AddItem < Event
+        def initialize(order_id, product_id, product_name, product_variation, unit_price, quantity)
+          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:
+      #
+      #     ga('ecommerce:send');
+      #
+      class TrackTransaction < SingleEvent
+        def initialize
+          super('ecommerce:send')
+        end
+      end
+      class ClearTransaction < SingleEvent
+        def initialize
+          super('ecommerce:clear')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# coding: utf-8
+
+require 'google-analytics/rails/view_helpers'
+
+module GoogleAnalytics::Rails
+  # @private
+  class Railtie < ::Rails::Railtie
+    initializer "google-analytics-rails" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

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

@@ -0,0 +1,208 @@
+# coding: utf-8
+
+require 'active_support/core_ext/string/output_safety'
+require 'active_support/core_ext/object/blank'
+
+module GoogleAnalytics::Rails
+  # All the helper methods output raw javascript with single quoted strings. This allows more flexbility in choosing when the event gets sent (on page load, on user action, etc).
+  #
+  # The only exception is {#analytics_init}, which is wrapped in a `<script>` tag.
+  #
+  # @example This event is always sent on page load
+  #
+  #     <script>
+  #       <%= analytics_track_event "Videos", "Play", "Gone With the Wind" %>
+  #     </script>
+  #
+  # @example This event is sent when the visitor clicks on the link
+  #
+  #     # note the double quotes around the onclick attribute,
+  #     # they are necessary because the javascript is single quoted
+  #     <a href="my_url" onclick="<%= analytics_track_event "Videos", "Play", "Gone With the Wind" %>">Link</a>
+  #
+  # @example Full ecommerce example
+  #
+  #     # create a new transaction
+  #     analytics_add_transaction(
+  #       '1234',           # order ID - required
+  #       'Acme Clothing',  # affiliation or store name
+  #       '11.99',          # total - required
+  #       '1.29',           # tax
+  #       '5'               # shipping
+  #     )
+  #
+  #     # add an item to the transaction
+  #     analytics_add_item(
+  #       '1234',           # order ID - required
+  #       'DD44',           # SKU/code - required
+  #       'T-Shirt',        # product name
+  #       'Green Medium',   # category or variation
+  #       '11.99',          # unit price - required
+  #       '1'               # quantity - required
+  #     )
+  #
+  #     # submit the transaction
+  #     analytics_track_transaction
+  #
+  module ViewHelpers
+    # 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
+    #   The domain name to track, see {GoogleAnalytics::Events::SetDomainName}
+    # @option options [Boolean] :anonymize
+    #   Whether to anonymize the visitor ip or not.
+    #   This is required for european websites and actively enforced for german ones,
+    #   see {GoogleAnalytics::Events::AnonymizeIp}.
+    # @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::SetCustomDimension, GoogleAnalytics::Events::SetCustomMetric] :custom_vars ([])
+    #
+    # @example Set the local bit in development mode
+    #   analytics_init :local => Rails.env.development?
+    #
+    # @example Allow links across domains
+    #   analytics_init :add_events => Events::SetAllowLinker.new(true)
+    #
+    # @return [String] a `<script>` tag, containing the analytics initialization sequence.
+    #
+    def analytics_init(options = {})
+      unless tracker = options.delete(:tracker).presence
+        tracker = GA.tracker
+        raise ArgumentError, "Tracker must be set! Did you set GA.tracker ?" unless tracker
+      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
+
+
+      events = options.delete(:add_events) || []
+      events = [events] unless events.is_a?(Array)
+
+      # 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({: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::Require.new('linkid') if link_attribution
+
+      # If this is 'local' env, give the cookieDomain none, and allow linker
+      if local
+        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.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
+    end
+
+    # Track a custom event
+    # @see http://code.google.com/apis/analytics/docs/tracking/eventTrackerGuide.html
+    #
+    # @example
+    #
+    #     analytics_track_event "Videos", "Play", "Gone With the Wind"
+    #
+    def analytics_track_event(category, action, label = nil, value = nil)
+      analytics_render_event(GA::Events::TrackEvent.new(category, action, label, value))
+    end
+
+    # Set a custom variable.
+    # @see http://code.google.com/apis/analytics/docs/tracking/gaTrackingCustomVariables.html
+    # You're allowed only 1-5 for the index.
+    # The lifetime is defined by:
+    #  1 = visitor-level
+    #  2 = session-level
+    #  3 = page-level (default)
+    def analytics_set_custom_var(index, name, value, opt_scope = 3)
+      analytics_render_event(GA::Events::SetCustomVar.new(index, name, value, opt_scope))
+    end
+
+    # 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
+
+    # Add an item to the current transaction
+    # @see http://code.google.com/apis/analytics/docs/tracking/gaTrackingEcommerce.html
+    def analytics_add_item(order_id, product_id, product_name, product_variation, unit_price, quantity)
+      analytics_render_event(GA::Events::Ecommerce::AddItem.new(order_id, product_id, product_name, product_variation, unit_price, quantity))
+    end
+
+    # Flush the current transaction
+    # @see http://code.google.com/apis/analytics/docs/tracking/gaTrackingEcommerce.html
+    def analytics_track_transaction
+      analytics_render_event(GA::Events::Ecommerce::TrackTransaction.new)
+    end
+
+    private
+
+    def analytics_render_event(event)
+      raise ArgumentError, "Tracker must be set! Did you set GA.tracker ?" unless GA.valid_tracker?
+      GA::EventRenderer.new(event, nil).to_s.html_safe
+    end
+  end
+end