Module: Devise::Models::Rememberable

Extended by:
ActiveSupport::Concern
Defined in:
lib/devise/models/rememberable.rb

Overview

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)

Defined Under Namespace

Modules: ClassMethods

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#extend_remember_periodObject

Returns the value of attribute extend_remember_period



42
43
44
# File 'lib/devise/models/rememberable.rb', line 42

def extend_remember_period
  @extend_remember_period
end

#remember_meObject

Returns the value of attribute remember_me



42
43
44
# File 'lib/devise/models/rememberable.rb', line 42

def remember_me
  @remember_me
end

Class Method Details

.required_fields(klass) ⇒ Object



44
45
46
# File 'lib/devise/models/rememberable.rb', line 44

def self.required_fields(klass)
  [:remember_created_at]
end

Instance Method Details

#after_rememberedObject

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


102
103
# File 'lib/devise/models/rememberable.rb', line 102

def after_remembered
end

#forget_me!Object

If the record is persisted, remove the remember token (but only if it exists), and save the record without validations.



58
59
60
61
62
63
# 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

#generate_remember_timestamp?(extend_period) ⇒ Boolean (protected)

Generate a timestamp if extend_remember_period is true, if no remember_token exists, or if an existing remember token has expired.

Returns:

  • (Boolean)


113
114
115
# File 'lib/devise/models/rememberable.rb', line 113

def generate_remember_timestamp?(extend_period) #:nodoc:
  extend_period || remember_created_at.nil? || remember_expired?
end

#generate_remember_token?Boolean (protected)

:nodoc:

Returns:

  • (Boolean)


107
108
109
# File 'lib/devise/models/rememberable.rb', line 107

def generate_remember_token? #:nodoc:
  respond_to?(:remember_token) && remember_expired?
end

#remember_expired?Boolean

Remember token should be expired if expiration time not overpass now.

Returns:

  • (Boolean)


66
67
68
# File 'lib/devise/models/rememberable.rb', line 66

def remember_expired?
  remember_created_at.nil? || (remember_expires_at <= Time.now.utc)
end

#remember_expires_atObject

Remember token expires at created time + remember_for configuration



71
72
73
# File 'lib/devise/models/rememberable.rb', line 71

def remember_expires_at
  remember_created_at + self.class.remember_for
end

#remember_me!(extend_period = false) ⇒ Object

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



50
51
52
53
54
# 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

#rememberable_optionsObject



88
89
90
# File 'lib/devise/models/rememberable.rb', line 88

def rememberable_options
  self.class.rememberable_options
end

#rememberable_valueObject



75
76
77
78
79
80
81
82
83
84
85
86
# 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