rack-tracker 1.11.2 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a22c7f5dec27b8abd60ab5a9cbd1161e336c0063fa2d0171db5d7795a3b79024
-  data.tar.gz: 41d811bf5ee13c120791703df76b805a2095a5c517cb763338cf807d0c776e6a
+  metadata.gz: 96cc84b108179e10df6c41c10fb536597f8ba93ac7106d38bbfe9b8d36e6da6e
+  data.tar.gz: dccdd57d1f3c8985ef500c45a6441b0821e7a1dc33dd232503bd1ca73d5ed1ef
 SHA512:
-  metadata.gz: b2d88b11dc5d33c7639dc41058832ef5e8ca8b06121e46b72dfe08697e7b990b8588f3c50b6f30aa9fe094cd37bbcd42cfa87de71d769c2e8d2c088417149366
-  data.tar.gz: 6067ba21908d7724eaf70a77d06887af81486315604dca450ea8740039625d4858f517ef4791617eb03918b250bd59e82a5122a982ebeba7f0d15dd1cfdc2639
+  metadata.gz: 78b014112e736701afb694c07384cd368a37054c8d734a8b38d9bb9224a33d0b857e8596e486a9e06d8c0038a54e9917835e7e2ba64efc96ecb5f06a21bc7b30
+  data.tar.gz: 9d81d707139e7393409c15a2e1f9fe7289394988bf1804613550bab4a114d3c393e175c512062bca1b3816b97ad3aa4c913614fd51a27cbc736a57bd8517aa96

data/.travis.yml

@@ -6,8 +6,18 @@ rvm:
   - 2.5.3
   - 2.6.1
   - jruby-9.1.10.0
+  - jruby-9.2.7.0
 gemfile:
   - Gemfile
   - Gemfile.rails-3.2
   - Gemfile.rails-4.2
   - Gemfile.rails-5.2
+  - Gemfile.rails-6.0
+matrix:
+  exclude:
+  - rvm: 2.3.8
+    gemfile: Gemfile.rails-6.0
+  - rvm: 2.4.5
+    gemfile: Gemfile.rails-6.0
+  - rvm: jruby-9.1.10.0
+    gemfile: Gemfile.rails-6.0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # 1.12.0
 
+* [ENHANCEMENT] Add support for Heap #147 (thx @mohanzhang)
+
+# 1.11.2
+
  * [ENHANCEMENT] Allows disabling the Google Analytics pageview send. Defaults to true #131 (thx @ChrisCoffey)
 
 # 1.11.1

data/Gemfile.rails-6.0

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

data/README.md

