Class: Rack::Utm

Inherits:
Object
  • Object
show all
Defined in:
lib/rack-utm.rb

Overview

Rack Middleware for extracting information from the request params and cookies. It populates env, # env and +env if it detects a request came from an affiliated link

Constant Summary collapse 

"u_source"
"u_medium"
"u_term"
COOKIE_CONTENT = 
"u_content"
"u_campaign"
"u_from"
"u_time"
"u_lp"

Instance Method Summary collapse

Constructor Details

#initialize(app, opts = {}) ⇒ Utm

Returns a new instance of Utm.



19
20
21
22
23
24
25
 
# File 'lib/rack-utm.rb', line 19

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

Instance Method Details

#call(env) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/rack-utm.rb', line 27

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

#cookie_info(req) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/rack-utm.rb', line 85

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

#params_info(req) ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/rack-utm.rb', line 72

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

#utm_info(req) ⇒ Object 



68
69
70
 
# File 'lib/rack-utm.rb', line 68

def utm_info(req)
  params_info(req) || cookie_info(req) 
end