rack-ga-track 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b92bcb3b371ada83ad23980f38d88415c8110f81
+  data.tar.gz: a265c689ac2191bbfc423976eb55978b96bcb3ae
+SHA512:
+  metadata.gz: 2336943aab1d42f717bf7407ce461eb9e9696b11708ab387da76656ab112edff9fec3d9b421dcd43488ed79fc1c7a015dd57ee7ac8eef740867773e0f3faf490
+  data.tar.gz: c2cbb3e4dfe72c65fbabe72524ba927653ddd54e5d9d0b05827e5652bc9c58d730e52178c63d07c9068512c7b80e3413c05c0e56a170e6778a73f669e18b7b66

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+gem "rack", "~> 1.5", ">= 1.5.2"
+
+group :development do
+  gem "bundler", "~> 1.6", ">= 1.6.2"
+  gem "jeweler", "~> 1.6", ">= 1.6.4"
+  gem 'simplecov', '~> 0.8', ">= 0.8.2"
+  gem "rack-test", "~> 0.6", ">= 0.6.2"
+  gem "minitest", "~> 5.4", ">= 5.4.0"
+  gem "timecop", "~> 0.7", ">= 0.7.1"
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    docile (1.1.5)
+    git (1.2.7)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    minitest (5.4.0)
+    multi_json (1.10.1)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.3.2)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    timecop (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6, >= 1.6.2)
+  jeweler (~> 1.6, >= 1.6.4)
+  minitest (~> 5.4, >= 5.4.0)
+  rack (~> 1.5, >= 1.5.2)
+  rack-test (~> 0.6, >= 0.6.2)
+  simplecov (~> 0.8, >= 0.8.2)
+  timecop (~> 0.7, >= 0.7.1)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License
+Original work Copyright (c) 2011 Alex Levin
+Modified work Copyright (c) 2014 Unitio, Inc
+
+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,59 @@
+Rack::GaTrack
+================
+
+Rack::GaTrack is a rack middleware that extracts Google Analytics Campaign
+params from the request. Specifically, it looks for a param utm\_source in the request.
+If found, it creates a cookie with utm\_source, utm\_content, utm\_term,
+utm\_campaign, and time.
+
+Use Case
+---------------
+Let's say you want to track signups in your app from a specific campaign.
+
+1. A user clicks a link on an external site that has your Google Analytics
+   Campaign params in the request.
+2. Rack::GaTrack finds utm\_source param in the
+   request and parses the other Google Analytics Campaign params from the request and saves them in a cookie.
+3. If a user signs up now or in the future you can read the Google Analytics
+   Campaign params from the env variables that Rack::GaTrack creates and save
+   them to the created user record.
+
+Installation
+------------
+gem install rack-ga-track
+
+Rails 4 Example Usage
+---------------------
+
+Add the Rack::GaTrack to your application stack:
+
+    #Rails 4 in config/application.rb
+    class Application < Rails::Application
+      config.middleware.use Rack::GaTrack
+    end
+
+You can now access your Google Analytics Campaign params in
+<code>request.env['ga\_track.source']</code>
+<code>request.env['ga\_track.term']</code>
+<code>request.env['ga\_track.content']</code>
+<code>request.env['ga\_track.campaign']</code>
+<code>request.env['ga\_track.medium']</code>
+
+Customization
+-------------
+
+By default cookie is set for 30 days, you can extend time to live with <code>:ttl</code> option (default is 30 days).
+
+    #Rails 4 in config/application.rb
+    class Application < Rails::Application
+      config.middleware.use Rack::Affiliates, :ttl => 3.months
+    end
+
+The <code>:domain</code> option allows to customize cookie domain.
+
+    #Rails 4 in config/application.rb
+    class Application < Rails::Application
+      config.middleware.use Rack::Affiliates, :domain => '.example.org'
+    end
+
+Rack::GaTrack will set cookie on <code>.example.org</code> so it's accessible on <code>www.example.org</code>, <code>app.example.org</code> etc.

data/Rakefile

@@ -0,0 +1,35 @@
+# 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-ga-track"
+  gem.homepage = "http://github.com/T1D/rack-ga-track"
+  gem.license = "MIT"
+  gem.summary = %Q{Tracks referrals via Google Analytics Campaign links.}
+  gem.description = %Q{If the user visits via a Google Analytics Campaign link,
+  this middleware will track utm_source, utm_content, utm_term, utm_medium, utm_campaign, and time.}
+  gem.email = "dnolan@t1dexchange.org"
+  gem.authors = ["Daniel Nolan"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |test|
+  test.libs << 'lib' << 'spec'
+  test.pattern = 'spec/**/*_spec.rb'
+  test.verbose = true
+end
+
+task :default => :spec

data/VERSION

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

data/lib/rack-ga-track.rb

@@ -0,0 +1,61 @@
+module Rack
+  class GaTrack
+
+    def initialize(app, opts = {})
+      @app = app
+      @cookie_ttl = opts[:ttl] || 60*60*24*30
+      @cookie_domain = opts[:domain] || nil
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+      status, headers, body = @app.call(env)
+
+      args = {}
+
+      if req.cookies['utm_source']
+        args = params_hash(req.cookies)
+      elsif req.params['utm_source']
+        args = params_hash(req.params)
+        create_cookies(headers, args)
+      end
+
+      unless args.empty?
+        create_env_vars(env, args)
+      end
+
+      [status, headers, body]
+    end
+
+    private
+
+    def params_hash(params)
+      params['utm_time'] ||= Time.now
+
+      {
+        source: params['utm_source'],
+        medium: params['utm_medium'],
+        term: params['utm_term'],
+        content: params['utm_content'],
+        campaign: params['utm_campaign'],
+        time: params['utm_time'].to_i
+      }
+    end
+
+    def create_cookies(headers, args)
+      expires = Time.now + @cookie_ttl
+        args.each do |key, value|
+          cookie_hash = {:value => value, :expires => expires}
+          cookie_hash[:domain] = @cookie_domain if @cookie_domain
+          cookie_key = 'utm_' + key.to_s
+          Rack::Utils.set_cookie_header!(headers, cookie_key, cookie_hash)
+      end
+    end
+
+    def create_env_vars(env, args)
+      args.each do |key, value|
+        env["ga_track.#{key.to_s}"] = value
+      end
+    end
+  end
+end

data/rack-ga-track.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: rack-ga-track 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "rack-ga-track"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Daniel Nolan"]
+  s.date = "2014-07-15"
+  s.description = "If the user visits via a Google Analytics Campaign link,\n  this middleware will track utm_source, utm_content, utm_term, utm_medium, utm_campaign, and time."
+  s.email = "dnolan@t1dexchange.org"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/rack-ga-track.rb",
+    "rack-ga-track.gemspec",
+    "spec/helper.rb",
+    "spec/rack_ga_track_spec.rb"
+  ]
+  s.homepage = "http://github.com/T1D/rack-ga-track"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.3.0"
+  s.summary = "Tracks referrals via Google Analytics Campaign links."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, [">= 1.5.2", "~> 1.5"])
+      s.add_development_dependency(%q<bundler>, [">= 1.6.2", "~> 1.6"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.6.4", "~> 1.6"])
+      s.add_development_dependency(%q<simplecov>, [">= 0.8.2", "~> 0.8"])
+      s.add_development_dependency(%q<rack-test>, [">= 0.6.2", "~> 0.6"])
+      s.add_development_dependency(%q<minitest>, [">= 5.4.0", "~> 5.4"])
+      s.add_development_dependency(%q<timecop>, [">= 0.7.1", "~> 0.7"])
+    else
+      s.add_dependency(%q<rack>, [">= 1.5.2", "~> 1.5"])
+      s.add_dependency(%q<bundler>, [">= 1.6.2", "~> 1.6"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.4", "~> 1.6"])
+      s.add_dependency(%q<simplecov>, [">= 0.8.2", "~> 0.8"])
+      s.add_dependency(%q<rack-test>, [">= 0.6.2", "~> 0.6"])
+      s.add_dependency(%q<minitest>, [">= 5.4.0", "~> 5.4"])
+      s.add_dependency(%q<timecop>, [">= 0.7.1", "~> 0.7"])
+    end
+  else
+    s.add_dependency(%q<rack>, [">= 1.5.2", "~> 1.5"])
+    s.add_dependency(%q<bundler>, [">= 1.6.2", "~> 1.6"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.4", "~> 1.6"])
+    s.add_dependency(%q<simplecov>, [">= 0.8.2", "~> 0.8"])
+    s.add_dependency(%q<rack-test>, [">= 0.6.2", "~> 0.6"])
+    s.add_dependency(%q<minitest>, [">= 5.4.0", "~> 5.4"])
+    s.add_dependency(%q<timecop>, [">= 0.7.1", "~> 0.7"])
+  end
+end
+

data/spec/helper.rb

@@ -0,0 +1,35 @@
+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 "simplecov"
+SimpleCov.start
+
+require "minitest/spec"
+require "minitest/autorun"
+require "rack/test"
+require 'timecop'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rack-ga-track'
+
+class MiniTest::Test
+  include Rack::Test::Methods
+
+  def app
+    hello_world_app = lambda do |env|
+      [200, {}, "Hello World"]
+    end
+
+    @app = Rack::GaTrack.new(hello_world_app)
+  end
+end
+

data/spec/rack_ga_track_spec.rb

@@ -0,0 +1,80 @@
+require 'helper'
+
+describe "RackGaTrack" do
+  before :each do
+    clear_cookies
+  end
+
+  it "should handle empty GA Campaign params" do
+    get '/'
+
+    last_request.env['ga_track.source'].must_equal nil
+    last_request.env['ga_track.term'].must_equal nil
+    last_request.env['ga_track.campaign'].must_equal nil
+    last_request.env['ga_track.content'].must_equal nil
+    last_request.env['ga_track.medium'].must_equal nil
+    last_request.env['ga_track.time'].must_equal nil
+  end
+
+  it "should set ga_track env vars from params" do
+    Timecop.freeze do
+      @time = Time.now
+      get '/', {utm_source: 'testing', utm_campaign: 'email', utm_content: 'test_content'}
+    end
+
+    last_request.env['ga_track.source'].must_equal "testing"
+    last_request.env['ga_track.campaign'].must_equal "email"
+    last_request.env['ga_track.content'].must_equal "test_content"
+    last_request.env['ga_track.time'].must_equal @time.to_i
+  end
+
+  it "should save GA Campaign params in a cookie" do
+    Timecop.freeze do
+      @time = Time.now
+      get '/', {utm_source: 'testing', utm_campaign: 'email', utm_content: 'test_content'}
+    end
+
+    rack_mock_session.cookie_jar["utm_source"].must_equal "testing"
+    rack_mock_session.cookie_jar["utm_campaign"].must_equal "email"
+    rack_mock_session.cookie_jar["utm_content"].must_equal "test_content"
+    rack_mock_session.cookie_jar["utm_time"].must_equal "#{@time.to_i}"
+  end
+
+  describe "when cookie exists" do
+    before :each do
+      @time = Time.now
+      clear_cookies
+      set_cookie("utm_source=testing")
+      set_cookie("utm_campaign=email")
+      set_cookie("utm_content=test_content")
+      set_cookie("utm_time=#{@time.to_i}")
+    end
+
+    it "should restore GA Campaign params from cookie" do
+      Timecop.freeze do
+        get '/'
+      end
+
+      last_request.env['ga_track.source'].must_equal "testing"
+      last_request.env['ga_track.campaign'].must_equal "email"
+      last_request.env['ga_track.content'].must_equal "test_content"
+      last_request.env['ga_track.time'].must_equal @time.to_i
+    end
+
+    it 'should not update existing cookie' do
+      Timecop.freeze(60*60*24) do
+        get '/'
+      end
+
+      last_request.env['ga_track.source'].must_equal "testing"
+      last_request.env['ga_track.campaign'].must_equal "email"
+      last_request.env['ga_track.content'].must_equal "test_content"
+      last_request.env['ga_track.time'].must_equal @time.to_i
+
+      rack_mock_session.cookie_jar["utm_source"].must_equal "testing"
+      rack_mock_session.cookie_jar["utm_campaign"].must_equal "email"
+      rack_mock_session.cookie_jar["utm_content"].must_equal "test_content"
+      rack_mock_session.cookie_jar["utm_time"].must_equal "#{@time.to_i}"
+    end
+  end
+ end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: rack-ga-track
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Nolan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-15 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
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: |-
+  If the user visits via a Google Analytics Campaign link,
+    this middleware will track utm_source, utm_content, utm_term, utm_medium, utm_campaign, and time.
+email: dnolan@t1dexchange.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/rack-ga-track.rb
+- rack-ga-track.gemspec
+- spec/helper.rb
+- spec/rack_ga_track_spec.rb
+homepage: http://github.com/T1D/rack-ga-track
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Tracks referrals via Google Analytics Campaign links.
+test_files: []