gsiener-analytical 2.10.0

data/lib/analytical/modules/base.rb

@@ -0,0 +1,83 @@
+module Analytical
+  module Modules
+    module Base
+      attr_reader :tracking_command_location, :options, :initialized
+      attr_reader :command_store
+
+      def initialize(_options={})
+        @options = _options
+        @tracking_command_location = :body_prepend
+        @initialized = false
+        @command_store = @options[:session_store] || Analytical::CommandStore.new
+      end
+
+      def protocol
+        @options[:ssl] ? 'https' : 'http'
+      end
+
+      #
+      # The core methods that most analytics services implement are listed below.
+      # Modules will ignore any calls that they don't respond to, allowing them to
+      # only partially implement this basic template (or implement their own arbitrary custom methods)
+      #
+
+      # This is used to record page-view events, where you want to pass a URL to an analytics service
+      # def track(*args)
+
+      # Identify provides a unique identifier to an analytics service to keep track of the current user
+      # id should be a unique string (depending on which service you use), and some services also
+      # make use of a data hash as a second parameters, containing :email=>'test@test.com', for instance
+      # def identify(id, *args)
+
+      # Event is meant to track important funnel conversions in your app, or other important events
+      # that you want to inform a funnel analytics service about.  You can pass optional data to this method as well.
+      # def event(name, *args)
+
+      # Set passes some data to the analytics service that should be attached to the current user identity
+      # It can be used to set AB-testing choices and other unique data, so that split testing results can be
+      # reported by an analytics service
+      # def set(data)
+
+      # This method generates the initialization javascript that an analytics service uses to track your site
+      # def init_javascript(location)
+
+      def queue(*args)
+        return if @options[:ignore_duplicates] && @command_store.include?(args)
+        if args.first==:identify
+          @command_store.unshift args
+        else
+          @command_store << args
+        end
+      end
+      def process_queued_commands
+        command_strings = @command_store.collect do |c|
+          send(*c) if respond_to?(c.first)
+        end.compact
+        @command_store.flush
+        command_strings
+      end
+
+      def init_location?(location)
+        if @tracking_command_location.is_a?(Array)
+          @tracking_command_location.map { |item|item.to_sym }.include?(location.to_sym)
+        else
+          @tracking_command_location.to_sym == location.to_sym
+        end
+      end
+
+      def init_location(location, &block)
+        if init_location?(location)
+          @initialized = true
+          if block_given?
+            yield
+          else
+            ''
+          end
+        else
+          ''
+        end
+      end
+
+    end
+  end
+end

data/lib/analytical/modules/chartbeat.rb

