Module: RefererTracking::ControllerAddons

Defined in:
lib/referer_tracking/controller_addons.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



81
82
83
84
85
86
87
88
89
 
# File 'lib/referer_tracking/controller_addons.rb', line 81

def self.included(base)
  base.class_eval do
    before_filter :before_filter_referer_tracking_save_to_session
    helper_method :'referer_tracking_first_request?'
    helper_method :'referer_tracking_add_info'
    helper_method :'referer_tracking_set_info'
    helper_method :'referer_tracking_get_info'
  end
end

Instance Method Details

#before_filter_referer_tracking_save_to_session ⇒ Object

before_filter :before_filter_referer_tracking_save_to_session



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/referer_tracking/controller_addons.rb', line 5

def before_filter_referer_tracking_save_to_session
  unless request_is_from_a_known_bot?
    if session[:referer_tracking].nil?
      @referer_tracking_first_request = true
      session[:referer_tracking] = hash = Hash.new

      request_ref = "unknown"
      request_ref = request.headers["HTTP_REFERER"] if !request.headers["HTTP_REFERER"].blank?

      request_ref = request_ref.to_s.gsub(/pass(word)?=[^&]+/, 'pass=xxxx')
      first_url = request.url.to_s.gsub(/pass(word)?=[^&]+/, 'pass=xxxx')

      hash[:session_referer_url] = request_ref
      hash[:session_first_url] = first_url

      if RefererTracking.set_referer_cookies && cookies[RefererTracking.set_referer_cookies_name].nil?
        cookie_info = "v01|||#{Time.now.utc.to_i}|||#{first_url.first(RefererTracking.set_referer_cookies_first_url_max_length)}|||#{request_ref.first(RefererTracking.set_referer_cookies_ref_url_max_length)}"
        cookies[RefererTracking.set_referer_cookies_name] = { :value => cookie_info, :expires => 5.years.from_now, :domain => :all }
      end

      logger.info( "REFERER_TRACKING_FIRST: ver04 (ref|first) ||| #{hash[:session_referer_url]} ||| #{hash[:session_first_url]}" )
    end

  end
end

#referer_tracking_add_info(key, value) ⇒ Object

Add only if referer_tracking already in session and key has not been added/changed before So this is only performed on the first time of the session



36
37
38
39
40
 
# File 'lib/referer_tracking/controller_addons.rb', line 36

def referer_tracking_add_info(key, value)
  if !session[:referer_tracking].nil? && session[:referer_tracking][key.to_sym].nil?
    referer_tracking_set_info(key, value)
  end
end

#referer_tracking_first_request? ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/referer_tracking/controller_addons.rb', line 66

def referer_tracking_first_request?
  @referer_tracking_first_request
end

#referer_tracking_get_info(key) ⇒ Object 



48
49
50
 
# File 'lib/referer_tracking/controller_addons.rb', line 48

def referer_tracking_get_info(key)
  session[:referer_tracking].nil? ? nil : session[:referer_tracking][key.to_sym]
end

#referer_tracking_request_set_info(key, value) ⇒ Object 



60
61
62
 
# File 'lib/referer_tracking/controller_addons.rb', line 60

def referer_tracking_request_set_info(key, value)
  referer_tracking_request_add_infos[key.to_sym] = value
end

#referer_tracking_set_info(key, value) ⇒ Object 



42
43
44
45
46
 
# File 'lib/referer_tracking/controller_addons.rb', line 42

def referer_tracking_set_info(key, value)
  if !session[:referer_tracking].nil?
    session[:referer_tracking][key.to_sym] = value
  end
end

#request_is_from_a_known_bot? ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
74
 
# File 'lib/referer_tracking/controller_addons.rb', line 71

def request_is_from_a_known_bot?
  bot_user_agents = /\b(GoogleBot|Mediapartners-Google|msnbot|TwengaBot|DigExt; DTS Agent|YandexImages)\b/i
  request.user_agent =~ bot_user_agents
end

#request_is_from_a_possible_bot? ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/referer_tracking/controller_addons.rb', line 76

def request_is_from_a_possible_bot?
  request.user_agent =~ /bot/i
end