module Devise::Models::Rememberable
Rememberable
manages generating and clearing token for remember the user from a saved cookie. Rememberable
also has utility methods for dealing with serializing the user into the cookie and back from the cookie, trying to lookup the record based on the saved information. You probably wouldn’t use rememberable methods directly, they are used mostly internally for handling the remember token.
Options¶ ↑
Rememberable
adds the following options in devise_for:
* +remember_for+: the time you want the user will be remembered without asking for credentials. After this time the user will be blocked and will have to enter their credentials again. This configuration is also used to calculate the expires time for the cookie created to remember the user. By default remember_for is 2.weeks. * +extend_remember_period+: if true, extends the user's remember period when remembered via cookie. False by default. * +rememberable_options+: configuration options passed to the created cookie.
Examples¶ ↑
User.find(1).remember_me! # regenerating the token User.find(1).forget_me! # clearing the token # generating info to put into cookies User.serialize_into_cookie(user) # lookup the user based on the incoming cookie information User.serialize_from_cookie(cookie_string)
Attributes
Public Class Methods
# File lib/devise/models/rememberable.rb, line 44 def self.required_fields(klass) [:remember_created_at] end
Public Instance Methods
A callback initiated after successfully being remembered. This can be used to insert your own logic that is only run after the user is remembered.
Example:
def after_remembered self.update_attribute(:invite_code, nil) end
# File lib/devise/models/rememberable.rb, line 102 def after_remembered end
If the record is persisted, remove the remember token (but only if it exists), and save the record without validations.
# File lib/devise/models/rememberable.rb, line 58 def forget_me! return unless persisted? self.remember_token = nil if respond_to?(:remember_token=) self.remember_created_at = nil if self.class.expire_all_remember_me_on_sign_out save(validate: false) end
Remember token should be expired if expiration time not overpass now.
# File lib/devise/models/rememberable.rb, line 66 def remember_expired? remember_created_at.nil? || (remember_expires_at <= Time.now.utc) end
Remember token expires at created time + remember_for configuration
# File lib/devise/models/rememberable.rb, line 71 def remember_expires_at remember_created_at + self.class.remember_for end
Generate a new remember token and save the record without validations if remember expired (token is no longer valid) or extend_remember_period
is true
# File lib/devise/models/rememberable.rb, line 50 def remember_me!(extend_period=false) self.remember_token = self.class.remember_token if generate_remember_token? self.remember_created_at = Time.now.utc if generate_remember_timestamp?(extend_period) save(validate: false) if self.changed? end
# File lib/devise/models/rememberable.rb, line 88 def rememberable_options self.class.rememberable_options end
# File lib/devise/models/rememberable.rb, line 75 def rememberable_value if respond_to?(:remember_token) remember_token elsif respond_to?(:authenticatable_salt) && (salt = authenticatable_salt) salt else raise "authenticable_salt returned nil for the #{self.class.name} model. " \ "In order to use rememberable, you must ensure a password is always set " \ "or have a remember_token column in your model or implement your own " \ "rememberable_value in the model with custom logic." end end