the_tracker 1.2.3 → 1.3.0

data/README.md

@@ -1,3 +1,7 @@
+[![Gem Version](https://badge.fury.io/rb/the_tracker.svg)](http://badge.fury.io/rb/the_tracker)
+
+Simple way to add Google analytics, universal analytics, uservoice to your rails app
+
 # 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.
@@ -20,6 +24,8 @@ Currently this components are supported:
 
   Relevant Traffic Conversion Pixel
 
+  YD RTB Pixel
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -65,7 +71,7 @@ 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
+For instance, this example will show the Google Analytics code only if `some_condition` evaluates to true
 
     <header>
       <% TheTracker::Tracker.instance.trackers[:ganalytics].active = some_condition %>
@@ -78,140 +84,10 @@ You can add a tracking code on a single page:
       tmf.add_once TheTracker::Trackers::Uservoice.new('YOUR_KEY', {:forum_id => 123, :tab_label => 'Say Hi and disappear!'})
     end
 
+## [Documentation](https://github.com/jorgegorka/the_tracker/wiki)
 
-## 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.
+Read the documentation to find details about how to implement each pixel available.
 
-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
 
@@ -237,6 +113,10 @@ The Tracker is released under the [MIT License](http://www.opensource.org/licens
 
 ## Log
 
+### Version 1.3.0
+
+YD RTB support
+
 ### Version 1.2.3
 
 Fixed bug with namespace

data/lib/the_tracker/trackers/yd.rb

@@ -0,0 +1,26 @@
+module TheTracker
+  module Trackers
+    class Yd < Base
+
+      # Yd info
+      def initialize(options)
+        @id         = options[:id]
+        @product    = options[:product ]
+        @order_id   = options[:order_id]
+        @cookies    = options.delete(:cookies_allowed) || 1
+        super()
+      end
+
+      def name
+        :yd
+      end
+
+      def body_bottom
+        return if !active
+        <<-EOF
+        <iframe src="https://d.254a.com/pixel?id=#{@id}&t=3&cookies_allowed=#{@cookies}&orderid=#{@order_id}&product=#{@product}&secure=true" width="0" height="0" style="display:none;visibility:hidden"></iframe>
+        EOF
+      end
+    end
+  end
+end

data/lib/the_tracker/version.rb

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

data/spec/the_tracker/trackers/yd_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe TheTracker::Trackers::Yd do
+  subject { described_class.new(id: 12345678, product: '9876543', order_id: '2', cookies_allowed: 1) }
+  describe :methods do
+    describe :body_bottom do
+      it 'should return ad_form content' do
+        subject.body_bottom.should include('https://d.254a.com')
+      end
+
+      it 'should include id, seg and orderID' do
+        subject.body_bottom.should include("id=12345678");
+        subject.body_bottom.should include("product=9876543");
+        subject.body_bottom.should include("orderid=2");
+        subject.body_bottom.should include("cookies_allowed=1");
+      end
+
+      it 'returns nothing if tracker not active' do
+        subject.active = false
+        subject.body_bottom.should == nil
+      end
+    end
+
+    describe :cookiesAllowed do
+      context 'when cookiesAllowed is not set in the params' do
+        before :each do
+          @yd_tracker = described_class.new(id: 12345678, product: '9876543', order_id: '2')
+        end
+
+        it 'should be 1' do
+          @yd_tracker.body_bottom.should include("cookies_allowed=1");
+        end
+      end
+    end
+  end
+end

data/the_tracker.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = TheTracker::VERSION
   gem.authors       = ["Jorge Alvarez"]
   gem.email         = ["jorge@alvareznavarro.es"]
-  gem.description   = %q{Add tracking codes to your rails app}
-  gem.summary       = %q{Analytics, Website Optimizer, Clicktale...}
+  gem.description   = %q{Simple way to add Google analytics, universal analytics, uservoice, etc. to your rails app}
+  gem.summary       = %q{Add tracking pixels like Analytics, Universal Analytics, RTB, remarketing, etc...}
   gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_tracker
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-08 00:00:00.000000000 Z
+date: 2014-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -75,7 +75,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Add tracking codes to your rails app
+description: Simple way to add Google analytics, universal analytics, uservoice, etc.
+  to your rails app
 email:
 - jorge@alvareznavarro.es
 executables: []
@@ -101,6 +102,7 @@ files:
 - lib/the_tracker/trackers/kenshoo.rb
 - lib/the_tracker/trackers/relevant.rb
 - lib/the_tracker/trackers/uservoice.rb
+- lib/the_tracker/trackers/yd.rb
 - lib/the_tracker/version.rb
 - lib/the_tracker/view_helpers.rb
 - spec/spec_helper.rb
@@ -114,7 +116,9 @@ files:
 - spec/the_tracker/trackers/kenshoo_spec.rb
 - spec/the_tracker/trackers/relevant_spec.rb
 - spec/the_tracker/trackers/uservoice_spec.rb
+- spec/the_tracker/trackers/yd_spec.rb
 - spec/the_tracker/view_helpers_spec.rb
+- the_tracker-1.2.3.gem
 - the_tracker.gemspec
 homepage: ''
 licenses: []
@@ -139,7 +143,8 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Analytics, Website Optimizer, Clicktale...
+summary: Add tracking pixels like Analytics, Universal Analytics, RTB, remarketing,
+  etc...
 test_files:
 - spec/spec_helper.rb
 - spec/the_tracker/tracker_spec.rb
@@ -152,5 +157,6 @@ test_files:
 - spec/the_tracker/trackers/kenshoo_spec.rb
 - spec/the_tracker/trackers/relevant_spec.rb
 - spec/the_tracker/trackers/uservoice_spec.rb
+- spec/the_tracker/trackers/yd_spec.rb
 - spec/the_tracker/view_helpers_spec.rb
 has_rdoc: