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.



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/authlogic/session/cookies.rb', line 82

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)



145
146
147
148
 
# File 'lib/authlogic/session/cookies.rb', line 145

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



151
152
153
 
# File 'lib/authlogic/session/cookies.rb', line 151

def httponly=(value)
  @httponly = value
end

#httponly? ⇒ Boolean

See httponly

Returns:

  • (Boolean) 


156
157
158
 
# File 'lib/authlogic/session/cookies.rb', line 156

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?



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

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



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

def remember_me=(value)
  @remember_me = value
end

#remember_me? ⇒ Boolean

See remember_me

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/authlogic/session/cookies.rb', line 106

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

#remember_me_expired? ⇒ Boolean

Has the cookie expired due to current time being greater than remember_me_until.

Returns:

  • (Boolean) 


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

def remember_me_expired?
  return unless remember_me?
  (Time.parse(cookie_credentials[2]) < Time.now)
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



111
112
113
114
 
# File 'lib/authlogic/session/cookies.rb', line 111

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.



117
118
119
120
 
# File 'lib/authlogic/session/cookies.rb', line 117

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)



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

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.



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

def secure=(value)
  @secure = value
end

#secure? ⇒ Boolean

See secure

Returns:

  • (Boolean) 


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

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

#sign_cookie ⇒ Object

If the cookie should be signed



161
162
163
164
 
# File 'lib/authlogic/session/cookies.rb', line 161

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

#sign_cookie=(value) ⇒ Object

Accepts a boolean as to whether the cookie should be signed. If true the cookie will be saved and verified using a signature.



167
168
169
 
# File 'lib/authlogic/session/cookies.rb', line 167

def sign_cookie=(value)
  @sign_cookie = value
end

#sign_cookie? ⇒ Boolean

See sign_cookie

Returns:

  • (Boolean) 


172
173
174
 
# File 'lib/authlogic/session/cookies.rb', line 172

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