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.

Confirmable tracks the following columns:

  • confirmation_token - A unique random token

  • confirmed_at - A timestamp when the user clicked the confirmation link

  • confirmation_sent_at - A timestamp when the confirmation_token was generated (not sent)

  • unconfirmed_email - An email address copied from the email attr. After confirmation

    this value is copied to the email attr then cleared

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.
  Confirmable will not generate a new token if a repeat confirmation is requested
  during this time frame, unless the user's email changed too.

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

Class Method Details

.required_fields(klass) ⇒ Object



60
61
62
63
64
# File 'lib/devise/models/confirmable.rb', line 60

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.

Returns:

  • (Boolean)


139
140
141
# File 'lib/devise/models/confirmable.rb', line 139

def active_for_authentication?
  super && (!confirmation_required? || confirmed? || confirmation_period_valid?)
end

#after_confirmationObject (protected)

A callback initiated after successfully confirming. This can be used to insert your own logic that is only run after the user successfully confirms.

Example:

def after_confirmation
  self.update_attribute(:invite_code, nil)
end


280
281
# File 'lib/devise/models/confirmable.rb', line 280

def after_confirmation
end

#confirm(args = {}) ⇒ 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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/devise/models/confirmable.rb', line 69

def confirm(args={})
  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.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: args[:ensure_valid] == true)
    end

    after_confirmation if saved
    saved
  end
end

#confirm!(args = {}) ⇒ Object



95
96
97
98
# File 'lib/devise/models/confirmable.rb', line 95

def confirm!(args={})
  ActiveSupport::Deprecation.warn "confirm! is deprecated in favor of confirm"
  confirm(args)
end

#confirmation_period_expired?Boolean (protected)

Checks if the user confirmation happens before the token becomes invalid Examples:

# confirm_within = 3.days and confirmation_sent_at = 2.days.ago
confirmation_period_expired?  # returns false

# confirm_within = 3.days and confirmation_sent_at = 4.days.ago
confirmation_period_expired?  # returns true

# confirm_within = nil
confirmation_period_expired?  # will always return false

Returns:

  • (Boolean)


218
219
220
# File 'lib/devise/models/confirmable.rb', line 218

def confirmation_period_expired?
  self.class.confirm_within && (Time.now > self.confirmation_sent_at + self.class.confirm_within)
end

#confirmation_period_valid?Boolean (protected)

Checks if the confirmation for the user is within the limit time. We do this by calculating if the difference between today and the confirmation sent date does not exceed the confirm in time configured. Confirm_within is a model configuration, must always be an integer value.

Example:

# allow_unconfirmed_access_for = 1.day and confirmation_sent_at = today
confirmation_period_valid?   # returns true

# allow_unconfirmed_access_for = 5.days and confirmation_sent_at = 4.days.ago
confirmation_period_valid?   # returns true

# allow_unconfirmed_access_for = 5.days and confirmation_sent_at = 5.days.ago
confirmation_period_valid?   # returns false

# allow_unconfirmed_access_for = 0.days
confirmation_period_valid?   # will always return false

# allow_unconfirmed_access_for = nil
confirmation_period_valid?   # will always return true

Returns:

  • (Boolean)


202
203
204
# File 'lib/devise/models/confirmable.rb', line 202

def confirmation_period_valid?
  self.class.allow_unconfirmed_access_for.nil? || (confirmation_sent_at && confirmation_sent_at.utc >= self.class.allow_unconfirmed_access_for.ago)
end

#confirmation_required?Boolean (protected)

Callback to overwrite if confirmation is required or not.

Returns:

  • (Boolean)


176
177
178
# File 'lib/devise/models/confirmable.rb', line 176

def confirmation_required?
  !confirmed?
end

#confirmed?Boolean

Verifies whether a user is confirmed or not

Returns:

  • (Boolean)


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

def confirmed?
  !!confirmed_at
end

#generate_confirmation_tokenObject (protected)

Generates a new random token for confirmation, and stores the time this token is being generated in confirmation_sent_at



234
235
236
237
238
239
240
241
242
# File 'lib/devise/models/confirmable.rb', line 234

