Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make confirm_success_url paramater optional #177

Closed
wants to merge 1 commit into from
Closed

make confirm_success_url paramater optional #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ The following settings are available for configuration in `config/initializers/d
| **`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. |
| **`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](#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). |
| **`require_confirm_success_url`** | `true` | By default when using devise's confirmable a confirm_success_url paramater will be required when creating a user.


## OmniAuth authentication
Expand Down Expand Up @@ -351,7 +352,7 @@ Note that if the model that you're trying to access isn't called `User`, the hel
# app/controllers/test_controller.rb
class TestController < ApplicationController
before_action :authenticate_user!

def members_only
render json: {
data: {
Expand Down Expand Up @@ -457,7 +458,7 @@ This gem supports the use of multiple user models. One possible use case is to a
1. Define the routes to be used by the `Admin` user within a [`devise_scope`](https://github.com/plataformatec/devise#configuring-routes).

**Example**:

~~~ruby
Rails.application.routes.draw do
# when using multiple models, controllers will default to the first available
Expand All @@ -480,7 +481,7 @@ This gem supports the use of multiple user models. One possible use case is to a
end
end
~~~

1. Configure any `Admin` restricted controllers. Controllers will now have access to the methods [described here](#methods):
* `before_action: :authenticate_admin!`
* `current_admin`
Expand All @@ -497,7 +498,7 @@ It is also possible to control access to multiple user types at the same time us
class DemoGroupController < ApplicationController
devise_token_auth_group :member, contains: [:user, :admin]
before_action :authenticate_member!

def members_only
render json: {
data: {
Expand Down Expand Up @@ -579,7 +580,7 @@ end

## Custom Controller Overrides

The built-in controllers can be overridden with your own custom controllers.
The built-in controllers can be overridden with your own custom controllers.

For example, the default behavior of the [`validate_token`](https://github.com/lynndylanhurley/devise_token_auth/blob/8a33d25deaedb4809b219e557e82ec7ec61bf940/app/controllers/devise_token_auth/token_validations_controller.rb#L6) method of the [`TokenValidationController`](https://github.com/lynndylanhurley/devise_token_auth/blob/8a33d25deaedb4809b219e557e82ec7ec61bf940/app/controllers/devise_token_auth/token_validations_controller.rb) is to return the `User` object as json (sans password and token data). The following example shows how to override the `validate_token` action to include a model method as well.

Expand All @@ -588,7 +589,7 @@ For example, the default behavior of the [`validate_token`](https://github.com/l
~~~ruby
# config/routes.rb
Rails.application.routes.draw do
...
...
mount_devise_token_auth_for 'User', at: 'auth', controllers: {
token_validations: 'overrides/token_validations'
}
Expand Down Expand Up @@ -689,7 +690,7 @@ Removing the `new` routes will require significant modifications to devise. If t

### I'm having trouble using this gem alongside [ActiveAdmin](http://activeadmin.info/)...

For some odd reason, [ActiveAdmin](http://activeadmin.info/) extends from your own app's `ApplicationController`. This becomes a problem if you include the `DeviseTokenAuth::Concerns::SetUserByToken` concern in your app's `ApplicationController`.
For some odd reason, [ActiveAdmin](http://activeadmin.info/) extends from your own app's `ApplicationController`. This becomes a problem if you include the `DeviseTokenAuth::Concerns::SetUserByToken` concern in your app's `ApplicationController`.

The solution is to use two separate `ApplicationController` classes - one for your API, and one for ActiveAdmin. Something like this:

Expand Down Expand Up @@ -784,7 +785,7 @@ Thanks to the following contributors:
* [@m2omou](https://github.com/m2omou)
* [@smarquez1](https://github.com/smarquez1)
* [@jartek](https://github.com/jartek)
* [@nicolas-besnard](https://github.com/nicolas-besnard)
* [@nicolas-besnard](https://github.com/nicolas-besnard)

# Contributing

Expand Down
6 changes: 3 additions & 3 deletions app/controllers/devise_token_auth/registrations_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ def create
@resource.email = sign_up_params[:email]
end

# success redirect url is required
if resource_class.devise_modules.include?(:confirmable) && !params[:confirm_success_url]
# success redirect url may be required
if resource_class.devise_modules.include?(:confirmable) && DeviseTokenAuth.require_confirm_success_url && !params[:confirm_success_url]
return render json: {
status: 'error',
data: @resource.as_json,
Expand All @@ -28,7 +28,7 @@ def create
resource_class.skip_callback("create", :after, :send_on_create_confirmation_instructions)
if @resource.save

unless @resource.confirmed?
if params[:confirm_success_url] && !@resource.confirmed?
# user will require email authentication
@resource.send_confirmation_instructions({
client_config: params[:config_name],
Expand Down
4 changes: 3 additions & 1 deletion lib/devise_token_auth/engine.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,14 @@ class Engine < ::Rails::Engine
mattr_accessor :change_headers_on_each_request,
:token_lifespan,
:batch_request_buffer_throttle,
:omniauth_prefix
:omniauth_prefix,
:require_confirm_success_url

self.change_headers_on_each_request = true
self.token_lifespan = 2.weeks
self.batch_request_buffer_throttle = 5.seconds
self.omniauth_prefix = '/omniauth'
self.require_confirm_success_url = true

def self.setup(&block)
yield self
Expand Down