rack-tracker 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0a9cfcc30e5e0f2ad7537aaa11e73bcfeafe80fa
-  data.tar.gz: 7645b119a9d73df232c29ee86f2d55f43118403c
+SHA256:
+  metadata.gz: 55705dd46c88e815dd7b0187c3d6d2a50b36a79f5ccc52e801a96d282ba348be
+  data.tar.gz: 5cad1746a043405f4f0e1b2cf85904dd9a6daa50923199d77d71bb32b7a357ba
 SHA512:
-  metadata.gz: ecea4935a9470f58ab52b413f0e6b984238d5db11d527fa5eaceeda5dac904bdcd65c804b2f0fe2680224b135e71c4443554f3d6d8f7aaa556c9b75b32d6c499
-  data.tar.gz: 6ecdf64a615c1bc9d46828c817e5836e5af6d64cc9ec5476fe19558b8c498a68211112386ef3838645828b5796e44e29da30cf4a81a94c4fa91c1604fd5cc648
+  metadata.gz: 0ea613048f9899f3c532eee40c7dd40ed9e4c6c6623f318df1522bbb11e3a05656bb3b96adf0b3b46bd10e33c34f9ab5774c7d48402e1830e3efff2042b144e2
+  data.tar.gz: ea8b57893ebdcc970e55085f20cefc4cdb1e18f5172b6e44cc3c54a2189335109cafe0694e30854edaa90ed3f3d8330051dc2619b7826f3a5180cb168ea129d3

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.7.0
+
+  * [BUGFIX] dup response string in Rack::Tracker#inject to avoid RuntimeError #114 (thx @zpfled)
+  * [ENHANCEMENT] Allow to use custom pageview url script for GoogleAnalytics tracker. #119 (thx @Haerezis)
+
 # 1.6.0
 
   * [BUGFIX] set wildcard to non-greedy for GTM body insertion #107

data/README.md

@@ -30,6 +30,32 @@ but to get you started we're shipping support for the following services out of
 * [Zanox](#zanox)
 * [Hotjar](#hotjar)
 
+## Respecting the Do Not Track (DNT) HTTP header
+
+The Do Not Track (DNT) HTTP header is a HTTP header that requests the server to disable its tracking of the individual user.
+This is an opt-out option supported by most browsers. This option is disabled by default and has to be explicitly enabled to indicate the user's request to opt-out.
+We believe evey application should respect the user's choice to opt-out and respect this HTTP header.
+
+Since version 2.0.0 rack-tracker respects that request header by default. That means NO tracker is injected IF the DNT header is set to "1".
+
+This option can be overwriten using the `DO_NOT_RESPECT_DNT_HEADER => true` option which must be set on any handler that should ignore the DNT header. (but please think twice before doing that)
+
+### Example on how to not respect the DNT header
+
+```ruby
+use Rack::Tracker do
+  # this tracker will be injected EVEN IF the DNT header is set to 1
+  handler :maybe_a_friendly_tracker, { tracker: 'U-XXXXX-Y', DO_NOT_RESPECT_DNT_HEADER: true }
+  # this tracker will NOT be injected if the DNT header is set to 1
+  handler :google_analytics, { tracker: 'U-XXXXX-Y' }
+end
+```
+
+Further reading on the DNT header:
+
+* [Wikipedia Do Not Track](https://en.wikipedia.org/wiki/Do_Not_Track)
+* [EFF: Do Not Track](https://www.eff.org/issues/do-not-track)
+
 
 ## Installation
 
@@ -97,6 +123,7 @@ request.env['tracker'] = {
 * `: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'`).
+* `:pageview_url_script` - a String containing a custom js script evaluating to the url that shoudl be given to the pageview event. Default to `window.location.pathname + window.location.search`.
 
 #### Events
 
@@ -276,6 +303,26 @@ First, add the following to your config:
   end
 ```
 
+#### Dynamic Pixel Configuration
+
+If you need to have different pixel ids e.g. based on the request or serving pages for different accounts, you have the possibility to achieve this by passing a lambda:
+
+```ruby
+  config.middleware.use(Rack::Tracker) do
+    handler :facebook_pixel, { id: lambda { |env| env['PIXEL_ID'] } }
+  end
+```
+
+and set the pixel id within the request `env` variable. Here an example on how it can be done in a rails action:
+
+```ruby
+  class MyController < ApplicationController
+    def show
+      request.env['PIXEL_ID'] = 'DYNAMIC_PIXEL_ID'
+    end
+  end
+```
+
 #### Standard Events
 
 To track Standard Events from the server side just call the `tracker` method in your controller.

data/lib/rack/tracker.rb

@@ -58,10 +58,11 @@ module Rack
     def html?; @headers['Content-Type'] =~ /html/; end
 
     def inject(env, response)
+      duplicated_response = response.dup
       @handlers.each(env) do |handler|
-        handler.inject(response)
+        handler.inject(duplicated_response)
       end
-      response
+      duplicated_response
     end
 
     class HandlerSet

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

@@ -65,6 +65,10 @@ class Rack::Tracker::GoogleAnalytics < Rack::Tracker::Handler
     events.select {|e| e.kind_of?(EnhancedEcommerce) }
   end
 
+  def pageview_url_script
+    options[:pageview_url_script] || 'window.location.pathname + window.location.search'
+  end
+
   private
 
   def tracker_option_key(key)

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

@@ -39,6 +39,6 @@
   ga('ecommerce:send');
 <% end %>
 <% if tracker %>
-  ga('send', 'pageview', window.location.pathname + window.location.search);
+  ga('send', 'pageview', <%= pageview_url_script %>);
 <% end %>
 </script>

data/lib/rack/tracker/handler.rb

@@ -38,6 +38,11 @@ class Rack::Tracker::Handler
   end
 
   def inject(response)
+    # default to not inject this tracker if the DNT HTTP header is set
+    # if the DO_NOT_RESPECT_DNT_HEADER config is set the DNT header is ignored :( - please do respect the DNT header!
+    if self.dnt_header_opt_out? && !self.options.has_key?(:DO_NOT_RESPECT_DNT_HEADER)
+      return response
+    end
     # Sub! is enough, in well formed html there's only one head or body tag.
     # Block syntax need to be used, otherwise backslashes in input will mess the output.
     # @see http://stackoverflow.com/a/4149087/518204 and https://github.com/railslove/rack-tracker/issues/50
@@ -70,6 +75,11 @@ class Rack::Tracker::Handler
     end
   end
 
+  # the request has set the DO NOT TRACK (DNT) and has opted to get not tracked (DNT=1)
+  def dnt_header_opt_out?
+    self.env['HTTP_DNT'] && self.env['HTTP_DNT'].to_s == '1'
+  end
+
   private
 
   # Transformations to be applied to tracker option keys.

data/lib/rack/tracker/version.rb

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

data/spec/handler/google_analytics_spec.rb

@@ -267,4 +267,22 @@ RSpec.describe Rack::Tracker::GoogleAnalytics do
       expect(subject).to include %q{setTimeout(function() { ga('send', 'event', '30_seconds', 'read'); },30000)}
     end
   end
+
+  describe '#pageview_url_script' do
+    context 'without custom pageview url script' do
+      subject { described_class.new(env, {} ) }
+
+      it 'returns return the custom pageview url script' do
+        expect(subject.pageview_url_script).to eql ("window.location.pathname + window.location.search")
+      end
+    end
+
+    context 'with a custom pageview url script' do
+      subject { described_class.new(env, { pageview_url_script: "{ 'page': location.pathname + location.search + location.hash }"}) }
+
+      it 'returns return the custom pageview url script' do
+        expect(subject.pageview_url_script).to eql ("{ 'page': location.pathname + location.search + location.hash }")
+      end
+    end
+  end
 end

data/spec/integration/google_analytics_integration_spec.rb

@@ -16,6 +16,10 @@ RSpec.describe "Google Analytics Integration" do
     expect(page.find("head")).to have_content('ga("send",{"hitType":"event","eventCategory":"button","eventAction":"click","eventLabel":"nav-buttons","eventValue":"X"})')
   end
 
+  it "will have default pageview url script" do
+    expect(page.find("head")).to have_content("ga('send', 'pageview', window.location.pathname + window.location.search);")
+  end
+
   describe 'adjust tracker position via options' do
     before do
       setup_app(action: :google_analytics) do |tracker|
@@ -49,4 +53,18 @@ RSpec.describe "Google Analytics Integration" do
       expect(page.find('head')).to have_content %q{Author\\'s name}
     end
   end
-end
+
+  describe 'Use custom pageview script' do
+    before do
+      setup_app(action: :google_analytics) do |tracker|
+        tracker.handler :google_analytics, { tracker: 'U-XXX-Y', pageview_url_script: "{ 'page': location.pathname + location.search + location.hash }"}
+      end
+      visit '/'
+    end
+
+    it "will use the custom pageview script for the pageview event" do
+      expect(page.find("head")).to have_content("ga('send', 'pageview', { 'page': location.pathname + location.search + location.hash });")
+    end
+  end
+
+end

data/spec/tracker/tracker_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class DummyHandler < Rack::Tracker::Handler
   def render
     Tilt.new( File.join( File.dirname(__FILE__), '../fixtures/dummy.erb') ).render(self)
@@ -20,6 +21,7 @@ RSpec.describe Rack::Tracker do
       use Rack::Tracker do
         handler DummyHandler, { foo: 'head' }
         handler BodyHandler, { foo: 'body' }
+        handler DummyHandler, { foo: 'I am evil', DO_NOT_RESPECT_DNT_HEADER: true }
       end
 
       run lambda {|env|
@@ -105,4 +107,39 @@ RSpec.describe Rack::Tracker do
       expect(last_response.body).to_not include("alert('this is a dummy class');")
     end
   end
+
+  describe 'do not track' do
+    context 'DNT header set to 1' do
+      it 'will not inject any tracker' do
+        get '/', {}, {'HTTP_DNT' => 1 }
+
+        # the DummyHandler respects the DNT
+        expect(last_response.body).to_not include("console.log('head');")
+      end
+
+      it 'will allow the DO_NOT_RESPECT_DNT_HEADER overwrite' do
+        get '/', {}, {'HTTP_DNT' => 1 }
+
+        # the EvilHandler respects the DNT
+        expect(last_response.body).to include("console.log('I am evil');")
+      end
+    end
+
+    context 'DNT header set to 0' do
+      it 'injects all trackers' do
+        get '/', {}, {'HTTP_DNT' => 0 }
+        expect(last_response.body).to include("console.log('head');")
+        expect(last_response.body).to include("console.log('I am evil');")
+      end
+    end
+
+    context 'DNT header is not set' do
+      it 'injects all trackers' do
+        get '/'
+        expect(last_response.body).to include("console.log('head');")
+        expect(last_response.body).to include("console.log('I am evil');")
+      end
+    end
+
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-tracker
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Lars Brillert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -246,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Tracking made easy