the_tracker 1.2.3

data/.gitignore

@@ -0,0 +1,16 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in the_tracker.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,138 @@
+PATH
+  remote: .
+  specs:
+    the_tracker (1.2.3)
+      rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    ffi (1.8.1)
+    formatador (0.2.4)
+    guard (1.8.0)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (2.5.4)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    hike (1.2.3)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.8.0)
+    listen (1.0.3)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.3)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.1)
+    mime-types (1.25.1)
+    multi_json (1.7.6)
+    polyglot (0.3.4)
+    pry (0.9.12.1)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.13)
+      actionmailer (= 3.2.13)
+      actionpack (= 3.2.13)
+      activerecord (= 3.2.13)
+      activeresource (= 3.2.13)
+      activesupport (= 3.2.13)
+      bundler (~> 1.0)
+      railties (= 3.2.13)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.4)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    rspec-rails (2.13.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    slop (3.4.4)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.18.1)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.39)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard-rspec
+  pry
+  rspec-rails
+  the_tracker!

data/Guardfile

@@ -0,0 +1,8 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jorge Alvarez
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,272 @@
+# TheTracker
+
+A Gem to help you add tracker components to your application.  Instead of having to write javascript code to add this trackers you can use plain pure ruby.
+
+Currently this components are supported:
+
+  Google Analytics
+
+  Google Universal Analytics
+
+  Google Tag Mangaer
+
+  Uservoice
+
+  Ad Form
+
+  Google Ad Services
+
+  Kenshoo Conversion Pixel
+
+  Relevant Traffic Conversion Pixel
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'the_tracker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install the_tracker
+
+## Usage
+
+Create a file in config/initializers/tracker.rb
+
+Add all the trackers you need
+
+    TheTracker::Tracker.config do |tmf|
+      tmf.add TheTracker::Trackers::Uservoice.new('YOUR_KEY', {:forum_id => 123, :tab_label => 'Say Hi!'})
+      tmf.add TheTracker::Trackers::GAnalytics.new(:id => 'UA-1234123-99')
+    end
+
+In your views add
+
+    <header>
+      <%= header_tracking_code.html_safe %>
+    </header>
+
+If the tracker needs to add code into the body:
+
+    <body>
+      <%= body_top_tracking_code.html_safe %>
+
+      ... your page html ...
+
+      <%= body_bottom_tracking_code.html_safe %>
+    </body>
+
+And that's all, the tracking code will be added automatically
+
+Sometimes you only want to track certain pages:
+
+For instance, this example will not show the Google Analytics code if `some_condition` evaluates to true
+
+    <header>
+      <% TheTracker::Tracker.instance.trackers[:ganalytics].active = some_condition %>
+      <%= header_tracking_code.html_safe %>
+    </header>
+
+You can add a tracking code on a single page:
+
+    TheTracker::Tracker.config do |tmf|
+      tmf.add_once TheTracker::Trackers::Uservoice.new('YOUR_KEY', {:forum_id => 123, :tab_label => 'Say Hi and disappear!'})
+    end
+
+
+## Available Trackers
+
+### AdFrom
+
+      TheTracker::Trackers::AdForm.new(:pm => 123, :id => 444)
+
+### Uservoice
+
+      TheTracker::Trackers::Uservoice.new(
+        'THE_KEY',
+        {
+        mode: 'full',
+        primary_color: '#ff0000',
+        link_color: '#007dbf',
+        default_mode: 'support',
+        forum_id: 111,
+        tab_label: 'Say Hi!',
+        tab_color: '#cc0000',
+        tab_position: 'middle-left',
+        tab_inverted: true
+        }
+      )
+
+### Google Analytics
+
+#### Regular tracking code
+      TheTracker::Trackers::GAnalytics.new(:id => 'UA-111111-11')
+
+You can optionally set domain name and allow linker
+
+      TheTracker::Trackers::GAnalytics.new(:id => 'UA-111111-11', :domain_name => 'mydomain.com', :allow_linker => true)
+
+#### Add an e-commerce transaction
+      TheTracker::Tracker.instance.trackers[:ganalytics].add_transaction(tid=0, store='', total=0, tax=0, shipping=0, city='', state='', country='')
+
+Yo don't need to specify an id.  If id is zero the transaction id will be the current timestamp
+
+To add items to the transaction:
+
+      TheTracker::Tracker.instance.trackers[:ganalytics].add_transaction_item(sku='', product='', category='', price=0, quantity=0)
+
+#### Add custom vars
+
+      TheTracker::Tracker.instance.trackers[:ganalytics].add_custom_var(index, name, value, scope)
+
+#### Track an event
+
+      TheTracker::Tracker.instance.trackers[:ganalytics].track_event(category, action, label='', value=0, non_interactive=false)
+
+### Google Universal Analytics
+
+#### Regular tracking code
+      TheTracker::Trackers::GUniversal.new(:id => 'UA-111111-11')
+
+You can optionally set an array of domains and allow linker
+
+      TheTracker::Trackers::GUniversal.new(:id => 'UA-111111-11', :domain_name => ['onedomain.com', 'anotherdomain.com'], :allow_linker => true)
+
+#### Track multiple analytics accounts
+
+All tracking codes are namespaced to avoid conflicts with other existant Universal analytics accounts or to allow you to use more than one account.
+
+If you create an account without specifiying a name the default name will be 'guniversal':
+      TheTracker::Trackers::GUniversal.new(:id => 'UA-111111-11')
+
+the code that will be injected on the page will be like this:
+      ga('guniversal.send', 'pageview');
+
+If you want to add another universal analytics account you should define a name when creating it:
+      TheTracker::Trackers::GUniversal.new(id: 'UA-111111-11', name: 'second_account')
+
+and the code generated will be like this:
+      ga('second_account.send', 'pageview');
+
+To add information to a specific account just use the appropiate tracker
+      TheTracker::Tracker.instance.trackers[:second_account].add_custom_var(:dimension, 1, 'I am second to none')
+
+#### Add an e-commerce transaction
+      TheTracker::Tracker.instance.trackers[:guniversal].add_transaction(tid=0, store='', total=0, tax=0, shipping=0)
+
+Yo don't need to specify an id.  If id is zero the transaction id will be the current timestamp
+
+To add items to the transaction:
+
+      TheTracker::Tracker.instance.trackers[:guniversal].add_transaction_item(sku='', product='', category='', price=0, quantity=0)
+
+#### Add custom dimensions and metrics
+
+      TheTracker::Tracker.instance.trackers[:guniversal].add_custom_var(:dimension, index, value)
+      TheTracker::Tracker.instance.trackers[:guniversal].add_custom_var(:metric, index, value)
+
+#### Add User Id
+
+      TheTracker::Tracker.instance.trackers[:guniversal].add_user_id(id)
+
+### Google Tag Manager
+
+      TheTracker::Trackers::Gtm.new(:gtmid => 'GTM-111111')
+
+To add [dataLayer variables to GTM](https://developers.google.com/tag-manager/devguide)
+
+      TheTracker::Tracker.instance.trackers[:gtm].add_data_layer(name, value)
+
+### Google AdServices
+
+      TheTracker::Trackers::GAdServices.new(
+        id: 'UA-111111-11'
+        language: 'en',
+        format: '1',
+        color: 'ffffff',
+        label: 'qwerty',
+        value: '0'
+      )
+
+### Kenshoo Conversion Pixel
+
+      TheTracker::Trackers::Kenshoo.new(
+        token: '999'
+        type: 'conv',
+        val: '0',
+        orderId: '88988',
+        promoCode: 'easter',
+        valueCurrency: 'EUR',
+        trackEvent: '1234'
+      )
+
+### Relevant Traffic Conversion Pixel
+
+      TheTracker::Trackers::Relevant.new(
+        token: '4329847'
+        seg: '289347',
+        orderId: '88AB988'
+      )
+
+## Author
+
+ Created by Jorge Alvarez
+
+ @jorgealvarez
+
+ http://www.alvareznavarro.es
+
+ I would like to thanks to the [Sage One](http://www.sageone.es) team for their support in the development of this gem
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+The Tracker is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+
+## Log
+
+### Version 1.2.3
+
+Fixed bug with namespace
+
+### Version 1.2.2
+
+Support for more than one Universal analytics account
+
+### Version 1.2.1
+
+Support for userId in Universal analytics
+
+### Version 1.2.0
+
+Added Universal analytics
+
+### Version 1.1.2
+
+Added Relevant Traffic conversion pixel support
+
+### Version 1.0.0
+
+Everything is stable so time to bump version to 1.0.0
+
+Added Kenshoo conversion pixel support
+
+### Version 0.5.0
+
+Now you can add a tracker that will be displayed only once and removed from subsequent requests.
+
+### Version 0.4.6
+
+Fixed bug that keeped information about transactions on each page load.  Now transaction information is displayed only once.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/the_tracker/railtie.rb

@@ -0,0 +1,9 @@
+require 'the_tracker/view_helpers'
+
+module TheTracker
+  class Railtie < Rails::Railtie
+    initializer "the_tracker.view_helpers" do |app|
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/the_tracker/tracker.rb

@@ -0,0 +1,64 @@
+require 'singleton'
+
+module TheTracker
+  # Common tracker behaviour
+  class Tracker
+    include Singleton
+
+    def self.config
+      yield self.instance if block_given?
+    end
+
+    # register a new tracker
+    def add(tracker)
+      regular_trackers[tracker.name] = tracker
+    end
+
+    # register a new one time only tracker
+    def add_once(tracker)
+      one_time_trackers[tracker.name] = tracker
+    end
+
+    # registered trackers
+    def trackers
+      one_time_trackers.empty? ? regular_trackers : regular_trackers.merge(one_time_trackers)
+    end
+
+    # Return header content for all registered trackers
+    def header
+      show_trackers_for(:header)
+    end
+
+    # Return body top content for all registered trackers
+    def body_top
+      show_trackers_for(:body_top)
+    end
+
+    # Return body bottom content for all registered trackers
+    def body_bottom
+      trk_result = show_trackers_for(:body_bottom)
+      remove_one_time_trackers
+      return trk_result
+    end
+
+    private
+
+    def show_trackers_for(position)
+      trackers.map do | id, tracker |
+        tracker.send(position)
+      end.compact.join("\n")
+    end
+
+    def regular_trackers
+      @regular_trackers ||= {}
+    end
+
+    def one_time_trackers
+      @one_time_trackers ||= {}
+    end
+
+    def remove_one_time_trackers
+      @one_time_trackers = {}
+    end
+  end
+end

data/lib/the_tracker/trackers/ad_form.rb

@@ -0,0 +1,37 @@
+module TheTracker
+  module Trackers
+    class AdForm < Base
+
+      # AdForm info pm and id
+      def initialize(options)
+        @pm = options[:pm]
+        @id = options[:id]
+        super()
+      end
+
+      def name
+        :adform
+      end
+
+      def header
+        return if !active
+        <<-EOF
+      <!-- Adform Tracking Code BEGIN -->
+      <script type="text/javascript">
+      var _adftrack = {
+      pm: #{@pm},
+      id: #{@id}
+      };
+      (function(){var s=document.createElement('script');s.type='text/javascript';s.async=true;s.src='https://track.adform.net/serving/scripts/trackpoint/async/';var x = document.getElementsByTagName('script')[0];x.parentNode.insertBefore(s, x);})();
+      </script>
+      <noscript>
+      <p style="margin:0;padding:0;border:0;">
+      <img src="https://track.adform.net/Serving/TrackPoint/?pm=#{@pm}&amp;lid=#{@id}" width="1" height="1" alt="" />
+      </p>
+      </noscript>
+      <!-- Adform Tracking Code END -->
+      EOF
+      end
+    end
+  end
+end

data/lib/the_tracker/trackers/base.rb

@@ -0,0 +1,32 @@
+module TheTracker
+  module Trackers
+    # Base class for trackers
+    class Base
+      attr_accessor :active
+
+      def initialize
+        @active   = true
+      end
+
+      # public name
+      def name
+        raise NotImplementedError
+      end
+
+      # code that should appear on the header section
+      def header
+        []
+      end
+
+      # code that should appear on the body top section
+      def body_top
+        []
+      end
+
+      # code that should appear on the body bottom section
+      def body_bottom
+        []
+      end
+    end
+  end
+end

data/lib/the_tracker/trackers/g_ad_services.rb

@@ -0,0 +1,46 @@
+module TheTracker
+  module Trackers
+    class GAdServices < Base
+
+      # GAdService info id, language, format, color, label and value
+      def initialize(options)
+        @id = options[:id]
+        @language = options[:language]
+        @format = options[:format]
+        @color = options[:color]
+        @label = options[:label]
+        @value = options[:value]
+        super()
+      end
+
+      def name
+        :gadservices
+      end
+
+      def body_bottom
+        return if !active
+        <<-EOF
+        <!-- Google Code for Cliente Potencial Conversion Page BEGIN -->
+        <script type="text/javascript">
+        /* <![CDATA[ */
+        var google_conversion_id = #{@id};
+        var google_conversion_language = \"#{@language}\";
+        var google_conversion_format = \"#{@format}\";
+        var google_conversion_color = \"#{@color}\";
+        var google_conversion_label = \"#{@label}\";
+        var google_conversion_value = #{@value};
+        /* ]]> */
+        </script>
+        <script type=\"text/javascript\" src=\"//www.googleadservices.com/pagead/conversion.js\">
+        </script>
+        <noscript>
+        <div style=\"display:inline;\">
+          <img height=\"1\" width=\"1\" style=\"border-style:none;\" alt=\"\" src=\"//www.googleadservices.com/pagead/conversion/#{@id}/?value=#{@value}&label=#{@label}&guid=ON&script=0\"/>
+        </div>
+        </noscript>
+        <!-- Google Code for Cliente Potencial Conversion Page END -->
+        EOF
+      end
+    end
+  end
+end