@@ -0,0 +1,49 @@
+module Analytical
+  module Modules
+    class Chartbeat
+      include Analytical::Modules::Base
+
+      def initialize(options={})
+        super
+        @tracking_command_location = [:head_prepend, :body_append]
+      end
+
+      def init_javascript(location)
+        init_location(location) do
+          case location.to_sym
+            when :head_prepend
+            js = <<-HTML
+            <!-- Analytical Head Init: Chartbeat -->
+            <script type="text/javascript">var _sf_startpt=(new Date()).getTime();</script>
+            HTML
+            js
+            when :body_append
+            js = <<-HTML
+            <!-- Analytical Body Init: Chartbeat -->
+            <script type="text/javascript">
+              var _sf_async_config={uid:#{options[:key]}, domain:"#{options[:domain]}"};
+              (function(){
+                function loadChartbeat() {
+                  window._sf_endpt=(new Date()).getTime();
+                  var e = document.createElement('script');
+                  e.setAttribute('language', 'javascript');
+                  e.setAttribute('type', 'text/javascript');
+                  e.setAttribute('src',
+                     (("https:" == document.location.protocol) ? "https://s3.amazonaws.com/" : "http://") +
+                     "static.chartbeat.com/js/chartbeat.js");
+                  document.body.appendChild(e);
+                }
+                var oldonload = window.onload;
+                window.onload = (typeof window.onload != 'function') ?
+                   loadChartbeat : function() { oldonload(); loadChartbeat(); };
+              })();
+              </script>
+            HTML
+            js
+            end
+        end
+      end
+
+    end
+  end
+end

data/lib/analytical/modules/click_tale.rb

@@ -0,0 +1,47 @@
+module Analytical
+  module Modules
+    class ClickTale
+      include Analytical::Modules::Base
+
+      def initialize(options={})
+        super
+        @tracking_command_location = [:body_prepend, :body_append]
+      end
+
+      def init_javascript(location)
+        init_location(location) do
+          case location.to_sym
+            when :body_prepend
+              js = <<-HTML
+              <!-- Analytical Init: ClickTale Top part -->
+              <script type="text/javascript">
+              var WRInitTime=(new Date()).getTime();
+              </script>
+              <!-- ClickTale end of Top part -->
+              HTML
+              js
+            when :body_append
+              js = <<-HTML
+              <!-- Analytical Init: ClickTale Bottom part -->
+          		<div id="ClickTaleDiv" style="display: none;"></div>
+          		<script type='text/javascript'>
+          		document.write(unescape("%3Cscript%20src='"+
+          		 (document.location.protocol=='https:'?
+          		  'https://clicktale.pantherssl.com/':
+          		  'http://s.clicktale.net/')+
+          		 "WRb6.js'%20type='text/javascript'%3E%3C/script%3E"));
+          		</script>
+          		<script type="text/javascript">
+          		var ClickTaleSSL=1;
+          		if(typeof ClickTale=='function') ClickTale(#{@options[:project_id]},#{@options[:site_traffic]},"www");
+          		</script>
+          		<!-- ClickTale end of Bottom part -->
+              HTML
+              js
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/analytical/modules/clicky.rb

@@ -0,0 +1,49 @@
+module Analytical
+  module Modules
+    class Clicky
+      include Analytical::Modules::Base
+
+      def initialize(options={})
+        super
+        @tracking_command_location = :body_append
+      end
+
+      def init_javascript(location)
+        init_location(location) do
+          js = <<-HTML
+          <!-- Analytical Init: Clicky -->
+          <script src="#{protocol}://static.getclicky.com/js" type="text/javascript"></script>
+          <script type="text/javascript">clicky.init('#{@options[:key]}');</script>
+          <noscript><p><img alt="Clicky" width="1" height="1" src="#{protocol}://in.getclicky.com/#{@options[:key]}ns.gif" /></p></noscript>
+          HTML
+
+          identify_commands = []
+          @command_store.commands.each do |c|
+            if c[0] == :identify
+              identify_commands << identify(*c[1..-1])
+            end
+          end
+          js = identify_commands.join("\n") + "\n" + js
+          @command_store.commands = @command_store.commands.delete_if {|c| c[0] == :identify }
+
+          js
+        end
+      end
+
+      def track(*args)
+        "clicky.log(\"#{args.first}\");"
+      end
+
+      def identify(id, *args)
+        data = { :id=>id }.merge(args.first || {})
+        code = <<-HTML
+        <script type='text/javascript'>
+          var clicky_custom_session = #{data.to_json};
+        </script>
+        HTML
+        code
+      end
+
+    end
+  end
+end

data/lib/analytical/modules/comscore.rb

@@ -0,0 +1,25 @@
+module Analytical
+  module Modules
+    class Comscore
+      include Analytical::Modules::Base
+
+      def initialize(options={})
+        super
+        @tracking_command_location = :head_append
+      end
+
+      def init_javascript(location)
+        init_location(location) do
+          js = <<-HTML
+          <!-- Analytical Init: comScore -->
+          <script>document.write(unescape("%3Cscript src='" + (document.location.protocol == "https:" ? "https://sb" : "http://b") + ".scorecardresearch.com/beacon.js' %3E%3C/script%3E"));</script>
+          <script>COMSCORE.beacon({c1:2, c2:#{options[:key]}, c3:"", c4:"", c5:"", c6:"", c15:""});</script>
+          <noscript><img src="http://b.scorecardresearch.com/p?c1=2&c2=#{options[:key]}&c3=&c4=&c5=&c6=&c15=&cj=1" /></noscript>
+          HTML
+          js
+        end
+      end
+
+    end
+  end
+end

data/lib/analytical/modules/console.rb

@@ -0,0 +1,82 @@
+module Analytical
+  module Modules
+    class Console
+      include Analytical::Modules::Base
+
+      def initialize(options={})
+        super
+        @tracking_command_location = :body_append
+      end
+
+      def init_javascript(location)
+        init_location(location) do
+          js = <<-HTML
+          <!-- Analytical Init: Console -->
+          <script type="text/javascript">
+            if(typeof(console) !== 'undefined' && console != null) {
+              console.log('Analytical Init: Console');
+            }
+          </script>
+          HTML
+          js
+        end
+      end
+
+      def track(*args)
+        check_for_console <<-HERE
+        console.log("Analytical Track: "+"#{escape args.first}");
+        HERE
+      end
+
+      def identify(id, *args)
+        data = args.first || {}
+        check_for_console <<-HERE
+        console.log("Analytical Identify: "+"#{escape id}");
+        console.log(#{data.to_json});
+        HERE
+      end
+
+      def event(name, *args)
+        data = args.first || {}
+        check_for_console <<-HERE
+        console.log("Analytical Event: "+"#{escape name}");
+        console.log(#{data.to_json});
+        HERE
+      end
+
+      def set(data)
+        check_for_console <<-HERE
+        console.log("Analytical Set: ");
+        console.log(#{data.to_json});
+        HERE
+      end
+
+      def alias_identity(old_identity,new_identity)
+        check_for_console <<-HERE
+        console.log("Analytical Alias: #{old_identity} => #{new_identity}");
+        HERE
+      end
+
+      private
+
+      CONSOLE_JS_ESCAPE_MAP = {
+        '\\' => '\\\\',
+        '</' => '<\/',
+        "\r\n" => '\n',
+        "\n" => '\n',
+        "\r" => '\n',
+        '"' => '\\"',
+        "'" => "\\'"
+      } unless defined?(CONSOLE_JS_ESCAPE_MAP)
+
+      def escape(js)
+        js.to_s.gsub(/(\\|<\/|\r\n|[\n\r"'])/) { CONSOLE_JS_ESCAPE_MAP[$1] }
+      end
+
+      def check_for_console(data)
+        "if(typeof(console) !== 'undefined' && console != null) { #{data} }"
+      end
+
+    end
+  end
+end

data/lib/analytical/modules/crazy_egg.rb

@@ -0,0 +1,24 @@
+module Analytical
+  module Modules
+    class CrazyEgg
+      include Analytical::Modules::Base
+
+      def initialize(options={})
+        super
+        @tracking_command_location = :body_append
+      end
+
+      def init_javascript(location)
+        init_location(location) do
+          code_url = "#{options[:key].to_s[0,4]}/#{options[:key].to_s[4,4]}"
+          js = <<-HTML
+          <!-- Analytical Init: CrazyEgg -->
+          <script type="text/javascript" src="#{protocol}://s3.amazonaws.com/new.cetrk.com/pages/scripts/#{code_url}.js"> </script>
+          HTML
+          js
+        end
+      end
+
+    end
+  end
+end

data/lib/analytical/modules/google.rb

@@ -0,0 +1,44 @@
+module Analytical
+  module Modules
+    class Google
+      include Analytical::Modules::Base
+
+      def initialize(options={})
+        super
+        @tracking_command_location = :head_append
+      end
+
+      def init_javascript(location)
+        init_location(location) do
+          js = <<-HTML
+          <!-- Analytical Init: Google -->
+          <script type="text/javascript">
+            var _gaq = _gaq || [];
+            _gaq.push(['_setAccount', '#{options[:key]}']);
+            _gaq.push(['_setDomainName', '#{options[:domain]}']);
+            #{"_gaq.push(['_setAllowLinker', true]);" if options[:allow_linker]}
+            _gaq.push(['_trackPageview']);
+            (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>
+          HTML
+          js
+        end
+      end
+
+      def track(*args)
+        "_gaq.push(['_trackPageview'#{args.empty? ? ']' : ', "' + args.first + '"]'});"
+      end
+      
+      def event(name, *args)
+        data = args.first || nil
+        data_string = data ? ", '#{data.to_json}'" : ""
+        "_gaq.push(['_trackEvent', \"Event\", \"#{name}\"" + data_string + "]);"
+      end
+      
+    end
+  end
+end

data/lib/analytical/modules/google_optimizer.rb

@@ -0,0 +1,62 @@
+module Analytical
+  module Modules
+    class GoogleOptimizer
+      include Analytical::Modules::Base
+
+      def initialize(options={})
+        super
+        @tracking_command_location = :head_prepend
+      end
+
+      def init_javascript(location)
+        init_location(location) do
+          js = <<-HTML
+          <!-- Analytical Init:  Google Website Optimizer Control Script -->
+      		<script>
+      		function utmx_section(){}function utmx(){}
+      		(function(){var k='#{options[:key]}',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 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>
+      		<!-- End of Google Website Optimizer Control Script -->
+      		<!-- Analytical Init: Google Website Optimizer Tracking Script -->
+          <script type="text/javascript">
+          if(typeof(_gat)!='object')document.write('<sc'+'ript src="http'+
+          (document.location.protocol=='https:'?'s://ssl':'://www')+
+          '.google-analytics.com/ga.js"></sc'+'ript>')</script>
+          <script type="text/javascript">
+          try {
+            var gwoTracker=_gat._getTracker("#{options[:account]}");
+            gwoTracker._trackPageview("/#{options[:key]}/test");
+            }catch(err){}</script>
+          <!-- End of Google Website Optimizer Tracking Script -->
+          HTML
+          js
+        end
+      end
+
+      def conversion(*args)
+        js = <<-HTML
+        <!-- Analytical Init:  Google Website Optimizer Conversion Script -->
+        <script type="text/javascript">
+        if(typeof(_gat)!='object')document.write('<sc'+'ript src="http'+
+        (document.location.protocol=='https:'?'s://ssl':'://www')+
+        '.google-analytics.com/ga.js"></sc'+'ript>')</script>
+        <script type="text/javascript">
+        try {
+          var gwoTracker=_gat._getTracker("#{options[:account]}");
+          gwoTracker._trackPageview("/#{options[:key]}/goal");
+          }catch(err){}</script>
+        <!-- End of Google Website Optimizer Conversion Script -->
+        HTML
+        js
+      end
+
+    end
+  end
+end

data/lib/analytical/modules/hubspot.rb

@@ -0,0 +1,28 @@
+module Analytical
+  module Modules
+    class Hubspot
+      include Analytical::Modules::Base
+
+      def initialize(options={})
+        super
+        @tracking_command_location = :body_append
+      end
+
+      def init_javascript(location)
+        init_location(location) do
+          js = <<-HTML
+          <!-- Analytical Init: Hubspot -->
+          <script type="text/javascript" language="javascript">
+          var hs_portalid=#{options[:portal_id]};
+          var hs_salog_version = "2.00";
+          var hs_ppa = "#{options[:domain]}";
+          document.write(unescape("%3Cscript src='" + document.location.protocol + "//" + hs_ppa + "/salog.js.aspx' type='text/javascript'%3E%3C/script%3E"));
+          </script>
+          HTML
+          js
+        end
+      end
+
+    end
+  end
+end

data/lib/analytical/modules/kiss_metrics.rb

@@ -0,0 +1,54 @@
+module Analytical
+  module Modules
+    class KissMetrics
+      include Analytical::Modules::Base
+
+      def initialize(options={})
+        super
+        @tracking_command_location = :body_prepend
+      end
+
+      def init_javascript(location)
+        init_location(location) do
+          js = <<-HTML
+          <!-- Analytical Init: KissMetrics -->
+          <script type="text/javascript">
+            var _kmq = _kmq || [];
+            function _kms(u){
+              setTimeout(function(){
+                var s = document.createElement('script'); var f = document.getElementsByTagName('script')[0]; s.type = 'text/javascript'; s.async = true;
+                s.src = u; f.parentNode.insertBefore(s, f);
+              }, 1);
+            }
+            _kms('//i.kissmetrics.com/i.js');_kms('#{options[:js_url_key]}');
+          </script>
+          <script type="text/javascript">
+            _kmq.push(['pageView']);
+          </script>
+          HTML
+          js
+        end
+      end
+
+      def identify(id, *args)
+        data = args.first || {}
+        "_kmq.push([\"identify\", \"#{data[:email]}\"]);"
+      end
+
+      def event(name, *args)
+        data = args.first || {}
+        "_kmq.push([\"record\", \"#{name}\", #{data.to_json}]);"
+      end
+
+      def set(data)
+        return '' if data.blank?
+        "_kmq.push([\"set\", #{data.to_json}]);"
+      end
+
+      def alias_identity(old_identity, new_identity)
+        "_kmq.push([\"alias\", \"#{old_identity}\", \"#{new_identity}\"]);"
+      end
+
+    end
+  end
+end

data/lib/analytical/modules/loopfuse.rb

@@ -0,0 +1,30 @@
+module Analytical
+  module Modules
+    class Loopfuse
+      include Analytical::Modules::Base
+
+      def initialize(options={})
+        super
+        @tracking_command_location = :body_append
+      end
+
+      def init_javascript(location)
+        init_location(location) do
+          js = <<-HTML
+          <!-- Analytical Init: LOOPFUSE TRACKING -->
+          <script type="text/javascript">
+          var LFHost = (("https:" == document.location.protocol) ? "https://" : "http://");
+          document.write(unescape("%3Cscript src='" + LFHost + "lfov.net/webrecorder/js/listen.js' type='text/javascript'%3E%3C/script%3E"));
+          </script>
+          <script type="text/javascript">
+          _lf_cid = "#{options[:cid]}";
+          _lf_remora();
+          </script>
+      		<!-- END: LOOPFUSE TRACKING -->
+          HTML
+          js
+        end
+      end
+    end
+  end
+end

data/lib/analytical/modules/microsoft_ads.rb

@@ -0,0 +1,58 @@
+module Analytical
+  module Modules
+    class MicrosoftAds
+      include Analytical::Modules::Base
+
+      def initialize(options={})
+        super
+        @tracking_command_location = :body_append
+      end
+
+      def init_javascript(location)
+        init_location(location) do
+          @initializing = true
+          html = "<!-- Analytical Init: Microsoft Ads -->\n"
+          event_commands = []
+          @command_store.commands.each do |c|
+            if c[0] == :event
+              event_commands << event(*c[1..-1])
+            end
+          end
+          html += event_commands.join("\n")
+          @command_store.commands = @command_store.commands.delete_if {|c| c[0] == :event }
+          @initializing = false
+
+          html
+        end
+      end
+
+      #
+      # Define conversion events in analytical.yml like:
+      #
+      # microsoft_ads:
+      #   'Some Event':
+      #     id: 55555555-6666-7777-8888-111111111111
+      def event(name, *args)
+        return '' unless @initializing
+
+        data = args.first || {}
+        if conversion = options[name.to_sym]
+          conversion.symbolize_keys!
+          js = <<-HTML
+          <script type="text/javascript">if (!window.mstag) mstag = {loadTag : function(){},time : (new Date()).getTime()};</script>
+          <script id="mstag_tops" type="text/javascript" src="//flex.atdmt.com/mstag/site/#{conversion[:id]}/mstag.js"></script>
+          <script type="text/javascript"> mstag.loadTag("conversion", {cp:"5050",dedup:"1"})</script>
+          <noscript>
+            <iframe src="//flex.atdmt.com/mstag/tag/#{conversion[:id]}/conversion.html?cp=5050&dedup=1" frameborder="0" scrolling="no" width="1" height="1" style="visibility:hidden; display:none"></iframe>
+          </noscript>
+          HTML
+          js
+        else
+          "<!-- No Microsoft Ads Conversion for: #{name} -->"
+        end
+      end
+
+    end
+  end
+end
+