Module: Devise::Models::Confirmable
- Extended by:
- ActiveSupport::Concern
- Includes:
- ActionView::Helpers::DateHelper
- Defined in:
- lib/devise/models/confirmable.rb
Overview
Confirmable is responsible to verify if an account is already confirmed to sign in, and to send emails with confirmation instructions. Confirmation instructions are sent to the user email after creating a record and when manually requested by a new confirmation instruction request.
Options
Confirmable adds the following options to devise
:
* +allow_unconfirmed_access_for+: the time you want to allow the user to access their account
before confirming it. After this period, the user access is denied. You can
use this to let your user access some features of your application without
confirming the account, but blocking it after a certain period (ie 7 days).
By default allow_unconfirmed_access_for is zero, it means users always have to confirm to sign in.
* +reconfirmable+: requires any email changes to be confirmed (exactly the same way as
initial account confirmation) to be applied. Requires additional unconfirmed_email
db field to be setup (t.reconfirmable in migrations). Until confirmed new email is
stored in unconfirmed email column, and copied to email column on successful
confirmation.
* +confirm_within+: the time before a sent confirmation token becomes invalid.
You can use this to force the user to confirm within a set period of time.
Examples
User.find(1).confirm! # returns true unless it's already confirmed
User.find(1).confirmed? # true/false
User.find(1).send_confirmation_instructions # manually send instructions
Defined Under Namespace
Modules: ClassMethods
Class Method Summary collapse
Instance Method Summary collapse
-
#active_for_authentication? ⇒ Boolean
Overwrites active_for_authentication? for confirmation by verifying whether a user is active to sign in or not.
-
#confirm! ⇒ Object
Confirm a user by setting it’s confirmed_at to actual time.
-
#confirmed? ⇒ Boolean
Verifies whether a user is confirmed or not.
-
#inactive_message ⇒ Object
The message to be shown if the account is inactive.
- #initialize(*args, &block) ⇒ Object
- #pending_reconfirmation? ⇒ Boolean
-
#resend_confirmation_instructions ⇒ Object
Resend confirmation token.
-
#send_confirmation_instructions ⇒ Object
Send confirmation instructions by email.
- #send_reconfirmation_instructions ⇒ Object
-
#skip_confirmation! ⇒ Object
If you don’t want confirmation to be sent on create, neither a code to be generated, call skip_confirmation!.
-
#skip_confirmation_notification! ⇒ Object
Skips sending the confirmation/reconfirmation notification email after_create/after_update.
-
#skip_reconfirmation! ⇒ Object
If you don’t want reconfirmation to be sent, neither a code to be generated, call skip_reconfirmation!.
Class Method Details
.required_fields(klass) ⇒ Object
50 51 52 53 54 |
# File 'lib/devise/models/confirmable.rb', line 50 def self.required_fields(klass) required_methods = [:confirmation_token, :confirmed_at, :confirmation_sent_at] required_methods << :unconfirmed_email if klass.reconfirmable required_methods end |
Instance Method Details
#active_for_authentication? ⇒ Boolean
Overwrites active_for_authentication? for confirmation by verifying whether a user is active to sign in or not. If the user is already confirmed, it should never be blocked. Otherwise we need to calculate if the confirm time has not expired for this user.
125 126 127 |
# File 'lib/devise/models/confirmable.rb', line 125 def active_for_authentication? super && (!confirmation_required? || confirmed? || confirmation_period_valid?) end |
#confirm! ⇒ Object
Confirm a user by setting it’s confirmed_at to actual time. If the user is already confirmed, add an error to email field. If the user is invalid add errors
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/devise/models/confirmable.rb', line 59 def confirm! pending_any_confirmation do if confirmation_period_expired? self.errors.add(:email, :confirmation_period_expired, period: Devise::TimeInflector.time_ago_in_words(self.class.confirm_within.ago)) return false end self.confirmation_token = nil self.confirmed_at = Time.now.utc saved = if self.class.reconfirmable && unconfirmed_email.present? skip_reconfirmation! self.email = unconfirmed_email self.unconfirmed_email = nil # We need to validate in such cases to enforce e-mail uniqueness save(validate: true) else save(validate: false) end after_confirmation if saved saved end end |
#confirmed? ⇒ Boolean
Verifies whether a user is confirmed or not
87 88 89 |
# File 'lib/devise/models/confirmable.rb', line 87 def confirmed? !!confirmed_at end |
#inactive_message ⇒ Object
The message to be shown if the account is inactive.
130 131 132 |
# File 'lib/devise/models/confirmable.rb', line 130 def !confirmed? ? :unconfirmed : super end |
#initialize(*args, &block) ⇒ Object
42 43 44 45 46 47 48 |
# File 'lib/devise/models/confirmable.rb', line 42 def initialize(*args, &block) @bypass_confirmation_postpone = false @reconfirmation_required = false @skip_confirmation_notification = false @raw_confirmation_token = nil super end |
#pending_reconfirmation? ⇒ Boolean
91 92 93 |
# File 'lib/devise/models/confirmable.rb', line 91 def pending_reconfirmation? self.class.reconfirmable && unconfirmed_email.present? end |
#resend_confirmation_instructions ⇒ Object
Resend confirmation token. Regenerates the token if the period is expired.
115 116 117 118 119 |
# File 'lib/devise/models/confirmable.rb', line 115 def resend_confirmation_instructions pending_any_confirmation do send_confirmation_instructions end end |
#send_confirmation_instructions ⇒ Object
Send confirmation instructions by email
96 97 98 99 100 101 102 103 |
# File 'lib/devise/models/confirmable.rb', line 96 def send_confirmation_instructions unless @raw_confirmation_token generate_confirmation_token! end opts = pending_reconfirmation? ? { to: unconfirmed_email } : { } send_devise_notification(:confirmation_instructions, @raw_confirmation_token, opts) end |
#send_reconfirmation_instructions ⇒ Object
105 106 107 108 109 110 111 |
# File 'lib/devise/models/confirmable.rb', line 105 def send_reconfirmation_instructions @reconfirmation_required = false unless @skip_confirmation_notification send_confirmation_instructions end end |
#skip_confirmation! ⇒ Object
If you don’t want confirmation to be sent on create, neither a code to be generated, call skip_confirmation!
136 137 138 |
# File 'lib/devise/models/confirmable.rb', line 136 def skip_confirmation! self.confirmed_at = Time.now.utc end |
#skip_confirmation_notification! ⇒ Object
Skips sending the confirmation/reconfirmation notification email after_create/after_update. Unlike #skip_confirmation!, record still requires confirmation.
142 143 144 |
# File 'lib/devise/models/confirmable.rb', line 142 def skip_confirmation_notification! @skip_confirmation_notification = true end |
#skip_reconfirmation! ⇒ Object
If you don’t want reconfirmation to be sent, neither a code to be generated, call skip_reconfirmation!
148 149 150 |
# File 'lib/devise/models/confirmable.rb', line 148 def skip_reconfirmation! @bypass_confirmation_postpone = true end |