rack-tracker 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee9ff19b84fd4c1015a6fcb45ed4058730690a18
-  data.tar.gz: bee999355979d360bd8304cfd874ef9fb17fe905
+  metadata.gz: 0e83bc3662d5297183050ac1210f0707773bcc3c
+  data.tar.gz: b1dc4f2fee0a5965559641a347562ccdb07c9da3
 SHA512:
-  metadata.gz: fa80a05b10f7fbd960127453a5c83deb0888c1b04f57164a70a78cb12edf986d96ea8957af416951c9daa86e07f00c10593babe2aa08bee8bdfec43c3e904c72
-  data.tar.gz: dc886bd2cbd1c9ee963bf94a14d54e43c89cf5497ac1f4fa83d41b2c3c78d5cf62ab242e0aa2d2ac1ca7608444a5c65b3755eba19794558ca91afa8502d39ecf
+  metadata.gz: 3d0fe52d68d0e7109d2b2bd420179f2ce9973661c2159d15cf302e63b3e008f807a4a6fbb1da23cf1c4e4009e3a1b6be8a37fb9293cb35999444fec4b7182aa1
+  data.tar.gz: 0f6e8f2d08eab9e53716bb19813e40120cc3b6d34f7b621c9f2bb27d004ad6b3b97c9920b0424ea4a9abbc4f7fa0d78933dc3b91a13c4a25ff7948d2de4f01ba

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.2.0
+
+  * added support for GoSquared
+
 # 0.1.3
 
   * [BUGFIX] ecommerce events weren't created properly

data/README.md

@@ -1,10 +1,24 @@
 # Rack::Tracker
 
