rack-tracker 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 369334fdcc3574d943a28e93c42476ce029c226a
-  data.tar.gz: fcfbf2f2ead245e817a73a097b61ad3f4bf1101f
+  metadata.gz: 93dcd33285ad07b72e75cabe697bffa820b2212d
+  data.tar.gz: 2cfbf93add60fb26e91bf9f703b3dda0bc9aff95
 SHA512:
-  metadata.gz: 7a7ec8fb308171822fb8099dc229c3b881533c0449db0e09fdd0d063682a9a509199b650644dd6b2efacbfec22c7d1c15a3597fd9ca4f3d4b6decacbbecbba46
-  data.tar.gz: 655b2bb4713d4637bad055fba0aaa0753a9079fb5858746085bd420ba95525743acc5993cb84d7a6d3d1b88858492bbffdab962e0e26624460689d8d2e3be659
+  metadata.gz: c10ddd4e7a5abba1887219909bf4480c79a2b5775f81f072cab6cc40df914ec29b6dcce4eaf8609ff8087d284c154aaf6b34c64bb3ae5fb7c524d47c8b5fab26
+  data.tar.gz: 42310ccab992b9d71cd5817e1c6cc989cc4271d13c2ac628b3673f12712f9c1a01221e64b27528b622b41dfe4d1d01b74cb2eec9e3f1e2fc5e825a390a0e282a

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.5.0
+
+  * [ENHANCEMENT] facebook pixel now supports non-standard (custom) event names #93
+
 # 1.4.0
 
   * [ENHANCEMENT] welcome Hotjar! #90

data/README.md

@@ -293,6 +293,15 @@ Will result in the following:
   fbq("track", "Purchase", {"value":"100.0","currency":"USD"});
 ```
 
+You can also use non-standard (custom) event names for audience building when you do not need to track or optimize for conversions.
+
+```
+  tracker do |t|
+    t.facebook_pixel :track_custom, { type: 'FrequentShopper', options: { purchases: 24, category: 'Sport' } }
+  end
+```
+
+
 ### Visual website Optimizer (VWO)
 Just integrate the handler with your matching account_id and you will be ready to go
 

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

@@ -1,4 +1,6 @@
 class Rack::Tracker::FacebookPixel < Rack::Tracker::Handler
+  self.position = :body
+
   class Event < OpenStruct
     def write
       options.present? ? type_to_json << options_to_json : type_to_json
@@ -15,9 +17,15 @@ class Rack::Tracker::FacebookPixel < Rack::Tracker::Handler
     end
   end
 
-  self.position = :body
+  class Track < Event
+    def name
+      'track'
+    end
+  end
 
-  def self.track(name, *event)
-    { name.to_s => [event.last.merge('class_name' => 'Event')] }
+  class TrackCustom < Event
+    def name
+      'trackCustom'
+    end
   end
 end

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

@@ -18,7 +18,7 @@
 <% if events.any? %>
   <script type="text/javascript">
     <% events.each do |event| %>
-      fbq("track", <%= event.write %>);
+      fbq("<%= event.name %>", <%= event.write %>);
     <% end %>
   </script>
 <% end %>

data/lib/rack/tracker/go_squared/go_squared.rb

@@ -26,8 +26,4 @@ class Rack::Tracker::GoSquared < Rack::Tracker::Handler
   def visitor_info
     events.select{|e| e.kind_of?(VisitorInfo) }.first
   end
-
-  def self.track(name, *event)
-    { name.to_s => [event.last.merge('class_name' => event.first.to_s.classify)] }
-  end
 end

data/lib/rack/tracker/google_adwords_conversion/google_adwords_conversion.rb

@@ -1,11 +1,6 @@
 class Rack::Tracker::GoogleAdwordsConversion < Rack::Tracker::Handler
-
   class Conversion < OpenStruct
   end
 
   self.position = :body
-
-  def self.track(name, *event)
-    { name.to_s => [event.last.merge('class_name' => event.first.to_s.capitalize)] }
-  end
 end

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

@@ -74,8 +74,4 @@ class Rack::Tracker::GoogleAnalytics < Rack::Tracker::Handler
   def enhanced_ecommerce_events
     events.select {|e| e.kind_of?(EnhancedEcommerce) }
   end
-
-  def self.track(name, *event)
-    { name.to_s => [event.last.merge('class_name' => event.first.to_s.classify)] }
-  end
 end

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

@@ -30,8 +30,4 @@ class Rack::Tracker::GoogleTagManager < Rack::Tracker::Handler
   def render_body
     Tilt.new( File.join( File.dirname(__FILE__), 'template', 'google_tag_manager_body.erb') ).render(self)
   end
-
-  def self.track(name, *event)
-    { name.to_s => [event.last.merge('class_name' => event.first.to_s.capitalize)] }
-  end
 end

data/lib/rack/tracker/handler.rb

@@ -4,8 +4,9 @@ class Rack::Tracker::Handler
       new(env).write_event(track(method_name, *args, &block))
     end
 
-    def track(name, event)
-      raise NotImplementedError.new("class method `#{__callee__}` is not implemented.")
+    # overwrite me in the handler subclass if you need more control over the event
+    def track(name, *event)
+      { name.to_s => [event.last.merge('class_name' => event.first.to_s.classify)] }
     end
   end
 
