rack-affiliates 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f235b3dda5e49f7479173870577df0d1395be2ba
-  data.tar.gz: ec21042f606fed14b1f4279d30696c6f90f84cce
+  metadata.gz: 6ed7aa209d8a8ae9ea5d49fd5123d4232e1f742d
+  data.tar.gz: 45f606cb82272f5a6e0d4ce139ed0aedeaab137f
 SHA512:
-  metadata.gz: ce1c76fb4708658fd508a88bb51226f2e01dc81bd266c5cd0c26cec8779a34d306377b0ef4c73f36cc30f7bd268ff1566e4c6eef485c7ead903c1eaa3f4ab38d
-  data.tar.gz: 7f788ac693dae917858b26022f04badc8792b0dad4f63fbe213d799ddaeb699f789a2149d0e7ce069cb3fb040cf45a0b2902b7aec229eaa0fdfec954e7b7f49c
+  metadata.gz: bc5d01fc4c7a1fe3f5dd142ace8b5c01ea4d3ef4e5d75fab3709dabbd89da74a368f96d9ad35a8c8927084e459ce7c90d79683a9fa09bab0771865c148482da5
+  data.tar.gz: 0a4a1abea36a3c949ff312489be860dbbac420736d32b029a4152c03e885c2b276af46d915453aa2cd0a46d08a1a43f2c7cc99df7bb979bfa2ff2c2943fb9744

data/README.md

@@ -92,6 +92,17 @@ Middleware will set cookie on <code>.example.org</code> so it's accessible on <c
 
 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`.
 
+If you want to capture more attributes from the query string whenever it comes from an affiliate you can define those with the <code>extra_params</code> value.
+
+    #Rails 3/4 in config/application.rb
+    class Application < Rails::Application
+      ...
+      config.middleware.use Rack::Affiliates, { :extra_params => [:great_query_parameter] }
+      ...
+    end
+
+These will be availble through <code>env['affiliate.extras']</code> as a hash with the same keys.
+
 Credits
 =======
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/rack-affiliates.rb

@@ -2,20 +2,22 @@ module Rack
   #
   # Rack Middleware for extracting information from the request params and cookies.
   # It populates +env['affiliate.tag']+, # +env['affiliate.from']+ and
-  # +env['affiliate.time'] if it detects a request came from an affiliated link 
+  # +env['affiliate.time'] if it detects a request came from an affiliated link
   #
   class Affiliates
     COOKIE_TAG = "aff_tag"
     COOKIE_FROM = "aff_from"
     COOKIE_TIME = "aff_time"
+    COOKIE_EXTRA_VARS = "aff_extra"
 
     def initialize(app, opts = {})
       @app = app
       @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] 
+      @allow_overwrite = opts[:overwrite].nil? ? true : opts[:overwrite]
       @cookie_path = opts[:path] || nil
+      @extras = opts[:extra_params] || []
     end
 
     def call(env)
@@ -25,16 +27,16 @@ module Rack
       cookie_tag = req.cookies[COOKIE_TAG]
 
       if cookie_tag
-        tag, from, time = cookie_info(req)
+        tag, from, time, extras = cookie_info(req)
       end
 
       if params_tag && params_tag != cookie_tag
         if tag
           if @allow_overwrite
-            tag, from, time = params_info(req)
+            tag, from, time, extras = params_info(req)
           end
         else
-          tag, from, time = params_info(req)
+          tag, from, time, extras = params_info(req)
         end
       end
 
@@ -42,40 +44,51 @@ module Rack
         env["affiliate.tag"] = tag
         env['affiliate.from'] = from
         env['affiliate.time'] = time
+        env['affiliate.extras'] = extras
       end
-      
+
       status, headers, body = @app.call(env)
 
       if tag != cookie_tag
-        bake_cookies(headers, tag, from, time)
+        bake_cookies(headers, tag, from, time, extras)
       end
 
       [status, headers, body]
     end
 
     def affiliate_info(req)
-      params_info(req) || cookie_info(req) 
+      params_info(req) || cookie_info(req)
     end
 
     def params_info(req)
-      [req.params[@param], req.env["HTTP_REFERER"], Time.now.to_i]
+      extras = {}
+      @extras.each { |key| extras[key] = req.params[key.to_s] }
+
+      [req.params[@param], req.env["HTTP_REFERER"], Time.now.to_i, extras]
     end
 
     def cookie_info(req)
-      [req.cookies[COOKIE_TAG], req.cookies[COOKIE_FROM], req.cookies[COOKIE_TIME].to_i] 
+      extras = {}
+      @extras.each { |key| extras[key] = req.cookies["#{COOKIE_EXTRA_VARS}.#{key}"] }
+      [req.cookies[COOKIE_TAG], req.cookies[COOKIE_FROM], req.cookies[COOKIE_TIME].to_i, extras]
     end
 
     protected
-    def bake_cookies(headers, tag, from, time)
+    def bake_cookies(headers, tag, from, time, extras)
       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
-          cookie_hash[:path] = @cookie_path if @cookie_path
-          Rack::Utils.set_cookie_header!(headers, key, cookie_hash)
-      end 
+      data_hash = {
+        COOKIE_TAG => tag,
+        COOKIE_FROM => from,
+        COOKIE_TIME => time
+      }
+      extras.each { |key, value| data_hash["#{COOKIE_EXTRA_VARS}.#{key}"] = value }
+
+      data_hash.each do |key, value|
+        cookie_hash = {:value => value, :expires => expires}
+        cookie_hash[:domain] = @cookie_domain if @cookie_domain
+        cookie_hash[:path] = @cookie_path if @cookie_path
+        Rack::Utils.set_cookie_header!(headers, key, cookie_hash)
+      end
     end
   end
 end

data/rack-affiliates.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "rack-affiliates"
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Levin"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-affiliates
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alex Levin