rack_google_tag_manager 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc8af5dcf4324b0118bf19a3d9f99fd7fd9945de
+  data.tar.gz: 16105a7d9ea57be1bdfec07318252ddc2bf26d37
+SHA512:
+  metadata.gz: b61054a57157c2a83f147dffb57912d45982f59cee1705528657be4cc2fac4145721e2868006272cc67fe5668b53ff84093310a0d3b081187a4ca7a0541b7ff8
+  data.tar.gz: a3835c2c0784e0794bc53fef0e66ba6061eeb3d260c3b838db3d2750f39d29ae9dd5717aa4c95439bd4f1a9888ca47942f0af7d2c00b36f6460b4b483cfe780f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 2.0.0
+  - 2.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### v1.0.0, 2014-12-12
+
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack_google_tag_manager.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 On the Beach
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Rack Google Tag Manager [![Build Status](https://travis-ci.org/onthebeach/rack_google_tag_manager.svg)](https://travis-ci.org/onthebeach/rack_google_tag_manager)
+
+Rack Middleware to inject [Google Tag Manager](https://developers.google.com/tag-manager/)
+code snippet into all html responses with body tag for rack based applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack_google_tag_manager'
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+### Rails
+
+Add this line to your application's config/application.rb:
+
+    config.middleware.use 'Rack::GoogleTagManager', tacker: 'GTM-XXXXXX'
+
+To pass inforamtion to GTM from your application you can do it with a JavaScript
+array called *dataLayer*. There are two ways to use it:
+
+1. `dataLayer = [{ 'data': 'myData' }]`
+2. `dataLayer.push({ 'data': 'myData' })`
+
+The first one will overwrite all existing values that were previously
+passed to the service, while the second will append the new values to
+the existing ones.
+
+In order for the `push` API so be usable, the *dataLayer* must first be
+declared as an array, the GTM JavaScript snippet inserted at the
+top of the body will declare it for us.
+
+This initial declaration must occur before snippet. Since the snippet
+must appear at the very top of the body, then the *dataLayer* declaration
+must be the very first item in the body.
+
+## Contributing
+
+1. Fork it ( http://github.com/onthebeach/rack_google_tag_manager/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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec

data/lib/rack/google_tag_manager/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class GoogleTagManager
+    VERSION = '1.0.0'
+  end
+end

data/lib/rack/google_tag_manager.rb

@@ -0,0 +1,62 @@
+require 'rack'
+
+module Rack
+  class GoogleTagManager
+    def initialize(app, tracker: tracker)
+      @app, @tracker = app, tracker
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      @status, @headers, @body = app.call(env)
+      return [@status, @headers, @body] unless html_response?
+
+      response = Rack::Response.new([], @status, @headers)
+      @body.each { |fragment| response.write(inject_in(fragment)) }
+
+      @body.close if @body.respond_to?(:close)
+
+      response.finish
+    end
+
+    private
+
+    attr_reader :app, :tracker
+
+    def html_response?
+      @headers['Content-Type'] =~ %r{text/html}
+    end
+
+    def inject_in(response)
+      response.sub(open_body_tag_regex, "\\0\n#{container_snippet}")
+    end
+
+    def open_body_tag_regex
+      %r{<body.*?>}im
+    end
+
+    def container_snippet
+      @container_snippet ||= <<-EOS
+<!-- Google Tag Manager -->
+<noscript>
+  <iframe src="//www.googletagmanager.com/ns.html?id=#{tracker}"
+    height="0" width="0" style="display:none;visibility:hidden">
+  </iframe>
+</noscript>
+
+<script>
+  dataLayer = [];
+  (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+  new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+  j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+  '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+  })(window, document, 'script', 'dataLayer', '#{tracker}');
+</script>
+<!-- End Google Tag Manager -->
+      EOS
+    end
+  end
+end

data/lib/rack_google_tag_manager.rb

@@ -0,0 +1,2 @@
+require 'rack/google_tag_manager'
+require 'rack/google_tag_manager/version'

data/rack_google_tag_manager.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/google_tag_manager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack_google_tag_manager'
+  spec.version       = Rack::GoogleTagManager::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ['Ancor Cruz']
+  spec.email         = ['hello@ancorcruz.com']
+  spec.summary       = %q{Rack Middleware to inject Google Tag Manager code snippet into server html responses for rack based applications}
+  spec.description   = %q{Rack Middleware to inject Google Tag Manager code snippet into server html responses for rack based applications}
+  spec.homepage      = 'https://github.com/onthebeach/rack_google_tag_manager'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'simplecov'
+end

data/spec/dummy/app.rb

@@ -0,0 +1,13 @@
+module Dummy
+  class App
+    def call(env)
+      [200, {"Content-Type" => "text/html"}, response]
+    end
+
+    private
+
+    def response
+      [::File.read(::File.expand_path('../response.html', __FILE__))]
+    end
+  end
+end

data/spec/dummy/config.ru

@@ -0,0 +1,6 @@
+require 'rack_google_tag_manager'
+require_relative 'app'
+
+use Rack::GoogleTagManager, tracker: 'GTM-M2014'
+use Rack::Lint
+run Dummy::App.new

data/spec/dummy/response.html

@@ -0,0 +1,9 @@
+<html>
+  <head>
+    <title>My Dummy app!</title>
+  </head>
+
+  <body class='main'>
+    <h1>There is some stuff</h1>
+  </body>
+</html>

data/spec/integration/rack_google_tag_manager_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Rack::GoogleTagManager do
+  include Rack::Test::Methods
+
+  let(:tracker_id) { 'GTM-M2014' }
+  let(:app) { Rack::Builder.parse_file(app_rackup_file).first }
+  let(:app_rackup_file) {
+    ::File.expand_path('../../dummy/config.ru', __FILE__)
+  }
+
+  before { get '/' }
+
+  it { expect(last_response).to be_ok }
+
+  it 'includes google tag manager container snippet' do
+    expect(last_response).to match(%r[<body.*?>.*#{tracker_id}.*<h1>.*<\/body>]m)
+  end
+end

data/spec/lib/rack_google_tag_manager_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+module Rack
+  describe GoogleTagManager do
+    let(:tracker_id) { 'GTM-FAKEID' }
+    let(:middleware) { described_class.new(mock_app, tracker: tracker_id) }
+    let(:request) { Rack::MockRequest.new(middleware) }
+
+    context 'for a text/html response' do
+      subject { request.get('/').body }
+
+      it 'adds the container snippet after body tag' do
+        expect(subject).to match(%r[<body.*?>.*#{tracker_id}.*Works!<\/body>]m)
+      end
+
+      it 'includes the dataLayer declaration' do
+        expect(subject).to include('dataLayer = []')
+      end
+    end
+
+    context 'for a text/html response with uppercase html tags' do
+      subject { request.get('/uppercase_tags.html').body }
+
+      it 'adds the container snippet after body tag' do
+        expect(subject).to match(%r[<BODY.*?>.*#{tracker_id}.*Works!<\/BODY>]m)
+      end
+    end
+
+    context 'for a text/html response without body tag' do
+      subject { request.get('/fragment.html').body }
+
+      it 'does not add the container snippet' do
+        expect(subject).not_to include(tracker_id)
+      end
+
+      it 'does not modify the response' do
+        expect(subject).to eq(mock_html_fragment)
+      end
+    end
+
+    context 'for no text/html responses' do
+      subject { request.get('/test.json').body }
+
+      it 'does not add the container snippet' do
+        expect(subject).not_to include(tracker_id)
+      end
+
+      it 'does not modify the response' do
+        expect(subject).to eq(mock_json_response)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'rack_google_tag_manager'
+require 'support/mock_app_helper'
+require 'rack/test'
+
+RSpec.configure do |config|
+  include MockAppHelper
+end

data/spec/support/mock_app_helper.rb

@@ -0,0 +1,35 @@
+module MockAppHelper
+  def mock_app
+    -> (env) {
+      request = Rack::Request.new(env)
+      case request.path
+      when '/' then
+        [200, { 'Content-Type' => 'text/html' }, [mock_html_response]]
+      when '/test.json' then
+        [200, { 'Content-Type' => 'application/json' }, [mock_json_response]]
+      when '/fragment.html' then
+        [200, { 'Content-Type' => 'text/html' }, [mock_html_fragment]]
+      when '/uppercase_tags.html' then
+        [200, { 'Content-Type' => 'text/html' }, [mock_uppercase_tags_response]]
+      else
+        [404, 'Not found']
+      end
+    }
+  end
+
+  def mock_html_response
+    '<body class="main">Works!</body>'
+  end
+
+  def mock_html_fragment
+    '<div>it is a fragment of html</div>'
+  end
+
+  def mock_json_response
+    '{"json":"here"}'
+  end
+
+  def mock_uppercase_tags_response
+    '<BODY>Works!</BODY>'
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: rack_google_tag_manager
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ancor Cruz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: rack-test
+  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: simplecov
+  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: Rack Middleware to inject Google Tag Manager code snippet into server
+  html responses for rack based applications
+email:
+- hello@ancorcruz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/google_tag_manager.rb
+- lib/rack/google_tag_manager/version.rb
+- lib/rack_google_tag_manager.rb
+- rack_google_tag_manager.gemspec
+- spec/dummy/app.rb
+- spec/dummy/config.ru
+- spec/dummy/response.html
+- spec/integration/rack_google_tag_manager_spec.rb
+- spec/lib/rack_google_tag_manager_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock_app_helper.rb
+homepage: https://github.com/onthebeach/rack_google_tag_manager
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rack Middleware to inject Google Tag Manager code snippet into server html
+  responses for rack based applications
+test_files:
+- spec/dummy/app.rb
+- spec/dummy/config.ru
+- spec/dummy/response.html
+- spec/integration/rack_google_tag_manager_spec.rb
+- spec/lib/rack_google_tag_manager_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock_app_helper.rb