rack-affiliates 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f235b3dda5e49f7479173870577df0d1395be2ba
+  data.tar.gz: ec21042f606fed14b1f4279d30696c6f90f84cce
+SHA512:
+  metadata.gz: ce1c76fb4708658fd508a88bb51226f2e01dc81bd266c5cd0c26cec8779a34d306377b0ef4c73f36cc30f7bd268ff1566e4c6eef485c7ead903c1eaa3f4ab38d
+  data.tar.gz: 7f788ac693dae917858b26022f04badc8792b0dad4f63fbe213d799ddaeb699f789a2149d0e7ce069cb3fb040cf45a0b2902b7aec229eaa0fdfec954e7b7f49c

data/Gemfile

@@ -2,9 +2,9 @@ source "http://rubygems.org"
 gem 'rack'
 
 group :development do
-  gem "bundler", "~> 1.0.0"
+  gem "bundler", "~> 1.6"
   gem "jeweler", "~> 1.6.4"
-  gem "rcov", ">= 0"
+  gem "simplecov"
   gem "rack-test"
   gem "minitest"
   gem "timecop"

data/README.md

@@ -1,13 +1,20 @@
-Rack::Referrals
-=============
+Rack::Affiliates
+================
 
-Rack::Affiliates is a rack middleware that extracts information about the referrals came from an an affiliated site. Specifically, it looks up for parameter (eg. <code>ref</code> by default) in the request. If found it persists referal tag, referring url and time in a cookie for later use.
+Rack::Affiliates is a rack middleware that extracts information about the referrals came from an affiliated site. Specifically, it looks up for specific parameter (<code>ref</code> by default) in the request. If found, it persists affiliate tag, referring url and time in a cookie for later use.
 
-Purpose
--------
+Common Scenario
+---------------
 
 Affiliate links tracking is very common task if you want to promote your online business. This middleware helps you to do that.
 
+1. You associate an affiliate tag (for eg. <code>ABC123</code>) with your partner.
+2. The affiliate promotes your business at http://partner.org by linking to your site with like <code>http://yoursite.org?ref=ABC123</code>.
+3. A user clicks through the link and lands on your site.
+4. Rack::Affiliates middleware finds <code>ref</code> parameter in the request, extracts affiliate tag and saves it in a cookie
+5. User signs up (now or later) and you mark it as a referral from your partner
+6. PROFIT!
+
 Installation
 ------------
 
@@ -35,14 +42,14 @@ Add the middleware to your application stack:
       ...
     end
 
-Now you can check any request to see who came to your site via an affiliated link and use this information in your application. Moreover, referrer_id is saved in the cookie and will come into play if user returns to your site later.
+Now you can check any request to see who came to your site via an affiliated link and use this information in your application. Affiliate tag is saved in the cookie and will come into play if user returns to your site later.
 
     class ExampleController < ApplicationController
       def index
