rack-tracker 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42c882f19b618a8ce401d37e6dd5baba8dcc2335
-  data.tar.gz: b841bbdbac1fb8752bbddf6be2c526286a337c04
+  metadata.gz: f55df00d45fb101f47bca6a636ae7767a5fe4cfe
+  data.tar.gz: 32310d9a1103ac86809a3e374e7759de91a4c135
 SHA512:
-  metadata.gz: ad51b4b1fd58c9dcc2f0985d8066fe13b58504cdf4cb6d1397285bb67ae729ea3fdffb119bcd41c2abec7924da3c8887a1668f03468b70b4f941bc8f7cb90e16
-  data.tar.gz: bb7a62cde667581a270cc4036b1413ce15be8c1ad490569210060763c572713611d5bc9ecf1ca3b35640402e0c2eee39c1a6fba29d6d027702eefda7b0d5fdb6
+  metadata.gz: f4b01ad9bbfb3cd1df9e499492beb78bd80bc90fd20217714b6879bfc45009936c73734e0ccd9a03b9c3f29d1af889193ebec944fd13eefdb561cc0e99fe63b7
+  data.tar.gz: 27df0ea951b32d8db3d1e95bd5fd5a309fdce2327169a3606c6cf812bac0fbf3495b537f3d4a5f5b8dfa6e75b7e12f12a2f532596f66f5b77985e97ceee7ba9d

data/README.md

@@ -22,9 +22,11 @@ Or install it yourself as:
 
 Add it to your middleware stack
 
-    config.middleware.use(Rack::Tracker) do
-      handler :google_analytics, { tracker: 'U-XXXXX-Y' }
-    end
+```ruby
+config.middleware.use(Rack::Tracker) do
+  handler :google_analytics, { tracker: 'U-XXXXX-Y' }
+end
+````
 
 This will add Google Analytics as a tracking handler. `Rack::Tracker` some with
 support for Google Analytics and Facebook. Others might be added in the future
@@ -40,20 +42,32 @@ but you can easily write your own handlers.
 * `: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).
 
-### Facebook
+#### Events
+
+To issue [Events](https://developers.google.com/analytics/devguides/collection/analyticsjs/events) from the server side just call the `tracker` method in your controller.
 
-* `custom_audience_id`
+```ruby
+  def show
+    tracker do
+      google_analytics category: 'button', action: 'click', label: 'nav-buttons', value: 'X'
+    end
+  end
+```
+
+The event will show up in the next rendered page. If the next page is a redirect, the event are kept in the session for later use.
+
+### Facebook
 
+* `custom_audience` - adds the [Custom audience](https://developers.facebook.com/docs/reference/ads-api/custom-audience-website-faq) segmentation pixel
 
-## Server side events
+#### Events
 
-When using `rack-tracker` within a Rails application you can track events from
-your controller and the tracking snippit will then populated with this data.
+To track [Conversions](https://www.facebook.com/help/435189689870514) from the server side just call the `tracker` method in your controller.
 
 ```ruby
   def show
     tracker do
-      google_analytics category: 'foo'
+      facebook '123456789', value: 1, currency: 'EUR'
     end
   end
 ```

data/lib/rack/tracker/facebook/facebook.rb

@@ -1,22 +1,24 @@
 class Rack::Tracker::Facebook < Rack::Tracker::Handler
-  self.position = :body
-
-  # options do
-  #   locale 'de_DE'
-  #   app_id
-  #   custom_audience_id
-  # end
+  class Event < OpenStruct
+    attr_reader :id
+    def initialize(id, attributes = {})
+      @id = id
+      super(attributes)
+    end
 
-  # event do
-  #   id
-  #   value
-  #   currency
-  # end
+    def write
+      ['track', @id, to_h.compact].to_json
+    end
+  end
 
-  # position :body
+  self.position = :body
 
   def render
     Tilt.new( File.join( File.dirname(__FILE__), 'template/facebook.erb') ).render(self)
   end
 
+  def self.track(name, *event)
+    { name.to_s => [Event.new(*event)] }
+  end
+
 end

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

@@ -14,27 +14,27 @@
 
 </script>
 
-<% if options[:custom_audience_id] %>
+<% if options[:custom_audience] %>
 <script type="text/javascript">
-window._fbq.push(['addPixelId', '<%= options[:custom_audience_id] %>']);
+window._fbq.push(["addPixelId", "<%= options[:custom_audience] %>"]);
 window._fbq.push(["track", "PixelInitialized", {}]);
 </script>
 
 <noscript>
-  <img height="1" width="1" alt="" style="display:none" src="https://www.facebook.com/tr?id=<%= options[:custom_audience_id] %>&amp;ev=PixelInitialized">
+  <img height="1" width="1" alt="" style="display:none" src="https://www.facebook.com/tr?id=<%= options[:custom_audience] %>&amp;ev=PixelInitialized">
 </noscript>
 <% end %>
 
 <% if events.any? %>
 <script type="text/javascript">
 <% events.each do |event| %>
-window._fbq.push(['track', '<%= event["pixel_id"] %>', {'value': '<%= event["value"] %>', 'currency': '<%= event["currency"] %>'}]);
+window._fbq.push(<%= event.write %>);
 <% end %>
 </script>
 
 <noscript>
   <% events.each do |event| %>
-  <img height="1" width="1" alt="" style="display:none" src="https://www.facebook.com/offsite_event.php?id=<%= event["pixel_id"] %>&amp;value=<%= event["value"] %>&amp;currency=<%= event["currency"] %>">
+  <img height="1" width="1" alt="" style="display:none" src="https://www.facebook.com/offsite_event.php?id=<%= event.id %>&amp;value=<%= event.value %>&amp;currency=<%= event.currency %>">
   <% end %>
 </noscript>
 <% end %>

data/lib/rack/tracker/handler.rb

@@ -18,7 +18,7 @@ class Rack::Tracker::Handler
     raise NotImplementedError.new('needs implementation')
   end
 
-   def self.track(name, event)
+  def self.track(name, event)
     raise NotImplementedError.new("class method `#{__callee__}` is not implemented.")
   end
 end

data/lib/rack/tracker/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Tracker
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/handler/facebook_spec.rb

@@ -1,4 +1,13 @@
 RSpec.describe Rack::Tracker::Facebook do
+  describe Rack::Tracker::Facebook::Event do
+
+    subject { described_class.new('id', {foo: 'bar'}) }
+
+    describe '#write' do
+      specify { expect(subject.write).to eq(['track', 'id', {foo: 'bar'}].to_json) }
+    end
+  end
+
   def env
     {}
   end
@@ -9,10 +18,10 @@ RSpec.describe Rack::Tracker::Facebook do
   end
 
   describe 'with custom audience id' do
-    subject { described_class.new(env, custom_audience_id: 'custom_audience_id').render }
+    subject { described_class.new(env, custom_audience: 'custom_audience_id').render }
 
     it 'will push the tracking events to the queue' do
-      expect(subject).to match(%r{window._fbq.push\(\['addPixelId', 'custom_audience_id'\]\)})
+      expect(subject).to match(%r{window._fbq.push\(\["addPixelId", "custom_audience_id"\]\)})
       expect(subject).to match(%r{window._fbq.push\(\["track", "PixelInitialized", \{\}\]\)})
     end
 
@@ -27,9 +36,10 @@ RSpec.describe Rack::Tracker::Facebook do
         'tracker' => {
         'facebook' =>
           [
-            {'pixel_id' => '123456789',
+            Rack::Tracker::Facebook::Event.new('123456789', {
              'value' => '23',
-             'currency' => 'EUR'}
+             'currency' => 'EUR'
+            })
           ]
         }
       }
@@ -37,7 +47,7 @@ RSpec.describe Rack::Tracker::Facebook do
     subject { described_class.new(env).render }
 
     it 'will push the tracking events to the queue' do
-      expect(subject).to match(%r{\['track', '123456789', \{'value': '23', 'currency': 'EUR'\}\]})
+      expect(subject).to match(%r{\["track","123456789",\{"value":"23","currency":"EUR"\}\]})
     end
 
     it 'will add the noscript fallback' do

data/spec/integration/facebook_integration_spec.rb

@@ -0,0 +1,24 @@
+require 'support/metal_controller'
+require 'support/fake_handler'
+
+RSpec.describe "Facebook Integration" do
+  before do
+    Capybara.app = Rack::Builder.new do
+      use Rack::Tracker do
+        handler :facebook, { custom_audience: 'my-audience' }
+      end
+      run MetalController.action(:facebook)
+    end
+
+    visit '/'
+  end
+
+  subject { page }
+
+  it "embeds the script tag with tracking event from the controller action" do
+    expect(page).to have_content('window._fbq.push(["addPixelId", "my-audience"]);')
+    expect(page.body).to include('https://www.facebook.com/tr?id=my-audience&ev=PixelInitialized')
+    expect(page).to have_content('window._fbq.push(["track","conversion-event",{"value":"1","currency":"EUR"}]);')
+    expect(page.body).to include('https://www.facebook.com/offsite_event.php?id=conversion-event&value=1&currency=EUR')
+  end
+end

data/spec/integration/rails_integration_spec.rb

@@ -1,17 +1,19 @@
 require 'support/metal_controller'
 require 'support/fake_handler'
 
-Capybara.app = Rack::Builder.new do
-  use Rack::Tracker do
-    handler :track_all_the_things, { custom_key: 'SomeKey123' }
-    handler :another_handler, { custom_key: 'AnotherKey42' }
-  end
-  run MetalController.action(:index)
-end
+RSpec.describe "Rails Integration" do
+  before do
+    Capybara.app = Rack::Builder.new do
+      use Rack::Tracker do
+        handler :track_all_the_things, { custom_key: 'SomeKey123' }
+        handler :another_handler, { custom_key: 'AnotherKey42' }
+      end
+      run MetalController.action(:index)
+    end
 
+    visit '/'
+  end
 
-RSpec.describe "Rails Integration" do
-  before { visit '/' }
   subject { page.html.gsub(/^\s*/, '') }
 
   let(:expected_html) do

data/spec/support/metal_controller.rb

@@ -14,4 +14,11 @@ class MetalController < ActionController::Metal
     end
     render "metal/index"
   end
+
+  def facebook
+    tracker do
+      facebook 'conversion-event', { value: '1', currency: 'EUR' }
+    end
+    render "metal/index"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-tracker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Lars Brillert
@@ -15,126 +15,126 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.4.1
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.1.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.1.5
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Don’t fool around with adding tracking partials to your app and concentrate
@@ -146,9 +146,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -172,6 +172,7 @@ files:
 - spec/fixtures/views/metal/index.html.erb
 - spec/handler/facebook_spec.rb
 - spec/handler/google_analytics_spec.rb
+- spec/integration/facebook_integration_spec.rb
 - spec/integration/rails_integration_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_handler.rb
@@ -190,12 +191,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -212,6 +213,7 @@ test_files:
 - spec/fixtures/views/metal/index.html.erb
 - spec/handler/facebook_spec.rb
 - spec/handler/google_analytics_spec.rb
+- spec/integration/facebook_integration_spec.rb
 - spec/integration/rails_integration_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_handler.rb