rack-tracker 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5d422a3b9c89bb3594c892b498efbd590008469
-  data.tar.gz: 48405d43a9ddab1569886c927930fda3958767d0
+  metadata.gz: 42c882f19b618a8ce401d37e6dd5baba8dcc2335
+  data.tar.gz: b841bbdbac1fb8752bbddf6be2c526286a337c04
 SHA512:
-  metadata.gz: 8f65ac1d2b4ed1bb0500ffda34bea41f9205cc48e16ca90496402ac6bbcc2b52c8262db72df9df87f3ab3563671626b627c9ee50136dca0703052a67a5567541
-  data.tar.gz: 44c838bd7e679cc923c593d670b0f21b7d56dfceabf285a0dba0d21bfe0364596646c02eafb282ff4d480ede6eb99734c2824f3b9b711a4d7b4f0d28a27797cc
+  metadata.gz: ad51b4b1fd58c9dcc2f0985d8066fe13b58504cdf4cb6d1397285bb67ae729ea3fdffb119bcd41c2abec7924da3c8887a1668f03468b70b4f941bc8f7cb90e16
+  data.tar.gz: bb7a62cde667581a270cc4036b1413ce15be8c1ad490569210060763c572713611d5bc9ecf1ca3b35640402e0c2eee39c1a6fba29d6d027702eefda7b0d5fdb6

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0
   - 2.1.2
+  - jruby

data/README.md

@@ -2,7 +2,7 @@
 
 [![Code Climate](https://codeclimate.com/github/railslove/rack-tracker/badges/gpa.svg)](https://codeclimate.com/github/railslove/rack-tracker)
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/railslove/rack-tracker.svg?branch=master)](https://travis-ci.org/railslove/rack-tracker)
 
 ## Installation
 
@@ -20,11 +20,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Add it to your middleware stack
+
+    config.middleware.use(Rack::Tracker) do
+      handler :google_analytics, { tracker: 'U-XXXXX-Y' }
+    end
+
+This will add Google Analytics as a tracking handler. `Rack::Tracker` some with
+support for Google Analytics and Facebook. Others might be added in the future
+but you can easily write your own handlers.
+
+### 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.
+* `:cookie_domain` -  sets the domain name for the GATC cookies. Defaults to `auto`.
+* `:site_speed_sample_rate` - Defines a new sample set size for Site Speed data collection, see https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApiBasicConfiguration?hl=de#_gat.GA_Tracker_._setSiteSpeedSampleRate
+* `:adjusted_bounce_rate_timeouts` - An array of times in seconds that the tracker will use to set timeouts for adjusted bounce rate tracking. See http://analytics.blogspot.ca/2012/07/tracking-adjusted-bounce-rate-in-google.html for details.
+* `:enhanced_link_attribution` - Enables [Enhanced Link Attribution](https://developers.google.com/analytics/devguides/collection/analyticsjs/advanced#enhancedlink).
+* `:advertising` - Enables [Display Features](https://developers.google.com/analytics/devguides/collection/analyticsjs/display-features).
+* `:ecommerce` - Enables [Ecommerce Tracking](https://developers.google.com/analytics/devguides/collection/analyticsjs/ecommerce).
+
+### Facebook
+
+* `custom_audience_id`
+
+
+## Server side events
+
+When using `rack-tracker` within a Rails application you can track events from
+your controller and the tracking snippit will then populated with this data.
+
+```ruby
+  def show
+    tracker do
+      google_analytics category: 'foo'
+    end
+  end
+```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/rack-tracker/fork )
+1. Fork it ( http://github.com/railslove/rack-tracker/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rack/tracker.rb

@@ -1,7 +1,88 @@
+require "rack"
+require "tilt"
+require "active_support/core_ext/class/attribute"
+require "active_support/core_ext/hash"
+require "active_support/json"
+
 require "rack/tracker/version"
+require "rack/tracker/extensions"
+require 'rack/tracker/railtie' if defined?(Rails)
+require "rack/tracker/handler"
+require "rack/tracker/handler_delegator"
+require "rack/tracker/controller"
+require "rack/tracker/google_analytics/google_analytics"
+require "rack/tracker/facebook/facebook"
 
 module Rack
-  module Tracker
-    # Your code goes here...
+  class Tracker
+    EVENT_TRACKING_KEY = 'tracker'
+
+    def initialize(app, &block)
+      @app = app
+      @handlers = Rack::Tracker::HandlerSet.new(&block)
+    end
+
+    def call(env)
+      @status, @headers, @body = @app.call(env)
+      return [@status, @headers, @body] unless html?
+      response = Rack::Response.new([], @status, @headers)
+
+      env[EVENT_TRACKING_KEY] = {} unless env[EVENT_TRACKING_KEY]
+
+      session = env["rack.session"]
+      if response.ok?
+        # Write out the events now
+
+        # Get any stored events from a redirection
+        stored_events = session.delete(EVENT_TRACKING_KEY) if session
+
+        env[EVENT_TRACKING_KEY].deep_merge!(stored_events) { |key, old, new| Array.wrap(old) + Array.wrap(new) } unless stored_events.nil?
+      elsif response.redirection? && session
+        # Store the events until next time
+        env["rack.session"][EVENT_TRACKING_KEY] = env[EVENT_TRACKING_KEY]
+      end
+
+      @body.each { |fragment| response.write inject(env, fragment) }
+      @body.close if @body.respond_to?(:close)
+
+      response.finish
+    end
+
+    private
+
+    def html?; @headers['Content-Type'] =~ /html/; end
+
+    def inject(env, response)
+      @handlers.each(env) do |handler|
+        response.gsub!(%r{</#{handler.position}>}, handler.render + "</#{handler.position}>")
+      end
+      response
+    end
+
+    class HandlerSet
+      class Handler
+        def initialize(name, options)
+          @name = name
+          @options = options
+        end
+
+        def init(env)
+          @name.new(env, @options)
+        end
+      end
+
+      def initialize(&block)
+        @handlers = []
+        self.instance_exec(&block) if block_given?
+      end
+
+      def handler(name, opts = {}, &block)
+        @handlers << Handler.new(Rack::Tracker::HandlerDelegator.handler(name), opts)
+      end
+
+      def each(env = {}, &block)
+        @handlers.map{|h| h.init(env)}.each(&block)
+      end
+    end
   end
 end

data/lib/rack/tracker/controller.rb

@@ -0,0 +1,11 @@
+module Rack
+  class Tracker
+    module Controller
+      def tracker(&block)
+        if block_given?
+          Rack::Tracker::HandlerDelegator.new(env).instance_exec(&block)
+        end
+      end
+    end
+  end
+end

data/lib/rack/tracker/extensions.rb

@@ -0,0 +1,8 @@
+require 'ostruct'
+
+# Backport of 2.0.0 stdlib ostruct#to_h
+class OpenStruct
+  def to_h
+    @table.dup
+  end unless method_defined? :to_h
+end

data/lib/rack/tracker/facebook/facebook.rb

@@ -0,0 +1,22 @@
+class Rack::Tracker::Facebook < Rack::Tracker::Handler
+  self.position = :body
+
+  # options do
+  #   locale 'de_DE'
+  #   app_id
+  #   custom_audience_id
+  # end
+
+  # event do
+  #   id
+  #   value
+  #   currency
+  # end
+
+  # position :body
+
+  def render
+    Tilt.new( File.join( File.dirname(__FILE__), 'template/facebook.erb') ).render(self)
+  end
+
+end

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

@@ -0,0 +1,40 @@
+<script type="text/javascript">
+  (function() {
+    var _fbq = window._fbq || (window._fbq = []);
+    if (!_fbq.loaded) {
+      var fbds = document.createElement('script');
+      fbds.async = true;
+      fbds.src = '//connect.facebook.net/en_US/fbds.js';
+      var s = document.getElementsByTagName('script')[0];
+      s.parentNode.insertBefore(fbds, s);
+      _fbq.loaded = true;
+    }
+  })();
+  window._fbq = window._fbq || [];
+
+</script>
+
+<% if options[:custom_audience_id] %>
+<script type="text/javascript">
+window._fbq.push(['addPixelId', '<%= options[:custom_audience_id] %>']);
+window._fbq.push(["track", "PixelInitialized", {}]);
+</script>
+
+<noscript>
+  <img height="1" width="1" alt="" style="display:none" src="https://www.facebook.com/tr?id=<%= options[:custom_audience_id] %>&amp;ev=PixelInitialized">
+</noscript>
+<% end %>
+
+<% if events.any? %>
+<script type="text/javascript">
+<% events.each do |event| %>
+window._fbq.push(['track', '<%= event["pixel_id"] %>', {'value': '<%= event["value"] %>', 'currency': '<%= event["currency"] %>'}]);
+<% end %>
+</script>
+
+<noscript>
+  <% events.each do |event| %>
+  <img height="1" width="1" alt="" style="display:none" src="https://www.facebook.com/offsite_event.php?id=<%= event["pixel_id"] %>&amp;value=<%= event["value"] %>&amp;currency=<%= event["currency"] %>">
+  <% end %>
+</noscript>
+<% end %>

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

@@ -0,0 +1,33 @@
+class Rack::Tracker::GoogleAnalytics < Rack::Tracker::Handler
+  class Event < OpenStruct
+    def write
+      ['send', event].to_json.gsub(/\[|\]/, '')
+    end
+
+    def event
+      { hitType: 'event' }.merge(attributes).compact
+    end
+
+    def attributes
+      Hash[to_h.map { |k,v| ['event' + k.to_s.capitalize, v] }]
+    end
+  end
+
+  class Ecommerce < Struct.new(:action, :payload)
+    def write
+      [self.action, self.payload.compact].to_json.gsub(/\[|\]/, '')
+    end
+  end
+
+  def tracker
+    options[:tracker].try(:call, env) || options[:tracker]
+  end
+
+  def render
+    Tilt.new( File.join( File.dirname(__FILE__), 'template', 'google_analytics.erb') ).render(self)
+  end
+
+  def self.track(name, event)
+    { name.to_s => [Event.new(event)] }
+  end
+end

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

@@ -0,0 +1,43 @@
+<script type="text/javascript">
+
+<% if tracker %>
+  (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),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+  ga('create', '<%= tracker %>', <%= options.slice(:cookieDomain).to_json %>);
+
+<% if options[:enhanced_link_attribution] %>
+  ga('require', 'linkid', 'linkid.js');
+<% end %>
+
+<% if options[:advertising] %>
+  ga('require', 'displayfeatures');
+<% end %>
+
+<% if options[:ecommerce] %>
+  ga('require', 'ecommerce', 'ecommerce.js');
+<% end %>
+
+<% if options[:anonymize_ip] %>
+  ga('set', 'anonymizeIp', true);
+<% end %>
+
+<% if options[:adjusted_bounce_rate_timeouts] %>
+  <% options[:adjusted_bounce_rate_timeouts].each do |timeout| %>
+      setTimeout(ga('send', 'event', '<%= "#{timeout.to_s}_seconds" %>', 'read'),<%= timeout*1000 %>);
+  <% end %>
+<% end %>
+
+<% end %>
+
+<% events.each do |var| %>
+  ga(<%= var.write() %>);
+<% end %>
+
+<% if tracker %>
+  ga('send', 'pageview');
+<% end %>
+
+</script>

data/lib/rack/tracker/handler.rb

@@ -0,0 +1,24 @@
+class Rack::Tracker::Handler
+  class_attribute :position
+  self.position = :head
+
+  attr_accessor :options
+  attr_accessor :env
+
+  def initialize(env, options = {})
+    self.env = env
+    self.options = options
+  end
+
+  def events
+    env.fetch('tracker', {})[self.class.to_s.demodulize.underscore] || []
+  end
+
+  def render
+    raise NotImplementedError.new('needs implementation')
+  end
+
+   def self.track(name, event)
+    raise NotImplementedError.new("class method `#{__callee__}` is not implemented.")
+  end
+end

data/lib/rack/tracker/handler_delegator.rb

@@ -0,0 +1,48 @@
+class Rack::Tracker::HandlerDelegator
+  class << self
+    def handler(method_name)
+      new.handler(method_name)
+    end
+  end
+
+  attr_accessor :env
+
+  def initialize(env={})
+    @env = env
+  end
+
+  def method_missing(method_name, *args, &block)
+    if respond_to?(method_name)
+      write_event(handler(method_name).track(method_name, *args, &block))
+    else
+      super
+    end
+  end
+
+  def write_event(event)
+    if env.key?('tracker')
+      self.env = env['tracker'].deep_merge!(event)
+    else
+      self.env['tracker'] = event
+    end
+  end
+
+  def respond_to?(method_name, include_private=false)
+    handler(method_name).respond_to?(:track, include_private)
+  end
+
+  def handler(method_name)
+    return method_name if method_name.kind_of?(Class)
+
+    _handler = method_name.to_s.camelize
+    ["Rack::Tracker::#{_handler}", _handler].detect do |const|
+      begin
+        return const.constantize
+      rescue NameError
+        false
+      end
+    end
+
+    raise ArgumentError, "No such Handler: #{_handler}"
+  end
+end

data/lib/rack/tracker/railtie.rb

@@ -0,0 +1,11 @@
+module Rack
+  class Tracker
+    class Railtie < ::Rails::Railtie
+      initializer "rack-tracker.configure_controller" do |app|
+        ActiveSupport.on_load :action_controller do
+          include Rack::Tracker::Controller
+        end
+      end
+    end
+  end
+end

data/lib/rack/tracker/version.rb

@@ -1,5 +1,5 @@
 module Rack
-  module Tracker
-    VERSION = "0.0.1"
+  class Tracker
+    VERSION = "0.0.2"
   end
 end

data/rack-tracker.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Lars Brillert", "Marco Schaden"]
   spec.email         = ["lars@railslove.com", "marco@railslove.com"]
   spec.summary       = %q{Tracking made easy}
-  spec.description   = %q{Don’t fool around with adding tracking partials to your app concentrate on the things that matter.}
+  spec.description   = %q{Don’t fool around with adding tracking partials to your app and concentrate on the things that matter.}
   spec.homepage      = "https://github.com/railslove/rack-tracker"
   spec.license       = "MIT"
 
@@ -18,6 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "rack", "~> 1.5.2"
+  spec.add_dependency "tilt", "~> 1.4.1"
+  spec.add_dependency "activesupport", "~> 4.1.0"
+
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+  spec.add_development_dependency "capybara", "~> 2.4.1"
+  spec.add_development_dependency "actionpack", "~> 4.1.5"
+  spec.add_development_dependency "pry"
 end

data/spec/fixtures/another_handler.erb

@@ -0,0 +1,3 @@
+<script type="text/javascript">
+  anotherFunction("tracks-event-from-down-under", "<%= options[:custom_key] %>");
+</script>

data/spec/fixtures/dummy.erb

@@ -0,0 +1,9 @@
+<script type="text/javascript">
+  <% if dummy_alert %>
+    alert('<%= dummy_alert %>');
+  <% else %>
+    alert('this is a dummy class');
+  <% end %>
+
+  console.log('<%= options[:foo] %>');
+</script>

data/spec/fixtures/track_all_the_things.erb

@@ -0,0 +1,3 @@
+<script type="text/javascript">
+  myAwesomeFunction("tracks", "like", "<%= track_me[:like] %>", "<%= options[:custom_key] %>");
+</script>

data/spec/fixtures/views/layouts/application.html.erb

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>Metal Layout</title>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/fixtures/views/metal/index.html.erb

@@ -0,0 +1 @@
+<h1>welcome to metal#index</h1>

data/spec/handler/facebook_spec.rb

@@ -0,0 +1,47 @@
+RSpec.describe Rack::Tracker::Facebook do
+  def env
+    {}
+  end
+
+  it 'will be placed in the body' do
+    expect(described_class.position).to eq(:body)
+    expect(described_class.new(env).position).to eq(:body)
+  end
+
+  describe 'with custom audience id' do
+    subject { described_class.new(env, custom_audience_id: 'custom_audience_id').render }
+
+    it 'will push the tracking events to the queue' do
+      expect(subject).to match(%r{window._fbq.push\(\['addPixelId', 'custom_audience_id'\]\)})
+      expect(subject).to match(%r{window._fbq.push\(\["track", "PixelInitialized", \{\}\]\)})
+    end
+
+    it 'will add the noscript fallback' do
+      expect(subject).to match(%r{https://www.facebook.com/tr\?id=custom_audience_id&ev=PixelInitialized})
+    end
+  end
+
+  describe 'with events' do
+    def env
+      {
+        'tracker' => {
+        'facebook' =>
+          [
+            {'pixel_id' => '123456789',
+             'value' => '23',
+             'currency' => 'EUR'}
+          ]
+        }
+      }
+    end
+    subject { described_class.new(env).render }
+
+    it 'will push the tracking events to the queue' do
+      expect(subject).to match(%r{\['track', '123456789', \{'value': '23', 'currency': 'EUR'\}\]})
+    end
+
+    it 'will add the noscript fallback' do
+      expect(subject).to match(%r{https://www.facebook.com/offsite_event.php\?id=123456789&value=23&currency=EUR})
+    end
+  end
+end

data/spec/handler/google_analytics_spec.rb

@@ -0,0 +1,117 @@
+RSpec.describe Rack::Tracker::GoogleAnalytics 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 "default" do
+      def env
+        {'tracker' => {
+          'google_analytics' => [
+            Rack::Tracker::GoogleAnalytics::Event.new(category: "Users", action: "Login", label: "Standard")
+          ]
+        }}
+      end
+
+      subject { described_class.new(env, tracker: 'somebody', cookieDomain: "railslabs.com").render }
+      it "will show events" do
+        expect(subject).to match(%r{ga\(\"send\",{\"hitType\":\"event\",\"eventCategory\":\"Users\",\"eventAction\":\"Login\",\"eventLabel\":\"Standard\"}\)})
+      end
+    end
+
+    describe "with a event value" do
+      def env
+        {'tracker' => { 'google_analytics' => [
+          Rack::Tracker::GoogleAnalytics::Event.new(category: "Users", action: "Login", label: "Standard", value: 5)
+        ]}}
+      end
+
+      subject { described_class.new(env, tracker: 'somebody', cookieDomain: "railslabs.com").render }
+      it "will show events with values" do
+        expect(subject).to match(%r{ga\(\"send\",{\"hitType\":\"event\",\"eventCategory\":\"Users\",\"eventAction\":\"Login\",\"eventLabel\":\"Standard\",\"eventValue\":5}\)},)
+      end
+    end
+  end
+
+  describe 'with e-commerce events' do
+    describe "default" do
+      def env
+        {'tracker' => {
+          'google_analytics' => [
+            Rack::Tracker::GoogleAnalytics::Ecommerce.new('ecommerce:addItem', {id: '1234', affiliation: 'Acme Clothing', revenue: 11.99, shipping: '5', tax: '1.29', currency: 'EUR'})
+          ]
+        }}
+      end
+
+      subject { described_class.new(env, tracker: 'somebody', cookieDomain: "railslabs.com").render }
+      it "will show events" do
+        expect(subject).to match(%r{ga\(\"ecommerce:addItem\",#{{id: '1234', affiliation: 'Acme Clothing', revenue: 11.99, shipping: '5', tax: '1.29', currency: 'EUR'}.to_json}})
+      end
+    end
+  end
+
+  describe "with custom domain" do
+    subject { described_class.new(env, tracker: 'somebody', cookieDomain: "railslabs.com").render }
+
+    it "will show asyncronous tracker with cookieDomain" do
+      expect(subject).to match(%r{ga\('create', 'somebody', {\"cookieDomain\":\"railslabs.com\"}\)})
+      expect(subject).to match(%r{ga\('send', 'pageview'\)})
+    end
+  end
+
+  describe "with enhanced_link_attribution" do
+    subject { described_class.new(env, tracker: 'happy', enhanced_link_attribution: true).render }
+
+    it "will embedded the linkid plugin script" do
+      expect(subject).to match(%r{linkid.js})
+    end
+  end
+
+  describe "with advertising" do
+    subject { described_class.new(env, tracker: 'happy', advertising: true).render }
+
+    it "will require displayfeatures" do
+      expect(subject).to match(%r{ga\('require', 'displayfeatures'\)})
+    end
+  end
+
+  describe "with e-commerce" do
+    subject { described_class.new(env, tracker: 'happy', ecommerce: true).render }
+
+    it "will require the ecommerce plugin" do
+      expect(subject).to match(%r{ga\('require', 'ecommerce', 'ecommerce\.js'\)})
+    end
+  end
+
+  describe "with anonymizeIp" do
+    subject { described_class.new(env, tracker: 'happy', anonymize_ip: true).render }
+
+    it "will set anonymizeIp to true" do
+      expect(subject).to match(%r{ga\('set', 'anonymizeIp', true\)})
+    end
+  end
+
+  describe "with dynamic tracker" do
+    subject { described_class.new(env, { tracker: lambda { |env| return env[:misc] }}).render }
+
+    it 'will call tracker lambdas to obtain tracking codes' do
+      expect(subject).to match(%r{ga\('create', 'foobar', {}\)})
+    end
+  end
+
+  describe 'adjusted bounce rate' do
+    subject { described_class.new(env, tracker: 'afake', adjusted_bounce_rate_timeouts: [15, 30]).render }
+
+    it "will add timeouts to push read events" do
+      expect(subject).to match(%r{ga\('send', 'event', '15_seconds', 'read'\)})
+      expect(subject).to match(%r{ga\('send', 'event', '30_seconds', 'read'\)})
+    end
+  end
+
+end

data/spec/integration/rails_integration_spec.rb

@@ -0,0 +1,39 @@
+require 'support/metal_controller'
+require 'support/fake_handler'
+
+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)
+end
+
+
+RSpec.describe "Rails Integration" do
+  before { visit '/' }
+  subject { page.html.gsub(/^\s*/, '') }
+
+  let(:expected_html) do
+    <<-HTML.gsub(/^\s*/, '')
+      <html>
+        <head>
+          <title>Metal Layout</title>
+        <script type="text/javascript">
+        myAwesomeFunction("tracks", "like", "no-one-else", "SomeKey123");
+      </script>
+      </head>
+        <body>
+          <h1>welcome to metal#index</h1>
+        <script type="text/javascript">
+        anotherFunction("tracks-event-from-down-under", "AnotherKey42");
+      </script>
+        </body>
+      </html>
+    HTML
+  end
+
+  it "embeds the script tag with tracking event from the controller action" do
+    expect(subject).to eql(expected_html)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,70 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'rack/test'
+require 'capybara/rspec'
+require 'rack/tracker'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+Capybara.ignore_hidden_elements = false
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.include Capybara::DSL
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/fake_handler.rb

@@ -0,0 +1,30 @@
+class TrackAllTheThings < Rack::Tracker::Handler
+  def render
+    Tilt.new( File.join( File.dirname(__FILE__), '../fixtures/track_all_the_things.erb') ).render(self)
+  end
+
+  def self.track(name, event)
+    { name.to_s => event }
+  end
+
+  def track_me
+    env['tracker']['track_all_the_things']
+  end
+end
+
+
+class AnotherHandler < Rack::Tracker::Handler
+  self.position = :body
+
+  def render
+    Tilt.new( File.join( File.dirname(__FILE__), '../fixtures/another_handler.erb') ).render(self)
+  end
+
+  def self.track(name, event)
+    { name.to_s => event }
+  end
+
+  def track_me
+    env['tracker']['another_handler']
+  end
+end

data/spec/support/metal_controller.rb

@@ -0,0 +1,17 @@
+require 'action_controller'
+
+class MetalController < ActionController::Metal
+  include Rack::Tracker::Controller
+  include AbstractController::Rendering
+  include ActionView::Layouts
+  append_view_path File.join(File.dirname(__FILE__), '../fixtures/views')
+  layout 'application'
+
+  def index
+    tracker do
+      track_all_the_things like: 'no-one-else'
+      another_handler likes: 'you'
+    end
+    render "metal/index"
+  end
+end

data/spec/tracker/controller_spec.rb

@@ -0,0 +1,31 @@
+class SomeController
+  include Rack::Tracker::Controller
+
+  attr_accessor :env
+
+  def initialize
+    @env = {}
+  end
+
+  def index
+    tracker do
+      google_analytics category: 'foo'
+    end
+  end
+end
+
+
+RSpec.describe Rack::Tracker::Controller do
+  context 'controller' do
+    let(:event) { Rack::Tracker::GoogleAnalytics::Event.new(category: 'foo') }
+
+    it 'writes the event into env' do
+      controller = SomeController.new
+      expect {
+        controller.index
+      }.to change {
+        controller.env
+      }.from({}).to('tracker' => {'google_analytics' => [event]})
+    end
+  end
+end

data/spec/tracker/handler_delegator_spec.rb

@@ -0,0 +1,26 @@
+Foo = Class.new
+Bar = Class.new
+
+RSpec.describe Rack::Tracker::HandlerDelegator do
+
+  describe '#handler' do
+
+    it 'will find handler in the Rack::Tracker namespace' do
+      expect(described_class.handler(:google_analytics)).to eq(Rack::Tracker::GoogleAnalytics)
+    end
+
+    it 'will find handler outside the Rack::Tracker namespace' do
+      expect(described_class.handler(:foo)).to eq(Foo)
+    end
+
+    it 'will just return a class' do
+      expect(described_class.handler(Bar)).to eq(Bar)
+    end
+
+    it 'will raise when no handler is found' do
+      expect { described_class.handler(:baz)}.to raise_error(ArgumentError, "No such Handler: Baz")
+    end
+
+  end
+
+end

data/spec/tracker/handler_set_spec.rb

@@ -0,0 +1,32 @@
+class Dummy < Rack::Tracker::Handler
+end
+
+RSpec.describe Rack::Tracker::HandlerSet do
+
+  let(:set) do
+    Rack::Tracker::HandlerSet.new do
+      handler 'dummy', {foo: "bar"}
+    end
+  end
+
+  describe '#each' do
+    subject { set.each }
+    specify { expect(subject.to_a.size).to eq(1) }
+    specify { expect(subject).to match_array(Dummy) }
+  end
+
+  describe Rack::Tracker::HandlerSet::Handler do
+    subject { described_class.new(Dummy, {foo: 'bar'}) }
+
+    describe '#init' do
+      it 'will initialize the handler with the given class' do
+        expect(subject.init({})).to be_kind_of(Dummy)
+      end
+
+      it 'will initialize the handler with the given options' do
+        expect(subject.init({}).options).to eq({foo: 'bar'})
+      end
+    end
+  end
+
+end

data/spec/tracker/tracker_spec.rb

@@ -0,0 +1,100 @@
+class DummyHandler < Rack::Tracker::Handler
+  def render
+    Tilt.new( File.join( File.dirname(__FILE__), '../fixtures/dummy.erb') ).render(self)
+  end
+
+  def dummy_alert
+    env['tracker']['dummy']
+  end
+end
+
+class BodyHandler < DummyHandler
+  self.position = :body
+end
+
+RSpec.describe Rack::Tracker do
+  def app
+    Rack::Builder.new do
+      use Rack::Session::Cookie, secret: "FOO"
+
+      use Rack::Tracker do
+        handler DummyHandler, { foo: 'head' }
+        handler BodyHandler, { foo: 'body' }
+      end
+
+      run lambda {|env|
+        request = Rack::Request.new(env)
+        case request.path
+          when '/' then
+            [200, {'Content-Type' => 'application/html'}, ['<head>Hello world</head>']]
+          when '/body' then
+            [200, {'Content-Type' => 'application/html'}, ['<body>bob here</body>']]
+          when '/body-head' then
+            [200, {'Content-Type' => 'application/html'}, ['<head></head><body></body>']]
+          when '/test.xml' then
+            [200, {'Content-Type' => 'application/xml'}, ['Xml here']]
+          when '/redirect' then
+            [302, {'Content-Type' => 'application/html', 'Location' => '/'}, ['<body>redirection</body>']]
+          else
+            [404, 'Nothing here']
+        end
+      }
+    end
+  end
+  subject { app }
+
+  describe 'when head is present' do
+    it 'injects the handler code' do
+      get '/'
+      expect(last_response.body).to include("alert('this is a dummy class');")
+    end
+
+    it 'will pass options to the Handler' do
+      get '/'
+      expect(last_response.body).to include("console.log('head');")
+      expect(last_response.body).to_not include("console.log('body');")
+    end
+
+    it 'injects custom variables that was directly assigned' do
+      get '/', {}, {'tracker' => { 'dummy' => 'foo bar'}}
+      expect(last_response.body).to include("alert('foo bar');")
+    end
+
+    it 'injects custom variables that lives in the session' do
+      get '/', {}, {'rack.session' => {'tracker' => { 'dummy' => 'bar foo'}}}
+      expect(last_response.body).to include("alert('bar foo');")
+    end
+  end
+
+  describe 'when body is present' do
+    it 'will not inject the body handler code' do
+      get '/body'
+      expect(last_response.body).to include("console.log('body');")
+      expect(last_response.body).to_not include("console.log('head');")
+    end
+  end
+
+  describe 'when head and body is present' do
+    it 'will pass options to the Handler' do
+      get '/body-head'
+      expect(last_response.body).to include("console.log('head');")
+      expect(last_response.body).to include("console.log('body');")
+    end
+  end
+
+  describe 'when a redirect' do
+    it 'will keep the tracker attributes and show them on the new location' do
+      get '/redirect', {}, { 'tracker' => { 'dummy' => 'Keep this!' } }
+      follow_redirect!
+      expect(last_response.body).to include("alert('Keep this!');")
+    end
+  end
+
+  describe 'when not html' do
+    it 'will not inject the handler code' do
+      get '/test.xml'
+
+      expect(last_response.body).to_not include("alert('this is a dummy class');")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-tracker
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Lars Brillert
@@ -9,37 +9,135 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2014-08-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Don’t fool around with adding tracking partials to your app concentrate
+description: Don’t fool around with adding tracking partials to your app and concentrate
   on the things that matter.
 email:
 - lars@railslove.com
@@ -48,15 +146,40 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/rack/tracker.rb
+- lib/rack/tracker/controller.rb
+- lib/rack/tracker/extensions.rb
+- lib/rack/tracker/facebook/facebook.rb
+- lib/rack/tracker/facebook/template/facebook.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
 - rack-tracker.gemspec
+- spec/fixtures/another_handler.erb
+- spec/fixtures/dummy.erb
+- spec/fixtures/track_all_the_things.erb
+- spec/fixtures/views/layouts/application.html.erb
+- spec/fixtures/views/metal/index.html.erb
+- spec/handler/facebook_spec.rb
+- spec/handler/google_analytics_spec.rb
+- spec/integration/rails_integration_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_handler.rb
+- spec/support/metal_controller.rb
+- spec/tracker/controller_spec.rb
+- spec/tracker/handler_delegator_spec.rb
+- spec/tracker/handler_set_spec.rb
+- spec/tracker/tracker_spec.rb
 homepage: https://github.com/railslove/rack-tracker
 licenses:
 - MIT
@@ -67,12 +190,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -81,4 +204,19 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Tracking made easy
-test_files: []
+test_files:
+- spec/fixtures/another_handler.erb
+- spec/fixtures/dummy.erb
+- spec/fixtures/track_all_the_things.erb
+- spec/fixtures/views/layouts/application.html.erb
+- spec/fixtures/views/metal/index.html.erb
+- spec/handler/facebook_spec.rb
+- spec/handler/google_analytics_spec.rb
+- spec/integration/rails_integration_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_handler.rb
+- spec/support/metal_controller.rb
+- spec/tracker/controller_spec.rb
+- spec/tracker/handler_delegator_spec.rb
+- spec/tracker/handler_set_spec.rb
+- spec/tracker/tracker_spec.rb