-        str = if request.env['affiliate.tag] && affiliate = User.find_by_affiliate_tag(request.env['affiliate.tag'])
-          "Howdy, referral! You've been referred here by #{affiliate.name} and from #{request.env['affiliate.from']} @ #{Time.at(env['affiliate.time'])}"
+        str = if request.env['affiliate.tag'] && affiliate = User.find_by_affiliate_tag(request.env['affiliate.tag'])
+          "Halo, referral! You've been referred here by #{affiliate.name} from #{request.env['affiliate.from']} @ #{Time.at(env['affiliate.time'])}"
         else
-          "We're so glad you found us on your own!"
+          "We're glad you found us on your own!"
         end
         
         render :text => str
@@ -53,24 +60,40 @@ Now you can check any request to see who came to your site via an affiliated lin
 Customization
 -------------
 
-You can customize default parameter name <code>ref</code> by providing <code>:param</code> option.
-If you want to save your affiliate id for later use, you can specify time to live with <code>:ttl</code> option (default is 30 days). 
+You can customize parameter name by providing <code>:param</code> option (default is <code>ref</code>).
+By default cookie is set for 30 days, you can extend time to live with <code>:ttl</code> option (default is 30 days). 
 
-    #Rails 3 in config/application.rb
+    #Rails 3/4 in config/application.rb
     class Application < Rails::Application
       ...
-      config.middleware.use Rack::Affiliates.new :param => 'aff_id', :ttl => 3.months 
+      config.middleware.use Rack::Affiliates, {:param => 'aff_id', :ttl => 3.months}
       ...
     end
 
 The <code>:domain</code> option allows to customize cookie domain. 
 
+    #Rails 3/4 in config/application.rb
     class Application < Rails::Application
       ...
-      config.middleware.use Rack::Affiliates.new :domain => '.example.org'
+      config.middleware.use Rack::Affiliates, :domain => '.example.org'
       ...
     end
 
-Middleware will set cookie on '.example.org' domain so it's accessible on 'www.example.org', 'app.example.org' etc.
+The <code>:path</code> option allows to hardcode the cookie path allowing you to record affiliate links at any URL on your site.
+
+    #Rails 3/4 in config/application.rb
+    class Application < Rails::Application
+      ...
+      config.middleware.use Rack::Affiliates, { :path => '/' }
+      ...
+    end
+
+Middleware will set cookie on <code>.example.org</code> so it's accessible on <code>www.example.org</code>, <code>app.example.org</code> etc.
+
+The <code>:overwrite</code> option allows to set whether to overwrite the existing affiliate tag previously stored in cookies. By default it is set to `true`.
+
+Credits
+=======
 
+Thanks goes to Rack::Referrals (https://github.com/deviantech/rack-referrals) for the inspiration.
 

data/Rakefile

@@ -31,12 +31,4 @@ Rake::TestTask.new(:spec) do |test|
   test.verbose = true
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'spec'
-  test.pattern = 'spec/**/*_spec.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
-end
-
 task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/rack-affiliates.rb

@@ -14,6 +14,8 @@ module Rack
       @param = opts[:param] || "ref"
       @cookie_ttl = opts[:ttl] || 60*60*24*30  # 30 days
       @cookie_domain = opts[:domain] || nil
+      @allow_overwrite = opts[:overwrite].nil? ? true : opts[:overwrite] 
+      @cookie_path = opts[:path] || nil
     end
 
     def call(env)
@@ -27,7 +29,13 @@ module Rack
       end
 
       if params_tag && params_tag != cookie_tag
-        tag, from, time = params_info(req)
+        if tag
+          if @allow_overwrite
+            tag, from, time = params_info(req)
+          end
+        else
+          tag, from, time = params_info(req)
+        end
       end
 
       if tag
@@ -38,13 +46,11 @@ module Rack
       
       status, headers, body = @app.call(env)
 
-      response = Rack::Response.new body, status, headers
-
       if tag != cookie_tag
-        bake_cookies(response, tag, from, time)
+        bake_cookies(headers, tag, from, time)
       end
 
-      response.finish
+      [status, headers, body]
     end
 
     def affiliate_info(req)
@@ -60,14 +66,15 @@ module Rack
     end
 
     protected
-    def bake_cookies(res, tag, from, time)
+    def bake_cookies(headers, tag, from, time)
       expires = Time.now + @cookie_ttl
       { COOKIE_TAG => tag, 
         COOKIE_FROM => from, 
         COOKIE_TIME => time }.each do |key, value|
           cookie_hash = {:value => value, :expires => expires}
           cookie_hash[:domain] = @cookie_domain if @cookie_domain
-          res.set_cookie(key, cookie_hash)
+          cookie_hash[:path] = @cookie_path if @cookie_path
+          Rack::Utils.set_cookie_header!(headers, key, cookie_hash)
       end 
     end
   end

data/rack-affiliates.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "rack-affiliates"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Levin"]
@@ -41,7 +41,7 @@ Gem::Specification.new do |s|
       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<simplecov>, [">= 0"])
       s.add_development_dependency(%q<rack-test>, [">= 0"])
       s.add_development_dependency(%q<minitest>, [">= 0"])
       s.add_development_dependency(%q<timecop>, [">= 0"])
@@ -49,7 +49,7 @@ Gem::Specification.new do |s|
       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<simplecov>, [">= 0"])
       s.add_dependency(%q<rack-test>, [">= 0"])
       s.add_dependency(%q<minitest>, [">= 0"])
       s.add_dependency(%q<timecop>, [">= 0"])
@@ -58,7 +58,7 @@ Gem::Specification.new do |s|
     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<simplecov>, [">= 0"])
     s.add_dependency(%q<rack-test>, [">= 0"])
     s.add_dependency(%q<minitest>, [">= 0"])
     s.add_dependency(%q<timecop>, [">= 0"])

data/spec/helper.rb

@@ -9,6 +9,9 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
+require "simplecov"
+SimpleCov.start
+
 require "minitest/spec"
 require "minitest/autorun"
 require "rack/test"

metadata

@@ -1,135 +1,123 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rack-affiliates
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+version: !ruby/object:Gem::Version
+  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Alex Levin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-20 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id001
+date: 2011-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  version_requirements: *id002
-  name: bundler
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 6
-        - 4
-        version: 1.6.4
-  version_requirements: *id003
-  name: jeweler
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id004
-  name: rcov
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id005
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rack-test
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id006
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: minitest
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id007
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: timecop
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-description: If the user clicked through from an affiliated site, this middleware will track affiliate tag, referring url and time.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: If the user clicked through from an affiliated site, this middleware
+  will track affiliate tag, referring url and time.
 email: experiment17@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.md
-files: 
-- .document
+files:
+- ".document"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -140,37 +128,27 @@ files:
 - spec/helper.rb
 - spec/rack_affiliates_spec.rb
 homepage: http://github.com/alexlevin/rack-affiliates
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 3
 summary: Tracks referrals came via an affiliated links.
 test_files: []
-