@@ -25,8 +26,8 @@ class Rack::Tracker::Handler
   end
 
   def events
-    events = env.fetch('tracker', {})[self.class.to_s.demodulize.underscore] || []
-    events.map{ |ev| "#{self.class}::#{ev['class_name']}".constantize.new(ev.except('class_name')) }
+    events = env.fetch('tracker', {})[handler_name] || []
+    events.map { |ev| "#{self.class}::#{ev['class_name']}".constantize.new(ev.except('class_name')) }
   end
 
   def render

data/lib/rack/tracker/version.rb

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

data/lib/rack/tracker/zanox/zanox.rb

@@ -36,9 +36,4 @@ class Rack::Tracker::Zanox < Rack::Tracker::Handler
   def sale_events
     events.select{ |event| event.class.to_s.demodulize == 'Sale' }
   end
-
-  # this is called with additional arguments to t.zanox
-  def self.track(name, *event)
-    { name.to_s => [event.last.merge('class_name' => event.first.to_s.capitalize)] }
-  end
 end

data/spec/handler/facebook_pixel_spec.rb

@@ -1,13 +1,4 @@
 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
@@ -37,12 +28,20 @@ RSpec.describe Rack::Tracker::FacebookPixel do
           [
             {
               'type' => 'Purchase',
-              'class_name' => 'Event',
+              'class_name' => 'Track',
               'options' =>
                 {
                   'value' => '23',
                   'currency' => 'EUR'
                 }
+            },{
+              'type' => 'FrequentShopper',
+              'class_name' => 'TrackCustom',
+              'options' =>
+                {
+                  'purchases' => 8,
+                  'category' => 'Sport'
+                }
             }
           ]
         }
@@ -52,6 +51,7 @@ RSpec.describe Rack::Tracker::FacebookPixel do
 
     it 'will push the tracking events to the queue' do
       expect(subject).to match(%r{"track", "Purchase", \{"value":"23","currency":"EUR"\}})
+      expect(subject).to match(%r{"trackCustom", "FrequentShopper", \{"purchases":8,"category":"Sport"\}})
     end
 
     it 'will add the noscript fallback' do

data/spec/integration/facebook_pixel_integration_spec.rb

@@ -14,4 +14,13 @@ RSpec.describe "Facebook Pixel Integration" 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
+
+  it 'tracks multiple events' do
+    expect(page.body).to match(/fbq\("track", "Purchase", {\"value\":42,\"currency\":\"USD\"}\);/)
+    expect(page.body).to match(/fbq\("track", "CompleteRegistration", {\"value\":0.75,\"currency\":\"EUR\"}\);/)
+  end
+
+  it "can use non-standard event names for audience building" do
+    expect(page.body).to match(/fbq\("trackCustom", "FrequentShopper", {\"purchases\":24,\"category\":\"Sport\"}/)
+  end
 end

data/spec/support/metal_controller.rb

@@ -43,7 +43,9 @@ class MetalController < ActionController::Metal
 
   def facebook_pixel
     tracker do |t|
-      t.facebook_pixel :track, { id: 'conversion-event', value: '1', currency: 'EUR' }
+      t.facebook_pixel :track, { type: 'Purchase', options: { value: 42, currency: 'USD' } }
+      t.facebook_pixel :track, { type: 'CompleteRegistration', options: { value: 0.75, currency: 'EUR' } }
+      t.facebook_pixel :track_custom, { type: 'FrequentShopper', options: { purchases: 24, category: 'Sport' } }
     end
     render "metal/index"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-tracker
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Lars Brillert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-25 00:00:00.000000000 Z
+date: 2017-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack