rack-tracker 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7967cb6b637c7fbcbef964f3e12a198a3e18b4d3
-  data.tar.gz: 090e46d7451bf2d2d3a449b04a0162bf39e8fd6e
+  metadata.gz: f8b00e842917a8b4a5860ba6b66fc31d007330e4
+  data.tar.gz: ddcef1305f6638771741e5b1dcb0a95093cf1d30
 SHA512:
-  metadata.gz: 0da5aef1623fe668fd12b9c646cc80c262bbcd610bb6686af8fb01b0c201a722191020fa6b4a45ab22e9bf5f33561f7ece544bd9890b88b5f0c85552f0ba6319
-  data.tar.gz: 8ff3380ee3229d099f78eba30914e7cb67a991013810ab0209db287b3b119a93319966015c6cab06f94dd7e3ec1fe7492ab8763d51cf2302c06afd146a6a9ea0
+  metadata.gz: ec3e26414ba7877d46661e8f8eca1b2d80192d8f1eedd4d789f06dd5302937ea59f5ebf83a370bfc04d85ca890a242840c95187aaebf3f8b0d27a574494a292a
+  data.tar.gz: 7b9c3a9e365ca61ae867e9a5cc971daad4706d10c96aebffcfb7d65f8de7aa2eaa3a6de95cfc51a39645564657a0e254ddcc13c1829cdbebe0ed13cb1112dea6

data/.travis.yml

@@ -1,11 +1,17 @@
 language: ruby
 sudo: false
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.5
-  - 2.2.3
-  - jruby
+  - 2.1.10
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+  - jruby-9.1.10.0
 gemfile:
+  - Gemfile
   - Gemfile.rails-3.2
   - Gemfile.rails-4.2
+  - Gemfile.rails-5.1
+matrix:
+  exclude:
+    - rvm: 2.1.10
+      gemfile: Gemfile.rails-5.1 # rails 5 needs ruby >= 2.2.2

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 1.2.0
+
+  * Added Facebook Pixel support #75
+  * Datalayer position fix #72
+  * Dropped support for Ruby 1.9
+  * Rails 5.x compatibility
+
 # 1.1.0
 
   * [BREAKING] Google Tag Manager #59

data/Gemfile.rails-5.1

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'activesupport', '~> 5.1.0'
+gem 'actionpack', '~> 5.1.0'

data/README.md

@@ -88,10 +88,10 @@ request.env['tracker'] = {
 
 * `:anonymize_ip` -  sets the tracker to remove the last octet from all IP addresses, see https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApi_gat?hl=de#_gat._anonymizeIp for details.
 * `:cookie_domain` -  sets the domain name for the [GATC cookies](https://developers.google.com/analytics/devguides/collection/analyticsjs/domains#implementation). If not set its the website domain, with the www. prefix removed.
-* `:user_id` -  defines a proc to set the [userId](https://developers.google.com/analytics/devguides/collection/analyticsjs/user-id). Ex: `user_id: lambda { |env| env['rack.session']['user_id'] }` would return the user_id from the session.
+* `:user_id` -  defines a proc to set the [userId](https://developers.google.com/analytics/devguides/collection/analyticsjs/cookies-user-id#user_id). Ex: `user_id: lambda { |env| env['rack.session']['user_id'] }` would return the user_id from the session.
 * `:site_speed_sample_rate` - Defines a new sample set size for Site Speed data collection, see https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApiBasicConfiguration?hl=de#_gat.GA_Tracker_._setSiteSpeedSampleRate
 * `:adjusted_bounce_rate_timeouts` - An array of times in seconds that the tracker will use to set timeouts for adjusted bounce rate tracking. See http://analytics.blogspot.ca/2012/07/tracking-adjusted-bounce-rate-in-google.html for details.
-* `:enhanced_link_attribution` - Enables [Enhanced Link Attribution](https://developers.google.com/analytics/devguides/collection/analyticsjs/advanced#enhancedlink).
+* `:enhanced_link_attribution` - Enables [Enhanced Link Attribution](https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-link-attribution).
 * `: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)
@@ -254,16 +254,26 @@ To add events or variables to the dataLayer from the server side, just call the
 
 ### Facebook
 
-* `custom_audience` - adds the [Custom audience](https://developers.facebook.com/docs/reference/ads-api/custom-audience-website-faq) segmentation pixel
+* `Facebook Pixel` - adds the [Facebook Pixel](https://www.facebook.com/business/help/952192354843755)
 
-#### Conversions
+Use in conjunction with the [Facebook Helper](https://developers.facebook.com/docs/facebook-pixel/pixel-helper) to confirm your event fires correctly.
 
-To track [Conversions](https://www.facebook.com/help/435189689870514) from the server side just call the `tracker` method in your controller.
+First, add the following to your config:
+
+```ruby
+  config.middleware.use(Rack::Tracker) do
+    handler :facebook_pixel, { id: 'PIXEL_ID' }
+  end
+```
+
+#### Standard Events
+
+To track Standard Events from the server side just call the `tracker` method in your controller.
 
 ```ruby
   def show
     tracker do |t|
-      t.facebook :track, { id: '123456789', value: 1, currency: 'EUR' }
+      t.facebook_pixel :track, { type: 'Purchase', options: { value: 100, currency: 'USD' } }
     end
   end
 ```
@@ -271,8 +281,9 @@ To track [Conversions](https://www.facebook.com/help/435189689870514) from the s
 Will result in the following:
 
 ```javascript
-  window._fbq.push(["track", "123456789", {'value': 1, 'currency': 'EUR'}]);
+  fbq("track", "Purchase", {"value":"100.0","currency":"USD"});
 ```
+
 ### Visual website Optimizer (VWO)
 Just integrate the handler with your matching account_id and you will be ready to go
 
@@ -538,6 +549,12 @@ end
 Checkout the existing handlers in `lib/rack/tracker` for some inspiration. :)
 
 
+## Please note
+
+Most tracking is done using some kind of Javascript and any tracking data is simply passed on.  
+Using unvalidated user input in the tracking might result in [XSS issues](https://en.wikipedia.org/wiki/Cross-site_scripting). Do only use secure data. 
+
+
 ## Contributing
 
 First of all, **thank** you for your help! :green_heart:

data/lib/rack/tracker.rb

@@ -16,6 +16,7 @@ require "rack/tracker/google_analytics/google_analytics"
 require "rack/tracker/google_tag_manager/google_tag_manager"
 require "rack/tracker/google_adwords_conversion/google_adwords_conversion"
 require "rack/tracker/facebook/facebook"
+require "rack/tracker/facebook_pixel/facebook_pixel"
 require "rack/tracker/vwo/vwo"
 require "rack/tracker/go_squared/go_squared"
 require "rack/tracker/criteo/criteo"

data/lib/rack/tracker/controller.rb

@@ -3,7 +3,7 @@ module Rack
     module Controller
       def tracker(&block)
         if block_given?
-          yield(Rack::Tracker::HandlerDelegator.new(env))
+          yield(Rack::Tracker::HandlerDelegator.new(respond_to?(:request) ? request.env : env))
         end
       end
     end

data/lib/rack/tracker/facebook/README.md

@@ -0,0 +1,3 @@
+PLEAE NOTE! ATTENTION! OBACHT! ACHTUNG! 
+
+The facebook handler is deprecated. Please use the facebook_pixel handler. 

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

@@ -0,0 +1,27 @@
+class Rack::Tracker::FacebookPixel < Rack::Tracker::Handler
+  class Event < OpenStruct
+    def write
+      options.present? ? type_to_json << options_to_json : type_to_json
+    end
+
+    private
+
+    def type_to_json
+      type.to_json
+    end
+
+    def options_to_json
+      ", #{options.to_json}"
+    end
+  end
+
+  self.position = :body
+
+  def render
+    Tilt.new( File.join( File.dirname(__FILE__), 'template/facebook_pixel.erb') ).render(self)
+  end
+
+  def self.track(name, *event)
+    { name.to_s => [event.last.merge('class_name' => 'Event')] }
+  end
+end

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

@@ -0,0 +1,24 @@
+<script type="text/javascript">
+  if (typeof fbq == 'undefined') {
+
+    !function(f,b,e,v,n,t,s){if(f.fbq)return;n=f.fbq=function(){n.callMethod?
+    n.callMethod.apply(n,arguments):n.queue.push(arguments)};if(!f._fbq)f._fbq=n;
+    n.push=n;n.loaded=!0;n.version='2.0';n.queue=[];t=b.createElement(e);t.async=!0;
+    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('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"/>
+</noscript>
+
+<% if events.any? %>
+  <script type="text/javascript">
+    <% events.each do |event| %>
+      fbq("track", <%= event.write %>);
+    <% end %>
+  </script>
+<% end %>

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

@@ -3,6 +3,12 @@
   dataLayer = [];
 </script>
 
+<script>
+dataLayer.push(
+  <%= events.map(&:write).join(', ') %>
+);
+</script>
+
 <noscript><iframe src="//www.googletagmanager.com/ns.html?id=<%= container %>"
 height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
 <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
@@ -11,9 +17,4 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
 '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
 })(window,document,'script','dataLayer','<%= container %>');</script>
 
-<script>
-dataLayer.push(
-  <%= events.map(&:write).join(', ') %>
-);
-</script>
 <% end %>

data/lib/rack/tracker/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Tracker
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end

data/rack-tracker.gemspec

@@ -28,4 +28,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "capybara", "~> 2.4"
   spec.add_development_dependency "pry"
+  if RUBY_VERSION < "2.0"
+    spec.add_development_dependency "mime-types", "< 3.0"
+    spec.add_development_dependency "addressable", "< 2.5"
+  end
 end

data/spec/handler/facebook_pixel_spec.rb

@@ -0,0 +1,61 @@
+RSpec.describe Rack::Tracker::FacebookPixel do
+  # describe Rack::Tracker::FacebookPixel::Event do
+
+  #   subject { described_class.new({id: 'id', foo: 'bar'}) }
+
+  #   describe '#write' do
+  #     specify { expect(subject.write).to eq(['track', 'id', {foo: 'bar'}].to_json) }
+  #   end
+  # end
+
+  def env
+    {}
+  end
+
+  it 'will be placed in the body' do
+    expect(described_class.position).to eq(:body)
+    expect(described_class.new(env).position).to eq(:body)
+  end
+
+  describe 'with id' do
+    subject { described_class.new(env, id: 'PIXEL_ID').render }
+
+    it 'will push the tracking events to the queue' do
+      expect(subject).to match(%r{fbq\('init', 'PIXEL_ID'\)})
+    end
+
+    it 'will add the noscript fallback' do
+      expect(subject).to match(%r{https://www.facebook.com/tr\?id=PIXEL_ID&ev=PageView&noscript=1})
+    end
+  end
+
+  describe 'with events' do
+    def env
+      {
+        'tracker' => {
+        'facebook_pixel' =>
+          [
+            {
+              'type' => 'Purchase',
+              'class_name' => 'Event',
+              'options' =>
+                {
+                  'value' => '23',
+                  'currency' => 'EUR'
+                }
+            }
+          ]
+        }
+      }
+    end
+    subject { described_class.new(env).render }
+
+    it 'will push the tracking events to the queue' do
+      expect(subject).to match(%r{"track", "Purchase", \{"value":"23","currency":"EUR"\}})
+    end
+
+    it 'will add the noscript fallback' do
+      expect(subject).to match(%r{https://www.facebook.com/tr\?id=&ev=PageView&noscript=1})
+    end
+  end
+end

data/spec/integration/facebook_pixel_integration_spec.rb

@@ -0,0 +1,17 @@
+require 'support/capybara_app_helper'
+
+RSpec.describe "Facebook Pixel Integration" do
+  before do
+    setup_app(action: :facebook_pixel) do |tracker|
+      tracker.handler :facebook_pixel, { id: 'PIXEL_ID' }
+    end
+    visit '/'
+  end
+
+  subject { page }
+
+  it "embeds the script tag with tracking event from the controller action" do
+    expect(page).to have_content("fbq('init', 'PIXEL_ID');")
+    expect(page.body).to include('https://www.facebook.com/tr?id=PIXEL_ID&ev=PageView&noscript=1')
+  end
+end

data/spec/support/metal_controller.rb

@@ -29,6 +29,13 @@ class MetalController < ActionController::Metal
     render "metal/index"
   end
 
+  def facebook_pixel
+    tracker do |t|
+      t.facebook_pixel :track, { id: 'conversion-event', value: '1', currency: 'EUR' }
+    end
+    render "metal/index"
+  end
+
   def google_analytics
     tracker do |t|
       t.google_analytics :ecommerce, { type: 'addTransaction', id: 1234, affiliation: 'Acme Clothing', revenue: 11.99, shipping: 5, tax: 1.29 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-tracker
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Lars Brillert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-10 00:00:00.000000000 Z
+date: 2017-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -153,6 +153,7 @@ files:
 - Gemfile
 - Gemfile.rails-3.2
 - Gemfile.rails-4.2
+- Gemfile.rails-5.1
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -161,8 +162,11 @@ files:
 - lib/rack/tracker/criteo/criteo.rb
 - lib/rack/tracker/criteo/template/criteo.erb
 - lib/rack/tracker/extensions.rb
+- lib/rack/tracker/facebook/README.md
 - lib/rack/tracker/facebook/facebook.rb
 - lib/rack/tracker/facebook/template/facebook.erb
+- lib/rack/tracker/facebook_pixel/facebook_pixel.rb
+- lib/rack/tracker/facebook_pixel/template/facebook_pixel.erb
 - lib/rack/tracker/go_squared/go_squared.rb
 - lib/rack/tracker/go_squared/template/go_squared.erb
 - lib/rack/tracker/google_adwords_conversion/google_adwords_conversion.rb
@@ -187,6 +191,7 @@ files:
 - spec/fixtures/views/layouts/application.html.erb
 - spec/fixtures/views/metal/index.html.erb
 - spec/handler/criteo_spec.rb
+- spec/handler/facebook_pixel_spec.rb
 - spec/handler/facebook_spec.rb
 - spec/handler/go_squared_spec.rb
 - spec/handler/google_adwords_conversion_spec.rb
@@ -196,6 +201,7 @@ files:
 - spec/handler/zanox_spec.rb
 - spec/integration/criteo_integration_spec.rb
 - spec/integration/facebook_integration_spec.rb
+- spec/integration/facebook_pixel_integration_spec.rb
 - spec/integration/go_squared_integration_spec.rb
 - spec/integration/google_adwords_conversion_integration_spec.rb
 - spec/integration/google_analytics_integration_spec.rb
@@ -232,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Tracking made easy
@@ -243,6 +249,7 @@ test_files:
 - spec/fixtures/views/layouts/application.html.erb
 - spec/fixtures/views/metal/index.html.erb
 - spec/handler/criteo_spec.rb
+- spec/handler/facebook_pixel_spec.rb
 - spec/handler/facebook_spec.rb
 - spec/handler/go_squared_spec.rb
 - spec/handler/google_adwords_conversion_spec.rb
@@ -252,6 +259,7 @@ test_files:
 - spec/handler/zanox_spec.rb
 - spec/integration/criteo_integration_spec.rb
 - spec/integration/facebook_integration_spec.rb
+- spec/integration/facebook_pixel_integration_spec.rb
 - spec/integration/go_squared_integration_spec.rb
 - spec/integration/google_adwords_conversion_integration_spec.rb
 - spec/integration/google_analytics_integration_spec.rb