the_tracker 1.2.3

data/lib/the_tracker/trackers/g_analytics.rb

@@ -0,0 +1,98 @@
+module TheTracker
+  module Trackers
+    class GAnalytics < Base
+
+      # Analytics uat
+      def initialize(options)
+        @options = options
+        super()
+      end
+
+      def name
+        :ganalytics
+      end
+
+      def add_transaction(tid=0, store='', total=0, tax=0, shipping=0, city='', state='', country='')
+        tid = Time.now.to_i if (tid.nil?) or (tid.to_s == '0')
+        @transaction = Transaction.new(tid, store, total, tax, shipping, city, state, country)
+      end
+
+      def add_transaction_item(sku='', product='', category='', price=0, quantity=0)
+        @transaction.add_item(sku, product, category, price, quantity)
+      end
+
+      def add_custom_var(index, name, value, scope)
+        custom_vars[index] = [name, value, scope]
+      end
+
+      def track_event(category, action, label='', value=0, non_interactive=false)
+        "_gaq.push(['_trackEvent', '#{category}', '#{action}', '#{label}', #{value}, #{non_interactive}]);"
+      end
+
+      def header
+        return if !active
+        <<-EOF
+        <script type="text/javascript">//<![CDATA[
+        var _gaq = _gaq || [];
+        _gaq.push(['_setAccount', '#{@options[:id]}']);
+        #{extra_conf}
+        _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>
+        EOF
+      end
+
+      private
+
+      def extra_conf
+        conf = ''
+        conf << "_gaq.push(['_setDomainName', '#{@options[:domain_name]}']);\n" if @options[:domain_name]
+        conf << "_gaq.push(['_setAllowLinker', #{@options[:allow_linker]}]);\n" if @options[:allow_linker]
+        conf << set_custom_vars
+        conf << set_transactions
+        conf
+      end
+
+      def set_custom_vars
+        custom_vars.map do | index, cv |
+          "_gaq.push(['_setCustomVar', #{index}, '#{cv[0]}', '#{cv[1]}', '#{cv[2]}']);"
+        end.join('\n')
+      end
+
+      def set_transactions
+        return '' unless @transaction
+        conf = "_gaq.push(['_addTrans', '#{@transaction.id}', '#{@transaction.store}', '#{@transaction.total}', '#{@transaction.tax}', '#{@transaction.shipping}', '#{@transaction.city}', '#{@transaction.state}', '#{@transaction.country}']);\n"
+        conf << @transaction.items.map do |item|
+          "_gaq.push(['_addItem', '#{@transaction.id}', '#{item.sku}', '#{item.product}', '#{item.category}', '#{item.price}', '#{item.quantity}']);"
+        end.join('\n')
+        conf << "_gaq.push(['_trackTrans']);"
+        @transaction = nil
+        conf
+      end
+
+      def custom_vars
+        @custom_vars ||= {}
+      end
+    end
+
+    class Item < Struct.new(:sku, :product, :category, :price, :quantity)
+    end
+
+    class Transaction < Struct.new(:id, :store, :total, :tax, :shipping, :city, :state, :country)
+      def add_item(sku, product, category, price, quantity)
+        items << Item.new(sku, product, category, price, quantity)
+      end
+
+      def items
+        @items ||= []
+      end
+    end
+  end
+end

data/lib/the_tracker/trackers/g_universal.rb

