rack-tracker 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55705dd46c88e815dd7b0187c3d6d2a50b36a79f5ccc52e801a96d282ba348be
-  data.tar.gz: 5cad1746a043405f4f0e1b2cf85904dd9a6daa50923199d77d71bb32b7a357ba
+  metadata.gz: e9d098ca10113dc7340ab5e268dec40e8b0143a0d1284d1caaeac155510c1bd6
+  data.tar.gz: c84e057fd1021e504ff749fd5a70e3a79ced5343d39720af987fb5b3783a38b3
 SHA512:
-  metadata.gz: 0ea613048f9899f3c532eee40c7dd40ed9e4c6c6623f318df1522bbb11e3a05656bb3b96adf0b3b46bd10e33c34f9ab5774c7d48402e1830e3efff2042b144e2
-  data.tar.gz: ea8b57893ebdcc970e55085f20cefc4cdb1e18f5172b6e44cc3c54a2189335109cafe0694e30854edaa90ed3f3d8330051dc2619b7826f3a5180cb168ea129d3
+  metadata.gz: 4a140e3e30f813d916adec3e6a6aed6919b53d72281d2880ae81ecc035d980c9c330fce2b0bd85497bb92e20172db0aa5bffa8edd0e9fd538f15380be66124aa
+  data.tar.gz: 357e0828908134f96ed5370554b17d9ecdce43a098493471dc9a5807e1af7f186ce05bb7a5674ac2f36a0f6eddefdf93742be93f8682573266065bd368c087d6

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.8.0
+
+ * [ENHANCEMENT] Google Global Site Tag: basic integration with support for pageviews to Google global tag #123 (thx @atd)
+
 # 1.7.0
 
   * [BUGFIX] dup response string in Rack::Tracker#inject to avoid RuntimeError #114 (thx @zpfled)

data/README.md

@@ -20,6 +20,7 @@ to the middleware stack the second part are the service-handlers that you're goi
 in your application. It's easy to add your own [custom handlers](#custom-handlers),
 but to get you started we're shipping support for the following services out of the box:
 
