rack-referral-tracking 0.0.1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Craig Kerstiens and Matthew Conway
+
+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,36 @@
+# Rack::Referral::Tracking
+
+Rack middleware that detects requests from a referral and places some details
+about the referral in a user's cookies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-referral-tracking'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-referral-tracking
+
+## Usage
+
+Set a secure secret in your environment:
+
+    $ export SECRET=50mJn9wvwAXtQ28obpwxD7uMcqJRUquFz+GMRGDB4ZU=
+
+Then in your Rack-based application:
+
+    use Rack::ReferralTracking::Middleware
+
+## Contributing
+
+1. Fork it
+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 @@
+require "bundler/gem_tasks"

data/lib/rack-referral-tracking.rb

@@ -0,0 +1,8 @@
+require "rack-referral-tracking/version"
+
+require "rack-referral-tracking/middleware"
+
+module Rack
+  module ReferralTracking
+  end
+end

data/lib/rack-referral-tracking/middleware.rb

@@ -0,0 +1,46 @@
+require 'domainatrix'
+require 'fernet'
+require 'uri'
+
+module Rack
+  module ReferralTracking
+    class Middleware
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        status, headers, body = @app.call(env)
+
+        params        = CGI.parse env['QUERY_STRING']
+        host          = Domainatrix.parse(env["SERVER_NAME"]).domain_with_tld
+        cookie_domain = '.' + host
+
+        if referred_from_outside?(env)
+          referer = Fernet.generate(ENV['SECRET']) do |generator|
+            generator.data = { :referrer => env["HTTP_REFERER"] }
+          end
+        end
+
+        Rack::Utils.set_cookie_header!(headers, "utm_campaign", :value => params['utm_campaign'], :domain => cookie_domain, :path => '/') if params.has_key? 'utm_campaign'
+        Rack::Utils.set_cookie_header!(headers, "utm_source", :value => params['utm_source'], :domain => cookie_domain, :path => '/') if params.has_key? 'utm_source'
+        Rack::Utils.set_cookie_header!(headers, "utm_medium", :value => params['utm_medium'], :domain => cookie_domain, :path => '/') if params.has_key? 'utm_medium'
+        Rack::Utils.set_cookie_header!(headers, "ref", :value => referer, :domain => cookie_domain, :path => '/') if referer
+
+        [status, headers, body]
+      end
+
+      private
+
+      def referred_from_outside?(env)
+        if env.has_key? 'HTTP_REFERER'
+          refererer_domain = Domainatrix.parse(env['HTTP_REFERER']).domain_with_tld
+          host             = Domainatrix.parse(env["SERVER_NAME"]).domain_with_tld
+          host != refererer_domain
+        end
+      end
+
+    end
+  end
+end

data/lib/rack-referral-tracking/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module ReferralTracking
+    VERSION = "0.0.1"
+  end
+end

data/rack-referral-tracking.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack-referral-tracking/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rack-referral-tracking"
+  gem.version       = Rack::ReferralTracking::VERSION
+  gem.authors       = ["Craig Kerstiens", "Matthew Conway"]
+  gem.email         = ["himself@mattonrails.com"]
+  gem.description   = %q{Remember a visitor's referrer across subdomains}
+  gem.summary       = %q{Remember a visitor's referrer across subdomains}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'domainatrix'
+  gem.add_dependency 'fernet'
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rack-referral-tracking
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Craig Kerstiens
+- Matthew Conway
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: domainatrix
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fernet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Remember a visitor's referrer across subdomains
+email:
+- himself@mattonrails.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-referral-tracking.rb
+- lib/rack-referral-tracking/middleware.rb
+- lib/rack-referral-tracking/version.rb
+- rack-referral-tracking.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1136483963235757473
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1136483963235757473
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Remember a visitor's referrer across subdomains
+test_files: []