rack-tracker 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93dcd33285ad07b72e75cabe697bffa820b2212d
-  data.tar.gz: 2cfbf93add60fb26e91bf9f703b3dda0bc9aff95
+  metadata.gz: 0a9cfcc30e5e0f2ad7537aaa11e73bcfeafe80fa
+  data.tar.gz: 7645b119a9d73df232c29ee86f2d55f43118403c
 SHA512:
-  metadata.gz: c10ddd4e7a5abba1887219909bf4480c79a2b5775f81f072cab6cc40df914ec29b6dcce4eaf8609ff8087d284c154aaf6b34c64bb3ae5fb7c524d47c8b5fab26
-  data.tar.gz: 42310ccab992b9d71cd5817e1c6cc989cc4271d13c2ac628b3673f12712f9c1a01221e64b27528b622b41dfe4d1d01b74cb2eec9e3f1e2fc5e825a390a0e282a
+  metadata.gz: ecea4935a9470f58ab52b413f0e6b984238d5db11d527fa5eaceeda5dac904bdcd65c804b2f0fe2680224b135e71c4443554f3d6d8f7aaa556c9b75b32d6c499
+  data.tar.gz: 6ecdf64a615c1bc9d46828c817e5836e5af6d64cc9ec5476fe19558b8c498a68211112386ef3838645828b5796e44e29da30cf4a81a94c4fa91c1604fd5cc648

data/.travis.yml

@@ -2,9 +2,10 @@ language: ruby
 sudo: false
 rvm:
   - 2.1.10
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
   - jruby-9.1.10.0
 gemfile:
   - Gemfile

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 1.6.0
+
+  * [BUGFIX] set wildcard to non-greedy for GTM body insertion #107
+  * [ENHANCEMENT] Test against Ruby 2.5 #104
+  * [ENHANCEMENT] Google Optimize container ID #103
+  * [ENHANCEMENT] Allow for dynamic Facebook Pixel options #101
+
 # 1.5.0
 
   * [ENHANCEMENT] facebook pixel now supports non-standard (custom) event names #93

data/README.md

@@ -96,6 +96,7 @@ request.env['tracker'] = {
 * `:advertising` - Enables [Display Features](https://developers.google.com/analytics/devguides/collection/analyticsjs/display-features).
 * `:ecommerce` - Enables [Ecommerce Tracking](https://developers.google.com/analytics/devguides/collection/analyticsjs/ecommerce).
 * `:enhanced_ecommerce` - Enables [Enhanced Ecommerce Tracking](https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce)
+* `:optimize` - pass [Google Optimize container ID](https://support.google.com/360suite/optimize/answer/6262084#example-combined-snippet) as value (e.g. `optimize: 'GTM-1234'`).
 
 #### Events
 

data/lib/rack/tracker/facebook_pixel/facebook_pixel.rb

@@ -1,5 +1,6 @@
 class Rack::Tracker::FacebookPixel < Rack::Tracker::Handler
   self.position = :body
+  self.allowed_tracker_options = [:id]
 
   class Event < OpenStruct
     def write

data/lib/rack/tracker/facebook_pixel/template/facebook_pixel.erb

@@ -7,12 +7,12 @@
     t.src=v;s=b.getElementsByTagName(e)[0];s.parentNode.insertBefore(t,s)}(window,
     document,'script','//connect.facebook.net/en_US/fbevents.js');
 
-    fbq('init', '<%= options[:id] %>');
+    fbq('init', '<%= tracker_options[:id] %>');
     fbq('track', "PageView");
   }
 </script>
 <noscript>
-  <img height="1" width="1" style="display:none" src="https://www.facebook.com/tr?id=<%= options[:id] %>&ev=PageView&noscript=1"/>
+  <img height="1" width="1" style="display:none" src="https://www.facebook.com/tr?id=<%= tracker_options[:id] %>&ev=PageView&noscript=1"/>
 </noscript>
 
 <% if events.any? %>

data/lib/rack/tracker/google_analytics/google_analytics.rb

@@ -1,6 +1,6 @@
 class Rack::Tracker::GoogleAnalytics < Rack::Tracker::Handler
 
-  ALLOWED_TRACKER_OPTIONS = [:cookie_domain, :user_id]
+  self.allowed_tracker_options = [:cookie_domain, :user_id]
 
   class Send < OpenStruct
     def initialize(attrs = {})
@@ -57,16 +57,6 @@ class Rack::Tracker::GoogleAnalytics < Rack::Tracker::Handler
     options[:tracker].respond_to?(:call) ? options[:tracker].call(env) : options[:tracker]
   end
 
-  def tracker_options
-    @tracker_options ||= {}.tap do |tracker_options|
-      options.slice(*ALLOWED_TRACKER_OPTIONS).each do |key, value|
-        if option_value = value.respond_to?(:call) ? value.call(env) : value
-          tracker_options[key.to_s.camelize(:lower).to_sym] = option_value.to_s
-        end
-      end
-    end
-  end
-
   def ecommerce_events
     events.select {|e| e.kind_of?(Ecommerce) }
   end
@@ -74,4 +64,14 @@ class Rack::Tracker::GoogleAnalytics < Rack::Tracker::Handler
   def enhanced_ecommerce_events
     events.select {|e| e.kind_of?(EnhancedEcommerce) }
   end
+
+  private
+
+  def tracker_option_key(key)
+    key.to_s.camelize(:lower).to_sym
+  end
+
+  def tracker_option_value(value)
+    value.to_s
+  end
 end

data/lib/rack/tracker/google_analytics/template/google_analytics.erb

@@ -20,6 +20,9 @@
 <% if options[:ecommerce] %>
   ga('require', 'ecommerce', 'ecommerce.js');
 <% end %>
+<% if options[:optimize] %>
+  ga('require', '<%= options[:optimize] %>');
+<% end %>
 <% if options[:anonymize_ip] %>
   ga('set', 'anonymizeIp', true);
 <% end %>

data/lib/rack/tracker/google_tag_manager/google_tag_manager.rb

@@ -13,7 +13,7 @@ class Rack::Tracker::GoogleTagManager < Rack::Tracker::Handler
     response.sub! %r{<head.*>} do |m|
       m.to_s << self.render_head
     end
-    response.sub! %r{<body.*>} do |m|
+    response.sub! %r{<body.*?>} do |m|
       m.to_s << self.render_body
     end
     response

data/lib/rack/tracker/handler.rb

@@ -13,6 +13,9 @@ class Rack::Tracker::Handler
   class_attribute :position
   self.position = :head
 
+  class_attribute :allowed_tracker_options
+  self.allowed_tracker_options = []
+
   attr_accessor :options
   attr_accessor :env
 
@@ -56,4 +59,28 @@ class Rack::Tracker::Handler
   def handler_name
     self.class.name.demodulize.underscore
   end
+
+  def tracker_options
+    @_tracker_options ||= {}.tap do |tracker_options|
+      options.slice(*allowed_tracker_options).each do |key, value|
+        if option_value = value.respond_to?(:call) ? value.call(env) : value
+          tracker_options[tracker_option_key(key)] = tracker_option_value(option_value)
+        end
+      end
+    end
+  end
+
+  private
+
+  # Transformations to be applied to tracker option keys.
+  # Override in descendants, if necessary.
+  def tracker_option_key(key)
+    key.to_sym
+  end
+
+  # Transformations to be applied to tracker option values.
+  # Override in descendants, if necessary.
+  def tracker_option_value(value)
+    value
+  end
 end

data/lib/rack/tracker/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Tracker
-    VERSION = '1.5.0'
+    VERSION = '1.6.0'
   end
 end

data/spec/handler/facebook_pixel_spec.rb

@@ -1,6 +1,6 @@
 RSpec.describe Rack::Tracker::FacebookPixel do
   def env
-    {}
+    { 'PIXEL_ID' => 'DYNAMIC_PIXEL_ID' }
   end
 
   it 'will be placed in the body' do
@@ -8,7 +8,7 @@ RSpec.describe Rack::Tracker::FacebookPixel do
     expect(described_class.new(env).position).to eq(:body)
   end
 
-  describe 'with id' do
+  describe 'with static id' do
     subject { described_class.new(env, id: 'PIXEL_ID').render }
 
     it 'will push the tracking events to the queue' do
@@ -20,6 +20,18 @@ RSpec.describe Rack::Tracker::FacebookPixel do
     end
   end
 
+  describe 'with dynamic id' do
+    subject { described_class.new(env, id: lambda { |env| env['PIXEL_ID'] }).render }
+
+    it 'will push the tracking events to the queue' do
+      expect(subject).to match(%r{fbq\('init', 'DYNAMIC_PIXEL_ID'\)})
+    end
+
+    it 'will add the noscript fallback' do
+      expect(subject).to match(%r{https://www.facebook.com/tr\?id=DYNAMIC_PIXEL_ID&ev=PageView&noscript=1})
+    end
+  end
+
   describe 'with events' do
     def env
       {

data/spec/handler/google_analytics_spec.rb

@@ -53,28 +53,24 @@ RSpec.describe Rack::Tracker::GoogleAnalytics do
   end
 
   describe '#tracker_options' do
-    before do
-      stub_const("#{described_class}::ALLOWED_TRACKER_OPTIONS", [:some_option])
-    end
-
     context 'with an allowed option configured with a static value' do
-      subject { described_class.new(env, { some_option: 'value' }) }
+      subject { described_class.new(env, { user_id: 'value' }) }
 
       it 'returns hash with option set' do
-        expect(subject.tracker_options).to eql ({ someOption: 'value' })
+        expect(subject.tracker_options).to eql ({ userId: 'value' })
       end
     end
 
     context 'with an allowed option configured with a block' do
-      subject { described_class.new(env, { some_option: lambda { |env| return env[:misc] } }) }
+      subject { described_class.new(env, { user_id: lambda { |env| return env[:misc] } }) }
 
       it 'returns hash with option set' do
-        expect(subject.tracker_options).to eql ({ someOption: 'foobar' })
+        expect(subject.tracker_options).to eql ({ userId: 'foobar' })
       end
     end
 
     context 'with an allowed option configured with a block returning nil' do
-      subject { described_class.new(env, { some_option: lambda { |env| return env[:non_existing_key] } }) }
+      subject { described_class.new(env, { user_id: lambda { |env| return env[:non_existing_key] } }) }
 
       it 'returns an empty hash' do
         expect(subject.tracker_options).to eql ({})
@@ -192,7 +188,7 @@ RSpec.describe Rack::Tracker::GoogleAnalytics do
   describe "with custom domain" do
     subject { described_class.new(env, tracker: 'somebody', cookie_domain: "railslabs.com").render }
 
-    it "will show asyncronous tracker with cookieDomain" do
+    it "will show asynchronous tracker with cookieDomain" do
       expect(subject).to match(%r{ga\('create', 'somebody', {\"cookieDomain\":\"railslabs.com\"}\)})
       expect(subject).to match(%r{ga\('send', 'pageview', window\.location\.pathname \+ window\.location\.search\)})
     end
@@ -201,7 +197,7 @@ RSpec.describe Rack::Tracker::GoogleAnalytics do
   describe "with user_id tracking" do
     subject { described_class.new(env, tracker: 'somebody', user_id: lambda { |env| return env[:user_id] } ).render }
 
-    it "will show asyncronous tracker with userId" do
+    it "will show asynchronous tracker with userId" do
       expect(subject).to match(%r{ga\('create', 'somebody', {\"userId\":\"123\"}\)})
       expect(subject).to match(%r{ga\('send', 'pageview', window\.location\.pathname \+ window\.location\.search\)})
     end
@@ -239,6 +235,14 @@ RSpec.describe Rack::Tracker::GoogleAnalytics do
     end
   end
 
+  describe "with optimize" do
+    subject { described_class.new(env, tracker: 'happy', optimize: 'GTM-1234').render }
+
+    it "will require the optimize plugin with container ID" do
+      expect(subject).to match(%r{ga\('require', 'GTM-1234'\)})
+    end
+  end
+
   describe "with anonymizeIp" do
     subject { described_class.new(env, tracker: 'happy', anonymize_ip: true).render }
 

data/spec/handler/handler_spec.rb

@@ -0,0 +1,38 @@
+RSpec.describe Rack::Tracker::Handler do
+  def env
+    { misc: 'foobar' }
+  end
+
+  describe '#tracker_options' do
+    context 'without overriding allowed_tracker_options' do
+      subject { described_class.new(env, { some_option: 'value' }) }
+
+      it 'returns an empty hash' do
+        expect(subject.tracker_options).to eql ({})
+      end
+    end
+
+    context 'with overridden allowed_tracker_options' do
+      subject do
+        handler = described_class.new(env, {
+          static_option: 'value',
+          dynamic_option: lambda { |env| return env[:misc] },
+          dynamic_nil_option: lambda { |env| return env[:non_existent_key] },
+          non_allowed_option: 'value'
+        })
+
+        handler.allowed_tracker_options =
+          [:static_option, :dynamic_option, :dynamic_nil_option]
+
+        handler
+      end
+
+      it 'evaluates dynamic options, rejecting nonallowed and nil ones' do
+        expect(subject.tracker_options).to eql ({
+          static_option: 'value',
+          dynamic_option: 'foobar'
+        })
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-tracker
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Lars Brillert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-23 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -202,6 +202,7 @@ files:
 - spec/handler/google_adwords_conversion_spec.rb
 - spec/handler/google_analytics_spec.rb
 - spec/handler/google_tag_manager_spec.rb
+- spec/handler/handler_spec.rb
 - spec/handler/hotjar_spec.rb
 - spec/handler/vwo_spec.rb
 - spec/handler/zanox_spec.rb
@@ -245,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Tracking made easy
@@ -264,6 +265,7 @@ test_files:
 - spec/handler/google_adwords_conversion_spec.rb
 - spec/handler/google_analytics_spec.rb
 - spec/handler/google_tag_manager_spec.rb
+- spec/handler/handler_spec.rb
 - spec/handler/hotjar_spec.rb
 - spec/handler/vwo_spec.rb
 - spec/handler/zanox_spec.rb