the_tracker 1.2.3

data/spec/the_tracker/trackers/g_analytics_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe TheTracker::Trackers::GAnalytics do
+ subject { described_class.new(:id => 'UA-111-11') }
+
+  describe :initialize do
+    before :each do
+      @ga = described_class.new(
+        id: 111,
+        domain_name: 'test.com',
+        allow_linker: true
+      )
+    end
+
+    it 'should return domain name content' do
+      @ga.header.should include("_gaq.push(['_setDomainName', 'test.com']);")
+    end
+
+    it 'should return allow linker name content' do
+      @ga.header.should include("_gaq.push(['_setAllowLinker', true]);")
+    end
+  end
+
+  describe :methods do
+    describe :add_custom_var do
+      it 'should add a custom var' do
+        subject.add_custom_var(1, 'user', '111', 1)
+        subject.header.should include("_gaq.push(['_setCustomVar', 1, 'user', '111', '1']);")
+      end
+    end
+
+    describe :track_event do
+      it 'should add the event tag' do
+        subject.track_event('Category', 'Action', "label\'s", '99', true).should == "_gaq.push(['_trackEvent', 'Category', 'Action', 'label\'s', 99, true]);"
+      end
+    end
+
+    describe :transactions do
+      before :each do
+        subject.add_transaction('1234', 'Acme Clothing', '11.99', '1.29', '5', 'San Jose', 'California', 'USA')
+        subject.add_transaction_item('DD44', 'T-Shirt', 'Green Medium', '11.99', '1')
+      end
+
+      describe :add_transaction do
+        it 'should add the transaction tag' do
+          subject.header.should include("_gaq.push(['_addTrans'")
+        end
+
+        it 'should add the transaction tag but only once' do
+          subject.header
+          subject.header.should_not include("_gaq.push(['_addTrans'")
+        end
+      end
+
+      describe :add_transaction_item do
+        it 'should add the transaction_item tag' do
+          subject.header.should include("_gaq.push(['_addItem'")
+        end
+      end
+
+      it 'should add the tracker of the transaction' do
+        subject.header.should include("_gaq.push(['_trackTrans']);")
+      end
+
+      context 'if transaction id is nil' do
+        before :each do
+          @default = described_class.new(:id => 'UA-111-11')
+        end
+
+        it 'should add default timestamp as transaction id when zero' do
+          @default.add_transaction(0, 'Acme Clothing', '11.99', '1.29', '5', 'San Jose', 'California', 'USA')
+          @default.header.should =~ /_gaq.push\(\['_addTrans', '\d{2,}'/
+        end
+
+        it 'should add default timestamp as transaction id when nil' do
+          @default.add_transaction(nil, 'Acme Clothing', '11.99', '1.29', '5', 'San Jose', 'California', 'USA')
+          @default.header.should =~ /_gaq.push\(\['_addTrans', '\d{2,}'/
+        end
+      end
+    end
+
+    describe :header do
+      it 'should return analytics content' do
+        subject.header.should include("_gaq.push(['_trackPageview']);")
+      end
+
+      it 'should include ua information' do
+        subject.header.should include("_gaq.push(['_setAccount', 'UA-111-11']);")
+      end
+    end
+
+    describe :name do
+      it 'should return ganalytics' do
+        subject.name.should == :ganalytics
+      end
+    end
+  end
+end

data/spec/the_tracker/trackers/g_universal_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+describe TheTracker::Trackers::GUniversal do
+ subject { described_class.new(:id => 'UA-111-11') }
+
+  describe :initialize do
+    before :each do
+      @ga = described_class.new(
+        id: 'UA-111-22',
+        domain_name: ['source.com', 'destination.com'],
+        allow_linker: true
+      )
+    end
+
+    it 'should return allow linker name content' do
+      @ga.header.should include("ga('create', 'UA-111-22', 'auto', {'name': 'guniversal', 'allowLinker': true});")
+    end
+
+    it 'should return require linker' do
+      @ga.header.should include("ga('guniversal.require', 'linker');")
+    end
+
+    it 'should include all domains in autolink' do
+      @ga.header.should include("ga('linker:autoLink', [\"source.com\", \"destination.com\"]);")
+    end
+  end
+
+    it 'should return User Id' do
+      subject.add_custom_var(:metric, 1, 999.99)
+    end
+
+  describe :methods do
+    describe :add_custom_dimension do
+      it 'should add a custom dimension' do
+        subject.add_custom_var(:dimension, 1, 'user')
+        subject.header.should include("ga('guniversal.set', 'dimension1', 'user');")
+      end
+    end
+
+    describe :add_custom_metric do
+      it 'should add a custom metric' do
+        subject.add_custom_var(:metric, 1, 999.99)
+        subject.header.should include("ga('guniversal.set', 'metric1', '999.99');")
+      end
+    end
+
+    describe :transactions do
+      before :each do
+        subject.add_transaction('1234', 'Acme Clothing', '11.99', '1.29', '5')
+        subject.add_transaction_item('DD44', 'T-Shirt', 'Green Medium', '11.99', '1')
+      end
+
+      it 'should add transaction library' do
+        subject.header.should include("ga('guniversal.require', 'ecommerce', 'ecommerce.js');")
+      end
+
+      describe :add_transaction do
+        it 'should add the transaction tag' do
+          subject.header.should include("ga('guniversal.ecommerce:addTransaction'")
+        end
+
+        it 'should add the transaction tag but only once' do
+          subject.header
+          subject.header.should_not include("ga('guniversal.ecommerce:addTransaction'")
+        end
+      end
+
+      describe :add_transaction_item do
+        it 'should add the transaction_item tag' do
+          subject.header.should include("ga('guniversal.ecommerce:addItem', {")
+        end
+      end
+
+      it 'should add the tracker of the transaction' do
+        subject.header.should include("ga('guniversal.ecommerce:send');")
+      end
+
+      context 'if transaction id is nil' do
+        before :each do
+          @default = described_class.new(:id => 'UA-111-11', :name => :second_tracker)
+        end
+
+        it 'should add default timestamp as transaction id when zero' do
+          @default.add_transaction(0, 'Acme Clothing', '11.99', '1.29', '5')
+          @default.header.should =~ /ga\('second_tracker.ecommerce:addTransaction', { 'id': '\d{2,}'/
+        end
+
+        it 'should add default timestamp as transaction id when nil' do
+          @default.add_transaction(nil, 'Acme Clothing', '11.99', '1.29', '5')
+          @default.header.should =~ /ga\('second_tracker.ecommerce:addTransaction', { 'id': '\d{2,}'/
+        end
+      end
+
+      describe :add_user_id do
+        it 'should return User Id' do
+          subject.add_user_id('abcde123456')
+          subject.header.should include("ga('create', 'UA-111-11', 'auto', {'name': 'guniversal', 'userId': 'abcde123456'});")
+        end
+      end
+    end
+
+    describe :header do
+      it 'should return analytics content' do
+        subject.header.should include("ga('guniversal.send', 'pageview');")
+      end
+
+      it 'should include UA information' do
+        subject.header.should include("ga('create', 'UA-111-11', 'auto', {'name': 'guniversal'});")
+      end
+
+      it 'should not include linker information by default' do
+        subject.header.should_not include("ga('create', 'UA-111-11', 'auto', {'allowLinker': true});")
+      end
+    end
+
+    describe :name do
+      context 'when name is set in options' do
+        before :each do
+          @universal =  described_class.new(id: 'UA-111-11', name: 'test_track')
+        end
+        it 'should name the instance as name' do
+          @universal.name.should == 'test_track'
+        end
+
+        it 'should track pageviews namespaced' do
+          @universal.header.should include("ga('test_track.send', 'pageview');")
+        end
+      end
+
+      context 'when no name is provided' do
+        it 'should return ganalytics' do
+          subject.name.should == :guniversal
+        end
+
+        it 'should track pageviews namespaced' do
+          subject.header.should include("ga('guniversal.send', 'pageview');")
+        end
+      end
+    end
+  end
+end

data/spec/the_tracker/trackers/gtm_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe TheTracker::Trackers::Gtm do
+  subject { described_class.new(:gtmid => 'GTM-XXXXX') }
+  describe :methods do
+    describe :body_top do
+      it 'should return gtm content' do
+        subject.body_top.should include('<iframe src="//www.googletagmanager.com/ns.html?id=')
+      end
+
+      it 'returns nothing if tracker not active' do
+        subject.active = false
+        subject.body_top.should == nil
+      end
+    end
+
+    describe :add_data_layer do
+      before :each do
+        subject.add_data_layer('client_id', 123)
+      end
+
+      it 'adds a new value to data layer info' do
+        subject.body_top.should include("'client_id': '123'")
+      end
+      it 'adds a new value to data layer info stack' do
+        subject.add_data_layer('status', 'big_boss')
+        subject.body_top.should include("'client_id': '123','status': 'big_boss'")
+      end
+    end
+  end
+end

data/spec/the_tracker/trackers/kenshoo_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe TheTracker::Trackers::Kenshoo do
+  subject { described_class.new(:token => 12345678, :type => 'en', :val => '2', :orderId => "ffffff", :promoCode => 'SomeThingReallyCool', :valueCurrency => 'EUR', trackEvent: '6969') }
+  describe :methods do
+    describe :body_bottom do
+      it 'should return ad_form content' do
+        subject.body_top.should include('://6969.xg4ken.com/media/getpx.php')
+      end
+
+      it 'should include id, langage, format, color, label and value information' do
+        subject.body_top.should include("params[0]='id=12345678'");
+        subject.body_top.should include("params[1]='type=en'");
+        subject.body_top.should include("params[2]='val=2'");
+        subject.body_top.should include("params[3]='orderId=ffffff'");
+        subject.body_top.should include("params[4]='promoCode=SomeThingReallyCool'");
+        subject.body_top.should include("params[5]='valueCurrency=EUR'");
+        subject.body_top.should include("k_trackevent(params,'6969'");
+      end
+
+      it 'returns nothing if tracker not active' do
+        subject.active = false
+        subject.body_top.should == nil
+      end
+    end
+  end
+end

data/spec/the_tracker/trackers/relevant_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe TheTracker::Trackers::Relevant do
+  subject { described_class.new(:token => 12345678, :seg => '9876543', :orderId => '2') }
+  describe :methods do
+    describe :body_bottom do
+      it 'should return ad_form content' do
+        subject.body_bottom.should include('://ib.adnxs.com/px')
+      end
+
+      it 'should include id, seg and orderID' do
+        subject.body_bottom.should include("id=12345678");
+        subject.body_bottom.should include("seg=9876543");
+        subject.body_bottom.should include("orderId=2");
+      end
+
+      it 'returns nothing if tracker not active' do
+        subject.active = false
+        subject.body_bottom.should == nil
+      end
+    end
+  end
+end

data/spec/the_tracker/trackers/uservoice_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe TheTracker::Trackers::Uservoice do
+  subject { described_class.new('abcd', {:forum_id => '111', :tab_label => 'Say Hi!'}) }
+  describe :methods do
+    describe :header do
+      it 'should return uservoice script' do
+        subject.header.should include('widget.uservoice.com/abcd.js')
+      end
+    end
+
+    describe :name do
+      it 'should return uservoice' do
+        subject.name.should == :uservoice
+      end
+    end
+
+    describe :body_bottom do
+      it 'should return uservoice variable' do
+        subject.body_bottom.should include('UserVoice = window.UserVoice')
+      end
+
+      it 'should include forum_id and tab_label information' do
+        subject.body_bottom.should include('"forum_id":"111"')
+        subject.body_bottom.should include('"tab_label":"Say Hi!"')
+      end
+    end
+  end
+end

data/spec/the_tracker/view_helpers_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+class GAnalitics < TheTracker::Trackers::Base
+  def header
+    'header tracking code'
+  end
+
+  def body_top
+    'body top tracking code'
+  end
+
+  def body_bottom
+    'body bottom tracking code'
+  end
+
+  def name
+    :ganalytics
+  end
+end
+
+class ViewClass
+  include TheTracker::ViewHelpers
+end
+
+describe 'View Helpers' do
+  before :each do
+    TheTracker::Tracker.reset
+    TheTracker::Tracker.config do |tmf|
+      tmf.add GAnalitics.new
+    end
+    @vc = ViewClass.new
+  end
+
+  describe 'Header' do
+    it 'display header info' do
+      @vc.header_tracking_code.should == 'header tracking code'
+    end
+  end
+
+  describe 'Body Top' do
+    it 'display top info' do
+      @vc.body_top_tracking_code.should == 'body top tracking code'
+    end
+  end
+
+  describe 'Body Bottom' do
+    it 'display bottom info' do
+      @vc.body_bottom_tracking_code.should == 'body bottom tracking code'
+    end
+  end
+end

data/the_tracker.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'the_tracker/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "the_tracker"
+  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.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency "rails"
+  gem.add_development_dependency "rspec-rails"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: the_tracker
+version: !ruby/object:Gem::Version
+  version: 1.2.3
+  prerelease: 
+platform: ruby
+authors:
+- Jorge Alvarez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add tracking codes to your rails app
+email:
+- jorge@alvareznavarro.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/the_tracker.rb
+- lib/the_tracker/railtie.rb
+- lib/the_tracker/tracker.rb
+- lib/the_tracker/trackers/ad_form.rb
+- lib/the_tracker/trackers/base.rb
+- lib/the_tracker/trackers/g_ad_services.rb
+- lib/the_tracker/trackers/g_analytics.rb
+- lib/the_tracker/trackers/g_universal.rb
+- lib/the_tracker/trackers/gtm.rb
+- lib/the_tracker/trackers/kenshoo.rb
+- lib/the_tracker/trackers/relevant.rb
+- lib/the_tracker/trackers/uservoice.rb
+- lib/the_tracker/version.rb
+- lib/the_tracker/view_helpers.rb
+- spec/spec_helper.rb
+- spec/the_tracker/tracker_spec.rb
+- spec/the_tracker/trackers/ad_form_spec.rb
+- spec/the_tracker/trackers/base_spec.rb
+- spec/the_tracker/trackers/g_ad_services_spec.rb
+- spec/the_tracker/trackers/g_analytics_spec.rb
+- spec/the_tracker/trackers/g_universal_spec.rb
+- spec/the_tracker/trackers/gtm_spec.rb
+- spec/the_tracker/trackers/kenshoo_spec.rb
+- spec/the_tracker/trackers/relevant_spec.rb
+- spec/the_tracker/trackers/uservoice_spec.rb
+- spec/the_tracker/view_helpers_spec.rb
+- the_tracker.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Analytics, Website Optimizer, Clicktale...
+test_files:
+- spec/spec_helper.rb
+- spec/the_tracker/tracker_spec.rb
+- spec/the_tracker/trackers/ad_form_spec.rb
+- spec/the_tracker/trackers/base_spec.rb
+- spec/the_tracker/trackers/g_ad_services_spec.rb
+- spec/the_tracker/trackers/g_analytics_spec.rb
+- spec/the_tracker/trackers/g_universal_spec.rb
+- spec/the_tracker/trackers/gtm_spec.rb
+- spec/the_tracker/trackers/kenshoo_spec.rb
+- spec/the_tracker/trackers/relevant_spec.rb
+- spec/the_tracker/trackers/uservoice_spec.rb
+- spec/the_tracker/view_helpers_spec.rb
+has_rdoc: