Module: Devise::Models::Recoverable

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

Overview

Recoverable takes care of resetting the user password and send reset instructions.

Options

Recoverable adds the following options to devise_for:

* +reset_password_keys+: the keys you want to use when recovering the password for an account

Examples

# resets the user password and save the record, true if valid passwords are given, otherwise false
User.find(1).reset_password!('password123', 'password123')

# only resets the user password, without saving the record
user = User.find(1)
user.reset_password('password123', 'password123')

# creates a new token and send it with instructions about how to reset the password
User.find(1).send_reset_password_instructions

Defined Under Namespace

Modules: ClassMethods

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) required_fields(klass)



27
28
29
# File 'lib/devise/models/recoverable.rb', line 27

def self.required_fields(klass)
  [:reset_password_sent_at, :reset_password_token]
end

Instance Method Details

- (Object) after_password_reset (protected)



86
87
# File 'lib/devise/models/recoverable.rb', line 86

def after_password_reset
end

- (Object) clear_reset_password_token (protected)

Removes reset_password token



81
82
83
84
# File 'lib/devise/models/recoverable.rb', line 81

def clear_reset_password_token
  self.reset_password_token = nil
  self.reset_password_sent_at = nil
end

- (Object) reset_password!(new_password, new_password_confirmation)

Update password saving the record and clearing token. Returns true if the passwords are valid and the record was saved, false otherwise.



33
34
35
36
37
38
39
40
41
42
43
# File 'lib/devise/models/recoverable.rb', line 33

def reset_password!(new_password, new_password_confirmation)
  self.password = new_password
  self.password_confirmation = new_password_confirmation

  if valid?
    clear_reset_password_token
    after_password_reset
  end

  save
end

- (Boolean) reset_password_period_valid?

Checks if the reset password token sent is within the limit time. We do this by calculating if the difference between today and the sending date does not exceed the confirm in time configured. Returns true if the resource is not responding to reset_password_sent_at at all. reset_password_within is a model configuration, must always be an integer value.

Example:

# reset_password_within = 1.day and reset_password_sent_at = today
reset_password_period_valid?   # returns true

# reset_password_within = 5.days and reset_password_sent_at = 4.days.ago
reset_password_period_valid?   # returns true

# reset_password_within = 5.days and reset_password_sent_at = 5.days.ago
reset_password_period_valid?   # returns false

# reset_password_within = 0.days
reset_password_period_valid?   # will always return false

Returns:

  • (Boolean)


74
75
76
# File 'lib/devise/models/recoverable.rb', line 74

def reset_password_period_valid?
  reset_password_sent_at && reset_password_sent_at.utc >= self.class.reset_password_within.ago
end

- (Object) send_reset_password_instructions

Resets reset password token and send reset password instructions by email. Returns the token sent in the e-mail.



47
48
49
50
51
52
# File 'lib/devise/models/recoverable.rb', line 47

def send_reset_password_instructions
  token = set_reset_password_token
  send_reset_password_instructions_notification(token)

  token
end

- (Object) send_reset_password_instructions_notification(token) (protected)



98
99
100
# File 'lib/devise/models/recoverable.rb', line 98

def send_reset_password_instructions_notification(token)
  send_devise_notification(:reset_password_instructions, token, {})
end

- (Object) set_reset_password_token (protected)



89
90
91
92
93
94
95
96
# File 'lib/devise/models/recoverable.rb', line 89

def set_reset_password_token
  raw, enc = Devise.token_generator.generate(self.class, :reset_password_token)

  self.reset_password_token   = enc
  self.reset_password_sent_at = Time.now.utc
  self.save(validate: false)
  raw
end