rack-tracker 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9d098ca10113dc7340ab5e268dec40e8b0143a0d1284d1caaeac155510c1bd6
-  data.tar.gz: c84e057fd1021e504ff749fd5a70e3a79ced5343d39720af987fb5b3783a38b3
+  metadata.gz: 36432546f568d8bd4224d5009397e5dbaa6481977b605c7faaa4248caa527a0c
+  data.tar.gz: 54aa497e17eda29100f863958db67dc9a8a68331f580719d2c425e4cf8325341
 SHA512:
-  metadata.gz: 4a140e3e30f813d916adec3e6a6aed6919b53d72281d2880ae81ecc035d980c9c330fce2b0bd85497bb92e20172db0aa5bffa8edd0e9fd538f15380be66124aa
-  data.tar.gz: 357e0828908134f96ed5370554b17d9ecdce43a098493471dc9a5807e1af7f186ce05bb7a5674ac2f36a0f6eddefdf93742be93f8682573266065bd368c087d6
+  metadata.gz: b1eb4c67eeddaae64d5f539d2d276fdb19e5bfded706e5e0156f68ab3edb4a1bcb159fdb959bba69f0480c7068397d7a2bb38f1e9476c6a98670199eacbccc0e
+  data.tar.gz: a927f10a586c038598836ed80528ee3ecc7d122dfb22d63b43a5c88dff06cb98b6472dd0eb7fea7affe2a8a89a1b1eed9802b5294e83efe150b92c0eca430e31

data/.travis.yml

@@ -1,18 +1,13 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.1.10
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.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
+  - Gemfile.rails-5.2

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.9.0
+
+ * [ENHANCEMENT] Integration for Bing tracking #131 (thx @pcraston)
+ * [ENHANCEMENT] Possibility to integrate Google Optimize ID into the allowed tracker options #127 (thx @nachoabad)
+ * [ENHANCEMENT] Support for google global events #126 (thx @atd)
+
 # 1.8.0
 
  * [ENHANCEMENT] Google Global Site Tag: basic integration with support for pageviews to Google global tag #123 (thx @atd)

data/Gemfile.rails-5.2

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

data/README.md

@@ -120,6 +120,7 @@ request.env['tracker'] = {
 * `:link_attribution` - Enables [Enhanced Link Attribution](https://developers.google.com/analytics/devguides/collection/gtagjs/enhanced-link-attribution).
 * `:allow_display_features` - Can be used to disable [Display Features](https://developers.google.com/analytics/devguides/collection/gtagjs/display-features).
 * `:custom_map` - Used to [Configure and send custom dimensions](https://developers.google.com/analytics/devguides/collection/gtagjs/custom-dims-mets)
+* `:optimize_id` - Used to [Deploy Optimize using gtag](https://support.google.com/optimize/answer/7513085)
 * `:set` - Used in the [set command to configure multiple properties](https://developers.google.com/analytics/devguides/collection/gtagjs/setting-values)
 
 #### Trackers
@@ -575,6 +576,31 @@ config.middleware.use(Rack::Tracker) do
 end
 ```
 
+### Bing
+
+[Bing](https://bingads.microsoft.com/)
+
+To add the tracking snippet:
+
+```
+config.middleware.use(Rack::Tracker) do
+  handler :bing, { tracker: '12345678' }
+end
+```
+
+To send conversion events:
+```
+tracker do |t|
+  t.bing :conversion, {
+    type: 'event',
+    category: 'Users',
+    action: 'Login',
+    label: 'Standard',
+    value: 10
+  }
+end
+```
+
 
 ### Custom Handlers
 

data/lib/rack/tracker.rb

@@ -23,6 +23,7 @@ require "rack/tracker/go_squared/go_squared"
 require "rack/tracker/criteo/criteo"
 require "rack/tracker/zanox/zanox"
 require "rack/tracker/hotjar/hotjar"
+require "rack/tracker/bing/bing"
 
 module Rack
   class Tracker

data/lib/rack/tracker/bing/bing.rb

@@ -0,0 +1,12 @@
+class Rack::Tracker::Bing < Rack::Tracker::Handler
+
+  class Conversion < OpenStruct
+  end
+
+  self.position = :body
+
+  def tracker
+    options[:tracker].respond_to?(:call) ? options[:tracker].call(env) : options[:tracker]
+  end
+
+end

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

@@ -0,0 +1,22 @@
+<% if events.any? %>
+<script src="//bat.bing.com/bat.js" async=""></script>
+<script>
+  window.uetq = window.uetq || [];
+  <% events.each do |event| %>
+  window.uetq.push({ 'ec': '<%= event.category %>', 'ea': '<%= event.action %>', 'el': '<%= event.label %>', 'ev': <%= event.value %> });
+  <% end %>
+</script>
+<% end %>
+
+
+<script>(function (w, d, t, r, u) {
+  var f, n, i;
+  w[u] = w[u] || [], f = function () {
+    var o = {ti: "<%= tracker %>"};
+    o.q = w[u], w[u] = new UET(o), w[u].push("pageLoad")
+  }, n = d.createElement(t), n.src = r, n.async = 1, n.onload = n.onreadystatechange = function () {
+    var s = this.readyState;
+    s && s !== "loaded" && s !== "complete" || (f(), n.onload = n.onreadystatechange = null)
+  }, i = d.getElementsByTagName(t)[0], i.parentNode.insertBefore(n, i)
+})(window, document, "script", "//bat.bing.com/bat.js", "uetq");
+</script>

data/lib/rack/tracker/google_global/google_global.rb

@@ -1,7 +1,7 @@
 class Rack::Tracker::GoogleGlobal < Rack::Tracker::Handler
   self.allowed_tracker_options = [:cookie_domain, :user_id,
     :link_attribution, :allow_display_features, :anonymize_ip,
-    :custom_map]
+    :custom_map, :optimize_id]
 
   class Page < OpenStruct
     def params
@@ -9,8 +9,30 @@ class Rack::Tracker::GoogleGlobal < Rack::Tracker::Handler
     end
   end
 
+  class Event < OpenStruct
+    PREFIXED_PARAMS = %i[category label]
+    LITERAL_PARAMS  = %i[value]
+    PARAMS = PREFIXED_PARAMS + LITERAL_PARAMS
+
+    def params
+      Hash[to_h.slice(*PARAMS).map { |key, value| [param_key(key), value] }]
+    end
+
+    private
+
+    def param_key(key)
+      PREFIXED_PARAMS.include?(key) ? "event_#{key}" : key.to_s
+    end
+  end
+
   def pages
-    events # TODO: Filter pages after Event is implemented
+    select_handler_events(Page)
+  end
+
+  alias handler_events events
+
+  def events
+    select_handler_events(Event)
   end
 
   def trackers
@@ -29,4 +51,8 @@ class Rack::Tracker::GoogleGlobal < Rack::Tracker::Handler
     value = options[:set]
     value.respond_to?(:call) ? value.call(env) : value
   end
+
+  def select_handler_events(klass)
+    handler_events.select { |event| event.is_a?(klass) }
+  end
 end

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

@@ -15,5 +15,9 @@
     <% end %>
     gtag('config', '<%= tracker[:id] %>', <%= tracker_options.to_json %>);
   <% end %>
+
+  <% events.each do |event| %>
+    gtag('event', '<%= event.action %>', <%= event.params.to_json %>);
+  <% end %>
 </script>
 <% end %>

data/lib/rack/tracker/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Tracker
-    VERSION = '1.8.0'
+    VERSION = '1.9.0'
   end
 end

data/rack-tracker.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 3.0'
 
   spec.add_development_dependency 'actionpack', '>= 3.0'
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler", ">= 1.16"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "capybara", "~> 2.4"

data/spec/handler/bing_spec.rb

@@ -0,0 +1,53 @@
+RSpec.describe Rack::Tracker::Bing do
+
+  it 'will be placed in the body' do
+    expect(described_class.position).to eq(:body)
+  end
+
+  describe "with events" do
+    subject { described_class.new(env, tracker: 'somebody').render }
+
+    describe "default" do
+      def env
+        {'tracker' => {
+          'bing' => [
+            { 'class_name' => 'Conversion', 'category' => 'Users', 'action' => 'Login', 'label' => 'Standard', 'value' => 10 }
+          ]
+        }}
+      end
+
+      it "will show event initialiser" do
+        expect(subject).to include "window.uetq = window.uetq || [];"
+      end
+
+      it "will show events" do
+        expect(subject).to include "window.uetq.push({ 'ec': 'Users', 'ea': 'Login', 'el': 'Standard', 'ev': 10 });"
+      end
+    end
+  end
+
+  describe "with multiple events" do
+    subject { described_class.new(env, tracker: 'somebody').render }
+
+    describe "default" do
+      def env
+        {'tracker' => {
+          'bing' => [
+            { 'class_name' => 'Conversion', 'category' => 'Users', 'action' => 'Login', 'label' => 'Standard', 'value' => 10 },
+            { 'class_name' => 'Conversion', 'category' => 'Users', 'action' => 'Logout', 'label' => 'Standard', 'value' => 5 }
+          ]
+        }}
+      end
+
+      it "will show event initialiser" do
+        expect(subject).to include "window.uetq = window.uetq || [];"
+      end
+
+      it "will show events" do
+        expect(subject).to include "window.uetq.push({ 'ec': 'Users', 'ea': 'Login', 'el': 'Standard', 'ev': 10 });"
+        expect(subject).to include "window.uetq.push({ 'ec': 'Users', 'ea': 'Logout', 'el': 'Standard', 'ev': 5 });"
+      end
+    end
+  end
+
+end

data/spec/handler/google_global_spec.rb

@@ -184,4 +184,40 @@ RSpec.describe Rack::Tracker::GoogleGlobal do
       end
     end
   end
+
+  describe "with events" do
+    subject { described_class.new(env, trackers: [{ id: 'somebody' }]).render }
+
+    describe "default" do
+      def env
+        {'tracker' => {
+          'google_global' => [
+            { 'class_name' => 'Event', 'action' => 'login' }
+          ]
+        }}
+      end
+
+      it "will show the event" do
+        expect(subject).to match(%r{gtag\('event', 'login', {}\);})
+      end
+    end
+
+    describe "with event parameters" do
+      def env
+        {'tracker' => {
+          'google_global' => [
+            { 'class_name' => 'Event',
+              'action'     => 'login',
+              'category'   => 'engagement',
+              'label'      => 'Github',
+              'value'      => 5 }
+          ]
+        }}
+      end
+
+      it "will show event" do
+        expect(subject).to match(%r{gtag\('event', 'login', {\"event_category\":\"engagement\",\"event_label\":\"Github\",\"value\":5}\);})
+      end
+    end
+  end
 end

data/spec/integration/bing_integration_spec.rb

@@ -0,0 +1,17 @@
+require 'support/capybara_app_helper'
+
+RSpec.describe "Bing Integration" do
+  before do
+    setup_app(action: :bing) do |tracker|
+      tracker.handler :bing, { tracker: '12345678' }
+    end
+    visit '/'
+  end
+
+  subject { page }
+
+  it "embeds the script tag with tracker" do
+    expect(page.find("body")).to have_content('var o = {ti: "12345678"};')
+  end
+
+end

data/spec/support/metal_controller.rb

@@ -116,4 +116,8 @@ class MetalController < ActionController::Metal
   def hotjar
     render "metal/index"
   end
+
+  def bing
+    render "metal/index"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-tracker
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Lars Brillert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-31 00:00:00.000000000 Z
+date: 2019-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -71,16 +71,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -153,11 +153,13 @@ files:
 - Gemfile
 - Gemfile.rails-3.2
 - Gemfile.rails-4.2
-- Gemfile.rails-5.1
+- Gemfile.rails-5.2
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/rack/tracker.rb
+- lib/rack/tracker/bing/bing.rb
+- lib/rack/tracker/bing/template/bing.erb
 - lib/rack/tracker/controller.rb
 - lib/rack/tracker/criteo/criteo.rb
 - lib/rack/tracker/criteo/template/criteo.erb
@@ -197,6 +199,7 @@ files:
 - spec/fixtures/views/layouts/application.html.erb
 - spec/fixtures/views/metal/index.html.erb
 - spec/fixtures/views/metal/turing.html.erb
+- spec/handler/bing_spec.rb
 - spec/handler/criteo_spec.rb
 - spec/handler/facebook_pixel_spec.rb
 - spec/handler/facebook_spec.rb
@@ -209,6 +212,7 @@ files:
 - spec/handler/hotjar_spec.rb
 - spec/handler/vwo_spec.rb
 - spec/handler/zanox_spec.rb
+- spec/integration/bing_integration_spec.rb
 - spec/integration/criteo_integration_spec.rb
 - spec/integration/facebook_integration_spec.rb
 - spec/integration/facebook_pixel_integration_spec.rb
@@ -249,8 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Tracking made easy
@@ -262,6 +265,7 @@ test_files:
 - spec/fixtures/views/layouts/application.html.erb
 - spec/fixtures/views/metal/index.html.erb
 - spec/fixtures/views/metal/turing.html.erb
+- spec/handler/bing_spec.rb
 - spec/handler/criteo_spec.rb
 - spec/handler/facebook_pixel_spec.rb
 - spec/handler/facebook_spec.rb
@@ -274,6 +278,7 @@ test_files:
 - spec/handler/hotjar_spec.rb
 - spec/handler/vwo_spec.rb
 - spec/handler/zanox_spec.rb
+- spec/integration/bing_integration_spec.rb
 - spec/integration/criteo_integration_spec.rb
 - spec/integration/facebook_integration_spec.rb
 - spec/integration/facebook_pixel_integration_spec.rb

data/Gemfile.rails-5.1

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