Skip to content

Commit

Permalink
Move instance methods in user concern out of it
Browse files Browse the repository at this point in the history
  • Loading branch information
@MaicolBen
MaicolBen committed Jun 21, 2020
1 parent 449a0be commit 143a619
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 59 deletions.
92 changes: 46 additions & 46 deletions app/models/devise_token_auth/concerns/user.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,68 +39,68 @@ def self.tokens_match?(token_hash, token)
# remove old tokens if password has changed
before_save :remove_tokens_after_password_reset

# don't use default devise email validation
def email_required?; false; end
def email_changed?; false; end
def will_save_change_to_email?; false; end

if DeviseTokenAuth.send_confirmation_email && devise_modules.include?(:confirmable)
include DeviseTokenAuth::Concerns::ConfirmableSupport
end
end

def password_required?
return false unless provider == 'email'
super
end
# don't use default devise email validation
def email_required?; false; end
def email_changed?; false; end
def will_save_change_to_email?; false; end

# override devise method to include additional info as opts hash
def send_confirmation_instructions(opts = {})
generate_confirmation_token! unless @raw_confirmation_token
def password_required?
return false unless provider == 'email'
super
end

# fall back to "default" config name
opts[:client_config] ||= 'default'
opts[:to] = unconfirmed_email if pending_reconfirmation?
opts[:redirect_url] ||= DeviseTokenAuth.default_confirm_success_url
# override devise method to include additional info as opts hash
def send_confirmation_instructions(opts = {})
generate_confirmation_token! unless @raw_confirmation_token

send_devise_notification(:confirmation_instructions, @raw_confirmation_token, opts)
end
# fall back to "default" config name
opts[:client_config] ||= 'default'
opts[:to] = unconfirmed_email if pending_reconfirmation?
opts[:redirect_url] ||= DeviseTokenAuth.default_confirm_success_url

# override devise method to include additional info as opts hash
def send_reset_password_instructions(opts = {})
token = set_reset_password_token
send_devise_notification(:confirmation_instructions, @raw_confirmation_token, opts)
end

# fall back to "default" config name
opts[:client_config] ||= 'default'
# override devise method to include additional info as opts hash
def send_reset_password_instructions(opts = {})
token = set_reset_password_token

send_devise_notification(:reset_password_instructions, token, opts)
token
end
# fall back to "default" config name
opts[:client_config] ||= 'default'

# override devise method to include additional info as opts hash
def send_unlock_instructions(opts = {})
raw, enc = Devise.token_generator.generate(self.class, :unlock_token)
self.unlock_token = enc
save(validate: false)
send_devise_notification(:reset_password_instructions, token, opts)
token
end

# fall back to "default" config name
opts[:client_config] ||= 'default'
# override devise method to include additional info as opts hash
def send_unlock_instructions(opts = {})
raw, enc = Devise.token_generator.generate(self.class, :unlock_token)
self.unlock_token = enc
save(validate: false)

send_devise_notification(:unlock_instructions, raw, opts)
raw
end
# fall back to "default" config name
opts[:client_config] ||= 'default'

send_devise_notification(:unlock_instructions, raw, opts)
raw
end

def create_token(client: nil, lifespan: nil, cost: nil, **token_extras)
token = DeviseTokenAuth::TokenFactory.create(client: client, lifespan: lifespan, cost: cost)
def create_token(client: nil, lifespan: nil, cost: nil, **token_extras)
token = DeviseTokenAuth::TokenFactory.create(client: client, lifespan: lifespan, cost: cost)

tokens[token.client] = {
token: token.token_hash,
expiry: token.expiry
}.merge!(token_extras)
tokens[token.client] = {
token: token.token_hash,
expiry: token.expiry
}.merge!(token_extras)

clean_old_tokens
clean_old_tokens

token
end
token
end

def valid_token?(token, client = 'default')
Expand Down Expand Up @@ -218,7 +218,7 @@ def destroy_expired_tokens
end

def should_remove_tokens_after_password_reset?
if Rails::VERSION::MAJOR <= 5 ||defined?('Mongoid')
if Rails::VERSION::MAJOR <= 5 || const_defined?('Mongoid')
encrypted_password_changed? &&
DeviseTokenAuth.remove_tokens_after_password_reset
else
Expand Down
26 changes: 13 additions & 13 deletions docs/config/initialization.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@ The following settings are available for configuration in `config/initializers/d

| Name (default) | Description|
|---|---|---|
| **`change_headers_on_each_request`** (`true`) | By default the access-token header will change after each request. The client is responsible for keeping track of the changing tokens. Both [ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) and [jToker](https://github.com/lynndylanhurley/j-toker) do this out of the box. While this implementation is more secure, it can be difficult to manage. Set this to false to prevent the `access-token` header from changing after each request. [Read more](/conceptual#about-token-management). |
| **`token_lifespan`** (`2.weeks`) | Set the length of your tokens' lifespans. Users will need to re-authenticate after this duration of time has passed since their last login. |
| **`token_cost`** (`10`) | Set the cost of your tokens' cost. The possible cost value is within range from 4 to 31. It is recommended to not use a value more than 10. For details see [BCrypt Cost Factors](https://github.com/codahale/bcrypt-ruby#cost-factors). |
| **`batch_request_buffer_throttle`** (`5.seconds`) | Sometimes it's necessary to make several requests to the API at the same time. In this case, each request in the batch will need to share the same auth token. This setting determines how far apart the requests can be while still using the same auth token. [Read more](conceptual#about-batch-requests). |
| **`omniauth_prefix`** (`"/omniauth"`) | This route will be the prefix for all oauth2 redirect callbacks. For example, using the default '/omniauth' setting, the github oauth2 provider will redirect successful authentications to '/omniauth/github/callback'. [Read more](#omniauth-provider-settings). |
| **`default_confirm_success_url`** (`nil`) | By default this value is expected to be sent by the client so that the API knows where to redirect users after successful email confirmation. If this param is set, the API will redirect to this value when no value is provided by the client. |
| **`default_password_reset_url`** (`nil`) | By default this value is expected to be sent by the client so that the API knows where to redirect users after successful password resets. If this param is set, the API will redirect to this value when no value is provided by the client. |
| **`redirect_whitelist`** (`nil`) | As an added security measure, you can limit the URLs to which the API will redirect after email token validation (password reset, email confirmation, etc.). This value should be an array containing matches to the client URLs to be visited after validation. Wildcards are supported. |
| **`enable_standard_devise_support`** (`false`) | By default, only Bearer Token authentication is implemented out of the box. If, however, you wish to integrate with legacy Devise authentication, you can do so by enabling this flag. NOTE: This feature is highly experimental! |
| **`remove_tokens_after_password_reset`** (`false`) | By default, old tokens are not invalidated when password is changed. Enable this option if you want to make passwords updates to logout other devices. |
| **`change_headers_on_each_request`**<br />(`true`) | By default the access-token header will change after each request. The client is responsible for keeping track of the changing tokens. Both [ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) and [jToker](https://github.com/lynndylanhurley/j-toker) do this out of the box. While this implementation is more secure, it can be difficult to manage. Set this to false to prevent the `access-token` header from changing after each request. [Read more](/conceptual#about-token-management). |
| **`token_lifespan`**<br />(`2.weeks`) | Set the length of your tokens' lifespans. Users will need to re-authenticate after this duration of time has passed since their last login. |
| **`token_cost`**<br />(`10`) | Set the cost of your tokens' cost. The possible cost value is within range from 4 to 31. It is recommended to not use a value more than 10. For details see [BCrypt Cost Factors](https://github.com/codahale/bcrypt-ruby#cost-factors). |
| **`batch_request_buffer_throttle`**<br />(`5.seconds`) | Sometimes it's necessary to make several requests to the API at the same time. In this case, each request in the batch will need to share the same auth token. This setting determines how far apart the requests can be while still using the same auth token. [Read more](conceptual#about-batch-requests). |
| **`omniauth_prefix`**<br />(`"/omniauth"`) | This route will be the prefix for all oauth2 redirect callbacks. For example, using the default '/omniauth' setting, the github oauth2 provider will redirect successful authentications to '/omniauth/github/callback'. [Read more](#omniauth-provider-settings). |
| **`default_confirm_success_url`**<br />(`nil`) | By default this value is expected to be sent by the client so that the API knows where to redirect users after successful email confirmation. If this param is set, the API will redirect to this value when no value is provided by the client. |
| **`default_password_reset_url`**<br />(`nil`) | By default this value is expected to be sent by the client so that the API knows where to redirect users after successful password resets. If this param is set, the API will redirect to this value when no value is provided by the client. |
| **`redirect_whitelist`**<br />(`nil`) | As an added security measure, you can limit the URLs to which the API will redirect after email token validation (password reset, email confirmation, etc.). This value should be an array containing matches to the client URLs to be visited after validation. Wildcards are supported. |
| **`enable_standard_devise_support`**<br />(`false`) | By default, only Bearer Token authentication is implemented out of the box. If, however, you wish to integrate with legacy Devise authentication, you can do so by enabling this flag. NOTE: This feature is highly experimental! |
| **`remove_tokens_after_password_reset`**<br />(`false`) | By default, old tokens are not invalidated when password is changed. Enable this option if you want to make passwords updates to logout other devices. |
| **`default_callbacks`** (`true`) | By default User model will include the `DeviseTokenAuth::Concerns::UserOmniauthCallbacks` concern, which has `email`, `uid` validations & `uid` synchronization callbacks. |
| **`bypass_sign_in`** (`true`) | By default DeviseTokenAuth will not check user's `#active_for_authentication?` which includes confirmation check on each call (it will do it only on sign in). If you want it to be validated on each request (for example, to be able to deactivate logged in users on the fly), set it to false. |
| **`send_confirmation_email`** (`false`) | By default DeviseTokenAuth will not send confirmation email, even when including devise confirmable module. If you want to use devise confirmable module and send email, set it to true. (This is a setting for compatibility) |
| **`require_client_password_reset_token`** (`false`) | By default, the password-reset confirmation link redirects to the client with valid session credentials as querystring params. With this option enabled, the redirect will NOT include the valid session credentials. Instead the redirect will include a password_reset_token querystring param that can be used to reset the users password. Once the user has reset their password, the password-reset success response headers will contain valid session credentials. |
| **`bypass_sign_in`**<br />(`true`) | By default DeviseTokenAuth will not check user's `#active_for_authentication?` which includes confirmation check on each call (it will do it only on sign in). If you want it to be validated on each request (for example, to be able to deactivate logged in users on the fly), set it to false. |
| **`send_confirmation_email`**<br />(`false`) | By default DeviseTokenAuth will not send confirmation email, even when including devise confirmable module. If you want to use devise confirmable module and send email, set it to true. (This is a setting for compatibility) |
| **`require_client_password_reset_token`**<br />(`false`) | By default, the password-reset confirmation link redirects to the client with valid session credentials as querystring params. With this option enabled, the redirect will NOT include the valid session credentials. Instead the redirect will include a password_reset_token querystring param that can be used to reset the users password. Once the user has reset their password, the password-reset success response headers will contain valid session credentials. |

Additionally, you can configure other aspects of devise by manually creating the traditional devise.rb file at `config/initializers/devise.rb`. Here are some examples of what you can do in this file:

Expand Down

0 comments on commit 143a619

Please sign in to comment.