@@ -0,0 +1,126 @@
+module TheTracker
+  module Trackers
+    class GUniversal < Base
+
+      attr_accessor :name
+
+      # Universal Analytics
+      def initialize(options)
+        @name    = options.delete(:name) || :guniversal
+        @options = options
+        super()
+      end
+
+      def add_transaction(tid=0, store='', total=0, tax=0, shipping=0)
+        tid = Time.now.to_i if (tid.nil?) or (tid.to_s == '0')
+        @transaction = EcommerceTransaction.new(tid, store, total, tax, shipping)
+      end
+
+      def add_transaction_item(sku='', product='', category='', price=0, quantity=0)
+        @transaction.add_item(sku, product, category, price, quantity)
+      end
+
+      def add_custom_var(type, index, value)
+        if (type == :dimension)
+          custom_dimensions[index] = value
+        else
+          custom_metrics[index] = value
+        end
+      end
+
+      def add_user_id(uid)
+        @uid = uid
+      end
+
+      def header
+        return if !active
+        <<-EOF
+        <!-- Google Analytics -->
+        <script>
+        (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[:id]}', 'auto', {#{create_conf}});
+        ga('#{name}.send', 'pageview');
+        #{extra_conf}
+        </script>
+        <!-- End Google Analytics -->
+        EOF
+      end
+
+      private
+
+      def create_conf
+        [account_name, allow_linker, user_id].compact.join(', ')
+      end
+
+      def account_name
+        "'name': '#{name}'"
+      end
+
+      def allow_linker
+        "'allowLinker': true" if @options[:allow_linker]
+      end
+
+      def user_id
+        "'userId': '#{@uid}'" if @uid
+      end
+
+      def extra_conf
+        conf = ''
+        conf << "ga('#{name}.require', 'linker');\n"
+        conf << "ga('linker:autoLink', #{@options[:domain_name]});\n" if @options[:domain_name]
+        conf << set_custom_dimensions
+        conf << set_custom_metrics
+        conf << set_transactions
+        conf
+      end
+
+      def set_custom_dimensions
+        custom_dimensions.map do | index, value |
+          "ga('#{name}.set', 'dimension#{index}', '#{value}');"
+        end.join(' ')
+      end
+
+      def set_custom_metrics
+        custom_metrics.map do | index, value |
+          "ga('#{name}.set', 'metric#{index}', '#{value}');"
+        end.join(' ')
+      end
+
+      def set_transactions
+        return '' unless @transaction
+        conf = "ga('#{name}.require', 'ecommerce', 'ecommerce.js');\n"
+        conf << "ga('#{name}.ecommerce:addTransaction', { 'id': '#{@transaction.id}', 'affiliation': '#{@transaction.store}', 'revenue': '#{@transaction.total}', 'shipping': '#{@transaction.shipping}', 'tax': '#{@transaction.tax}' });\n"
+        conf << @transaction.items.map do |item|
+          "ga('#{name}.ecommerce:addItem', {'id': '#{@transaction.id}', 'name': '#{item.product}', 'sku': '#{item.sku}', 'category': '#{item.category}', 'price': '#{item.price}', 'quantity': '#{item.quantity}'});\n"
+        end.join('\n')
+        conf << "ga('#{name}.ecommerce:send');\n"
+        @transaction = nil
+        conf
+      end
+
+      def custom_dimensions
+        @custom_dimensions ||= {}
+      end
+
+      def custom_metrics
+        @custom_metrics ||= {}
+      end
+    end
+
+    class EcommerceItem < Struct.new(:sku, :product, :category, :price, :quantity)
+    end
+
+    class EcommerceTransaction < Struct.new(:id, :store, :total, :tax, :shipping)
+      def add_item(sku, product, category, price, quantity)
+        items << EcommerceItem.new(sku, product, category, price, quantity)
+      end
+
+      def items
+        @items ||= []
+      end
+    end
+  end
+end

data/lib/the_tracker/trackers/gtm.rb

@@ -0,0 +1,59 @@
+module TheTracker
+  module Trackers
+    class Gtm < Base
+
+      attr_accessor :data_layer
+
+      # Gtm info
+      def initialize(options)
+        @gtmid = options[:gtmid]
+        super()
+      end
+
+      def name
+        :gtm
+      end
+
+      def body_top
+        return if !active
+        <<-EOF
+          #{show_data_layer}
+          <!-- Google Tag Manager -->
+          <noscript><iframe src="//www.googletagmanager.com/ns.html?id=#{@gtmid}"
+          height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
+          <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+          new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+          j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+          '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+          })(window,document,'script','dataLayer','#{@gtmid}');</script>
+          <!-- End Google Tag Manager -->
+        EOF
+      end
+
+      def add_data_layer(data, value)
+        data_layer[data] = value
+      end
+
+      private
+
+      def data_layer
+        @data_layer ||= {}
+      end
+
+      def show_data_layer
+        return if data_layer.empty?
+        <<-EOF
+          <script>
+          dataLayer = [{
+          #{data_layer_to_string}
+          }];
+          </script>
+        EOF
+      end
+
+      def data_layer_to_string
+        data_layer.map{|k,v| "'#{k}': '#{v}'"}.join(',')
+      end
+    end
+  end
+end

data/lib/the_tracker/trackers/kenshoo.rb

@@ -0,0 +1,49 @@
+module TheTracker
+  module Trackers
+    class Kenshoo < Base
+
+      # Kenshoo info
+      def initialize(options)
+        @token         = options[:token]
+        @type          = options[:type]
+        @val           = options[:val]
+        @orderId       = options[:orderId]
+        @promoCode     = options[:promoCode]
+        @valueCurrency = options[:valueCurrency]
+        @trackEvent    = options[:trackEvent]
+        super()
+      end
+
+      def name
+        :kenshoo
+      end
+
+      def body_top
+        return if !active
+        <<-EOF
+        <script type=text/javascript>
+          var hostProtocol = (("https:" == document.location.protocol) ? "https" : "http");
+          document.write('<scr'+'ipt src="', hostProtocol+
+            '://#{@trackEvent}.xg4ken.com/media/getpx.php?cid=#{@id}','" type="text/JavaScript"><\/scr'+'ipt>');
+        </script>
+        <script type=text/javascript>
+          var params = new Array();
+          params[0]='id=#{@token}';
+          params[1]='type=#{@type}';
+          params[2]='val=#{@val}';
+          params[3]='orderId=#{@orderId}';
+          params[4]='promoCode=#{@promoCode}';
+          params[5]='valueCurrency=#{@valueCurrency}';
+          params[6]='GCID='; //For Live Tracking only
+          params[7]='kw='; //For Live Tracking only
+          params[8]='product='; //For Live Tracking only
+          k_trackevent(params,'#{@trackEvent}');
+        </script>
+        <noscript>
+          <img src="https://1191.xg4ken.com/media/redir.php?track=1&token=#{@token}&type=#{@type}&val=#{@val}&orderId=#{@orderId}&promoCode=#{@promoCode}&valueCurrency=#{@valueCurrency}&GCID=&kw=&product=" width="1" height="1">
+        </noscript>
+        EOF
+      end
+    end
+  end
+end

data/lib/the_tracker/trackers/relevant.rb

@@ -0,0 +1,25 @@
+module TheTracker
+  module Trackers
+    class Relevant < Base
+
+      # Relevant info
+      def initialize(options)
+        @token         = options[:token]
+        @seg           = options[:seg ]
+        @orderId       = options[:orderId]
+        super()
+      end
+
+      def name
+        :relevant
+      end
+
+      def body_bottom
+        return if !active
+        <<-EOF
+        <img src="http://ib.adnxs.com/px?id=#{@token}&seg=#{@seg}&orderId=#{@orderId}&t=2" width="1" height="1" />
+        EOF
+      end
+    end
+  end
+end

data/lib/the_tracker/trackers/uservoice.rb

@@ -0,0 +1,39 @@
+module TheTracker
+  module Trackers
+    class Uservoice < Base
+      require 'json'
+
+      # AdForm info pm and id
+      def initialize(key_file, options)
+        @options  = options
+        @key_file = key_file
+        super()
+      end
+
+      def name
+        :uservoice
+      end
+
+      def header
+        return if !active
+        <<-EOF
+          <script type="text/javascript">
+          (function(){var uv=document.createElement('script');uv.type='text/javascript';uv.async=true;uv.src='//widget.uservoice.com/#{@key_file}.js';var s=document.getElementsByTagName('script')[0];s.parentNode.insertBefore(uv,s)})()
+          </script>
+        EOF
+      end
+
+      def body_bottom
+        return if !active
+        <<-EOF
+          <script type="text/javascript">
+          UserVoice = window.UserVoice || [];
+          UserVoice.push(['showTab', 'classic_widget',
+            #{@options.to_json}
+          ]);
+          </script>
+        EOF
+      end
+    end
+  end
+end