-[![Code Climate](https://codeclimate.com/github/railslove/rack-tracker/badges/gpa.svg)](https://codeclimate.com/github/railslove/rack-tracker)
-
-[![Build Status](https://travis-ci.org/railslove/rack-tracker.svg?branch=master)](https://travis-ci.org/railslove/rack-tracker)
-
-
+[![Code Climate](https://codeclimate.com/github/railslove/rack-tracker/badges/gpa.svg)](https://codeclimate.com/github/railslove/rack-tracker) [![Build Status](https://travis-ci.org/railslove/rack-tracker.svg?branch=master)](https://travis-ci.org/railslove/rack-tracker)
+
+## Rationale
+
+Most of the applications we're working on are using some sort of tracking/analytics service,
+Google Analytics comes first but its likely that more are added as the project grows.
+Normally you'd go ahead and add some partials to your application that will render out the
+needed tracking codes. As time passes by you'll find yourself with lots of tracking
+snippets, that will clutter your codebase :) When just looking at Analytics there are
+solutions like `rack-google-analytics` but they just soley tackle the existence of one
+service.
+
+We wanted a solution that ties all services together in one place and offers
+an easy interface to drop in new services. This is why we created `rack-tracker`, a
+rack middleware that can be hooked up to multiple services and exposing them in a unified
+fashion. It comes in two parts, the first one is the actual middleware that you can add
+to the middleware stack the second part are the service-handlers that you're going to use
+in your application. We're shipping support for Google and Facebook, to add your own please
+read about [custom handlers](#custom-handlers).
 
 ## Installation
 
@@ -80,8 +94,8 @@ Will give you this:
   ga('ecommerce:addItem', { 'id': '1234', 'affiliation': 'Acme Clothing', 'revenue': '11.99', 'shipping': '5', 'tax': '1.29'  })
 ```
 
-To load the `ecommerce`-plugin, add some configuration to the middleware initialization,
-this is _not_ needed for the above to work, but recommened, so you don't have to
+To load the `ecommerce`-plugin, add some configuration to the middleware initialization.
+This is _not_ needed for the above to work, but recommened, so you don't have to
 take care of the plugin on your own.
 
 ```ruby
@@ -112,8 +126,97 @@ Will result in the following:
 ```javascript
   window._fbq.push(["track", "123456789", {'value': 1, 'currency': 'EUR'}]);
 ```
+### Visual website Optimizer (VWO)
+Just integrate the handler with your matching account_id and you will be ready to go
+
+```ruby
+  use Rack::Tracker do
+    handler :vwo, { account_id: 'YOUR_ACCOUNT_ID' }
+  end
+```
+
+### GoSquared
+
+To enable GoSquared tracking:
+
+```ruby
+config.middleware.use(Rack::Tracker) do
+  handler :go_squared, { tracker: 'ABCDEFGH' }
+end
+````
+
+This will add the tracker to the page like so:
+
+``` javascript
+  _gs('ABCDEFGH');
+```
+
+You can also set multiple named trackers if need be:
+
+```ruby
+config.middleware.use(Rack::Tracker) do
+  handler :go_squared, {
+    trackers: {
+      primaryTracker: 'ABCDEFGH',
+      secondaryTracker: '1234567',
+    }
+  }
+end
+````
+
+This will add the specified trackers to the page like so:
+
+``` javascript
+  _gs('ABCDEFGH', 'primaryTracker');
+  _gs('1234567', 'secondaryTracker');
+```
+
+You can set [a variety of options](https://www.gosquared.com/developer/tracker/configuration/) by passing the following settings. If you don't set any of the following options, they will be omitted from the rendered code.
+
+* `:anonymize_ip`
+* `:cookie_domain`
+* `:use_cookies`
+* `:track_hash`
+* `:track_local`
+* `:track_params`
+
+#### Visitor Name
+
+To track the [visitor name](https://www.gosquared.com/developer/tracker/tagging/) from the server side, just call the `tracker` method in your controller.
+
+```ruby
+  def show
+    tracker do |t|
+      t.go_squared :visitor_name, { name: 'John Doe' }
+    end
+  end
+```
+
+It will render the following to the site source:
+
+```javascript
+  _gs("set", "visitorName", "John Doe");
+```
+
+#### Visitor Properties
+
+To track [visitor properties](https://www.gosquared.com/developer/tracker/tagging/) from the server side, just call the `tracker` method in your controller.
+
+```ruby
+  def show
+    tracker do |t|
+      t.go_squared :visitor_info, { age: 35, favorite_food: 'pizza' }
+    end
+  end
+```
+
+It will render the following to the site source:
+
+```javascript
+  _gs("set", "visitor", { "age": 35, "favorite_food": "pizza" });
+```
 
-#### Custom Handlers
+### Custom Handlers
 
 Tough we give you Google Analytics and Facebook right out of the box, you might
 be interested adding support for your custom tracking/analytics service.
@@ -156,8 +259,8 @@ Lets give it a try! We need to mount our new handler in the `Rack::Tracker` midd
   end
 ````
 
-Everything you're passing to the `handler` will be availble as `#options` in your
-template, You'll also gain access to the `env`-hash belonging to the current request.
+Everything you're passing to the `handler` will be available as `#options` in your
+template, so you'll also gain access to the `env`-hash belonging to the current request.
 
 Run your application and make a request, the result of the above template can be
 found right before `</head>`. You can change the position in your handler-code:

data/lib/rack/tracker.rb

@@ -3,6 +3,7 @@ require "tilt"
 require "active_support/core_ext/class/attribute"
 require "active_support/core_ext/hash"
 require "active_support/json"
+require "active_support/inflector"
 
 require "rack/tracker/version"
 require "rack/tracker/extensions"
@@ -12,6 +13,8 @@ require "rack/tracker/handler_delegator"
 require "rack/tracker/controller"
 require "rack/tracker/google_analytics/google_analytics"
 require "rack/tracker/facebook/facebook"
+require "rack/tracker/vwo/vwo"
+require "rack/tracker/go_squared/go_squared"
 
 module Rack
   class Tracker

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

@@ -0,0 +1,37 @@
+class Rack::Tracker::GoSquared < Rack::Tracker::Handler
+  class VisitorName < OpenStruct
+    def write
+      ['set', 'visitorName', self.name].to_json.gsub(/\[|\]/, '')
+    end
+  end
+
+  class VisitorInfo < OpenStruct
+    def write
+      ['set', 'visitor', to_h].to_json.gsub(/\[|\]/, '')
+    end
+  end
+
+  def tracker
+    options[:tracker]
+  end
+
+  def trackers
+    options[:trackers]
+  end
+
+  def render
+    Tilt.new( File.join( File.dirname(__FILE__), 'template', 'go_squared.erb') ).render(self)
+  end
+
+  def visitor_name
+    events.select{|e| e.kind_of?(VisitorName) }.first
+  end
+
+  def visitor_info
+    events.select{|e| e.kind_of?(VisitorInfo) }.first
+  end
+
+  def self.track(name, *event)
+    { name.to_s => [const_get(event.first.to_s.classify).new(event.last)] }
+  end
+end

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

@@ -0,0 +1,47 @@
+<script>
+  !function(g,s,q,r,d){r=g[r]=g[r]||function(){(r.q=r.q||[]).push(
+  arguments)};d=s.createElement(q);q=s.getElementsByTagName(q)[0];
+  d.src='//d1l6p2sc9645hc.cloudfront.net/tracker.js';q.parentNode.
+  insertBefore(d,q)}(window,document,'script','_gs');
+  <% if tracker %>
+  _gs('<%= tracker %>');
+  <% end %>
+
+  <% if trackers %>
+  <% trackers.each do |name, code| %>
+  _gs('<%= code %>', '<%= name %>');
+  <% end %>
+  <% end %>
+
+  <% if options[:anonymize_ip] %>
+    _gs('set', 'anonymizeIp', <%= options[:anonymize_ip] %>);
+  <% end %>
+
+  <% if options[:cookie_domain] %>
+    _gs('set', 'cookieDomain', '<%= options[:cookie_domain] %>');
+  <% end %>
+
+  <% if options[:use_cookies] %>
+    _gs('set', 'useCookies', <%= options[:use_cookies] %>);
+  <% end %>
+
+  <% if options[:track_hash] %>
+    _gs('set', 'trackHash', <%= options[:track_hash] %>);
+  <% end %>
+
+  <% if options[:track_local] %>
+    _gs('set', 'trackLocal', <%= options[:track_local] %>);
+  <% end %>
+
+  <% if options[:track_params] %>
+    _gs('set', 'trackParams', <%= options[:track_params] %>);
+  <% end %>
+
+  <% if visitor_name %>
+  _gs(<%= visitor_name.write() %>);
+  <% end %>
+
+  <% if visitor_info %>
+  _gs(<%= visitor_info.write() %>);
+  <% end %>
+</script>

data/lib/rack/tracker/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Tracker
-    VERSION = "0.1.3"
+    VERSION = "0.2.0"
   end
 end

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

@@ -0,0 +1,10 @@
+<!-- Start Visual Website Optimizer Asynchronous Code -->
+<script type='text/javascript'>
+var _vwo_code=(function(){
+settings_tolerance=2000,
+library_tolerance=2500,
+use_existing_jquery=false,
+// DO NOT EDIT BELOW THIS LINE
+f=false,d=document;return{use_existing_jquery:function(){return use_existing_jquery;},library_tolerance:function(){return library_tolerance;},finish:function(){if(!f){f=true;var a=d.getElementById('_vis_opt_path_hides');if(a)a.parentNode.removeChild(a);}},finished:function(){return f;},load:function(a){var b=d.createElement('script');b.src=a;b.type='text/javascript';b.innerText;b.onerror=function(){_vwo_code.finish();};d.getElementsByTagName('head')[0].appendChild(b);},init:function(){settings_timer=setTimeout('_vwo_code.finish()',settings_tolerance);this.load('//dev.visualwebsiteoptimizer.com/j.php?a='+ '<%= options[:account_id] %>' + '&u='+encodeURIComponent(d.URL)+'&r='+Math.random());var a=d.createElement('style'),b='body{opacity:0 !important;filter:alpha(opacity=0) !important;background:none !important;}',h=d.getElementsByTagName('head')[0];a.setAttribute('id','_vis_opt_path_hides');a.setAttribute('type','text/css');if(a.styleSheet)a.styleSheet.cssText=b;else a.appendChild(d.createTextNode(b));h.appendChild(a);return settings_timer;}};}());_vwo_settings_timer=_vwo_code.init();
+</script>
+<!-- End Visual Website Optimizer Asynchronous Code -->

data/lib/rack/tracker/vwo/vwo.rb

@@ -0,0 +1,5 @@
+class Vwo <  Rack::Tracker::Handler
+  def render
+    Tilt.new( File.join( File.dirname(__FILE__), 'template', 'vwo.erb') ).render(self)
+  end
+end

data/spec/handler/go_squared_spec.rb

@@ -0,0 +1,46 @@
+RSpec.describe Rack::Tracker::GoSquared do
+
+  def env
+    {misc: 'foobar'}
+  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
+
+  describe "with events" do
+    describe "visitor name" do
+      def env
+        {'tracker' => {
+          'go_squared' => [
+            Rack::Tracker::GoSquared::VisitorName.new(name: "John Doe")
+          ]
+        }}
+      end
+
+      subject { described_class.new(env, tracker: '12345').render }
+
+      it "will show the right name" do
+        expect(subject).to match(%r{_gs\(\"set\",\"visitorName\",\"John Doe\"\)})
+      end
+    end
+
+    describe "visitor details" do
+      def env
+        {'tracker' => {
+          'go_squared' => [
+            Rack::Tracker::GoSquared::VisitorInfo.new(age: 35, favorite_food: 'pizza')
+          ]
+        }}
+      end
+
+      subject { described_class.new(env, tracker: '12345').render }
+
+      it "will show the right properties" do
+        expect(subject).to match(%r{_gs\(\"set\",\"visitor\",{\"age\":35,\"favorite_food\":\"pizza\"}\)})
+      end
+    end
+  end
+
+end

data/spec/handler/vwo_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe Rack::Tracker::Vwo do
+
+  def env
+    {misc: 'foobar'}
+  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/facebook_integration_spec.rb

@@ -1,15 +1,10 @@
-require 'support/metal_controller'
-require 'support/fake_handler'
+require 'support/capybara_app_helper'
 
 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)
+    setup_app(action: :facebook) do |tracker|
+      tracker.handler :facebook, { custom_audience: 'my-audience' }
     end
-
     visit '/'
   end
 

data/spec/integration/go_squared_integration_spec.rb

@@ -0,0 +1,72 @@
+require 'support/capybara_app_helper'
+
+RSpec.describe "GoSquared Integration" do
+  subject { page }
+
+  before do
+    setup_app(action: :go_squared) do |tracker|
+      tracker.handler :go_squared, {
+        tracker: '123456',
+        anonymize_ip: true,
+        cookie_domain: 'domain.com',
+        use_cookies: true,
+        track_hash: true,
+        track_local: true,
+        track_params: true
+      }
+    end
+    visit '/'
+  end
+
+  it "adds the tracker to the page" do
+    expect(page).to have_content("_gs('123456');")
+  end
+
+  it "adds the visitorName to the page" do
+    expect(page).to have_content('_gs("set","visitorName","John Doe");')
+  end
+
+  it "adds the visitor to the page" do
+    expect(page).to have_content('_gs("set","visitor",{"age":35,"favorite_food":"pizza"});')
+  end
+
+  it "sets anonymizeIp" do
+    expect(page).to have_content("_gs('set', 'anonymizeIp', true);")
+  end
+
+  it "sets cookieDomain" do
+    expect(page).to have_content("_gs('set', 'cookieDomain', 'domain.com');")
+  end
+
+  it "sets useCookies" do
+    expect(page).to have_content("_gs('set', 'useCookies', true);")
+  end
+
+  it "sets trackHash" do
+    expect(page).to have_content("_gs('set', 'trackHash', true);")
+  end
+
+  it "sets trackLocal" do
+    expect(page).to have_content("_gs('set', 'trackLocal', true);")
+  end
+
+  it "sets trackParams" do
+    expect(page).to have_content("_gs('set', 'trackParams', true);")
+  end
+
+  context 'multiple trackers are passed in' do
+    before do
+      setup_app(action: :go_squared) do |tracker|
+        tracker.handler :go_squared, {
+          trackers: { primaryTracker: '12345', secondaryTracker: '67890' }
+        }
+      end
+      visit '/'
+    end
+
+    it "adds the tracker to the page" do
+      expect(page).to have_content("_gs('12345', 'primaryTracker');")
+      expect(page).to have_content("_gs('67890', 'secondaryTracker');")
+    end
+  end
+end

data/spec/integration/google_analytics_integration_spec.rb

@@ -1,15 +1,10 @@
-require 'support/metal_controller'
-require 'support/fake_handler'
+require 'support/capybara_app_helper'
 
 RSpec.describe "Facebook Integration" do
   before do
-    Capybara.app = Rack::Builder.new do
-      use Rack::Tracker do
-        handler :google_analytics, { tracker: 'U-XXX-Y' }
-      end
-      run MetalController.action(:google_analytics)
+    setup_app(action: :google_analytics) do |tracker|
+      tracker.handler :google_analytics, { tracker: 'U-XXX-Y' }
     end
-
     visit '/'
   end
 

data/spec/integration/rails_integration_spec.rb

@@ -1,14 +1,10 @@
-require 'support/metal_controller'
-require 'support/fake_handler'
+require 'support/capybara_app_helper'
 
 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)
+    setup_app(action: :index) do |tracker|
+      tracker.handler :track_all_the_things, { custom_key: 'SomeKey123' }
+      tracker.handler :another_handler, { custom_key: 'AnotherKey42' }
     end
 
     visit '/'

data/spec/integration/vwo_integration_spec.rb

@@ -0,0 +1,17 @@
+require 'support/capybara_app_helper'
+
+RSpec.describe "VWO Integration" do
+  before do
+    setup_app(action: :vwo) do |tracker|
+      tracker.handler :vwo, { account_id: '123456' }
+    end
+
+    visit '/'
+  end
+
+  subject { page }
+
+  it "embeds the script tag" do
+    expect(page).to have_content("this.load('//dev.visualwebsiteoptimizer.com/j.php?a='+ '123456'")
+  end
+end

data/spec/support/capybara_app_helper.rb

@@ -0,0 +1,27 @@
+require 'support/metal_controller'
+
+# helper to configure the middleware stack with custom handlers
+# and capybara app setup for more convenient testing.
+# You can use this in your integration spec by placing it in a before block.
+#
+# Example:
+#
+# before do
+#   setup_app(action: :your_controller_action) do |tracker|
+#     tracker.handler :your_new_handler, { custom_tracker_key: 'SomeKey123' }
+#   end
+# end
+#
+# By default this dispatches to a metal controller as a simple rack endpoint
+# like rails would do, but without booting up a full rails environment.
+def setup_app(options={}, &block)
+  rack_endpoint     = options[:endpoint] || MetalController
+  controller_action = options[:action]
+
+  Capybara.app = Rack::Builder.new do
+    use Rack::Tracker do
+      block[self]
+    end
+    run rack_endpoint.action(controller_action)
+  end
+end

data/spec/support/metal_controller.rb

@@ -29,4 +29,16 @@ class MetalController < ActionController::Metal
     end
     render "metal/index"
   end
+
+  def vwo
+    render "metal/index"
+  end
+
+  def go_squared
+    tracker do |t|
+      t.go_squared :visitor_name, { name: 'John Doe' }
+      t.go_squared :visitor_info, { age: 35, favorite_food: 'pizza' }
+    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.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Lars Brillert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-05 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -159,12 +159,16 @@ files:
 - lib/rack/tracker/extensions.rb
 - lib/rack/tracker/facebook/facebook.rb
 - lib/rack/tracker/facebook/template/facebook.erb
+- lib/rack/tracker/go_squared/go_squared.rb
+- lib/rack/tracker/go_squared/template/go_squared.erb
 - lib/rack/tracker/google_analytics/google_analytics.rb
 - lib/rack/tracker/google_analytics/template/google_analytics.erb
 - lib/rack/tracker/handler.rb
 - lib/rack/tracker/handler_delegator.rb
 - lib/rack/tracker/railtie.rb
 - lib/rack/tracker/version.rb
+- lib/rack/tracker/vwo/template/vwo.erb
+- lib/rack/tracker/vwo/vwo.rb
 - rack-tracker.gemspec
 - spec/fixtures/another_handler.erb
 - spec/fixtures/dummy.erb
@@ -172,11 +176,16 @@ files:
 - spec/fixtures/views/layouts/application.html.erb
 - spec/fixtures/views/metal/index.html.erb
 - spec/handler/facebook_spec.rb
+- spec/handler/go_squared_spec.rb
 - spec/handler/google_analytics_spec.rb
+- spec/handler/vwo_spec.rb
 - spec/integration/facebook_integration_spec.rb
+- spec/integration/go_squared_integration_spec.rb
 - spec/integration/google_analytics_integration_spec.rb
 - spec/integration/rails_integration_spec.rb
+- spec/integration/vwo_integration_spec.rb
 - spec/spec_helper.rb
+- spec/support/capybara_app_helper.rb
 - spec/support/fake_handler.rb
 - spec/support/metal_controller.rb
 - spec/tracker/controller_spec.rb
@@ -214,11 +223,16 @@ test_files:
 - spec/fixtures/views/layouts/application.html.erb
 - spec/fixtures/views/metal/index.html.erb
 - spec/handler/facebook_spec.rb
+- spec/handler/go_squared_spec.rb
 - spec/handler/google_analytics_spec.rb
+- spec/handler/vwo_spec.rb
 - spec/integration/facebook_integration_spec.rb
+- spec/integration/go_squared_integration_spec.rb
 - spec/integration/google_analytics_integration_spec.rb
 - spec/integration/rails_integration_spec.rb
+- spec/integration/vwo_integration_spec.rb
 - spec/spec_helper.rb
+- spec/support/capybara_app_helper.rb
 - spec/support/fake_handler.rb
 - spec/support/metal_controller.rb
 - spec/tracker/controller_spec.rb