devise 3.5.1 → 4.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +281 -1066
- data/MIT-LICENSE +2 -1
- data/README.md +292 -97
- data/app/controllers/devise/confirmations_controller.rb +3 -1
- data/app/controllers/devise/omniauth_callbacks_controller.rb +8 -6
- data/app/controllers/devise/passwords_controller.rb +10 -7
- data/app/controllers/devise/registrations_controller.rb +39 -18
- data/app/controllers/devise/sessions_controller.rb +9 -7
- data/app/controllers/devise/unlocks_controller.rb +4 -2
- data/app/controllers/devise_controller.rb +25 -12
- data/app/helpers/devise_helper.rb +23 -18
- data/app/mailers/devise/mailer.rb +13 -3
- data/app/views/devise/confirmations/new.html.erb +2 -2
- data/app/views/devise/mailer/email_changed.html.erb +7 -0
- data/app/views/devise/mailer/password_change.html.erb +3 -0
- data/app/views/devise/passwords/edit.html.erb +5 -5
- data/app/views/devise/passwords/new.html.erb +2 -2
- data/app/views/devise/registrations/edit.html.erb +9 -5
- data/app/views/devise/registrations/new.html.erb +4 -4
- data/app/views/devise/sessions/new.html.erb +4 -4
- data/app/views/devise/shared/_error_messages.html.erb +15 -0
- data/app/views/devise/shared/_links.html.erb +8 -8
- data/app/views/devise/unlocks/new.html.erb +2 -2
- data/config/locales/en.yml +7 -2
- data/lib/devise/controllers/helpers.rb +42 -33
- data/lib/devise/controllers/rememberable.rb +11 -2
- data/lib/devise/controllers/scoped_views.rb +2 -0
- data/lib/devise/controllers/sign_in_out.rb +40 -21
- data/lib/devise/controllers/store_location.rb +25 -7
- data/lib/devise/controllers/url_helpers.rb +3 -1
- data/lib/devise/delegator.rb +2 -0
- data/lib/devise/encryptor.rb +6 -4
- data/lib/devise/failure_app.rb +84 -28
- data/lib/devise/hooks/activatable.rb +2 -0
- data/lib/devise/hooks/csrf_cleaner.rb +2 -0
- data/lib/devise/hooks/forgetable.rb +2 -0
- data/lib/devise/hooks/lockable.rb +4 -2
- data/lib/devise/hooks/proxy.rb +3 -1
- data/lib/devise/hooks/rememberable.rb +2 -0
- data/lib/devise/hooks/timeoutable.rb +7 -7
- data/lib/devise/hooks/trackable.rb +2 -0
- data/lib/devise/mailers/helpers.rb +7 -4
- data/lib/devise/mapping.rb +3 -1
- data/lib/devise/models/authenticatable.rb +63 -33
- data/lib/devise/models/confirmable.rb +108 -35
- data/lib/devise/models/database_authenticatable.rb +102 -22
- data/lib/devise/models/lockable.rb +24 -6
- data/lib/devise/models/omniauthable.rb +2 -0
- data/lib/devise/models/recoverable.rb +34 -26
- data/lib/devise/models/registerable.rb +4 -0
- data/lib/devise/models/rememberable.rb +42 -26
- data/lib/devise/models/timeoutable.rb +2 -6
- data/lib/devise/models/trackable.rb +15 -1
- data/lib/devise/models/validatable.rb +10 -3
- data/lib/devise/models.rb +3 -1
- data/lib/devise/modules.rb +2 -0
- data/lib/devise/omniauth/config.rb +2 -0
- data/lib/devise/omniauth/url_helpers.rb +14 -5
- data/lib/devise/omniauth.rb +4 -5
- data/lib/devise/orm/active_record.rb +5 -1
- data/lib/devise/orm/mongoid.rb +6 -2
- data/lib/devise/parameter_filter.rb +4 -0
- data/lib/devise/parameter_sanitizer.rb +139 -65
- data/lib/devise/rails/deprecated_constant_accessor.rb +39 -0
- data/lib/devise/rails/routes.rb +71 -51
- data/lib/devise/rails/warden_compat.rb +3 -10
- data/lib/devise/rails.rb +7 -16
- data/lib/devise/secret_key_finder.rb +27 -0
- data/lib/devise/strategies/authenticatable.rb +5 -3
- data/lib/devise/strategies/base.rb +2 -0
- data/lib/devise/strategies/database_authenticatable.rb +11 -4
- data/lib/devise/strategies/rememberable.rb +5 -6
- data/lib/devise/test/controller_helpers.rb +167 -0
- data/lib/devise/test/integration_helpers.rb +63 -0
- data/lib/devise/test_helpers.rb +7 -124
- data/lib/devise/time_inflector.rb +2 -0
- data/lib/devise/token_generator.rb +3 -41
- data/lib/devise/version.rb +3 -1
- data/lib/devise.rb +69 -46
- data/lib/generators/active_record/devise_generator.rb +46 -12
- data/lib/generators/active_record/templates/migration.rb +4 -2
- data/lib/generators/active_record/templates/migration_existing.rb +4 -2
- data/lib/generators/devise/controllers_generator.rb +3 -1
- data/lib/generators/devise/devise_generator.rb +5 -3
- data/lib/generators/devise/install_generator.rb +18 -5
- data/lib/generators/devise/orm_helpers.rb +10 -21
- data/lib/generators/devise/views_generator.rb +21 -11
- data/lib/generators/mongoid/devise_generator.rb +7 -5
- data/lib/generators/templates/README +9 -8
- data/lib/generators/templates/controllers/README +1 -1
- data/lib/generators/templates/controllers/confirmations_controller.rb +2 -0
- data/lib/generators/templates/controllers/omniauth_callbacks_controller.rb +3 -1
- data/lib/generators/templates/controllers/passwords_controller.rb +2 -0
- data/lib/generators/templates/controllers/registrations_controller.rb +6 -4
- data/lib/generators/templates/controllers/sessions_controller.rb +4 -2
- data/lib/generators/templates/controllers/unlocks_controller.rb +2 -0
- data/lib/generators/templates/devise.rb +65 -23
- data/lib/generators/templates/markerb/confirmation_instructions.markerb +1 -1
- data/lib/generators/templates/markerb/email_changed.markerb +7 -0
- data/lib/generators/templates/markerb/password_change.markerb +3 -0
- data/lib/generators/templates/markerb/reset_password_instructions.markerb +1 -1
- data/lib/generators/templates/markerb/unlock_instructions.markerb +1 -1
- data/lib/generators/templates/simple_form_for/confirmations/new.html.erb +5 -1
- data/lib/generators/templates/simple_form_for/passwords/edit.html.erb +10 -2
- data/lib/generators/templates/simple_form_for/passwords/new.html.erb +4 -1
- data/lib/generators/templates/simple_form_for/registrations/edit.html.erb +11 -3
- data/lib/generators/templates/simple_form_for/registrations/new.html.erb +11 -3
- data/lib/generators/templates/simple_form_for/sessions/new.html.erb +7 -2
- data/lib/generators/templates/simple_form_for/unlocks/new.html.erb +4 -1
- metadata +21 -306
- data/.gitignore +0 -10
- data/.travis.yml +0 -45
- data/.yardopts +0 -9
- data/CONTRIBUTING.md +0 -14
- data/Gemfile +0 -29
- data/Gemfile.lock +0 -191
- data/Rakefile +0 -36
- data/devise.gemspec +0 -29
- data/devise.png +0 -0
- data/gemfiles/Gemfile.rails-3.2-stable +0 -29
- data/gemfiles/Gemfile.rails-3.2-stable.lock +0 -169
- data/gemfiles/Gemfile.rails-4.0-stable +0 -29
- data/gemfiles/Gemfile.rails-4.0-stable.lock +0 -163
- data/gemfiles/Gemfile.rails-4.1-stable +0 -29
- data/gemfiles/Gemfile.rails-4.1-stable.lock +0 -169
- data/gemfiles/Gemfile.rails-4.2-stable +0 -29
- data/gemfiles/Gemfile.rails-4.2-stable.lock +0 -191
- data/script/cached-bundle +0 -49
- data/script/s3-put +0 -71
- data/test/controllers/custom_registrations_controller_test.rb +0 -40
- data/test/controllers/custom_strategy_test.rb +0 -62
- data/test/controllers/helpers_test.rb +0 -316
- data/test/controllers/inherited_controller_i18n_messages_test.rb +0 -51
- data/test/controllers/internal_helpers_test.rb +0 -129
- data/test/controllers/load_hooks_controller_test.rb +0 -19
- data/test/controllers/passwords_controller_test.rb +0 -31
- data/test/controllers/sessions_controller_test.rb +0 -103
- data/test/controllers/url_helpers_test.rb +0 -65
- data/test/delegator_test.rb +0 -19
- data/test/devise_test.rb +0 -107
- data/test/failure_app_test.rb +0 -298
- data/test/generators/active_record_generator_test.rb +0 -109
- data/test/generators/controllers_generator_test.rb +0 -48
- data/test/generators/devise_generator_test.rb +0 -39
- data/test/generators/install_generator_test.rb +0 -13
- data/test/generators/mongoid_generator_test.rb +0 -23
- data/test/generators/views_generator_test.rb +0 -96
- data/test/helpers/devise_helper_test.rb +0 -49
- data/test/integration/authenticatable_test.rb +0 -729
- data/test/integration/confirmable_test.rb +0 -324
- data/test/integration/database_authenticatable_test.rb +0 -95
- data/test/integration/http_authenticatable_test.rb +0 -105
- data/test/integration/lockable_test.rb +0 -239
- data/test/integration/omniauthable_test.rb +0 -133
- data/test/integration/recoverable_test.rb +0 -347
- data/test/integration/registerable_test.rb +0 -359
- data/test/integration/rememberable_test.rb +0 -176
- data/test/integration/timeoutable_test.rb +0 -189
- data/test/integration/trackable_test.rb +0 -92
- data/test/mailers/confirmation_instructions_test.rb +0 -115
- data/test/mailers/reset_password_instructions_test.rb +0 -96
- data/test/mailers/unlock_instructions_test.rb +0 -91
- data/test/mapping_test.rb +0 -134
- data/test/models/authenticatable_test.rb +0 -23
- data/test/models/confirmable_test.rb +0 -468
- data/test/models/database_authenticatable_test.rb +0 -249
- data/test/models/lockable_test.rb +0 -328
- data/test/models/omniauthable_test.rb +0 -7
- data/test/models/recoverable_test.rb +0 -228
- data/test/models/registerable_test.rb +0 -7
- data/test/models/rememberable_test.rb +0 -204
- data/test/models/serializable_test.rb +0 -49
- data/test/models/timeoutable_test.rb +0 -51
- data/test/models/trackable_test.rb +0 -41
- data/test/models/validatable_test.rb +0 -127
- data/test/models_test.rb +0 -144
- data/test/omniauth/config_test.rb +0 -57
- data/test/omniauth/url_helpers_test.rb +0 -54
- data/test/orm/active_record.rb +0 -10
- data/test/orm/mongoid.rb +0 -13
- data/test/parameter_sanitizer_test.rb +0 -81
- data/test/rails_app/Rakefile +0 -6
- data/test/rails_app/app/active_record/admin.rb +0 -6
- data/test/rails_app/app/active_record/shim.rb +0 -2
- data/test/rails_app/app/active_record/user.rb +0 -6
- data/test/rails_app/app/active_record/user_on_engine.rb +0 -7
- data/test/rails_app/app/active_record/user_on_main_app.rb +0 -7
- data/test/rails_app/app/controllers/admins/sessions_controller.rb +0 -6
- data/test/rails_app/app/controllers/admins_controller.rb +0 -11
- data/test/rails_app/app/controllers/application_controller.rb +0 -12
- data/test/rails_app/app/controllers/application_with_fake_engine.rb +0 -30
- data/test/rails_app/app/controllers/custom/registrations_controller.rb +0 -31
- data/test/rails_app/app/controllers/home_controller.rb +0 -25
- data/test/rails_app/app/controllers/publisher/registrations_controller.rb +0 -2
- data/test/rails_app/app/controllers/publisher/sessions_controller.rb +0 -2
- data/test/rails_app/app/controllers/users/omniauth_callbacks_controller.rb +0 -14
- data/test/rails_app/app/controllers/users_controller.rb +0 -31
- data/test/rails_app/app/helpers/application_helper.rb +0 -3
- data/test/rails_app/app/mailers/users/from_proc_mailer.rb +0 -3
- data/test/rails_app/app/mailers/users/mailer.rb +0 -3
- data/test/rails_app/app/mailers/users/reply_to_mailer.rb +0 -4
- data/test/rails_app/app/mongoid/admin.rb +0 -29
- data/test/rails_app/app/mongoid/shim.rb +0 -23
- data/test/rails_app/app/mongoid/user.rb +0 -39
- data/test/rails_app/app/mongoid/user_on_engine.rb +0 -39
- data/test/rails_app/app/mongoid/user_on_main_app.rb +0 -39
- data/test/rails_app/app/views/admins/index.html.erb +0 -1
- data/test/rails_app/app/views/admins/sessions/new.html.erb +0 -2
- data/test/rails_app/app/views/home/admin_dashboard.html.erb +0 -1
- data/test/rails_app/app/views/home/index.html.erb +0 -1
- data/test/rails_app/app/views/home/join.html.erb +0 -1
- data/test/rails_app/app/views/home/private.html.erb +0 -1
- data/test/rails_app/app/views/home/user_dashboard.html.erb +0 -1
- data/test/rails_app/app/views/layouts/application.html.erb +0 -24
- data/test/rails_app/app/views/users/edit_form.html.erb +0 -1
- data/test/rails_app/app/views/users/index.html.erb +0 -1
- data/test/rails_app/app/views/users/mailer/confirmation_instructions.erb +0 -1
- data/test/rails_app/app/views/users/sessions/new.html.erb +0 -1
- data/test/rails_app/bin/bundle +0 -3
- data/test/rails_app/bin/rails +0 -4
- data/test/rails_app/bin/rake +0 -4
- data/test/rails_app/config/application.rb +0 -40
- data/test/rails_app/config/boot.rb +0 -14
- data/test/rails_app/config/database.yml +0 -18
- data/test/rails_app/config/environment.rb +0 -5
- data/test/rails_app/config/environments/development.rb +0 -30
- data/test/rails_app/config/environments/production.rb +0 -84
- data/test/rails_app/config/environments/test.rb +0 -41
- data/test/rails_app/config/initializers/backtrace_silencers.rb +0 -7
- data/test/rails_app/config/initializers/devise.rb +0 -180
- data/test/rails_app/config/initializers/inflections.rb +0 -2
- data/test/rails_app/config/initializers/secret_token.rb +0 -8
- data/test/rails_app/config/initializers/session_store.rb +0 -1
- data/test/rails_app/config/routes.rb +0 -122
- data/test/rails_app/config.ru +0 -4
- data/test/rails_app/db/migrate/20100401102949_create_tables.rb +0 -71
- data/test/rails_app/db/schema.rb +0 -55
- data/test/rails_app/lib/shared_admin.rb +0 -17
- data/test/rails_app/lib/shared_user.rb +0 -29
- data/test/rails_app/lib/shared_user_without_omniauth.rb +0 -13
- data/test/rails_app/public/404.html +0 -26
- data/test/rails_app/public/422.html +0 -26
- data/test/rails_app/public/500.html +0 -26
- data/test/rails_app/public/favicon.ico +0 -0
- data/test/rails_test.rb +0 -9
- data/test/routes_test.rb +0 -264
- data/test/support/action_controller/record_identifier.rb +0 -10
- data/test/support/assertions.rb +0 -39
- data/test/support/helpers.rb +0 -73
- data/test/support/integration.rb +0 -92
- data/test/support/locale/en.yml +0 -8
- data/test/support/mongoid.yml +0 -6
- data/test/support/webrat/integrations/rails.rb +0 -24
- data/test/test_helper.rb +0 -34
- data/test/test_helpers_test.rb +0 -178
- data/test/test_models.rb +0 -33
data/README.md
CHANGED
@@ -1,12 +1,6 @@
|
|
1
|
-
![Devise Logo](https://raw.github.com/
|
1
|
+
![Devise Logo](https://raw.github.com/heartcombo/devise/master/devise.png)
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
[![Build Status](https://api.travis-ci.org/plataformatec/devise.svg?branch=master)](http://travis-ci.org/plataformatec/devise)
|
6
|
-
[![Code Climate](https://codeclimate.com/github/plataformatec/devise.svg)](https://codeclimate.com/github/plataformatec/devise)
|
7
|
-
[![Security](https://hakiri.io/github/plataformatec/devise/master.svg)](https://hakiri.io/github/plataformatec/devise/master)
|
8
|
-
|
9
|
-
This README is [also available in a friendly navigable format](http://devise.plataformatec.com.br/).
|
3
|
+
[![Code Climate](https://codeclimate.com/github/heartcombo/devise.svg)](https://codeclimate.com/github/heartcombo/devise)
|
10
4
|
|
11
5
|
Devise is a flexible authentication solution for Rails based on Warden. It:
|
12
6
|
|
@@ -17,18 +11,55 @@ Devise is a flexible authentication solution for Rails based on Warden. It:
|
|
17
11
|
|
18
12
|
It's composed of 10 modules:
|
19
13
|
|
20
|
-
* [Database Authenticatable](http://rubydoc.info/github/
|
21
|
-
* [Omniauthable](http://rubydoc.info/github/
|
22
|
-
* [Confirmable](http://rubydoc.info/github/
|
23
|
-
* [Recoverable](http://rubydoc.info/github/
|
24
|
-
* [Registerable](http://rubydoc.info/github/
|
25
|
-
* [Rememberable](http://rubydoc.info/github/
|
26
|
-
* [Trackable](http://rubydoc.info/github/
|
27
|
-
* [Timeoutable](http://rubydoc.info/github/
|
28
|
-
* [Validatable](http://rubydoc.info/github/
|
29
|
-
* [Lockable](http://rubydoc.info/github/
|
14
|
+
* [Database Authenticatable](http://www.rubydoc.info/github/heartcombo/devise/master/Devise/Models/DatabaseAuthenticatable): hashes and stores a password in the database to validate the authenticity of a user while signing in. The authentication can be done both through POST requests or HTTP Basic Authentication.
|
15
|
+
* [Omniauthable](http://www.rubydoc.info/github/heartcombo/devise/master/Devise/Models/Omniauthable): adds OmniAuth (https://github.com/omniauth/omniauth) support.
|
16
|
+
* [Confirmable](http://www.rubydoc.info/github/heartcombo/devise/master/Devise/Models/Confirmable): sends emails with confirmation instructions and verifies whether an account is already confirmed during sign in.
|
17
|
+
* [Recoverable](http://www.rubydoc.info/github/heartcombo/devise/master/Devise/Models/Recoverable): resets the user password and sends reset instructions.
|
18
|
+
* [Registerable](http://www.rubydoc.info/github/heartcombo/devise/master/Devise/Models/Registerable): handles signing up users through a registration process, also allowing them to edit and destroy their account.
|
19
|
+
* [Rememberable](http://www.rubydoc.info/github/heartcombo/devise/master/Devise/Models/Rememberable): manages generating and clearing a token for remembering the user from a saved cookie.
|
20
|
+
* [Trackable](http://www.rubydoc.info/github/heartcombo/devise/master/Devise/Models/Trackable): tracks sign in count, timestamps and IP address.
|
21
|
+
* [Timeoutable](http://www.rubydoc.info/github/heartcombo/devise/master/Devise/Models/Timeoutable): expires sessions that have not been active in a specified period of time.
|
22
|
+
* [Validatable](http://www.rubydoc.info/github/heartcombo/devise/master/Devise/Models/Validatable): provides validations of email and password. It's optional and can be customized, so you're able to define your own validations.
|
23
|
+
* [Lockable](http://www.rubydoc.info/github/heartcombo/devise/master/Devise/Models/Lockable): locks an account after a specified number of failed sign-in attempts. Can unlock via email or after a specified time period.
|
24
|
+
|
25
|
+
## Table of Contents
|
26
|
+
|
27
|
+
<!-- TOC depthFrom:1 depthTo:6 withLinks:1 orderedList:0 -->
|
28
|
+
|
29
|
+
- [Information](#information)
|
30
|
+
- [The Devise wiki](#the-devise-wiki)
|
31
|
+
- [Bug reports](#bug-reports)
|
32
|
+
- [StackOverflow and Mailing List](#stackoverflow-and-mailing-list)
|
33
|
+
- [RDocs](#rdocs)
|
34
|
+
- [Example applications](#example-applications)
|
35
|
+
- [Extensions](#extensions)
|
36
|
+
- [Contributing](#contributing)
|
37
|
+
- [Starting with Rails?](#starting-with-rails)
|
38
|
+
- [Getting started](#getting-started)
|
39
|
+
- [Controller filters and helpers](#controller-filters-and-helpers)
|
40
|
+
- [Configuring Models](#configuring-models)
|
41
|
+
- [Strong Parameters](#strong-parameters)
|
42
|
+
- [Configuring views](#configuring-views)
|
43
|
+
- [Configuring controllers](#configuring-controllers)
|
44
|
+
- [Configuring routes](#configuring-routes)
|
45
|
+
- [I18n](#i18n)
|
46
|
+
- [Test helpers](#test-helpers)
|
47
|
+
- [Controller tests](#controller-tests)
|
48
|
+
- [Integration tests](#integration-tests)
|
49
|
+
- [OmniAuth](#omniauth)
|
50
|
+
- [Configuring multiple models](#configuring-multiple-models)
|
51
|
+
- [ActiveJob Integration](#activejob-integration)
|
52
|
+
- [Password reset tokens and Rails logs](#password-reset-tokens-and-rails-logs)
|
53
|
+
- [Other ORMs](#other-orms)
|
54
|
+
- [Rails API mode](#rails-api-mode)
|
55
|
+
- [Additional information](#additional-information)
|
56
|
+
- [Warden](#warden)
|
57
|
+
- [Contributors](#contributors)
|
58
|
+
- [License](#license)
|
59
|
+
|
60
|
+
<!-- /TOC -->
|
61
|
+
|
30
62
|
|
31
|
-
Devise is guaranteed to be thread-safe on YARV. Thread-safety support on JRuby is in progress.
|
32
63
|
|
33
64
|
## Information
|
34
65
|
|
@@ -36,19 +67,23 @@ Devise is guaranteed to be thread-safe on YARV. Thread-safety support on JRuby i
|
|
36
67
|
|
37
68
|
The Devise Wiki has lots of additional information about Devise including many "how-to" articles and answers to the most frequently asked questions. Please browse the Wiki after finishing this README:
|
38
69
|
|
39
|
-
https://github.com/
|
70
|
+
https://github.com/heartcombo/devise/wiki
|
40
71
|
|
41
72
|
### Bug reports
|
42
73
|
|
43
74
|
If you discover a problem with Devise, we would like to know about it. However, we ask that you please review these guidelines before submitting a bug report:
|
44
75
|
|
45
|
-
https://github.com/
|
76
|
+
https://github.com/heartcombo/devise/wiki/Bug-reports
|
46
77
|
|
47
|
-
If you have discovered a security related bug, please do *NOT* use the GitHub issue tracker. Send an email to
|
78
|
+
If you have discovered a security related bug, please do *NOT* use the GitHub issue tracker. Send an email to heartcombo@googlegroups.com.
|
48
79
|
|
49
|
-
### Mailing
|
80
|
+
### StackOverflow and Mailing List
|
50
81
|
|
51
|
-
If you have any questions, comments, or concerns, please use
|
82
|
+
If you have any questions, comments, or concerns, please use StackOverflow instead of the GitHub issue tracker:
|
83
|
+
|
84
|
+
http://stackoverflow.com/questions/tagged/devise
|
85
|
+
|
86
|
+
The deprecated mailing list can still be read on
|
52
87
|
|
53
88
|
https://groups.google.com/group/plataformatec-devise
|
54
89
|
|
@@ -56,7 +91,7 @@ https://groups.google.com/group/plataformatec-devise
|
|
56
91
|
|
57
92
|
You can view the Devise documentation in RDoc format here:
|
58
93
|
|
59
|
-
http://rubydoc.info/github/
|
94
|
+
http://rubydoc.info/github/heartcombo/devise/master/frames
|
60
95
|
|
61
96
|
If you need to use Devise with previous versions of Rails, you can always run "gem server" from the command line after you install the gem to access the old documentation.
|
62
97
|
|
@@ -64,64 +99,115 @@ If you need to use Devise with previous versions of Rails, you can always run "g
|
|
64
99
|
|
65
100
|
There are a few example applications available on GitHub that demonstrate various features of Devise with different versions of Rails. You can view them here:
|
66
101
|
|
67
|
-
https://github.com/
|
102
|
+
https://github.com/heartcombo/devise/wiki/Example-Applications
|
68
103
|
|
69
104
|
### Extensions
|
70
105
|
|
71
106
|
Our community has created a number of extensions that add functionality above and beyond what is included with Devise. You can view a list of available extensions and add your own here:
|
72
107
|
|
73
|
-
https://github.com/
|
108
|
+
https://github.com/heartcombo/devise/wiki/Extensions
|
74
109
|
|
75
110
|
### Contributing
|
76
111
|
|
77
112
|
We hope that you will consider contributing to Devise. Please read this short overview for some information about how to get started:
|
78
113
|
|
79
|
-
https://github.com/
|
114
|
+
https://github.com/heartcombo/devise/wiki/Contributing
|
115
|
+
|
116
|
+
You will usually want to write tests for your changes. To run the test suite, go into Devise's top-level directory and run `bundle install` and `bin/test`.
|
117
|
+
Devise works with multiple Ruby and Rails versions, and ActiveRecord and Mongoid ORMs, which means you can run the test suite with some modifiers: `DEVISE_ORM` and `BUNDLE_GEMFILE`.
|
80
118
|
|
81
|
-
|
119
|
+
### DEVISE_ORM
|
120
|
+
Since Devise supports both Mongoid and ActiveRecord, we rely on this variable to run specific code for each ORM.
|
121
|
+
The default value of `DEVISE_ORM` is `active_record`. To run the tests for Mongoid, you can pass `mongoid`:
|
122
|
+
```
|
123
|
+
DEVISE_ORM=mongoid bin/test
|
124
|
+
|
125
|
+
==> Devise.orm = :mongoid
|
126
|
+
```
|
127
|
+
When running the tests for Mongoid, you will need to have a MongoDB server (version 2.0 or newer) running on your system.
|
128
|
+
|
129
|
+
Please note that the command output will show the variable value being used.
|
130
|
+
|
131
|
+
### BUNDLE_GEMFILE
|
132
|
+
We can use this variable to tell bundler what Gemfile it should use (instead of the one in the current directory).
|
133
|
+
Inside the [gemfiles](https://github.com/heartcombo/devise/tree/master/gemfiles) directory, we have one for each version of Rails we support. When you send us a pull request, it may happen that the test suite breaks using some of them. If that's the case, you can simulate the same environment using the `BUNDLE_GEMFILE` variable.
|
134
|
+
For example, if the tests broke using Ruby 2.4.2 and Rails 4.1, you can do the following:
|
135
|
+
```bash
|
136
|
+
rbenv shell 2.4.2 # or rvm use 2.4.2
|
137
|
+
BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.1-stable bundle install
|
138
|
+
BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.1-stable bin/test
|
139
|
+
```
|
140
|
+
|
141
|
+
You can also combine both of them if the tests broke for Mongoid:
|
142
|
+
```bash
|
143
|
+
BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.1-stable bundle install
|
144
|
+
BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.1-stable DEVISE_ORM=mongoid bin/test
|
145
|
+
```
|
146
|
+
|
147
|
+
### Running tests
|
148
|
+
Devise uses [Mini Test](https://github.com/seattlerb/minitest) as test framework.
|
149
|
+
|
150
|
+
* Running all tests:
|
151
|
+
```bash
|
152
|
+
bin/test
|
153
|
+
```
|
154
|
+
|
155
|
+
* Running tests for an specific file:
|
156
|
+
```bash
|
157
|
+
bin/test test/models/trackable_test.rb
|
158
|
+
```
|
159
|
+
|
160
|
+
* Running a specific test given a regex:
|
161
|
+
```bash
|
162
|
+
bin/test test/models/trackable_test.rb:16
|
163
|
+
```
|
82
164
|
|
83
165
|
## Starting with Rails?
|
84
166
|
|
85
|
-
If you are building your first Rails application, we recommend you *do not* use Devise. Devise requires a good understanding of the Rails Framework. In such cases, we advise you to start a simple authentication system from scratch.
|
167
|
+
If you are building your first Rails application, we recommend you *do not* use Devise. Devise requires a good understanding of the Rails Framework. In such cases, we advise you to start a simple authentication system from scratch. Here's a few resources that should help you get started:
|
86
168
|
|
87
169
|
* Michael Hartl's online book: https://www.railstutorial.org/book/modeling_users
|
88
|
-
* Ryan Bates'
|
170
|
+
* Ryan Bates' Railscasts: http://railscasts.com/episodes/250-authentication-from-scratch and http://railscasts.com/episodes/250-authentication-from-scratch-revised
|
171
|
+
* Codecademy's Ruby on Rails: Authentication and Authorization: https://www.codecademy.com/learn/rails-auth
|
89
172
|
|
90
173
|
Once you have solidified your understanding of Rails and authentication mechanisms, we assure you Devise will be very pleasant to work with. :smiley:
|
91
174
|
|
92
175
|
## Getting started
|
93
176
|
|
94
|
-
Devise
|
177
|
+
Devise 4.0 works with Rails 4.1 onwards. Add the following line to your Gemfile:
|
95
178
|
|
96
179
|
```ruby
|
97
180
|
gem 'devise'
|
98
181
|
```
|
99
182
|
|
100
|
-
|
183
|
+
Then run `bundle install`
|
101
184
|
|
102
|
-
|
185
|
+
Next, you need to run the generator:
|
103
186
|
|
104
187
|
```console
|
105
|
-
rails generate devise:install
|
188
|
+
$ rails generate devise:install
|
106
189
|
```
|
107
190
|
|
108
|
-
|
191
|
+
At this point, a number of instructions will appear in the console. Among these instructions, you'll need to set up the default URL options for the Devise mailer in each environment. Here is a possible configuration for `config/environments/development.rb`:
|
109
192
|
|
110
|
-
```
|
111
|
-
|
193
|
+
```ruby
|
194
|
+
config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
|
112
195
|
```
|
113
196
|
|
114
|
-
|
197
|
+
The generator will install an initializer which describes ALL of Devise's configuration options. It is *imperative* that you take a look at it. When you are done, you are ready to add Devise to any of your models using the generator.
|
115
198
|
|
116
|
-
Next, check the MODEL for any additional configuration options you might want to add, such as confirmable or lockable. If you add an option, be sure to inspect the migration file (created by the generator if your ORM supports them) and uncomment the appropriate section. For example, if you add the confirmable option in the model, you'll need to uncomment the Confirmable section in the migration. Then run `rake db:migrate`
|
117
199
|
|
118
|
-
|
200
|
+
In the following command you will replace `MODEL` with the class name used for the application’s users (it’s frequently `User` but could also be `Admin`). This will create a model (if one does not exist) and configure it with the default Devise modules. The generator also configures your `config/routes.rb` file to point to the Devise controller.
|
119
201
|
|
120
|
-
```
|
121
|
-
|
202
|
+
```console
|
203
|
+
$ rails generate devise MODEL
|
122
204
|
```
|
123
205
|
|
124
|
-
|
206
|
+
Next, check the MODEL for any additional configuration options you might want to add, such as confirmable or lockable. If you add an option, be sure to inspect the migration file (created by the generator if your ORM supports them) and uncomment the appropriate section. For example, if you add the confirmable option in the model, you'll need to uncomment the Confirmable section in the migration.
|
207
|
+
|
208
|
+
Then run `rails db:migrate`
|
209
|
+
|
210
|
+
You should restart your application after changing Devise's configuration options (this includes stopping spring). Otherwise, you will run into strange errors, for example, users being unable to login and route helpers being undefined.
|
125
211
|
|
126
212
|
### Controller filters and helpers
|
127
213
|
|
@@ -131,6 +217,8 @@ Devise will create some helpers to use inside your controllers and views. To set
|
|
131
217
|
before_action :authenticate_user!
|
132
218
|
```
|
133
219
|
|
220
|
+
For Rails 5, note that `protect_from_forgery` is no longer prepended to the `before_action` chain, so if you have set `authenticate_user` before `protect_from_forgery`, your request will result in "Can't verify CSRF token authenticity." To resolve this, either change the order in which you call them, or use `protect_from_forgery prepend: true`.
|
221
|
+
|
134
222
|
If your devise model is something other than User, replace "_user" with "_yourmodel". The same logic applies to the instructions below.
|
135
223
|
|
136
224
|
To verify if a user is signed in, use the following helper:
|
@@ -154,7 +242,7 @@ user_session
|
|
154
242
|
After signing in a user, confirming the account or updating the password, Devise will look for a scoped root path to redirect to. For instance, when using a `:user` resource, the `user_root_path` will be used if it exists; otherwise, the default `root_path` will be used. This means that you need to set the root inside your routes:
|
155
243
|
|
156
244
|
```ruby
|
157
|
-
root to:
|
245
|
+
root to: 'home#index'
|
158
246
|
```
|
159
247
|
|
160
248
|
You can also override `after_sign_in_path_for` and `after_sign_out_path_for` to customize your redirect hooks.
|
@@ -173,25 +261,43 @@ member_session
|
|
173
261
|
|
174
262
|
### Configuring Models
|
175
263
|
|
176
|
-
The Devise method in your models also accepts some options to configure its modules. For example, you can choose the cost of the
|
264
|
+
The Devise method in your models also accepts some options to configure its modules. For example, you can choose the cost of the hashing algorithm with:
|
177
265
|
|
178
266
|
```ruby
|
179
|
-
devise :database_authenticatable, :registerable, :confirmable, :recoverable, stretches:
|
267
|
+
devise :database_authenticatable, :registerable, :confirmable, :recoverable, stretches: 13
|
180
268
|
```
|
181
269
|
|
182
270
|
Besides `:stretches`, you can define `:pepper`, `:encryptor`, `:confirm_within`, `:remember_for`, `:timeout_in`, `:unlock_in` among other options. For more details, see the initializer file that was created when you invoked the "devise:install" generator described above. This file is usually located at `/config/initializers/devise.rb`.
|
183
271
|
|
184
272
|
### Strong Parameters
|
185
273
|
|
274
|
+
The Parameter Sanitizer API has changed for Devise 4 :warning:
|
275
|
+
|
276
|
+
*For previous Devise versions see https://github.com/heartcombo/devise/tree/3-stable#strong-parameters*
|
277
|
+
|
186
278
|
When you customize your own views, you may end up adding new attributes to forms. Rails 4 moved the parameter sanitization from the model to the controller, causing Devise to handle this concern at the controller as well.
|
187
279
|
|
188
|
-
There are just three actions in Devise that
|
280
|
+
There are just three actions in Devise that allow any set of parameters to be passed down to the model, therefore requiring sanitization. Their names and default permitted parameters are:
|
189
281
|
|
190
282
|
* `sign_in` (`Devise::SessionsController#create`) - Permits only the authentication keys (like `email`)
|
191
283
|
* `sign_up` (`Devise::RegistrationsController#create`) - Permits authentication keys plus `password` and `password_confirmation`
|
192
284
|
* `account_update` (`Devise::RegistrationsController#update`) - Permits authentication keys plus `password`, `password_confirmation` and `current_password`
|
193
285
|
|
194
|
-
In case you want to permit additional parameters (the lazy way™), you can do so using a simple before
|
286
|
+
In case you want to permit additional parameters (the lazy way™), you can do so using a simple before action in your `ApplicationController`:
|
287
|
+
|
288
|
+
```ruby
|
289
|
+
class ApplicationController < ActionController::Base
|
290
|
+
before_action :configure_permitted_parameters, if: :devise_controller?
|
291
|
+
|
292
|
+
protected
|
293
|
+
|
294
|
+
def configure_permitted_parameters
|
295
|
+
devise_parameter_sanitizer.permit(:sign_up, keys: [:username])
|
296
|
+
end
|
297
|
+
end
|
298
|
+
```
|
299
|
+
|
300
|
+
The above works for any additional fields where the parameters are simple scalar types. If you have nested attributes (say you're using `accepts_nested_attributes_for`), then you will need to tell devise about those nestings and types:
|
195
301
|
|
196
302
|
```ruby
|
197
303
|
class ApplicationController < ActionController::Base
|
@@ -200,18 +306,20 @@ class ApplicationController < ActionController::Base
|
|
200
306
|
protected
|
201
307
|
|
202
308
|
def configure_permitted_parameters
|
203
|
-
devise_parameter_sanitizer.
|
309
|
+
devise_parameter_sanitizer.permit(:sign_up, keys: [:first_name, :last_name, address_attributes: [:country, :state, :city, :area, :postal_code]])
|
204
310
|
end
|
205
311
|
end
|
206
312
|
```
|
207
313
|
|
208
|
-
|
314
|
+
Devise allows you to completely change Devise defaults or invoke custom behavior by passing a block:
|
209
315
|
|
210
316
|
To permit simple scalar values for username and email, use this
|
211
317
|
|
212
318
|
```ruby
|
213
319
|
def configure_permitted_parameters
|
214
|
-
devise_parameter_sanitizer.
|
320
|
+
devise_parameter_sanitizer.permit(:sign_in) do |user_params|
|
321
|
+
user_params.permit(:username, :email)
|
322
|
+
end
|
215
323
|
end
|
216
324
|
```
|
217
325
|
|
@@ -219,7 +327,9 @@ If you have some checkboxes that express the roles a user may take on registrati
|
|
219
327
|
|
220
328
|
```ruby
|
221
329
|
def configure_permitted_parameters
|
222
|
-
devise_parameter_sanitizer.
|
330
|
+
devise_parameter_sanitizer.permit(:sign_up) do |user_params|
|
331
|
+
user_params.permit({ roles: [] }, :email, :password, :password_confirmation)
|
332
|
+
end
|
223
333
|
end
|
224
334
|
```
|
225
335
|
For the list of permitted scalars, and how to declare permitted keys in nested hashes and arrays, see
|
@@ -230,8 +340,9 @@ If you have multiple Devise models, you may want to set up a different parameter
|
|
230
340
|
|
231
341
|
```ruby
|
232
342
|
class User::ParameterSanitizer < Devise::ParameterSanitizer
|
233
|
-
def
|
234
|
-
|
343
|
+
def initialize(*)
|
344
|
+
super
|
345
|
+
permit(:sign_up, keys: [:username, :email])
|
235
346
|
end
|
236
347
|
end
|
237
348
|
```
|
@@ -261,7 +372,7 @@ We built Devise to help you quickly develop an application that uses authenticat
|
|
261
372
|
Since Devise is an engine, all its views are packaged inside the gem. These views will help you get started, but after some time you may want to change them. If this is the case, you just need to invoke the following generator, and it will copy all views to your application:
|
262
373
|
|
263
374
|
```console
|
264
|
-
rails generate devise:views
|
375
|
+
$ rails generate devise:views
|
265
376
|
```
|
266
377
|
|
267
378
|
If you have more than one Devise model in your application (such as `User` and `Admin`), you will notice that Devise uses the same views for all models. Fortunately, Devise offers an easy way to customize views. All you need to do is set `config.scoped_views = true` inside the `config/initializers/devise.rb` file.
|
@@ -269,14 +380,14 @@ If you have more than one Devise model in your application (such as `User` and `
|
|
269
380
|
After doing so, you will be able to have views based on the role like `users/sessions/new` and `admins/sessions/new`. If no view is found within the scope, Devise will use the default view at `devise/sessions/new`. You can also use the generator to generate scoped views:
|
270
381
|
|
271
382
|
```console
|
272
|
-
rails generate devise:views users
|
383
|
+
$ rails generate devise:views users
|
273
384
|
```
|
274
385
|
|
275
386
|
If you would like to generate only a few sets of views, like the ones for the `registerable` and `confirmable` module,
|
276
387
|
you can pass a list of modules to the generator with the `-v` flag.
|
277
388
|
|
278
389
|
```console
|
279
|
-
rails generate devise:views -v registrations confirmations
|
390
|
+
$ rails generate devise:views -v registrations confirmations
|
280
391
|
```
|
281
392
|
|
282
393
|
### Configuring controllers
|
@@ -286,7 +397,7 @@ If the customization at the views level is not enough, you can customize each co
|
|
286
397
|
1. Create your custom controllers using the generator which requires a scope:
|
287
398
|
|
288
399
|
```console
|
289
|
-
rails generate devise:controllers [scope]
|
400
|
+
$ rails generate devise:controllers [scope]
|
290
401
|
```
|
291
402
|
|
292
403
|
If you specify `users` as the scope, controllers will be created in `app/controllers/users/`.
|
@@ -301,11 +412,12 @@ If the customization at the views level is not enough, you can customize each co
|
|
301
412
|
...
|
302
413
|
end
|
303
414
|
```
|
415
|
+
(Use the -c flag to specify a controller, for example: `rails generate devise:controllers users -c=sessions`)
|
304
416
|
|
305
417
|
2. Tell the router to use this controller:
|
306
418
|
|
307
419
|
```ruby
|
308
|
-
devise_for :users, controllers: { sessions:
|
420
|
+
devise_for :users, controllers: { sessions: 'users/sessions' }
|
309
421
|
```
|
310
422
|
|
311
423
|
3. Copy the views from `devise/sessions` to `users/sessions`. Since the controller was changed, it won't use the default views located in `devise/sessions`.
|
@@ -322,7 +434,7 @@ If the customization at the views level is not enough, you can customize each co
|
|
322
434
|
end
|
323
435
|
```
|
324
436
|
|
325
|
-
Or you can simply add new
|
437
|
+
Or you can simply add new behavior to it:
|
326
438
|
|
327
439
|
```ruby
|
328
440
|
class Users::SessionsController < Devise::SessionsController
|
@@ -343,21 +455,27 @@ Remember that Devise uses flash messages to let users know if sign in was succes
|
|
343
455
|
Devise also ships with default routes. If you need to customize them, you should probably be able to do it through the devise_for method. It accepts several options like :class_name, :path_prefix and so on, including the possibility to change path names for I18n:
|
344
456
|
|
345
457
|
```ruby
|
346
|
-
devise_for :users, path:
|
458
|
+
devise_for :users, path: 'auth', path_names: { sign_in: 'login', sign_out: 'logout', password: 'secret', confirmation: 'verification', unlock: 'unblock', registration: 'register', sign_up: 'cmon_let_me_in' }
|
347
459
|
```
|
348
460
|
|
349
|
-
Be sure to check `devise_for` documentation for details.
|
461
|
+
Be sure to check `devise_for` [documentation](http://www.rubydoc.info/github/heartcombo/devise/master/ActionDispatch/Routing/Mapper%3Adevise_for) for details.
|
350
462
|
|
351
|
-
If you have the need for more deep customization, for instance to also allow "/sign_in" besides "/users/sign_in", all you need to do is
|
463
|
+
If you have the need for more deep customization, for instance to also allow "/sign_in" besides "/users/sign_in", all you need to do is create your routes normally and wrap them in a `devise_scope` block in the router:
|
352
464
|
|
353
465
|
```ruby
|
354
466
|
devise_scope :user do
|
355
|
-
get
|
467
|
+
get 'sign_in', to: 'devise/sessions#new'
|
356
468
|
end
|
357
469
|
```
|
358
470
|
|
359
471
|
This way, you tell Devise to use the scope `:user` when "/sign_in" is accessed. Notice `devise_scope` is also aliased as `as` in your router.
|
360
472
|
|
473
|
+
Please note: You will still need to add `devise_for` in your routes in order to use helper methods such as `current_user`.
|
474
|
+
|
475
|
+
```ruby
|
476
|
+
devise_for :users, skip: :all
|
477
|
+
```
|
478
|
+
|
361
479
|
### I18n
|
362
480
|
|
363
481
|
Devise uses flash messages with I18n, in conjunction with the flash keys :notice and :alert. To customize your app, you can set up your locale file:
|
@@ -396,54 +514,113 @@ en:
|
|
396
514
|
|
397
515
|
Take a look at our locale file to check all available messages. You may also be interested in one of the many translations that are available on our wiki:
|
398
516
|
|
399
|
-
https://github.com/
|
517
|
+
https://github.com/heartcombo/devise/wiki/I18n
|
400
518
|
|
401
519
|
Caution: Devise Controllers inherit from ApplicationController. If your app uses multiple locales, you should be sure to set I18n.locale in ApplicationController.
|
402
520
|
|
403
521
|
### Test helpers
|
404
522
|
|
405
|
-
Devise includes some test helpers for
|
523
|
+
Devise includes some test helpers for controller and integration tests.
|
524
|
+
In order to use them, you need to include the respective module in your test
|
525
|
+
cases/specs.
|
526
|
+
|
527
|
+
### Controller tests
|
528
|
+
|
529
|
+
Controller tests require that you include `Devise::Test::IntegrationHelpers` on
|
530
|
+
your test case or its parent `ActionController::TestCase` superclass.
|
531
|
+
For Rails versions prior to 5, include `Devise::Test::ControllerHelpers` instead, since the superclass
|
532
|
+
for controller tests was changed to ActionDispatch::IntegrationTest
|
533
|
+
(for more details, see the [Integration tests](#integration-tests) section).
|
534
|
+
|
535
|
+
```ruby
|
536
|
+
class PostsControllerTest < ActionController::TestCase
|
537
|
+
include Devise::Test::IntegrationHelpers # Rails >= 5
|
538
|
+
end
|
539
|
+
```
|
406
540
|
|
407
541
|
```ruby
|
408
|
-
class ActionController::TestCase
|
409
|
-
include Devise::
|
542
|
+
class PostsControllerTest < ActionController::TestCase
|
543
|
+
include Devise::Test::ControllerHelpers # Rails < 5
|
410
544
|
end
|
411
545
|
```
|
412
546
|
|
413
|
-
If you're using RSpec, you can put the following inside a file named
|
547
|
+
If you're using RSpec, you can put the following inside a file named
|
548
|
+
`spec/support/devise.rb` or in your `spec/spec_helper.rb` (or
|
549
|
+
`spec/rails_helper.rb` if you are using `rspec-rails`):
|
414
550
|
|
415
551
|
```ruby
|
416
552
|
RSpec.configure do |config|
|
417
|
-
config.include Devise::
|
553
|
+
config.include Devise::Test::ControllerHelpers, type: :controller
|
554
|
+
config.include Devise::Test::ControllerHelpers, type: :view
|
418
555
|
end
|
419
556
|
```
|
420
557
|
|
421
558
|
Just be sure that this inclusion is made *after* the `require 'rspec/rails'` directive.
|
422
559
|
|
423
|
-
Now you are ready to use the `sign_in` and `sign_out` methods
|
560
|
+
Now you are ready to use the `sign_in` and `sign_out` methods on your controller
|
561
|
+
tests:
|
424
562
|
|
425
563
|
```ruby
|
426
|
-
sign_in
|
427
|
-
sign_in @user
|
564
|
+
sign_in @user
|
565
|
+
sign_in @user, scope: :admin
|
566
|
+
```
|
567
|
+
|
568
|
+
If you are testing Devise internal controllers or a controller that inherits
|
569
|
+
from Devise's, you need to tell Devise which mapping should be used before a
|
570
|
+
request. This is necessary because Devise gets this information from the router,
|
571
|
+
but since controller tests do not pass through the router, it needs to be stated
|
572
|
+
explicitly. For example, if you are testing the user scope, simply use:
|
573
|
+
|
574
|
+
```ruby
|
575
|
+
test 'GET new' do
|
576
|
+
# Mimic the router behavior of setting the Devise scope through the env.
|
577
|
+
@request.env['devise.mapping'] = Devise.mappings[:user]
|
578
|
+
|
579
|
+
# Use the sign_in helper to sign in a fixture `User` record.
|
580
|
+
sign_in users(:alice)
|
581
|
+
|
582
|
+
get :new
|
428
583
|
|
429
|
-
|
430
|
-
|
584
|
+
# assert something
|
585
|
+
end
|
431
586
|
```
|
432
587
|
|
433
|
-
|
588
|
+
### Integration tests
|
434
589
|
|
435
|
-
|
590
|
+
Integration test helpers are available by including the
|
591
|
+
`Devise::Test::IntegrationHelpers` module.
|
436
592
|
|
437
|
-
|
593
|
+
```ruby
|
594
|
+
class PostsTests < ActionDispatch::IntegrationTest
|
595
|
+
include Devise::Test::IntegrationHelpers
|
596
|
+
end
|
597
|
+
```
|
438
598
|
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
599
|
+
Now you can use the following `sign_in` and `sign_out` methods in your integration
|
600
|
+
tests:
|
601
|
+
|
602
|
+
```ruby
|
603
|
+
sign_in users(:bob)
|
604
|
+
sign_in users(:bob), scope: :admin
|
605
|
+
|
606
|
+
sign_out :user
|
607
|
+
```
|
608
|
+
|
609
|
+
RSpec users can include the `IntegrationHelpers` module on their `:feature` specs.
|
610
|
+
|
611
|
+
```ruby
|
612
|
+
RSpec.configure do |config|
|
613
|
+
config.include Devise::Test::IntegrationHelpers, type: :feature
|
614
|
+
end
|
615
|
+
```
|
616
|
+
|
617
|
+
Unlike controller tests, integration tests do not need to supply the
|
618
|
+
`devise.mapping` `env` value, as the mapping can be inferred by the routes that
|
619
|
+
are executed in your tests.
|
443
620
|
|
444
621
|
You can read more about testing your Rails 3 - Rails 4 controllers with RSpec in the wiki:
|
445
622
|
|
446
|
-
* https://github.com/
|
623
|
+
* https://github.com/heartcombo/devise/wiki/How-To:-Test-controllers-with-Rails-(and-RSpec)
|
447
624
|
|
448
625
|
### OmniAuth
|
449
626
|
|
@@ -455,7 +632,7 @@ config.omniauth :github, 'APP_ID', 'APP_SECRET', scope: 'user,public_repo'
|
|
455
632
|
|
456
633
|
You can read more about OmniAuth support in the wiki:
|
457
634
|
|
458
|
-
* https://github.com/
|
635
|
+
* https://github.com/heartcombo/devise/wiki/OmniAuth:-Overview
|
459
636
|
|
460
637
|
### Configuring multiple models
|
461
638
|
|
@@ -476,7 +653,7 @@ devise :database_authenticatable, :timeoutable
|
|
476
653
|
devise_for :admins
|
477
654
|
|
478
655
|
# Inside your protected controller
|
479
|
-
|
656
|
+
before_action :authenticate_admin!
|
480
657
|
|
481
658
|
# Inside your controllers and views
|
482
659
|
admin_signed_in?
|
@@ -502,12 +679,12 @@ end
|
|
502
679
|
|
503
680
|
### Password reset tokens and Rails logs
|
504
681
|
|
505
|
-
If you enable the [Recoverable](http://rubydoc.info/github/
|
682
|
+
If you enable the [Recoverable](http://rubydoc.info/github/heartcombo/devise/master/Devise/Models/Recoverable) module, note that a stolen password reset token could give an attacker access to your application. Devise takes effort to generate random, secure tokens, and stores only token digests in the database, never plaintext. However the default logging behavior in Rails can cause plaintext tokens to leak into log files:
|
506
683
|
|
507
684
|
1. Action Mailer logs the entire contents of all outgoing emails to the DEBUG level. Password reset tokens delivered to users in email will be leaked.
|
508
685
|
2. Active Job logs all arguments to every enqueued job at the INFO level. If you configure Devise to use `deliver_later` to send password reset emails, password reset tokens will be leaked.
|
509
686
|
|
510
|
-
Rails sets the production logger level to
|
687
|
+
Rails sets the production logger level to INFO by default. Consider changing your production logger level to WARN if you wish to prevent tokens from being leaked into your logs. In `config/environments/production.rb`:
|
511
688
|
|
512
689
|
```ruby
|
513
690
|
config.log_level = :warn
|
@@ -518,32 +695,50 @@ config.log_level = :warn
|
|
518
695
|
|
519
696
|
Devise supports ActiveRecord (default) and Mongoid. To select another ORM, simply require it in the initializer file.
|
520
697
|
|
521
|
-
|
698
|
+
### Rails API Mode
|
699
|
+
|
700
|
+
Rails 5+ has a built-in [API Mode](https://edgeguides.rubyonrails.org/api_app.html) which optimizes Rails for use as an API (only). Devise is _somewhat_ able to handle applications that are built in this mode without additional modifications in the sense that it should not raise exceptions and the like. But some issues may still arise during `development`/`testing`, as we still don't know the full extent of this compatibility. (For more information, see [issue #4947](https://github.com/heartcombo/devise/issues/4947/))
|
522
701
|
|
523
|
-
|
702
|
+
#### Supported Authentication Strategies
|
703
|
+
API-only applications don't support browser-based authentication via cookies, which is devise's default. Yet, devise can still provide authentication out of the box in those cases with the `http_authenticatable` strategy, which uses HTTP Basic Auth and authenticates the user on each request. (For more info, see this wiki article for [How To: Use HTTP Basic Authentication](https://github.com/heartcombo/devise/wiki/How-To:-Use-HTTP-Basic-Authentication))
|
524
704
|
|
525
|
-
|
705
|
+
The devise default for HTTP Auth is disabled, so it will need to be enabled in the devise initializer for the database strategy:
|
526
706
|
|
527
707
|
```ruby
|
528
|
-
config.
|
708
|
+
config.http_authenticatable = [:database]
|
529
709
|
```
|
530
710
|
|
531
|
-
|
711
|
+
This restriction does not limit you from implementing custom warden strategies, either in your application or via gem-based extensions for devise.
|
712
|
+
A common authentication strategy for APIs is token-based authentication. For more information on extending devise to support this type of authentication and others, see the wiki article for [Simple Token Authentication Examples and alternatives](https://github.com/heartcombo/devise/wiki/How-To:-Simple-Token-Authentication-Example#alternatives) or this blog post on [Custom authentication methods with Devise](http://blog.plataformatec.com.br/2019/01/custom-authentication-methods-with-devise/).
|
713
|
+
|
714
|
+
#### Testing
|
715
|
+
API Mode changes the order of the middleware stack, and this can cause problems for `Devise::Test::IntegrationHelpers`. This problem usually surfaces as an ```undefined method `[]=' for nil:NilClass``` error when using integration test helpers, such as `#sign_in`. The solution is simply to reorder the middlewares by adding the following to test.rb:
|
716
|
+
|
717
|
+
```ruby
|
718
|
+
Rails.application.config.middleware.insert_before Warden::Manager, ActionDispatch::Cookies
|
719
|
+
Rails.application.config.middleware.insert_before Warden::Manager, ActionDispatch::Session::CookieStore
|
720
|
+
```
|
721
|
+
|
722
|
+
For a deeper understanding of this, review [this issue](https://github.com/heartcombo/devise/issues/4696).
|
723
|
+
|
724
|
+
Additionally be mindful that without views supported, some email-based flows from Confirmable, Recoverable and Lockable are not supported directly at this time.
|
725
|
+
|
726
|
+
## Additional information
|
532
727
|
|
533
728
|
### Warden
|
534
729
|
|
535
730
|
Devise is based on Warden, which is a general Rack authentication framework created by Daniel Neighman. We encourage you to read more about Warden here:
|
536
731
|
|
537
|
-
https://github.com/
|
732
|
+
https://github.com/wardencommunity/warden
|
538
733
|
|
539
734
|
### Contributors
|
540
735
|
|
541
736
|
We have a long list of valued contributors. Check them all at:
|
542
737
|
|
543
|
-
https://github.com/
|
738
|
+
https://github.com/heartcombo/devise/graphs/contributors
|
544
739
|
|
545
740
|
## License
|
546
741
|
|
547
|
-
MIT License. Copyright 2009-
|
742
|
+
MIT License. Copyright 2020 Rafael França, Leonardo Tegon, Carlos Antônio da Silva. Copyright 2009-2019 Plataformatec.
|
548
743
|
|
549
|
-
|
744
|
+
The Devise logo is licensed under [Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License](https://creativecommons.org/licenses/by-nc-nd/4.0/).
|