heartcombo--devise/lib/devise/models/confirmable.rb

module Devise
  module Models

    # 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, after updating it's email and also when manually requested by
    # a new confirmation instruction request.
    # Whenever the user update it's email, his account is automatically unconfirmed,
    # it means it won't be able to sign in again without confirming the account
    # again through the email that was sent.
    # Confirmable also hooks into authenticate, to verify if the account is
    # confirmed or not before authenticating the user.
    # Examples:
    #
    #   User.authenticate('email@test.com', 'password123') # true if it's confirmed, otherwise false
    #   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
    #   User.find(1).reset_confirmation! # reset confirmation status and send instructions
    #
    module Confirmable

      def self.included(base)
        base.class_eval do
          extend ClassMethods

          after_create  :send_confirmation_instructions
          before_update :reset_confirmation, :if => :email_changed?
          after_update  :send_confirmation_instructions, :if => :email_changed?

          before_create :reset_perishable_token
        end
      end

      # Confirm a user by setting it's confirmed_at to actual time. If the user
      # is already confirmed, add en error to email field
      #
      def confirm!
        unless_confirmed do
          update_attribute(:confirmed_at, Time.now)
        end
      end

      # Verifies whether a user is confirmed or not
      #
      def confirmed?
        !new_record? && confirmed_at?
      end

      # Send confirmation instructions by email
      #
      def send_confirmation_instructions
        ::Notifier.deliver_confirmation_instructions(self)
      end

      # Remove confirmation date and send confirmation instructions, to ensure
      # after sending these instructions the user won't be able to sign in without
      # confirming it's account
      #
      def reset_confirmation!
        unless_confirmed do
          reset_confirmation
          reset_perishable_token!
          send_confirmation_instructions
        end
      end

      private

        # Remove confirmation date from the user, ensuring after a user update it's
        # email, it won't be able to sign in without confirming it.
        #
        def reset_confirmation
          self.confirmed_at = nil
        end

        # Checks whether the record is confirmed or not, yielding to the block if
        # it's already confirmed, otherwise adds an error to email.
        #
        def unless_confirmed
          unless confirmed?
            yield
          else
            errors.add(:email, :already_confirmed, :default => 'already confirmed')
            false
          end
        end

      module ClassMethods
        # Attempt to find a user by it's email. If a record is found, send new
        # confirmation instructions to it. If not user is found, returns a new user
        # with an email not found error.
        # Options must contain the user email
        #
        def send_confirmation_instructions(attributes={})
          confirmable = find_or_initialize_with_error_by_email(attributes[:email])
          confirmable.reset_confirmation! unless confirmable.new_record?
          confirmable
        end

        # Find a user by it's confirmation token and try to confirm it.
        # If no user is found, returns a new user
        # If the user is already confirmed, create an error for the user
        # Options must have the perishable_token
        #
        def confirm!(attributes={})
          confirmable = find_or_initialize_with_error_by_perishable_token(attributes[:perishable_token])
          confirmable.confirm! unless confirmable.new_record?
          confirmable
        end
      end
    end
  end
end