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

Allows you to set the remember_me option when passing credentials.



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/authlogic/session/cookies.rb', line 73

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] if values.first.with_indifferent_access.key?(:remember_me)
  else
    r = values.find { |value| value.is_a?(TrueClass) || value.is_a?(FalseClass) }
    self.remember_me = r if !r.nil?
  end
end

#httponly ⇒ Object

If the cookie should be marked as httponly (not accessable via javascript)



130
131
132
133
 
# File 'lib/authlogic/session/cookies.rb', line 130

def httponly
  return @httponly if defined?(@httponly)
  @httponly = self.class.httponly
end

#httponly=(value) ⇒ Object

Accepts a boolean as to whether the cookie should be marked as httponly. If true, the cookie will not be accessable from javascript



136
137
138
 
# File 'lib/authlogic/session/cookies.rb', line 136

def httponly=(value)
  @httponly = value
end

#httponly? ⇒ Boolean

See httponly

Returns:

  • (Boolean) 


141
142
143
 
# File 'lib/authlogic/session/cookies.rb', line 141

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

#remember_me ⇒ Object

Is the cookie going to expire after the session is over, or will it stick around?



86
87
88
89
 
# File 'lib/authlogic/session/cookies.rb', line 86

def remember_me
  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”.



92
93
94
 
# File 'lib/authlogic/session/cookies.rb', line 92

def remember_me=(value)
  @remember_me = value
end

#remember_me? ⇒ Boolean

See remember_me

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/authlogic/session/cookies.rb', line 97

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



102
103
104
105
 
# File 'lib/authlogic/session/cookies.rb', line 102

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.



108
109
110
111
 
# File 'lib/authlogic/session/cookies.rb', line 108

def remember_me_until
  return unless remember_me?
  remember_me_for.from_now
end

#secure ⇒ Object

If the cookie should be marked as secure (SSL only)



114
115
116
117
 
# File 'lib/authlogic/session/cookies.rb', line 114

def secure
  return @secure if defined?(@secure)
  @secure = self.class.secure
end

#secure=(value) ⇒ Object

Accepts a boolean as to whether the cookie should be marked as secure. If true the cookie will only ever be sent over an SSL connection.



120
121
122
 
# File 'lib/authlogic/session/cookies.rb', line 120

def secure=(value)
  @secure = value
end

#secure? ⇒ Boolean

See secure

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/authlogic/session/cookies.rb', line 125

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