+* [Google Global Site Tag](#google-global)
 * [Google Analytics](#google-analytics)
 * [Google Adwords Conversion](#google-adwords-conversion)
 * [Google Tag Manager](#google-tag-manager)
@@ -111,6 +112,27 @@ request.env['tracker'] = {
 }
 ```
 
+### Google Global Site Tag (gtag.js)
+
+* `:anonymize_ip` -  sets the tracker to remove the last octet from all IP addresses, see https://developers.google.com/analytics/devguides/collection/gtagjs/ip-anonymization for details.
+* `:cookie_domain` -  sets the domain name for the [GATC cookies](https://developers.google.com/analytics/devguides/collection/gtagjs/cookies-user-id). 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/gtagjs/cookies-user-id). Ex: `user_id: lambda { |env| env['rack.session']['user_id'] }` would return the user_id from the session.
+* `: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)
+* `:set` - Used in the [set command to configure multiple properties](https://developers.google.com/analytics/devguides/collection/gtagjs/setting-values)
+
+#### Trackers
+
+Google Global Site tag allows configuring multiple trackers. Use the tracker option to configure the ids:
+
+
+```ruby
+config.middleware.use(Rack::Tracker) do
+  handler :google_global, { trackers: [ { id: 'U-XXXXX-Y' }, { id: 'U-WWWWWW-Z'} ] }
+end
+```
+
 ### Google Analytics
 
 * `: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.

data/lib/rack/tracker.rb

@@ -13,6 +13,7 @@ require "rack/tracker/handler"
 require "rack/tracker/handler_delegator"
 require "rack/tracker/controller"
 require "rack/tracker/google_analytics/google_analytics"
+require "rack/tracker/google_global/google_global"
 require "rack/tracker/google_tag_manager/google_tag_manager"
 require "rack/tracker/google_adwords_conversion/google_adwords_conversion"
 require "rack/tracker/facebook/facebook"

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

@@ -0,0 +1,32 @@
+class Rack::Tracker::GoogleGlobal < Rack::Tracker::Handler
+  self.allowed_tracker_options = [:cookie_domain, :user_id,
+    :link_attribution, :allow_display_features, :anonymize_ip,
+    :custom_map]
+
+  class Page < OpenStruct
+    def params
+      Hash[to_h.slice(:title, :location, :path).map { |key, value| ["page_#{key}", value] }]
+    end
+  end
+
+  def pages
+    events # TODO: Filter pages after Event is implemented
+  end
+
+  def trackers
+    options[:trackers].map { |tracker|
+      tracker[:id].respond_to?(:call) ? tracker.merge(id: tracker[:id].call(env)) : tracker
+    }.reject { |tracker| tracker[:id].nil? }
+  end
+
+  def set_options
+    @_set_options ||= build_set_options
+  end
+
+  private
+
+  def build_set_options
+    value = options[:set]
+    value.respond_to?(:call) ? value.call(env) : value
+  end
+end

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

@@ -0,0 +1,19 @@
+<% if trackers %>
+<script async src='https://www.googletagmanager.com/gtag/js?id=<%= trackers[0][:id] %>'></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+  function gtag(){dataLayer.push(arguments)};
+  gtag('js', new Date());
+
+  <% if set_options %>
+    gtag('set', <%= set_options.to_json %>);
+  <% end %>
+
+  <% trackers.each do |tracker| %>
+    <% pages.each do |page| %>
+      gtag('config', '<%= tracker[:id] %>', <%= tracker_options.merge(page.params).to_json %>);
+    <% end %>
+    gtag('config', '<%= tracker[:id] %>', <%= tracker_options.to_json %>);
+  <% end %>
+</script>
+<% end %>

data/lib/rack/tracker/handler.rb

@@ -68,7 +68,8 @@ class Rack::Tracker::Handler
   def tracker_options
     @_tracker_options ||= {}.tap do |tracker_options|
       options.slice(*allowed_tracker_options).each do |key, value|
-        if option_value = value.respond_to?(:call) ? value.call(env) : value
+        option_value = value.respond_to?(:call) ? value.call(env) : value
+        unless option_value.nil? 
           tracker_options[tracker_option_key(key)] = tracker_option_value(option_value)
         end
       end

data/lib/rack/tracker/version.rb

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

data/spec/handler/google_global_spec.rb

@@ -0,0 +1,187 @@
+RSpec.describe Rack::Tracker::GoogleGlobal do
+  def env
+    {
+      misc: 'foobar',
+      user_id: '123'
+    }
+  end
+
+  it 'will be placed in the head' do
+    expect(described_class.position).to eq(:head)
+    expect(described_class.new(env).position).to eq(:head)
+    expect(described_class.new(env, position: :body).position).to eq(:body)
+  end
+
+  describe '#tracker_options' do
+    context 'with an allowed option configured with a static value' do
+      subject { described_class.new(env, user_id: 'value') }
+
+      it 'returns hash with option set' do
+        expect(subject.tracker_options).to eql ({ user_id: 'value' })
+      end
+    end
+
+    context 'with an allowed option configured with a block' do
+      subject { described_class.new(env, user_id: lambda { |env| return env[:misc] }) }
+
+      it 'returns hash with option set' do
+        expect(subject.tracker_options).to eql ({ user_id: 'foobar' })
+      end
+    end
+
+    context 'with an allowed option configured with a block returning nil' do
+      subject { described_class.new(env, user_id: lambda { |env| return env[:non_existing_key] }) }
+
+      it 'returns an empty hash' do
+        expect(subject.tracker_options).to eql ({})
+      end
+    end
+
+    context 'with a non allowed option' do
+      subject { described_class.new(env, new_option: 'value') }
+
+      it 'returns an empty hash' do
+        expect(subject.tracker_options).to eql ({})
+      end
+    end
+  end
+
+  describe '#set_options' do
+    context 'with option configured with a static value' do
+      subject { described_class.new(env, set: { option: 'value' }) }
+
+      it 'returns hash with option set' do
+        expect(subject.set_options).to eql ({ option: 'value' })
+      end
+    end
+
+    context 'with option configured with a block' do
+      subject { described_class.new(env, set: lambda { |env| return { option: env[:misc] } }) }
+
+      it 'returns hash with option set' do
+        expect(subject.set_options).to eql ({ option: 'foobar' })
+      end
+    end
+
+    context 'with option configured with a block returning nil' do
+      subject { described_class.new(env, set: lambda { |env| return env[:non_existing_key] }) }
+
+      it 'returns nil' do
+        expect(subject.set_options).to be nil
+      end
+    end
+  end
+  describe "with custom domain" do
+    let(:tracker) { { id: 'somebody'}}
+    let(:options) { { cookie_domain: "railslabs.com", trackers: [tracker] } }
+    subject { described_class.new(env, options).render }
+
+    it "will show asyncronous tracker with cookie_domain" do
+      expect(subject).to match(%r{gtag\('config', 'somebody', {\"cookie_domain\":\"railslabs.com\"}\)})
+    end
+  end
+
+  describe "with user_id tracking" do
+    let(:tracker) { { id: 'somebody'}}
+    let(:options) { { user_id: lambda { |env| return env[:user_id] }, trackers: [tracker] } }
+    subject { described_class.new(env, options).render }
+
+    it "will show asyncronous tracker with userId" do
+      expect(subject).to match(%r{gtag\('config', 'somebody', {\"user_id\":\"123\"}\)})
+    end
+  end
+
+  describe "with link_attribution" do
+    let(:tracker) { { id: 'happy'}}
+    let(:options) { { link_attribution: true, trackers: [tracker] } }
+    subject { described_class.new(env, options).render }
+
+    it "will show asyncronous tracker with link_attribution" do
+      expect(subject).to match(%r{gtag\('config', 'happy', {\"link_attribution\":true}\)})
+    end
+  end
+
+  describe "with allow_display_features" do
+    let(:tracker) { { id: 'happy'}}
+    let(:options) { { allow_display_features: false, trackers: [tracker] } }
+    subject { described_class.new(env, options).render }
+
+    it "will disable display features" do
+      expect(subject).to match(%r{gtag\('config', 'happy', {\"allow_display_features\":false}\)})
+    end
+  end
+
+  describe "with anonymizeIp" do
+    let(:tracker) { { id: 'happy'}}
+    let(:options) { { anonymize_ip: true, trackers: [tracker] } }
+    subject { described_class.new(env, options).render }
+
+    it "will set anonymizeIp to true" do
+      expect(subject).to match(%r{gtag\('config', 'happy', {\"anonymize_ip\":true}\)})
+    end
+  end
+
+  describe "with dynamic tracker" do
+    let(:tracker) { { id: lambda { |env| return env[:misc] } }}
+    let(:options) { { trackers: [tracker] } }
+    subject { described_class.new(env, options).render }
+
+    it 'will call tracker lambdas to obtain tracking codes' do
+      expect(subject).to match(%r{gtag\('config', 'foobar', {}\)})
+    end
+  end
+
+  describe "with empty tracker" do
+    let(:present_tracker) { { id: 'present' }}
+    let(:empty_tracker) { { id: lambda { |env| return } }}
+    let(:options) { { trackers: [present_tracker, empty_tracker] } }
+    subject { described_class.new(env, options).render }
+
+    it 'will not render config' do
+      expect(subject).to match(%r{gtag\('config', 'present', {}\)})
+      expect(subject).not_to match(%r{gtag\('config', '', {}\)})
+    end
+  end
+
+  describe "with set options" do
+    let(:tracker) { { id: 'with_options' } }
+    let(:options) { { trackers: [tracker], set: { foo: 'bar' } } }
+    subject { described_class.new(env, options).render }
+
+    it 'will show set command' do
+      expect(subject).to match(%r{gtag\('set', {\"foo\":\"bar\"}\)})
+    end
+  end
+
+  describe "with virtual pages" do
+    subject { described_class.new(env, trackers: [{ id: 'somebody' }]).render }
+
+    describe "default" do
+      def env
+        {'tracker' => {
+          'google_global' => [
+            { 'class_name' => 'Page', 'path' => '/virtual_page' }
+          ]
+        }}
+      end
+
+      it "will show virtual page" do
+        expect(subject).to match(%r{gtag\('config', 'somebody', {\"page_path\":\"/virtual_page\"}\);})
+      end
+    end
+
+    describe "with a event value" do
+      def env
+        {'tracker' => {
+          'google_global' => [
+            { 'class_name' => 'Page', 'path' => '/virtual_page', 'location' => 'https://example.com/virtual_page', 'title' => 'Virtual Page' }
+          ]
+        }}
+      end
+
+      it "will show virtual page" do
+        expect(subject).to match(%r{gtag\('config', 'somebody', {\"page_title\":\"Virtual Page\",\"page_location\":\"https:\/\/example.com\/virtual_page\",\"page_path\":\"/virtual_page\"}\);})
+      end
+    end
+  end
+end

data/spec/integration/google_global_integration_spec.rb

@@ -0,0 +1,30 @@
+require 'support/capybara_app_helper'
+
+RSpec.describe "Google Global Integration Integration" do
+  before do
+    setup_app(action: :google_global) do |tracker|
+      tracker.handler :google_global, trackers: [{ id: 'U-XXX-Y' }]
+    end
+    visit '/'
+  end
+
+  subject { page }
+
+  it "embeds the script tag with tracking event from the controller action" do
+    expect(page.find("head")).to have_content('U-XXX-Y')
+  end
+
+  describe 'adjust tracker position via options' do
+    before do
+      setup_app(action: :google_global) do |tracker|
+        tracker.handler :google_global, trackers: [{ id: 'U-XXX-Y' }], position: :body
+      end
+      visit '/'
+    end
+
+    it "will be placed in the specified tag" do
+     expect(page.find("head")).to_not have_content('U-XXX-Y')
+     expect(page.find("body")).to have_content('U-XXX-Y')
+    end
+  end
+end

data/spec/support/metal_controller.rb

@@ -61,6 +61,10 @@ class MetalController < ActionController::Metal
     render "metal/index"
   end
 
+  def google_global
+    render "metal/index"
+  end
+
   def google_tag_manager
     unless params[:no_events]
       tracker do |t|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-tracker
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Lars Brillert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-19 00:00:00.000000000 Z
+date: 2019-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -173,6 +173,8 @@ files:
 - lib/rack/tracker/google_adwords_conversion/template/google_adwords_conversion.erb
 - lib/rack/tracker/google_analytics/google_analytics.rb
 - lib/rack/tracker/google_analytics/template/google_analytics.erb
+- lib/rack/tracker/google_global/google_global.rb
+- lib/rack/tracker/google_global/template/google_global.erb
 - lib/rack/tracker/google_tag_manager/google_tag_manager.rb
 - lib/rack/tracker/google_tag_manager/template/google_tag_manager_body.erb
 - lib/rack/tracker/google_tag_manager/template/google_tag_manager_head.erb
@@ -201,6 +203,7 @@ files:
 - spec/handler/go_squared_spec.rb
 - spec/handler/google_adwords_conversion_spec.rb
 - spec/handler/google_analytics_spec.rb
+- spec/handler/google_global_spec.rb
 - spec/handler/google_tag_manager_spec.rb
 - spec/handler/handler_spec.rb
 - spec/handler/hotjar_spec.rb
@@ -212,6 +215,7 @@ files:
 - spec/integration/go_squared_integration_spec.rb
 - spec/integration/google_adwords_conversion_integration_spec.rb
 - spec/integration/google_analytics_integration_spec.rb
+- spec/integration/google_global_integration_spec.rb
 - spec/integration/google_tag_manager_integration_spec.rb
 - spec/integration/hotjar_integration_spec.rb
 - spec/integration/rails_integration_spec.rb
@@ -246,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Tracking made easy
@@ -264,6 +268,7 @@ test_files:
 - spec/handler/go_squared_spec.rb
 - spec/handler/google_adwords_conversion_spec.rb
 - spec/handler/google_analytics_spec.rb
+- spec/handler/google_global_spec.rb
 - spec/handler/google_tag_manager_spec.rb
 - spec/handler/handler_spec.rb
 - spec/handler/hotjar_spec.rb
@@ -275,6 +280,7 @@ test_files:
 - spec/integration/go_squared_integration_spec.rb
 - spec/integration/google_adwords_conversion_integration_spec.rb
 - spec/integration/google_analytics_integration_spec.rb
+- spec/integration/google_global_integration_spec.rb
 - spec/integration/google_tag_manager_integration_spec.rb
 - spec/integration/hotjar_integration_spec.rb
 - spec/integration/rails_integration_spec.rb