Module: Authlogic::Session::Cookies::InstanceMethods

Defined in:
lib/authlogic/session/cookies.rb

Overview

The methods available for an Authlogic::Session::Base object that make up the cookie feature set.

Instance Method Summary collapse

Instance Method Details

#credentials=(value) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/authlogic/session/cookies.rb', line 54

def credentials=(value)
  super
  values = value.is_a?(Array) ? value : [value]
  case values.first
  when Hash
    self.remember_me = values.first.with_indifferent_access[:remember_me]
  else
    r = values.find { |value| value.is_a?(TrueClass) || value.is_a?(FalseClass) }
    self.remember_me = r if !r.nil?
  end
end

#remember_me ⇒ Object

:nodoc:



66
67
68
69
 
# File 'lib/authlogic/session/cookies.rb', line 66

def remember_me # :nodoc:
  return @remember_me if defined?(@remember_me)
  @remember_me = self.class.remember_me
end

#remember_me=(value) ⇒ Object

Accepts a boolean as a flag to remember the session or not. Basically to expire the cookie at the end of the session or keep it for “remember_me_until”.



72
73
74
 
# File 'lib/authlogic/session/cookies.rb', line 72

def remember_me=(value)
  @remember_me = value
end

#remember_me? ⇒ Boolean

Allows users to be remembered via a cookie.

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/authlogic/session/cookies.rb', line 77

def remember_me?
  remember_me == true || remember_me == "true" || remember_me == "1"
end

#remember_me_for ⇒ Object

How long to remember the user if remember_me is true. This is based on the class level configuration: remember_me_for



82
83
84
85
 
# File 'lib/authlogic/session/cookies.rb', line 82

def remember_me_for
  return unless remember_me?
  self.class.remember_me_for
end

#remember_me_until ⇒ Object

When to expire the cookie. See remember_me_for configuration option to change this.



88
89
90
91
 
# File 'lib/authlogic/session/cookies.rb', line 88

def remember_me_until
  return unless remember_me?
  remember_me_for.from_now
end