rack-track 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+gem "rack"
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "rack-test"
+end

data/Gemfile.lock

@@ -0,0 +1,23 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rack (1.3.2)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rake (0.9.2)
+    rcov (0.9.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rack
+  rack-test
+  rcov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Michael Baldry
+
+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.markdown

@@ -0,0 +1,33 @@
+# Rack::Track
+
+On too many projects I've worked on, nobody actually know every tracking pixel we have, what areas/pages they appear on (or should appear on) and it 
+becomes a massive headache when you need to do work around them. This is where Rack::Track comes in to play, providing a DSL to define tracking pixels
+and the areas they should appear on. It's all in one place, instead of across layouts and pages and it's self documenting. 
+
+```ruby
+MyApp::Application.config.middleware.use(Rack::Track) do
+  area :confirmation_pages, "/checkout/order_confirmation", "/basket/complete"
+  
+  pixel "Generic GA", :on => :all_pages do
+    %Q{
+      <!-- GOOGLE ANALYTICS --> 
+      blah
+      <!-- END GOOGLE ANALYTICS --> 
+    }
+  end
+  
+  pixel "Goal GA", :on => :confirmation_pages do
+    %Q{
+      <!-- GOOGLE ANALYTICS --> 
+      blah
+      <!-- END GOOGLE ANALYTICS --> 
+    }
+  end
+end
+```
+These tracking pixels will be inserted in to the page before the body tag closes. This is what most tracking pixels expect. If you require a pixel
+to be placed in the head tag, or anywhere else, let me know and I'll extend it (or you could clone and submit a pull request with your changes!)
+
+      $ gem install rack-track
+
+      require "rack-track" # or "rack/track", whatever floats your boat.

data/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rack-track"
+  gem.version = "0.1.0"
+  gem.homepage = "http://github.com/michaelbaldry/rack-track"
+  gem.license = "MIT"
+  gem.summary = %Q{Taking all the pain away from managing Tracking Pixels}
+  gem.description = %Q{A rack middleware that allows you to define and document tracking pixels in one location}
+  gem.email = "clockwize@gmail.com"
+  gem.authors = ["Michael Baldry"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-track #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rack/track.rb

@@ -0,0 +1,54 @@
+module Rack
+  class Track
+    def initialize(app, &block)
+      @app = app
+      @rules = Rack::Track::PixelSet.new &block
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      status, headers, response = @app.call(env)
+      
+      if /^text\/html/ =~ headers["Content-Type"]
+        response_body = ""
+        response.each { |p| response_body += p }
+        response = [@rules.apply(request, response_body)] if response_body.include? "</body>"
+      end
+      
+      [status, headers, response]
+    end
+  
+    def each(&block)
+    end
+  
+    private
+  
+    class PixelSet
+      Pixel = Struct.new(:name, :area, :content)
+    
+      def initialize(&block)
+        @pixels = []
+        @areas = {}
+        self.instance_eval(&block) if block_given?
+      end
+    
+      def area(id, *paths)
+        @areas[id] = [] unless @areas[id]
+        paths.each { |path| @areas[id] << path.downcase }
+      end
+    
+      def pixel(name, opts = {}, &block)
+        @pixels << Pixel.new(name, opts[:on], block[])
+      end
+    
+      def apply(request, response)
+        url = URI::parse(request.url)
+        @pixels.each do |p|
+          paths = @areas[p.area]
+          response.insert(response.rindex("</body>"), p.content) if p.area == :all || paths.include?(url.path.downcase)
+        end
+        response
+      end
+    end
+  end
+end

data/lib/rack-track.rb

@@ -0,0 +1 @@
+require "rack/track"

data/rack-track.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-track}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Michael Baldry}]
+  s.date = %q{2011-08-03}
+  s.description = %q{A rack middleware that allows you to define and document tracking pixels in one location}
+  s.email = %q{clockwize@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "lib/rack-track.rb",
+    "lib/rack/track.rb",
+    "rack-track.gemspec",
+    "test/helper.rb",
+    "test/test_rack-track.rb"
+  ]
+  s.homepage = %q{http://github.com/michaelbaldry/rack-track}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{Taking all the pain away from managing Tracking Pixels}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rack-test>, [">= 0"])
+    else
+      s.add_dependency(%q<rack>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rack>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'rack/test'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rack-track'
+
+class Test::Unit::TestCase
+end

data/test/test_rack-track.rb

@@ -0,0 +1,107 @@
+require 'helper'
+
+class TestRackTrack < Test::Unit::TestCase
+  include Rack::Test::Methods
+  
+  def initialize(x)
+    super(x)
+    @rules = lambda {}
+    @app_class = SimpleApp
+  end
+  
+  FAIL_RULE = Proc.new do
+    pixel "Test pixel", :on => :all do
+      "FAIL"
+    end
+  end
+  
+  class SimpleApp
+    def call(env)
+      [200, {'Content-Type' => "text/html"}, ["<html><head><title></title></head><body>hello this is the body</body></html>"]]
+    end
+  end
+  
+  def app
+    Rack::Track.new(@app_class.new, &@rules)
+  end
+  
+  def test_defining_pixels_and_areas_with_dsl
+    tp = Rack::Track::PixelSet.new do
+      area :confirmation, "business-energy/confirmation", "business-communications/confirmation"
+      
+      pixel "Confirmation (GA)", :on => :confirmation do
+        "THIS IS A GA CONFIRMATION TEST"
+      end
+    end
+
+    assert tp.instance_variable_get(:@areas) == {:confirmation => ["business-energy/confirmation", "business-communications/confirmation"]}
+    assert tp.instance_variable_get(:@pixels) == [Rack::Track::PixelSet::Pixel.new("Confirmation (GA)", :confirmation, "THIS IS A GA CONFIRMATION TEST")]
+  end
+  
+  def test_psudo_area_all
+    @rules = Proc.new do 
+      pixel "Test pixel", :on => :all do
+        "THIS-IS-A-TEST"
+      end
+    end
+    get '/'
+    assert last_response.body.include? "THIS-IS-A-TEST</body>"
+    get '/poatoes'
+    assert last_response.body.include? "THIS-IS-A-TEST</body>"
+  end
+  
+  def test_area_inclusion
+    @rules = Proc.new do 
+      area :an_area, "/blah", "/blah/test"
+      
+      pixel "Test pixel", :on => :an_area do
+        "THIS-IS-A-TEST"
+      end
+    end
+    get '/'
+    assert !last_response.body.include?("THIS-IS-A-TEST</body>")
+    get '/blah'
+    assert last_response.body.include? "THIS-IS-A-TEST</body>"
+    get '/blah/test'
+    assert last_response.body.include? "THIS-IS-A-TEST</body>"
+  end
+  
+  def test_only_works_on_html_pages
+    @app_class = Class.new do
+      def call(env)
+        [200, {'Content-Type' => "text/css"}, ["<html><head><title></title></head><body>hello this is the body</body></html>"]]
+      end
+    end
+    
+    @rules = FAIL_RULE
+    
+    get '/'
+    assert last_response.body != "<html><head><title></title></head><body>hello this is the bodyFAIL</body></html>"
+  end
+  
+  def test_only_works_on_html_pages_with_charset
+    @app_class = Class.new do
+      def call(env)
+        [200, {'Content-Type' => "text/html; charset=utf-8"}, ["<html><head><title></title></head><body>hello this is the body</body></html>"]]
+      end
+    end
+    
+    @rules = FAIL_RULE
+    
+    get '/'
+    assert last_response.body == "<html><head><title></title></head><body>hello this is the bodyFAIL</body></html>"
+  end
+  
+  def test_only_works_on_pages_with_closing_body
+    @app_class = Class.new do
+      def call(env)
+        [200, {'Content-Type' => "text/html; charset=utf-8"}, ["<html><head><title></title></head><body>hello this is the body</html>"]]
+      end
+    end
+    
+    @rules = FAIL_RULE
+    
+    get '/'
+    assert last_response.body == "<html><head><title></title></head><body>hello this is the body</html>"
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: rack-track
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Baldry
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: A rack middleware that allows you to define and document tracking pixels in one location
+email: clockwize@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- lib/rack-track.rb
+- lib/rack/track.rb
+- rack-track.gemspec
+- test/helper.rb
+- test/test_rack-track.rb
+homepage: http://github.com/michaelbaldry/rack-track
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3420878610649270305
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Taking all the pain away from managing Tracking Pixels
+test_files: []
+