rack-param_to_cookie 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36aaf45de3d68dad838f4ef7c340316756698f6e
+  data.tar.gz: 01ff0729c13a30a8f8497ffa92ba83d8d9b5b259
+SHA512:
+  metadata.gz: e9d73307405f7344505f783fd77fe1f05ed801c73f4d24686a147ca3f8501f523eea3744be58611c35c988e0308d9e78dc941049755c69ce8a965742507d3eff
+  data.tar.gz: d059d64e866b4d6cea3538f6229091252936d5073f32e3c02dd28a459ff004ae02a2b390c88cf851592ea928009064b4ef159db01a1f61d9ec819fd8f92ce237

data/README.rdoc

@@ -0,0 +1,74 @@
+= Rack::ParamToCookie
+
+* https://github.com/jdleesmiller/rack-param_to_cookie
+
+== SYNOPSIS
+
+Rack::ParamToCookie is a rack middleware that extracts request parameters from requests and stores them in cookies for use in future requests. It's useful for affiliate, referral or promotion links, which often work something like:
+
+1. A referral partner puts a link on their site to somewhere on your site, and they include a request parameter like +ref+ so you can identify traffic from them, e.g. https://www.example.com/some-interesting-page?ref=123ABC
+1. A user clicks through the link and comes to your site.
+1. The Rack::ParamToCookie middleware finds the +ref+ parameter and stores it in a cookie for this user.
+1. The user browses around for a while and eventually signs up.
+1. Your sign up action recovers the referral code, +123ABC+, from the cookie, and you mark it as a successful referral from your partner.
+1. $$$$!
+
+== Usage
+
+In a Rails app, you can add it as middleware in +config/application.rb+. For a parameter called +ref+, the basic usage is:
+
+  config.middleware.use 'Rack::ParamToCookie', 'ref' => {}
+  
+This tells Rack::ParamToCookie to capture a request parameter called +ref+, store it in a cookie called +ref+, and make it available in your rails app as <tt>request.env['ref']</tt>. You can specify multiple parameters and configure them. Here's a more in-depth example:
+
+  config.middleware.use 'Rack::ParamToCookie',
+    'ref' => {cookie_name: 'referral_code',
+              env_name: 'referral.code',
+              ttl: 14*24*60*60},
+    'aff' => {cookie_name: 'affiliate_code',
+              env_name: 'affiliate.code'}
+
+The first cookie, +referral_code+ for parameter +ref+, has a 14 day time to live and is accessible in +request.env+ <tt>['referral.code']</tt>. The second, for parameter +aff+, has the default time to live, which is 30 days.
+
+== Installation
+
+Add to your Gemfile
+
+  gem 'rack-param_to_cookie'
+
+Or install directly
+
+  gem install rack-param_to_cookie
+
+You can load it with
+
+  require 'rack/param_to_cookie'
+
+== Credits
+
+This middleware is mostly based on Rack::Affiliates (https://github.com/alexlevin/rack-affiliates); this middleware is just a bit more generic and configurable.
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2014 John Lees-Miller
+
+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/lib/rack-param_to_cookie.rb

@@ -0,0 +1 @@
+require 'rack/param_to_cookie'

data/lib/rack/param_to_cookie.rb

@@ -0,0 +1,58 @@
+require 'rack/param_to_cookie/version'
+
+module Rack
+  #
+  # Rack middleware. See README.
+  #
+  class ParamToCookie
+    #
+    # @param [Object] app
+    #
+    # @param [Hash<String, Hash>] param_cookies map from parameter names to
+    #                             cookie options
+    #
+    def initialize app, param_cookies
+      @app = app
+      @param_cookies = param_cookies
+      @param_cookies.each do |param, options|
+        options[:cookie_name] ||= param
+        options[:env_name] ||= param
+        options[:ttl] ||= 60*60*24*30 # 30 days
+        options[:set_cookie_options] ||= {}
+      end
+    end
+
+    def call env
+      req = Rack::Request.new(env)
+
+      updated_cookies = {}
+      @param_cookies.each do |param, options|
+        # get the value from a previously set cookie
+        cookie_value = req.cookies[options[:cookie_name]]
+
+        # check whether there's a new value for the cookie with this request
+        params_value = req.params[param] rescue nil
+
+        value = params_value || cookie_value
+        env[options[:env_name]] = value if value
+
+        # once we handle the response, set the new cookie value
+        if params_value
+          updated_cookies[options[:cookie_name]] =
+            options[:set_cookie_options].merge(
+              value: params_value,
+              expires: Time.now + options[:ttl])
+        end
+      end
+
+      status, headers, body = @app.call(env)
+      response = Rack::Response.new body, status, headers
+
+      updated_cookies.each do |cookie, options|
+        response.set_cookie cookie, options
+      end
+
+      response.finish
+    end
+  end
+end

data/lib/rack/param_to_cookie/version.rb

@@ -0,0 +1,8 @@
+module Rack
+  class ParamToCookie
+    VERSION_MAJOR = 1
+    VERSION_MINOR = 0
+    VERSION_PATCH = 0
+    VERSION = [VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH].join('.')
+  end
+end

data/test/rack/param_to_cookie/param_to_cookie_test.rb

@@ -0,0 +1,135 @@
+require 'minitest/autorun'
+require 'rack/test'
+
+require 'rack/param_to_cookie'
+
+describe "Rack::ParamToCookie" do
+  include Rack::Test::Methods
+
+  def make_app *param_cookies
+    dummy_app = lambda do |env|
+      [200, {'Content-Type' => 'text/plain'}, ['hi']]
+    end
+    @app = Rack::ParamToCookie.new(dummy_app, *param_cookies)
+  end
+
+  def app
+    @app
+  end
+
+  describe "with defaults and a ref param" do
+    before do
+      make_app 'ref' => {}
+      clear_cookies
+    end
+
+    it "should do nothing when there is no ref parameter" do
+      get '/'
+
+      assert_equal nil, last_request.env['ref']
+      assert_equal({}, rack_mock_session.cookie_jar.to_hash)
+    end
+
+    it "should set a ref cookie if one is present" do
+      # first request sets ref
+      get '/', ref: 'abc'
+      assert_equal 'abc', last_request.env['ref']
+      assert_equal({'ref' => 'abc'}, rack_mock_session.cookie_jar.to_hash)
+      assert_match(/abc/, last_response.headers['Set-Cookie'])
+
+      # it should be remembered on the second request
+      get '/'
+      assert_equal 'abc', last_request.env['ref']
+      assert_equal({'ref' => 'abc'}, rack_mock_session.cookie_jar.to_hash)
+      assert_equal nil, last_response.headers['Set-Cookie']
+
+      # if we set it again, it gets overwritten
+      get '/', ref: '123'
+      assert_equal '123', last_request.env['ref']
+      assert_equal({'ref' => '123'}, rack_mock_session.cookie_jar.to_hash)
+      assert_match(/123/, last_response.headers['Set-Cookie'])
+
+      # ... and remembered
+      get '/'
+      assert_equal '123', last_request.env['ref']
+      assert_equal({'ref' => '123'}, rack_mock_session.cookie_jar.to_hash)
+      assert_equal nil, last_response.headers['Set-Cookie']
+    end
+  end
+
+  describe "with multiple parameters and custom names" do
+    before do
+      make_app \
+        'ref' => {cookie_name: 'ref_cookie', env_name: 'ref.env', ttl: 10},
+        'aff' => {cookie_name: 'aff_cookie', env_name: 'aff.env', ttl: 20}
+      clear_cookies
+    end
+
+    it "should set ref and aff" do
+      # initially no cookies
+      get '/'
+      assert_equal nil, last_request.env['ref.env']
+      assert_equal nil, last_request.env['aff.env']
+      assert_equal({}, rack_mock_session.cookie_jar.to_hash)
+
+      # set both at the same time
+      get '/', ref: 'foo', aff: 'bar'
+      assert_equal 'foo', last_request.env['ref.env']
+      assert_equal 'bar', last_request.env['aff.env']
+      assert_equal({'ref_cookie' => 'foo', 'aff_cookie' => 'bar'},
+                   rack_mock_session.cookie_jar.to_hash)
+
+      # should have set cookies with expiry times ~10s and ~20s, resp.
+      cookie_header = last_response.headers['Set-Cookie']
+      expires = cookie_header.scan(/^(.+?)_cookie=.+?; expires=(.+?)$/)
+      expires = expires.map {|cookie, date| [cookie, Time.parse(date)]}.to_h
+      assert expires['ref'] >  Time.now + 9
+      assert expires['ref'] <= Time.now + 11
+      assert expires['aff'] >  Time.now + 19
+      assert expires['aff'] <= Time.now + 21
+      assert_equal 2, expires.size
+
+      # retreive both
+      get '/'
+      assert_equal 'foo', last_request.env['ref.env']
+      assert_equal 'bar', last_request.env['aff.env']
+      assert_equal({'ref_cookie' => 'foo', 'aff_cookie' => 'bar'},
+                   rack_mock_session.cookie_jar.to_hash)
+      assert_equal nil, last_response.headers['Set-Cookie']
+
+      # update ref
+      get '/', ref: 'baz'
+      assert_equal 'baz', last_request.env['ref.env']
+      assert_equal 'bar', last_request.env['aff.env']
+      assert_equal({'ref_cookie' => 'baz', 'aff_cookie' => 'bar'},
+                   rack_mock_session.cookie_jar.to_hash)
+      assert_match(/baz/, last_response.headers['Set-Cookie'])
+      assert(/bar/ !~ last_response.headers['Set-Cookie'])
+
+      # retreive both
+      get '/'
+      assert_equal 'baz', last_request.env['ref.env']
+      assert_equal 'bar', last_request.env['aff.env']
+      assert_equal({'ref_cookie' => 'baz', 'aff_cookie' => 'bar'},
+                   rack_mock_session.cookie_jar.to_hash)
+      assert_equal nil, last_response.headers['Set-Cookie']
+
+      # update aff
+      get '/', aff: 'bat'
+      assert_equal 'baz', last_request.env['ref.env']
+      assert_equal 'bat', last_request.env['aff.env']
+      assert_equal({'ref_cookie' => 'baz', 'aff_cookie' => 'bat'},
+                   rack_mock_session.cookie_jar.to_hash)
+      assert_match(/bat/, last_response.headers['Set-Cookie'])
+      assert(/baz/ !~ last_response.headers['Set-Cookie'])
+
+      # retreive both
+      get '/'
+      assert_equal 'baz', last_request.env['ref.env']
+      assert_equal 'bat', last_request.env['aff.env']
+      assert_equal({'ref_cookie' => 'baz', 'aff_cookie' => 'bat'},
+                   rack_mock_session.cookie_jar.to_hash)
+      assert_equal nil, last_response.headers['Set-Cookie']
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: rack-param_to_cookie
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- John Lees-Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: gemma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.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'
+description: Store selected request parameters to cookies for use in future requests.
+  Useful for affiliate, referral or promotion links.
+email:
+- jdleesmiller@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- lib/rack-param_to_cookie.rb
+- lib/rack/param_to_cookie.rb
+- lib/rack/param_to_cookie/version.rb
+- test/rack/param_to_cookie/param_to_cookie_test.rb
+homepage: https://github.com/jdleesmiller/rack-param_to_cookie
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.rdoc
+- "--title"
+- rack-param_to_cookie-1.0.0 Documentation
+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: Store selected request parameters to cookies.
+test_files:
+- test/rack/param_to_cookie/param_to_cookie_test.rb
+has_rdoc: