Module: Devise::Models::TokenAuthenticatable

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

Overview

The TokenAuthenticatable module is responsible for generating an authentication token and validating the authenticity of the same while signing in.

This module only provides a few helpers to help you manage the token, but it is up to you to choose how to use it. For example, if you want to have a new token every time the user saves his account, you can do the following:

before_save :reset_authentication_token

On the other hand, if you want to generate token unless one exists, you should use instead:

before_save :ensure_authentication_token

If you want to delete the token after it is used, you can do so in the after_token_authentication callback.

Options

TokenAuthenticatable adds the following options to devise_for:

* +token_authentication_key+: Defines name of the authentication token params key. E.g. /users/sign_in?some_key=...

* +stateless_token+: By default, when you sign up with a token, Devise will store the user in session
  as any other authentication strategy. You can set stateless_token to true to avoid this.

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Instance Method Details

#after_token_authentication ⇒ Object

Hook called after token authentication.



55
56
 
# File 'lib/devise/models/token_authenticatable.rb', line 55

def after_token_authentication
end

#ensure_authentication_token ⇒ Object

Generate authentication token unless already exists.



45
46
47
 
# File 'lib/devise/models/token_authenticatable.rb', line 45

def ensure_authentication_token
  reset_authentication_token if authentication_token.blank?
end

#ensure_authentication_token! ⇒ Object

Generate authentication token unless already exists and save the record.



50
51
52
 
# File 'lib/devise/models/token_authenticatable.rb', line 50

def ensure_authentication_token!
  reset_authentication_token! if authentication_token.blank?
end

#reset_authentication_token ⇒ Object

Generate new authentication token (a.k.a. “single access token”).



34
35
36
 
# File 'lib/devise/models/token_authenticatable.rb', line 34

def reset_authentication_token
  self.authentication_token = self.class.authentication_token
end

#reset_authentication_token! ⇒ Object

Generate new authentication token and save the record.



39
40
41
42
 
# File 'lib/devise/models/token_authenticatable.rb', line 39

def reset_authentication_token!
  reset_authentication_token
  save(:validate => false)
end