def generate_confirmation_token
  if self.confirmation_token && !confirmation_period_expired?
    @raw_confirmation_token = self.confirmation_token
  else
    raw, _ = Devise.token_generator.generate(self.class, :confirmation_token)
    self.confirmation_token = @raw_confirmation_token = raw
    self.confirmation_sent_at = Time.now.utc
  end
end

#generate_confirmation_token!Object (protected)



244
245
246
# File 'lib/devise/models/confirmable.rb', line 244

def generate_confirmation_token!
  generate_confirmation_token && save(validate: false)
end

#inactive_messageObject

The message to be shown if the account is inactive.



144
145
146
# File 'lib/devise/models/confirmable.rb', line 144

def inactive_message
  !confirmed? ? :unconfirmed : super
end

#initialize(*args, &block) ⇒ Object



52
53
54
55
56
57
58
# File 'lib/devise/models/confirmable.rb', line 52

def initialize(*args, &block)
  @bypass_confirmation_postpone = false
  @reconfirmation_required = false
  @skip_confirmation_notification = false
  @raw_confirmation_token = nil
  super
end

#pending_any_confirmationObject (protected)

Checks whether the record requires any confirmation.



223
224
225
226
227
228
229
230
# File 'lib/devise/models/confirmable.rb', line 223

def pending_any_confirmation
  if (!confirmed? || pending_reconfirmation?)
    yield
  else
    self.errors.add(:email, :already_confirmed)
    false
  end
end

#pending_reconfirmation?Boolean

Returns:

  • (Boolean)


105
106
107
# File 'lib/devise/models/confirmable.rb', line 105

def pending_reconfirmation?
  self.class.reconfirmable && unconfirmed_email.present?
end

#postpone_email_change?Boolean (protected)

Returns:

  • (Boolean)


256
257
258
259
260
# File 'lib/devise/models/confirmable.rb', line 256

def postpone_email_change?
  postpone = self.class.reconfirmable && email_changed? && !@bypass_confirmation_postpone && self.email.present?
  @bypass_confirmation_postpone = false
  postpone
end

#postpone_email_change_until_confirmation_and_regenerate_confirmation_tokenObject (protected)



248
249
250
251
252
253
254
# File 'lib/devise/models/confirmable.rb', line 248

def postpone_email_change_until_confirmation_and_regenerate_confirmation_token
  @reconfirmation_required = true
  self.unconfirmed_email = self.email
  self.email = self.email_was
  self.confirmation_token = nil
  generate_confirmation_token
end

#reconfirmation_required?Boolean (protected)

Returns:

  • (Boolean)


262
263
264
# File 'lib/devise/models/confirmable.rb', line 262

def reconfirmation_required?
  self.class.reconfirmable && @reconfirmation_required && self.email.present?
end

#resend_confirmation_instructionsObject

Resend confirmation token. Regenerates the token if the period is expired.



129
130
131
132
133
# File 'lib/devise/models/confirmable.rb', line 129

def resend_confirmation_instructions
  pending_any_confirmation do
    send_confirmation_instructions
  end
end

#send_confirmation_instructionsObject

Send confirmation instructions by email



110
111
112
113
114
115
116
117
# File 'lib/devise/models/confirmable.rb', line 110

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_confirmation_notification?Boolean (protected)

Returns:

  • (Boolean)


266
267
268
# File 'lib/devise/models/confirmable.rb', line 266

def send_confirmation_notification?
  confirmation_required? && !@skip_confirmation_notification && self.email.present?
end

#send_on_create_confirmation_instructionsObject (protected)

A callback method used to deliver confirmation instructions on creation. This can be overridden in models to map to a nice sign up e-mail.



171
172
173
# File 'lib/devise/models/confirmable.rb', line 171

def send_on_create_confirmation_instructions
  send_confirmation_instructions
end

#send_reconfirmation_instructionsObject



119
120
121
122
123
124
125
# File 'lib/devise/models/confirmable.rb', line 119

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!



150
151
152
# File 'lib/devise/models/confirmable.rb', line 150

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.



156
157
158
# File 'lib/devise/models/confirmable.rb', line 156

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!



162
163
164
# File 'lib/devise/models/confirmable.rb', line 162

def skip_reconfirmation!
  @bypass_confirmation_postpone = true
end