rack-utm 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04985930656d4510deea4ea24cd7da8ce4da5a77
-  data.tar.gz: 22f89051a7956275054f544c5e202cf4678e8cdf
+  metadata.gz: 89224a6aa86ece24721e51069f9fb53dd1d104e1
+  data.tar.gz: d8ac445757f096d29767cda034b3ef87705a1ca6
 SHA512:
-  metadata.gz: 723146a7b42519a318756043f0cf7fc1d40c6dc128e606e92c0f9938029de386874a8e2f8958ec9552976c9befb358d6ce142cadeebbba088d8ce897d5d1c25b
-  data.tar.gz: be5e4341e83cbd597274afbc870e059d98c7632e5ec2b472bf26be08dd6cd56e81b4ca96f3f547cb0f3b216e04b74ea8abefe51a00bd250f85526892f3708706
+  metadata.gz: 8668179892c508a38eb78df21b07f3ca75697cc37c107eb17bd5007e0b324e00d97bf16da37b70ac31359c0ac81c43e184b1d3ea8d23b98b0b2934ea5eb8a1a3
+  data.tar.gz: 1caf3c955779c74a406fd98df163c280cc6d57180241df17633ee0a29725ac676726539debef2a4e4b94fdd18ab7b9f3abe190aa73f8abffcd7dfacb76678ea6

data/lib/rack-utm.rb

@@ -0,0 +1,120 @@
+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 
+  #
+  class Utm
+
+    COOKIE_SOURCE   = "u_source"
+    COOKIE_MEDIUM   = "u_medium"
+    COOKIE_TERM     = "u_term"
+    COOKIE_CONTENT  = "u_content"
+    COOKIE_CAMPAIGN = "u_campaign"
+    
+    COOKIE_FROM     = "u_from"
+    COOKIE_TIME     = "u_time"
+    COOKIE_LP       = "u_lp"
+    
+    def initialize(app, opts = {})
+      @app = app
+      @key_param = "utm_source"
+      @cookie_ttl = opts[:ttl] || 60*60*24*30  # 30 days
+      @cookie_domain = opts[:domain] || nil
+      @allow_overwrite = opts[:overwrite].nil? ? true : opts[:overwrite] 
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+
+      params_tag = req.params[@key_param]
+      cookie_tag = req.cookies[COOKIE_SOURCE]
+
+      if cookie_tag
+        source, medium, term, content, campaign, from, time, lp = cookie_info(req)
+      end
+
+      if params_tag && params_tag != cookie_tag
+        if source
+          if @allow_overwrite
+            source, medium, term, content, campaign, from, time, lp = params_info(req)
+          end
+        else
+          source, medium, term, content, campaign, from, time, lp = params_info(req)
+        end
+      end
+
+      if source
+        env["utm.source"] = source
+        env['utm.medium'] = medium
+        env['utm.term'] = term
+        env['utm.content'] = content
+        env['utm.campaign'] = campaign
+
+        env['utm.from'] = from
+        env['utm.time'] = time
+        env['utm.lp'] = lp
+      end
+
+      status, headers, body = @app.call(env)
+
+      if source != cookie_tag
+        bake_cookies(headers, source, medium, term, content, campaign, from, time, lp)
+      end
+
+      [status, headers, body]
+    end
+
+    def utm_info(req)
+      params_info(req) || cookie_info(req) 
+    end
+
+    def params_info(req)
+      [
+          req.params["utm_source"],
+          req.params["utm_medium"],
+          req.params["utm_term"],
+          req.params["utm_content"],
+          req.params["utm_campaign"],
+          req.env["HTTP_REFERER"],
+          Time.now.to_i,
+          req.path
+      ]
+    end
+
+    def cookie_info(req)
+      [
+        req.cookies[COOKIE_SOURCE],
+        req.cookies[COOKIE_MEDIUM],
+        req.cookies[COOKIE_TERM],
+        req.cookies[COOKIE_CONTENT],
+        req.cookies[COOKIE_CAMPAIGN],
+        
+        req.cookies[COOKIE_FROM],
+        req.cookies[COOKIE_TIME],
+        req.cookies[COOKIE_LP]
+
+      ]
+    end
+
+    protected
+    def bake_cookies(headers, source, medium, term, content, campaign, from, time, lp)
+      expires = Time.now + @cookie_ttl
+      { COOKIE_SOURCE => source,
+        COOKIE_MEDIUM => medium,
+        COOKIE_TERM => term,
+        COOKIE_CONTENT => content,
+        COOKIE_CAMPAIGN => campaign,
+        COOKIE_FROM => from,
+        COOKIE_TIME => time,
+        COOKIE_LP => lp
+      }.each do |key, value|
+          cookie_hash = {:value => value,
+                         :expires => expires,
+                         :path => "/"}
+          cookie_hash[:domain] = @cookie_domain if @cookie_domain
+          Rack::Utils.set_cookie_header!(headers, key, cookie_hash)
+      end 
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-utm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Severin Ulrich
@@ -119,6 +119,7 @@ extra_rdoc_files:
 files:
 - LICENSE.txt
 - README.md
+- lib/rack-utm.rb
 homepage: http://github.com/silvermind/rack-utm
 licenses:
 - MIT