@@ -615,6 +615,18 @@ config.middleware.use(Rack::Tracker) do
 end
 ```
 
+### Heap
+
+[Heap](https://heap.io/). Heap has Projects (e.g. "Main") which have multiple
+Environments (e.g. "Production" or "Development"). `env_id` is therefore the numerical ID
+that represents the Environment. See Settings -> Projects -> Environments in your dashboard.
+
+```
+config.middleware.use(Rack::Tracker) do
+  handler :heap, env_id: 'HEAP_ID'
+end
+```
+
 ### Custom Handlers
 
 Tough we give you handlers for a few tracking services right out of the box, you might

data/lib/rack/tracker.rb

@@ -26,6 +26,7 @@ require "rack/tracker/hotjar/hotjar"
 require "rack/tracker/bing/bing"
 require "rack/tracker/hubspot/hubspot"
 require "rack/tracker/drift/drift"
+require "rack/tracker/heap/heap"
 
 module Rack
   class Tracker

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

@@ -1,5 +1,5 @@
-<script type="text/javascript">
 <% if tracker %>
+<script type="text/javascript">
   if(typeof ga === 'undefined') {
     (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
     (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
@@ -40,5 +40,5 @@
 <% end %>
 <% if tracker && options[:explicit_pageview] %>
   ga('send', 'pageview', <%= pageview_url_script %>);
-<% end %>
 </script>
+<% end %>

data/lib/rack/tracker/heap/heap.rb

@@ -0,0 +1,2 @@
+class Rack::Tracker::Heap < Rack::Tracker::Handler
+end

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

@@ -0,0 +1,4 @@
+<script>
+  window.heap=window.heap||[],heap.load=function(e,t){window.heap.appid=e,window.heap.config=t=t||{};var r=t.forceSSL||"https:"===document.location.protocol,a=document.createElement("script");a.type="text/javascript",a.async=!0,a.src=(r?"https:":"http:")+"//cdn.heapanalytics.com/js/heap-"+e+".js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(a,n);for(var o=function(e){return function(){heap.push([e].concat(Array.prototype.slice.call(arguments,0)))}},p=["addEventProperties","addUserProperties","clearEventProperties","identify","resetIdentity","removeEventProperty","setEventProperties","track","unsetEventProperty"],c=0;c<p.length;c++)heap[p[c]]=o(p[c])};
+  heap.load("<%= options[:env_id] %>");
+</script>

data/lib/rack/tracker/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Tracker
-    VERSION = '1.11.2'
+    VERSION = '1.12.0'
   end
 end

data/spec/handler/heap_spec.rb

@@ -0,0 +1,10 @@
+RSpec.describe Rack::Tracker::Heap do
+  def env
+    { foo: 'bar' }
+  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)
+  end
+end

data/spec/integration/heap_integration_spec.rb

@@ -0,0 +1,17 @@
+require 'support/capybara_app_helper'
+
+RSpec.describe "Heap Integration" do
+  before do
+    setup_app(action: :heap) do |tracker|
+      tracker.handler :heap, { env_id: '12341234' }
+    end
+
+    visit '/'
+  end
+
+  subject { page }
+
+  it 'embeds the script with site_id' do
+    expect(page).to have_content('heap.load("12341234");')
+  end
+end

data/spec/integration/rails_integration_spec.rb

@@ -1,10 +1,19 @@
 require 'support/capybara_app_helper'
 
 RSpec.describe "Rails Integration" do
+  let(:callable_skip_inject) do
+    lambda do |env|
+      # check for anything in the env hash to decide
+      # if you return the `tracker id` or `nil` to skip injection
+      nil
+    end
+  end
+
   before do
     setup_app(action: :index) do |tracker|
       tracker.handler :track_all_the_things, { custom_key: 'SomeKey123' }
       tracker.handler :another_handler, { custom_key: 'AnotherKey42' }
+      tracker.handler :google_analytics, { tracker: callable_skip_inject }
     end
 
     visit '/'
@@ -17,15 +26,15 @@ RSpec.describe "Rails Integration" do
       <html>
         <head>
           <title>Metal Layout</title>
-        <script type="text/javascript">
-        myAwesomeFunction("tracks", "like", "no-one-else", "SomeKey123");
-      </script>
-      </head>
+          <script type="text/javascript">
+            myAwesomeFunction("tracks", "like", "no-one-else", "SomeKey123");
+          </script>
+        </head>
         <body class="do-we-support-attributes-on-the-body-tag">
           <h1>welcome to metal#index</h1>
-        <script type="text/javascript">
-        anotherFunction("tracks-event-from-down-under", "AnotherKey42");
-      </script>
+          <script type="text/javascript">
+            anotherFunction("tracks-event-from-down-under", "AnotherKey42");
+          </script>
         </body>
       </html>
     HTML

data/spec/support/metal_controller.rb

@@ -128,4 +128,8 @@ class MetalController < ActionController::Metal
   def drift
     render "metal/index"
   end
+
+  def heap
+    render "metal/index"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-tracker
 version: !ruby/object:Gem::Version
-  version: 1.11.2
+  version: 1.12.0
 platform: ruby
 authors:
 - Lars Brillert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-25 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -154,6 +154,7 @@ files:
 - Gemfile.rails-3.2
 - Gemfile.rails-4.2
 - Gemfile.rails-5.2
+- Gemfile.rails-6.0
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -184,6 +185,8 @@ files:
 - lib/rack/tracker/google_tag_manager/template/google_tag_manager_head.erb
 - lib/rack/tracker/handler.rb
 - lib/rack/tracker/handler_delegator.rb
+- lib/rack/tracker/heap/heap.rb
+- lib/rack/tracker/heap/template/heap.erb
 - lib/rack/tracker/hotjar/hotjar.rb
 - lib/rack/tracker/hotjar/template/hotjar.erb
 - lib/rack/tracker/hubspot/hubspot.rb
@@ -214,6 +217,7 @@ files:
 - spec/handler/google_global_spec.rb
 - spec/handler/google_tag_manager_spec.rb
 - spec/handler/handler_spec.rb
+- spec/handler/heap_spec.rb
 - spec/handler/hotjar_spec.rb
 - spec/handler/hubspot_spec.rb
 - spec/handler/vwo_spec.rb
@@ -228,6 +232,7 @@ files:
 - spec/integration/google_analytics_integration_spec.rb
 - spec/integration/google_global_integration_spec.rb
 - spec/integration/google_tag_manager_integration_spec.rb
+- spec/integration/heap_integration_spec.rb
 - spec/integration/hotjar_integration_spec.rb
 - spec/integration/hubspot_integration_spec.rb
 - spec/integration/rails_integration_spec.rb
@@ -261,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Tracking made easy
@@ -284,6 +289,7 @@ test_files:
 - spec/handler/google_global_spec.rb
 - spec/handler/google_tag_manager_spec.rb
 - spec/handler/handler_spec.rb
+- spec/handler/heap_spec.rb
 - spec/handler/hotjar_spec.rb
 - spec/handler/hubspot_spec.rb
 - spec/handler/vwo_spec.rb
@@ -298,6 +304,7 @@ test_files:
 - spec/integration/google_analytics_integration_spec.rb
 - spec/integration/google_global_integration_spec.rb
 - spec/integration/google_tag_manager_integration_spec.rb
+- spec/integration/heap_integration_spec.rb
 - spec/integration/hotjar_integration_spec.rb
 - spec/integration/hubspot_integration_spec.rb
 - spec/integration/rails_integration_spec.rb