data/lib/the_tracker/version.rb

@@ -0,0 +1,3 @@
+module TheTracker
+  VERSION = "1.2.3"
+end

data/lib/the_tracker/view_helpers.rb

@@ -0,0 +1,15 @@
+module TheTracker
+  module ViewHelpers
+    def header_tracking_code
+      TheTracker::Tracker.instance.header
+    end
+
+    def body_top_tracking_code
+      TheTracker::Tracker.instance.body_top
+    end
+
+    def body_bottom_tracking_code
+      TheTracker::Tracker.instance.body_bottom
+    end
+  end
+end

data/lib/the_tracker.rb

@@ -0,0 +1,8 @@
+require 'the_tracker/version'
+require 'the_tracker/tracker'
+require 'the_tracker/view_helpers'
+require 'the_tracker/trackers/base'
+require 'the_tracker/railtie' if defined? Rails
+Dir.glob("#{File.dirname(__FILE__)}/the_tracker/trackers/*.rb").each do |f|
+  require f
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'the_tracker'
+
+class TheTracker::Tracker
+  def self.reset
+    self.instance.instance_variable_set(:@trackers, {})
+  end
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+  config.before { TheTracker::Tracker.reset }
+end

data/spec/the_tracker/tracker_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe TheTracker::Tracker do
+  describe :methods do
+    describe :add do
+      it 'returns registered trackers' do
+        test_tr = mock('Object', :header => 'my tracker', :name => :track_test)
+        described_class.reset
+        described_class.config do |tmf|
+          tmf.add test_tr
+        end
+        test_tr2 = mock('Object', :header => 'other tracker', :name => :track_test2)
+        described_class.instance.add test_tr2
+        described_class.instance.trackers.size.should == 2
+      end
+    end
+
+    describe :add_once do
+      before :each do
+        test_tr = mock('Object', :body_bottom => 'my tracker', :name => :track_test)
+        described_class.reset
+        described_class.config do |tmf|
+          tmf.add test_tr
+        end
+        test_tr2 = mock('Object', :body_bottom => 'other tracker', :name => :track_test2)
+        described_class.instance.add_once test_tr2
+      end
+
+      it 'register a new tracker' do
+        described_class.instance.trackers.size.should == 2
+      end
+
+      it 'deregister the tracker after it has been injected on a page' do
+        described_class.instance.trackers.size.should == 2
+        described_class.instance.body_bottom
+        described_class.instance.trackers.size.should == 1
+      end
+    end
+
+    describe :header do
+      before :each do
+        ga = mock('Object', :header => 'google analytics', :name => :ganalytics)
+        tracker = TheTracker::Tracker.clone
+        @tracker = tracker.instance
+        @tracker.add ga
+      end
+
+      it 'returns all headers from trackers' do
+        @tracker.header.should == 'google analytics'
+      end
+
+      it 'adds headers of new tracker' do
+        sc = mock('Object', :header => 'site catalist', :name => :sitecat)
+        sc.stub(:header).and_return('site catalist')
+        @tracker.add sc
+        @tracker.header.should == "google analytics\nsite catalist"
+      end
+
+      it 'should not render nil trackers' do
+        ss = mock('Object', :header => 'site nil', :name => :stupid_site)
+        ss.stub(:header).and_return(nil)
+        @tracker.add ss
+        @tracker.header.should == 'google analytics'
+      end
+    end
+
+    describe :body_top do
+      before :each do
+        ga = mock('Object', :body_top => 'google analytics', :name => :ganalytics)
+        tracker = TheTracker::Tracker.clone
+        @tracker = tracker.instance
+        @tracker.add ga
+      end
+
+      it 'returns body_top from trackers' do
+        @tracker.body_top.should == 'google analytics'
+      end
+
+      it 'adds new tracker' do
+        sc = mock('Object', :body_top => 'site catalist', :name => :sitecat)
+        sc.stub(:body_top).and_return('site catalist')
+        @tracker.add sc
+        @tracker.body_top.should == "google analytics\nsite catalist"
+      end
+
+      it 'should not render nil trackers' do
+        ss = mock('Object', :body_top => 'site nil', :name => :stupid_site)
+        ss.stub(:body_top).and_return(nil)
+        @tracker.add ss
+        @tracker.body_top.should == 'google analytics'
+      end
+    end
+
+    describe :body_bottom do
+      before :each do
+        ga = mock('Object', :body_bottom => 'google analytics', :name => :ganalytics)
+        tracker = TheTracker::Tracker.clone
+        @tracker = tracker.instance
+        @tracker.add ga
+      end
+
+      it 'returns body_bottom from trackers' do
+        @tracker.body_bottom.should == 'google analytics'
+      end
+
+      it 'adds new tracker' do
+        sc = mock('Object', :body_bottom => 'site catalist', :name => :sitecat)
+        sc.stub(:body_bottom).and_return('site catalist')
+        @tracker.add sc
+        @tracker.body_bottom.should == "google analytics\nsite catalist"
+      end
+
+      it 'should not render nil trackers' do
+        ss = mock('Object', :body_bottom => 'site nil', :name => :stupid_site)
+        ss.stub(:body_bottom).and_return(nil)
+        @tracker.add ss
+        @tracker.body_bottom.should == 'google analytics'
+      end
+    end
+  end
+end

data/spec/the_tracker/trackers/ad_form_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe TheTracker::Trackers::AdForm do
+  subject { described_class.new(:pm => '111666', :id => '333555') }
+  describe :methods do
+    describe :header do
+      it 'should return ad_form content' do
+        subject.header.should include('https://track.adform.net/serving/scripts/trackpoint/async/')
+      end
+
+      it 'should include pm and id information' do
+        subject.header.should include('pm: 111666')
+        subject.header.should include('id: 333555')
+      end
+
+      it 'returns nothing if tracker not active' do
+        subject.active = false
+        subject.header.should == nil
+      end
+    end
+  end
+end

data/spec/the_tracker/trackers/base_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe TheTracker::Trackers::Base do
+  describe :methods do
+    describe :header do
+      it 'should return an empty array' do
+         subject.header.should == []
+      end
+    end
+
+    describe :body_top do
+      it 'should return an empty array' do
+         subject.body_top.should == []
+      end
+    end
+
+    describe :body_bottom do
+      it 'should return an empty array' do
+         subject.body_bottom.should == []
+      end
+    end
+
+    describe :name do
+      it 'should raise a NotImplementedError' do
+        expect { subject.name }.to raise_error(NotImplementedError)
+      end
+    end
+
+    describe :active do
+      it 'should be active by default' do
+        subject.active.should be
+      end
+
+      it 'should be active by default' do
+        subject.active = false
+        subject.active.should be_false
+      end
+    end
+  end
+end

data/spec/the_tracker/trackers/g_ad_services_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe TheTracker::Trackers::GAdServices do
+  subject { described_class.new(:id => 12345678, :language => 'en', :format => '2', :color => "ffffff", :label => 'SomeThingReallyCool', :value => 0) }
+  describe :methods do
+    describe :body_bottom do
+      it 'should return ad_form content' do
+        subject.body_bottom.should include('//www.googleadservices.com/pagead/conversion.js')
+      end
+
+      it 'should include id, langage, format, color, label and value information' do
+        subject.body_bottom.should include('var google_conversion_id = 12345678');
+        subject.body_bottom.should include("var google_conversion_language = \"en\"");
+        subject.body_bottom.should include("var google_conversion_format = \"2\"");
+        subject.body_bottom.should include("var google_conversion_color = \"ffffff\"");
+        subject.body_bottom.should include("var google_conversion_label = \"SomeThingReallyCool\"");
+        subject.body_bottom.should include('var google_conversion_value = 0');
+      end
+
+      it 'returns nothing if tracker not active' do
+        subject.active = false
+        subject.body_bottom.should == nil
+      end
+    end
+  end
+end