devise 4.4.2 → 4.8.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +124 -4
- data/MIT-LICENSE +2 -1
- data/README.md +97 -61
- data/app/controllers/devise/passwords_controller.rb +1 -0
- data/app/controllers/devise/registrations_controller.rb +26 -8
- data/app/controllers/devise_controller.rb +3 -3
- data/app/helpers/devise_helper.rb +21 -18
- data/app/mailers/devise/mailer.rb +5 -5
- data/app/views/devise/confirmations/new.html.erb +1 -1
- data/app/views/devise/passwords/edit.html.erb +3 -3
- data/app/views/devise/passwords/new.html.erb +1 -1
- data/app/views/devise/registrations/edit.html.erb +4 -4
- data/app/views/devise/registrations/new.html.erb +3 -3
- data/app/views/devise/sessions/new.html.erb +3 -3
- 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 +1 -1
- data/config/locales/en.yml +3 -2
- data/lib/devise/controllers/helpers.rb +8 -8
- data/lib/devise/controllers/sign_in_out.rb +8 -3
- data/lib/devise/controllers/url_helpers.rb +1 -1
- data/lib/devise/failure_app.rb +25 -5
- data/lib/devise/hooks/lockable.rb +2 -5
- data/lib/devise/hooks/timeoutable.rb +2 -2
- data/lib/devise/mapping.rb +1 -1
- data/lib/devise/models/authenticatable.rb +51 -48
- data/lib/devise/models/confirmable.rb +18 -3
- data/lib/devise/models/database_authenticatable.rb +51 -13
- data/lib/devise/models/lockable.rb +12 -4
- data/lib/devise/models/omniauthable.rb +2 -2
- data/lib/devise/models/recoverable.rb +3 -3
- data/lib/devise/models/registerable.rb +2 -0
- data/lib/devise/models/rememberable.rb +2 -2
- data/lib/devise/models/timeoutable.rb +1 -1
- data/lib/devise/models/trackable.rb +9 -2
- data/lib/devise/models/validatable.rb +2 -2
- data/lib/devise/omniauth.rb +2 -5
- data/lib/devise/parameter_filter.rb +2 -0
- data/lib/devise/parameter_sanitizer.rb +13 -1
- data/lib/devise/rails/deprecated_constant_accessor.rb +39 -0
- data/lib/devise/rails/routes.rb +6 -6
- data/lib/devise/rails.rb +1 -7
- data/lib/devise/secret_key_finder.rb +27 -0
- data/lib/devise/strategies/authenticatable.rb +1 -1
- data/lib/devise/strategies/database_authenticatable.rb +6 -1
- data/lib/devise/test/controller_helpers.rb +4 -2
- data/lib/devise/test/integration_helpers.rb +1 -1
- data/lib/devise/version.rb +1 -1
- data/lib/devise.rb +15 -6
- data/lib/generators/active_record/devise_generator.rb +26 -11
- data/lib/generators/devise/controllers_generator.rb +1 -1
- data/lib/generators/devise/devise_generator.rb +1 -1
- data/lib/generators/devise/install_generator.rb +1 -5
- data/lib/generators/devise/orm_helpers.rb +2 -2
- data/lib/generators/devise/views_generator.rb +1 -1
- data/lib/generators/mongoid/devise_generator.rb +5 -5
- data/lib/generators/templates/README +9 -1
- data/lib/generators/templates/controllers/omniauth_callbacks_controller.rb +1 -1
- data/lib/generators/templates/devise.rb +34 -6
- 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 +19 -314
- data/.gitignore +0 -10
- data/.travis.yml +0 -68
- data/.yardopts +0 -9
- data/CODE_OF_CONDUCT.md +0 -22
- data/CONTRIBUTING.md +0 -79
- data/Gemfile +0 -39
- data/Gemfile.lock +0 -193
- data/ISSUE_TEMPLATE.md +0 -19
- data/Rakefile +0 -37
- data/bin/test +0 -13
- data/devise.gemspec +0 -28
- data/devise.png +0 -0
- data/gemfiles/Gemfile.rails-4.1-stable +0 -32
- data/gemfiles/Gemfile.rails-4.1-stable.lock +0 -171
- data/gemfiles/Gemfile.rails-4.2-stable +0 -32
- data/gemfiles/Gemfile.rails-4.2-stable.lock +0 -192
- data/gemfiles/Gemfile.rails-5.0-stable +0 -33
- data/gemfiles/Gemfile.rails-5.0-stable.lock +0 -192
- data/gemfiles/Gemfile.rails-5.2-rc1 +0 -26
- data/gemfiles/Gemfile.rails-5.2-rc1.lock +0 -201
- data/guides/bug_report_templates/integration_test.rb +0 -106
- data/test/controllers/custom_registrations_controller_test.rb +0 -42
- data/test/controllers/custom_strategy_test.rb +0 -66
- data/test/controllers/helper_methods_test.rb +0 -24
- data/test/controllers/helpers_test.rb +0 -318
- data/test/controllers/inherited_controller_i18n_messages_test.rb +0 -53
- data/test/controllers/internal_helpers_test.rb +0 -129
- data/test/controllers/load_hooks_controller_test.rb +0 -21
- data/test/controllers/passwords_controller_test.rb +0 -34
- data/test/controllers/sessions_controller_test.rb +0 -108
- data/test/controllers/url_helpers_test.rb +0 -67
- data/test/delegator_test.rb +0 -21
- data/test/devise_test.rb +0 -109
- data/test/failure_app_test.rb +0 -340
- data/test/generators/active_record_generator_test.rb +0 -130
- data/test/generators/controllers_generator_test.rb +0 -50
- data/test/generators/devise_generator_test.rb +0 -41
- data/test/generators/install_generator_test.rb +0 -26
- data/test/generators/mongoid_generator_test.rb +0 -25
- data/test/generators/views_generator_test.rb +0 -105
- data/test/helpers/devise_helper_test.rb +0 -51
- data/test/integration/authenticatable_test.rb +0 -706
- data/test/integration/confirmable_test.rb +0 -326
- data/test/integration/database_authenticatable_test.rb +0 -97
- data/test/integration/http_authenticatable_test.rb +0 -114
- data/test/integration/lockable_test.rb +0 -242
- data/test/integration/mounted_engine_test.rb +0 -38
- data/test/integration/omniauthable_test.rb +0 -148
- data/test/integration/recoverable_test.rb +0 -349
- data/test/integration/registerable_test.rb +0 -365
- data/test/integration/rememberable_test.rb +0 -219
- data/test/integration/timeoutable_test.rb +0 -186
- data/test/integration/trackable_test.rb +0 -99
- data/test/mailers/confirmation_instructions_test.rb +0 -117
- data/test/mailers/email_changed_test.rb +0 -132
- data/test/mailers/mailer_test.rb +0 -20
- data/test/mailers/reset_password_instructions_test.rb +0 -98
- data/test/mailers/unlock_instructions_test.rb +0 -93
- data/test/mapping_test.rb +0 -136
- data/test/models/authenticatable_test.rb +0 -25
- data/test/models/confirmable_test.rb +0 -549
- data/test/models/database_authenticatable_test.rb +0 -283
- data/test/models/lockable_test.rb +0 -352
- data/test/models/omniauthable_test.rb +0 -9
- data/test/models/recoverable_test.rb +0 -263
- data/test/models/registerable_test.rb +0 -9
- data/test/models/rememberable_test.rb +0 -184
- data/test/models/serializable_test.rb +0 -60
- data/test/models/timeoutable_test.rb +0 -53
- data/test/models/trackable_test.rb +0 -62
- data/test/models/validatable_test.rb +0 -121
- data/test/models_test.rb +0 -155
- data/test/omniauth/config_test.rb +0 -61
- data/test/omniauth/url_helpers_test.rb +0 -53
- data/test/orm/active_record.rb +0 -24
- data/test/orm/mongoid.rb +0 -15
- data/test/parameter_sanitizer_test.rb +0 -77
- data/test/rails_app/Rakefile +0 -6
- data/test/rails_app/app/active_record/admin.rb +0 -8
- data/test/rails_app/app/active_record/shim.rb +0 -4
- data/test/rails_app/app/active_record/user.rb +0 -20
- data/test/rails_app/app/active_record/user_on_engine.rb +0 -9
- data/test/rails_app/app/active_record/user_on_main_app.rb +0 -9
- data/test/rails_app/app/active_record/user_with_validations.rb +0 -12
- data/test/rails_app/app/active_record/user_without_email.rb +0 -10
- data/test/rails_app/app/controllers/admins/sessions_controller.rb +0 -8
- data/test/rails_app/app/controllers/admins_controller.rb +0 -8
- data/test/rails_app/app/controllers/application_controller.rb +0 -13
- data/test/rails_app/app/controllers/application_with_fake_engine.rb +0 -32
- data/test/rails_app/app/controllers/custom/registrations_controller.rb +0 -33
- data/test/rails_app/app/controllers/home_controller.rb +0 -31
- data/test/rails_app/app/controllers/publisher/registrations_controller.rb +0 -4
- data/test/rails_app/app/controllers/publisher/sessions_controller.rb +0 -4
- data/test/rails_app/app/controllers/users/omniauth_callbacks_controller.rb +0 -16
- data/test/rails_app/app/controllers/users_controller.rb +0 -33
- data/test/rails_app/app/helpers/application_helper.rb +0 -5
- data/test/rails_app/app/mailers/users/from_proc_mailer.rb +0 -5
- data/test/rails_app/app/mailers/users/mailer.rb +0 -5
- data/test/rails_app/app/mailers/users/reply_to_mailer.rb +0 -6
- data/test/rails_app/app/mongoid/admin.rb +0 -31
- data/test/rails_app/app/mongoid/shim.rb +0 -25
- data/test/rails_app/app/mongoid/user.rb +0 -50
- data/test/rails_app/app/mongoid/user_on_engine.rb +0 -41
- data/test/rails_app/app/mongoid/user_on_main_app.rb +0 -41
- data/test/rails_app/app/mongoid/user_with_validations.rb +0 -37
- data/test/rails_app/app/mongoid/user_without_email.rb +0 -35
- 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 -48
- data/test/rails_app/config/boot.rb +0 -27
- data/test/rails_app/config/database.yml +0 -18
- data/test/rails_app/config/environment.rb +0 -7
- data/test/rails_app/config/environments/development.rb +0 -32
- data/test/rails_app/config/environments/production.rb +0 -88
- data/test/rails_app/config/environments/test.rb +0 -47
- data/test/rails_app/config/initializers/backtrace_silencers.rb +0 -9
- data/test/rails_app/config/initializers/devise.rb +0 -182
- data/test/rails_app/config/initializers/inflections.rb +0 -4
- data/test/rails_app/config/initializers/secret_token.rb +0 -5
- data/test/rails_app/config/initializers/session_store.rb +0 -3
- data/test/rails_app/config/routes.rb +0 -128
- data/test/rails_app/config.ru +0 -4
- data/test/rails_app/db/migrate/20100401102949_create_tables.rb +0 -77
- data/test/rails_app/db/schema.rb +0 -57
- data/test/rails_app/lib/shared_admin.rb +0 -23
- data/test/rails_app/lib/shared_user.rb +0 -32
- data/test/rails_app/lib/shared_user_without_email.rb +0 -28
- data/test/rails_app/lib/shared_user_without_omniauth.rb +0 -15
- 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 -11
- data/test/routes_test.rb +0 -281
- data/test/support/action_controller/record_identifier.rb +0 -12
- data/test/support/assertions.rb +0 -30
- data/test/support/helpers.rb +0 -83
- data/test/support/http_method_compatibility.rb +0 -53
- data/test/support/integration.rb +0 -95
- data/test/support/locale/en.yml +0 -8
- data/test/support/mongoid.yml +0 -6
- data/test/support/webrat/integrations/rails.rb +0 -35
- data/test/test/controller_helpers_test.rb +0 -193
- data/test/test/integration_helpers_test.rb +0 -34
- data/test/test_helper.rb +0 -36
- data/test/test_models.rb +0 -35
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 073edbd8314be8f7b4da9e8f1b2eb07f4f25faf77a4400b6ef91f6a7d6905fda
|
4
|
+
data.tar.gz: 96ba453ccdf7f73d76c40525644d867fe8a699efa7f0b3ab58f5e520af44f0d7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3e86e75d88256721b32dc38b9ace70d25ccbdff76885c4a942452da0d01a92f7179c4e4800c55f91a1f535e4a9ecf9cce696523651b94aa4f5ee75b0016c4132
|
7
|
+
data.tar.gz: 2a42ad0db913c2aa1ae782a06edd48096b0b3bd4dbe47a243cce6a7f923663240ca3e8ad9459aa0148623fa366fa89d3a30959b1bd2e7b399343ebc207beb7bf
|
data/CHANGELOG.md
CHANGED
@@ -1,4 +1,124 @@
|
|
1
|
-
###
|
1
|
+
### 4.8.1
|
2
|
+
|
3
|
+
* enhancements
|
4
|
+
* Add support for Rails 7.0. Please note that Turbo integration is not fully supported by Devise yet.
|
5
|
+
|
6
|
+
### 4.8.0 - 2021-04-29
|
7
|
+
|
8
|
+
* enhancements
|
9
|
+
* Devise now enables the upgrade of OmniAuth 2+. Previously Devise would raise an error if you'd try to upgrade. Please note that OmniAuth 2 is considered a security upgrade and recommended to everyone. You can read more about the details (and possible necessary changes to your app as part of the upgrade) in [their release notes](https://github.com/omniauth/omniauth/releases/tag/v2.0.0). [Devise's OmniAuth Overview wiki](https://github.com/heartcombo/devise/wiki/OmniAuth:-Overview) was also updated to cover OmniAuth 2.0 requirements.
|
10
|
+
- Note that the upgrade required Devise shared links that initiate the OmniAuth flow to be changed to `method: :post`, which is now a requirement for OmniAuth, part of the security improvement. If you have copied and customized the Devise shared links partial to your app, or if you have other links in your app that initiate the OmniAuth flow, they will have to be updated to use `method: :post`, or changed to use buttons (e.g. `button_to`) to work with OmniAuth 2. (if you're using links with `method: :post`, make sure your app has `rails-ujs` or `jquery-ujs` included in order for these links to work properly.)
|
11
|
+
- As part of the OmniAuth 2.0 upgrade you might also need to add the [`omniauth-rails_csrf_protection`](https://github.com/cookpad/omniauth-rails_csrf_protection) gem to your app if you don't have it already. (and you don't want to roll your own code to verify requests.) Check the OmniAuth v2 release notes for more info.
|
12
|
+
* Introduce `Lockable#reset_failed_attempts!` model method to reset failed attempts counter to 0 after the user signs in.
|
13
|
+
- This logic existed inside the lockable warden hook and is triggered automatically after the user signs in. The new model method is an extraction to allow you to override it in the application to implement things like switching to a write database if you're using the new multi-DB infrastructure from Rails for example, similar to how it's already possible with `Trackable#update_tracked_fields!`.
|
14
|
+
* Add support for Ruby 3.
|
15
|
+
* Add support for Rails 6.1.
|
16
|
+
* Move CI to GitHub Actions.
|
17
|
+
|
18
|
+
* deprecations
|
19
|
+
* `Devise::Models::Authenticatable::BLACKLIST_FOR_SERIALIZATION` is deprecated in favor of `Devise::Models::Authenticatable::UNSAFE_ATTRIBUTES_FOR_SERIALIZATION` (@hanachin)
|
20
|
+
|
21
|
+
### 4.7.3 - 2020-09-20
|
22
|
+
|
23
|
+
* bug fixes
|
24
|
+
* Do not modify `:except` option given to `#serializable_hash`. (by @dpep)
|
25
|
+
* Fix thor deprecation when running the devise generator. (by @deivid-rodriguez)
|
26
|
+
* Fix hanging tests for streaming controllers using Devise. (by @afn)
|
27
|
+
|
28
|
+
### 4.7.2 - 2020-06-10
|
29
|
+
|
30
|
+
* enhancements
|
31
|
+
* Increase default stretches to 12 (by @sergey-alekseev)
|
32
|
+
* Ruby 2.7 support (kwarg warnings removed)
|
33
|
+
|
34
|
+
* bug fixes
|
35
|
+
* Generate scoped views with proper scoped errors partial (by @shobhitic)
|
36
|
+
* Allow to set scoped `already_authenticated` error messages (by @gurgelrenan)
|
37
|
+
|
38
|
+
### 4.7.1 - 2019-09-06
|
39
|
+
|
40
|
+
* bug fixes
|
41
|
+
* Fix an edge case where records with a blank `confirmation_token` could be confirmed (by @tegon)
|
42
|
+
* Fix typo inside `update_needs_confirmation` i18n key (by @lslm)
|
43
|
+
|
44
|
+
### 4.7.0 - 2019-08-19
|
45
|
+
|
46
|
+
* enhancements
|
47
|
+
* Support Rails 6.0
|
48
|
+
* Update CI to rails 6.0.0.beta3 (by @tunnes)
|
49
|
+
* refactor method name to be more consistent (by @saiqulhaq)
|
50
|
+
* Fix rails 6.0.rc1 email uniqueness validation deprecation warning (by @Vasfed)
|
51
|
+
|
52
|
+
* bug fixes
|
53
|
+
* Add `autocomplete="new-password"` to `password_confirmation` fields (by @ferrl)
|
54
|
+
* Fix rails_51_and_up? method for Rails 6.rc1 (by @igorkasyanchuk)
|
55
|
+
|
56
|
+
### 4.6.2 - 2019-03-26
|
57
|
+
|
58
|
+
* bug fixes
|
59
|
+
* Revert "Set `encrypted_password` to `nil` when `password` is set to `nil`" since it broke backward compatibility with existing applications. See more on https://github.com/heartcombo/devise/issues/5033#issuecomment-476386275 (by @mracos)
|
60
|
+
|
61
|
+
### 4.6.1 - 2019-02-11
|
62
|
+
|
63
|
+
* bug fixes
|
64
|
+
* Check if `root_path` is defined with `#respond_to?` instead of `#present` (by @tegon)
|
65
|
+
|
66
|
+
### 4.6.0 - 2019-02-07
|
67
|
+
|
68
|
+
* enhancements
|
69
|
+
* Allow to skip email and password change notifications (by @iorme1)
|
70
|
+
* Include the use of `nil` for `allow_unconfirmed_access_for` in the docs (by @joaumg)
|
71
|
+
* Ignore useless files into the `.gem` file (by @huacnlee)
|
72
|
+
* Explain the code that prevents enumeration attacks inside `Devise::Strategies::DatabaseAuthenticatable` (by @tegon)
|
73
|
+
* Refactor the `devise_error_messages!` helper to render a partial (by @prograhamer)
|
74
|
+
* Add an option (`Devise.sign_in_after_change_password`) to not automatically sign in a user after changing a password (by @knjko)
|
75
|
+
|
76
|
+
* bug fixes
|
77
|
+
* Fix missing comma in Simple Form generator (by @colinross)
|
78
|
+
* Fix error with migration generator in Rails 6 (by @oystersauce8)
|
79
|
+
* Set `encrypted_password` to `nil` when `password` is set to `nil` (by @sivagollapalli)
|
80
|
+
* Consider whether the request supports flash messages inside `Devise::Controllers::Helpers#is_flashing_format?` (by @colinross)
|
81
|
+
* Fix typo inside `Devise::Generators::ControllersGenerator` (by @kopylovvlad)
|
82
|
+
* Sanitize parameters inside `Devise::Models::Authenticatable#find_or_initialize_with_errors` (by @rlue)
|
83
|
+
* `#after_database_authentication` callback was not called after authentication on password reset (by @kanmaniselvan)
|
84
|
+
* Fix corner case when `#confirmation_period_valid?` was called at the same second as `confirmation_sent_at` was set. Mostly true for date types that only have second precisions. (by @stanhu)
|
85
|
+
* Fix unclosed `li` tag in `error_messages` partial (by @mracos)
|
86
|
+
* Fix Routes issue when devise engine is mounted in another engine on Rails versions lower than 5.1 (by @a-barbieri)
|
87
|
+
* Make `#increment_failed_attempts` concurrency safe (by @tegon)
|
88
|
+
* Apply Test Helper fix to Rails 6.0 as well as 5.x (by @matthewrudy)
|
89
|
+
|
90
|
+
|
91
|
+
* deprecations
|
92
|
+
* The second argument of `DatabaseAuthenticatable`'s `#update_with_password` and `#update_without_password` is deprecated and will be removed in the next major version. It was added to support a feature deprecated in Rails 4, so you can safely remove it from your code. (by @ihatov08)
|
93
|
+
* The `DeviseHelper.devise_error_messages!` is deprecated and will be removed in the next major version. Use the `devise/shared/error_messages` partial instead. (by @mracos)
|
94
|
+
|
95
|
+
### 4.5.0 - 2018-08-15
|
96
|
+
|
97
|
+
* enhancements
|
98
|
+
* Use `before_action` instead of `before_filter` (by @edenthecat)
|
99
|
+
* Allow people to extend devise failure app, through invoking `ActiveSupport.run_load_hooks` once `Devise::FailureApp` is loaded (by @wnm)
|
100
|
+
* Use `update` instead of `update_attributes` (by @koic)
|
101
|
+
* Split IP resolution from `update_tracked_fields` (by @mckramer)
|
102
|
+
* upgrade dependencies for rails and responders (by @lancecarlson)
|
103
|
+
* Add `autocomplete="new-password"` to new password fields (by @gssbzn)
|
104
|
+
* Add `autocomplete="current-password"` to current password fields (by @gssbzn)
|
105
|
+
* Remove redundant `self` from `database_authenticatable` module (by @abhishekkanojia)
|
106
|
+
* Update `simple_form` templates with changes from https://github.com/heartcombo/devise/commit/16b3d6d67c7e017d461ea17ed29ea9738dc77e83 and https://github.com/heartcombo/devise/commit/6260c29a867b9a656f1e1557abe347a523178fab (by @gssbzn)
|
107
|
+
* Remove `:trackable` from the default modules in the generators, to be more GDPR-friendly (by @fakenine)
|
108
|
+
|
109
|
+
* bug fixes
|
110
|
+
* Use same string on failed login regardless of whether account exists when in paranoid mode (by @TonyMK9068)
|
111
|
+
* Fix error when params is not a hash inside `Devise::ParameterSanitizer` (by @b0nn1e)
|
112
|
+
* Look for `secret_key_base` inside `Rails.application` (by @gencer)
|
113
|
+
* Ensure `Devise::ParameterFilter` does not add missing keys when called with a hash that has a `default` / `default_proc`
|
114
|
+
configured (by @joshpencheon)
|
115
|
+
* Adds `is_navigational_format?` check to `after_sign_up_path_for` to keep consistency (by @iorme1)
|
116
|
+
|
117
|
+
### 4.4.3 - 2018-03-17
|
118
|
+
|
119
|
+
* bug fixes
|
120
|
+
* Fix undefined method `rails5?` for Devise::Test:Module (by @tegon)
|
121
|
+
* Fix: secret key was being required to be set inside credentials on Rails 5.2 (by @tegon)
|
2
122
|
|
3
123
|
### 4.4.2 - 2018-03-15
|
4
124
|
|
@@ -38,7 +158,7 @@
|
|
38
158
|
* Validations were being ignored on singup in the `Trackable#update_tracked_fields!` method. (by @AshleyFoster)
|
39
159
|
* Do not modify options for `#serializable_hash`. (by @guigs)
|
40
160
|
* Email confirmations were being sent on sign in/sign out for application using `mongoid` and `mongoid-paperclip` gems. This is because previously we were checking if a model is from Active Record by checking if the method `after_commit` was defined - since `mongoid` doesn' have one - but `mongoid-paperclip` gem does define one, which cause this issue. (by @fjg)
|
41
|
-
|
161
|
+
|
42
162
|
### 4.3.0 - 2017-05-14
|
43
163
|
|
44
164
|
* Enhancements
|
@@ -227,8 +347,8 @@
|
|
227
347
|
end
|
228
348
|
```
|
229
349
|
|
230
|
-
You can check more examples and explanations on the [README section](
|
350
|
+
You can check more examples and explanations on the [README section](README.md#strong-parameters)
|
231
351
|
and on the [ParameterSanitizer docs](lib/devise/parameter_sanitizer.rb).
|
232
352
|
|
233
|
-
Please check [3-stable](https://github.com/
|
353
|
+
Please check [3-stable](https://github.com/heartcombo/devise/blob/3-stable/CHANGELOG.md)
|
234
354
|
for previous changes.
|
data/MIT-LICENSE
CHANGED
@@ -1,4 +1,5 @@
|
|
1
|
-
Copyright
|
1
|
+
Copyright 2020 Rafael França, Leonardo Tegon, Carlos Antônio da Silva.
|
2
|
+
Copyright 2009-2019 Plataformatec.
|
2
3
|
|
3
4
|
Permission is hereby granted, free of charge, to any person obtaining
|
4
5
|
a copy of this software and associated documentation files (the
|
data/README.md
CHANGED
@@ -1,11 +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
|
-
|
8
|
-
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)
|
9
4
|
|
10
5
|
Devise is a flexible authentication solution for Rails based on Warden. It:
|
11
6
|
|
@@ -16,16 +11,16 @@ Devise is a flexible authentication solution for Rails based on Warden. It:
|
|
16
11
|
|
17
12
|
It's composed of 10 modules:
|
18
13
|
|
19
|
-
* [Database Authenticatable](http://rubydoc.info/github/
|
20
|
-
* [Omniauthable](http://rubydoc.info/github/
|
21
|
-
* [Confirmable](http://rubydoc.info/github/
|
22
|
-
* [Recoverable](http://rubydoc.info/github/
|
23
|
-
* [Registerable](http://rubydoc.info/github/
|
24
|
-
* [Rememberable](http://rubydoc.info/github/
|
25
|
-
* [Trackable](http://rubydoc.info/github/
|
26
|
-
* [Timeoutable](http://rubydoc.info/github/
|
27
|
-
* [Validatable](http://rubydoc.info/github/
|
28
|
-
* [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.
|
29
24
|
|
30
25
|
## Table of Contents
|
31
26
|
|
@@ -53,16 +48,11 @@ It's composed of 10 modules:
|
|
53
48
|
- [Integration tests](#integration-tests)
|
54
49
|
- [OmniAuth](#omniauth)
|
55
50
|
- [Configuring multiple models](#configuring-multiple-models)
|
56
|
-
- [Create a migration with the required fields](#create-a-migration-with-the-required-fields)
|
57
|
-
- [Inside your Admin model](#inside-your-admin-model)
|
58
|
-
- [Inside your routes](#inside-your-routes)
|
59
|
-
- [Inside your protected controller](#inside-your-protected-controller)
|
60
|
-
- [Inside your controllers and views](#inside-your-controllers-and-views)
|
61
51
|
- [ActiveJob Integration](#activejob-integration)
|
62
52
|
- [Password reset tokens and Rails logs](#password-reset-tokens-and-rails-logs)
|
63
53
|
- [Other ORMs](#other-orms)
|
54
|
+
- [Rails API mode](#rails-api-mode)
|
64
55
|
- [Additional information](#additional-information)
|
65
|
-
- [Heroku](#heroku)
|
66
56
|
- [Warden](#warden)
|
67
57
|
- [Contributors](#contributors)
|
68
58
|
- [License](#license)
|
@@ -77,15 +67,15 @@ It's composed of 10 modules:
|
|
77
67
|
|
78
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:
|
79
69
|
|
80
|
-
https://github.com/
|
70
|
+
https://github.com/heartcombo/devise/wiki
|
81
71
|
|
82
72
|
### Bug reports
|
83
73
|
|
84
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:
|
85
75
|
|
86
|
-
https://github.com/
|
76
|
+
https://github.com/heartcombo/devise/wiki/Bug-reports
|
87
77
|
|
88
|
-
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.
|
89
79
|
|
90
80
|
### StackOverflow and Mailing List
|
91
81
|
|
@@ -101,7 +91,7 @@ https://groups.google.com/group/plataformatec-devise
|
|
101
91
|
|
102
92
|
You can view the Devise documentation in RDoc format here:
|
103
93
|
|
104
|
-
http://rubydoc.info/github/
|
94
|
+
http://rubydoc.info/github/heartcombo/devise/master/frames
|
105
95
|
|
106
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.
|
107
97
|
|
@@ -109,26 +99,26 @@ If you need to use Devise with previous versions of Rails, you can always run "g
|
|
109
99
|
|
110
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:
|
111
101
|
|
112
|
-
https://github.com/
|
102
|
+
https://github.com/heartcombo/devise/wiki/Example-Applications
|
113
103
|
|
114
104
|
### Extensions
|
115
105
|
|
116
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:
|
117
107
|
|
118
|
-
https://github.com/
|
108
|
+
https://github.com/heartcombo/devise/wiki/Extensions
|
119
109
|
|
120
110
|
### Contributing
|
121
111
|
|
122
112
|
We hope that you will consider contributing to Devise. Please read this short overview for some information about how to get started:
|
123
113
|
|
124
|
-
https://github.com/
|
114
|
+
https://github.com/heartcombo/devise/wiki/Contributing
|
125
115
|
|
126
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`.
|
127
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`.
|
128
118
|
|
129
119
|
### DEVISE_ORM
|
130
|
-
Since Devise
|
131
|
-
The default value of `DEVISE_ORM` is `active_record`. To run the tests for
|
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`:
|
132
122
|
```
|
133
123
|
DEVISE_ORM=mongoid bin/test
|
134
124
|
|
@@ -140,7 +130,7 @@ Please note that the command output will show the variable value being used.
|
|
140
130
|
|
141
131
|
### BUNDLE_GEMFILE
|
142
132
|
We can use this variable to tell bundler what Gemfile it should use (instead of the one in the current directory).
|
143
|
-
Inside the [gemfiles](https://github.com/
|
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.
|
144
134
|
For example, if the tests broke using Ruby 2.4.2 and Rails 4.1, you can do the following:
|
145
135
|
```bash
|
146
136
|
rbenv shell 2.4.2 # or rvm use 2.4.2
|
@@ -154,19 +144,37 @@ BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.1-stable bundle install
|
|
154
144
|
BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.1-stable DEVISE_ORM=mongoid bin/test
|
155
145
|
```
|
156
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
|
+
```
|
164
|
+
|
157
165
|
## Starting with Rails?
|
158
166
|
|
159
|
-
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:
|
160
168
|
|
161
169
|
* Michael Hartl's online book: https://www.railstutorial.org/book/modeling_users
|
162
|
-
* Ryan Bates'
|
163
|
-
* Codecademy's Ruby on Rails: Authentication and Authorization:
|
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
|
164
172
|
|
165
173
|
Once you have solidified your understanding of Rails and authentication mechanisms, we assure you Devise will be very pleasant to work with. :smiley:
|
166
174
|
|
167
175
|
## Getting started
|
168
176
|
|
169
|
-
Devise 4.0 works with Rails 4.1 onwards.
|
177
|
+
Devise 4.0 works with Rails 4.1 onwards. Add the following line to your Gemfile:
|
170
178
|
|
171
179
|
```ruby
|
172
180
|
gem 'devise'
|
@@ -195,7 +203,7 @@ In the following command you will replace `MODEL` with the class name used for t
|
|
195
203
|
$ rails generate devise MODEL
|
196
204
|
```
|
197
205
|
|
198
|
-
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.
|
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.
|
199
207
|
|
200
208
|
Then run `rails db:migrate`
|
201
209
|
|
@@ -256,16 +264,16 @@ member_session
|
|
256
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:
|
257
265
|
|
258
266
|
```ruby
|
259
|
-
devise :database_authenticatable, :registerable, :confirmable, :recoverable, stretches:
|
267
|
+
devise :database_authenticatable, :registerable, :confirmable, :recoverable, stretches: 13
|
260
268
|
```
|
261
269
|
|
262
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`.
|
263
271
|
|
264
272
|
### Strong Parameters
|
265
273
|
|
266
|
-
|
274
|
+
The Parameter Sanitizer API has changed for Devise 4 :warning:
|
267
275
|
|
268
|
-
*For previous Devise versions see https://github.com/
|
276
|
+
*For previous Devise versions see https://github.com/heartcombo/devise/tree/3-stable#strong-parameters*
|
269
277
|
|
270
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.
|
271
279
|
|
@@ -275,7 +283,7 @@ There are just three actions in Devise that allow any set of parameters to be pa
|
|
275
283
|
* `sign_up` (`Devise::RegistrationsController#create`) - Permits authentication keys plus `password` and `password_confirmation`
|
276
284
|
* `account_update` (`Devise::RegistrationsController#update`) - Permits authentication keys plus `password`, `password_confirmation` and `current_password`
|
277
285
|
|
278
|
-
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`:
|
279
287
|
|
280
288
|
```ruby
|
281
289
|
class ApplicationController < ActionController::Base
|
@@ -303,7 +311,7 @@ class ApplicationController < ActionController::Base
|
|
303
311
|
end
|
304
312
|
```
|
305
313
|
|
306
|
-
Devise allows you to completely change Devise defaults or invoke custom
|
314
|
+
Devise allows you to completely change Devise defaults or invoke custom behavior by passing a block:
|
307
315
|
|
308
316
|
To permit simple scalar values for username and email, use this
|
309
317
|
|
@@ -404,6 +412,7 @@ If the customization at the views level is not enough, you can customize each co
|
|
404
412
|
...
|
405
413
|
end
|
406
414
|
```
|
415
|
+
(Use the -c flag to specify a controller, for example: `rails generate devise:controllers users -c=sessions`)
|
407
416
|
|
408
417
|
2. Tell the router to use this controller:
|
409
418
|
|
@@ -425,7 +434,7 @@ If the customization at the views level is not enough, you can customize each co
|
|
425
434
|
end
|
426
435
|
```
|
427
436
|
|
428
|
-
Or you can simply add new
|
437
|
+
Or you can simply add new behavior to it:
|
429
438
|
|
430
439
|
```ruby
|
431
440
|
class Users::SessionsController < Devise::SessionsController
|
@@ -449,7 +458,7 @@ Devise also ships with default routes. If you need to customize them, you should
|
|
449
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' }
|
450
459
|
```
|
451
460
|
|
452
|
-
Be sure to check `devise_for` [documentation](http://www.rubydoc.info/github/
|
461
|
+
Be sure to check `devise_for` [documentation](http://www.rubydoc.info/github/heartcombo/devise/master/ActionDispatch/Routing/Mapper%3Adevise_for) for details.
|
453
462
|
|
454
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:
|
455
464
|
|
@@ -505,7 +514,7 @@ en:
|
|
505
514
|
|
506
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:
|
507
516
|
|
508
|
-
https://github.com/
|
517
|
+
https://github.com/heartcombo/devise/wiki/I18n
|
509
518
|
|
510
519
|
Caution: Devise Controllers inherit from ApplicationController. If your app uses multiple locales, you should be sure to set I18n.locale in ApplicationController.
|
511
520
|
|
@@ -517,12 +526,21 @@ cases/specs.
|
|
517
526
|
|
518
527
|
### Controller tests
|
519
528
|
|
520
|
-
Controller tests require that you include `Devise::Test::
|
529
|
+
Controller tests require that you include `Devise::Test::IntegrationHelpers` on
|
521
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).
|
522
534
|
|
523
535
|
```ruby
|
524
536
|
class PostsControllerTest < ActionController::TestCase
|
525
|
-
include Devise::Test::
|
537
|
+
include Devise::Test::IntegrationHelpers # Rails >= 5
|
538
|
+
end
|
539
|
+
```
|
540
|
+
|
541
|
+
```ruby
|
542
|
+
class PostsControllerTest < ActionController::TestCase
|
543
|
+
include Devise::Test::ControllerHelpers # Rails < 5
|
526
544
|
end
|
527
545
|
```
|
528
546
|
|
@@ -602,7 +620,7 @@ are executed in your tests.
|
|
602
620
|
|
603
621
|
You can read more about testing your Rails 3 - Rails 4 controllers with RSpec in the wiki:
|
604
622
|
|
605
|
-
* https://github.com/
|
623
|
+
* https://github.com/heartcombo/devise/wiki/How-To:-Test-controllers-with-Rails-(and-RSpec)
|
606
624
|
|
607
625
|
### OmniAuth
|
608
626
|
|
@@ -614,7 +632,7 @@ config.omniauth :github, 'APP_ID', 'APP_SECRET', scope: 'user,public_repo'
|
|
614
632
|
|
615
633
|
You can read more about OmniAuth support in the wiki:
|
616
634
|
|
617
|
-
* https://github.com/
|
635
|
+
* https://github.com/heartcombo/devise/wiki/OmniAuth:-Overview
|
618
636
|
|
619
637
|
### Configuring multiple models
|
620
638
|
|
@@ -661,12 +679,12 @@ end
|
|
661
679
|
|
662
680
|
### Password reset tokens and Rails logs
|
663
681
|
|
664
|
-
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:
|
665
683
|
|
666
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.
|
667
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.
|
668
686
|
|
669
|
-
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`:
|
670
688
|
|
671
689
|
```ruby
|
672
690
|
config.log_level = :warn
|
@@ -677,32 +695,50 @@ config.log_level = :warn
|
|
677
695
|
|
678
696
|
Devise supports ActiveRecord (default) and Mongoid. To select another ORM, simply require it in the initializer file.
|
679
697
|
|
680
|
-
|
698
|
+
### Rails API Mode
|
681
699
|
|
682
|
-
|
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/))
|
683
701
|
|
684
|
-
|
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))
|
704
|
+
|
705
|
+
The devise default for HTTP Auth is disabled, so it will need to be enabled in the devise initializer for the database strategy:
|
685
706
|
|
686
707
|
```ruby
|
687
|
-
config.
|
708
|
+
config.http_authenticatable = [:database]
|
688
709
|
```
|
689
710
|
|
690
|
-
|
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
|
691
727
|
|
692
728
|
### Warden
|
693
729
|
|
694
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:
|
695
731
|
|
696
|
-
https://github.com/
|
732
|
+
https://github.com/wardencommunity/warden
|
697
733
|
|
698
734
|
### Contributors
|
699
735
|
|
700
736
|
We have a long list of valued contributors. Check them all at:
|
701
737
|
|
702
|
-
https://github.com/
|
738
|
+
https://github.com/heartcombo/devise/graphs/contributors
|
703
739
|
|
704
740
|
## License
|
705
741
|
|
706
|
-
MIT License. Copyright 2009-
|
742
|
+
MIT License. Copyright 2020 Rafael França, Leonardo Tegon, Carlos Antônio da Silva. Copyright 2009-2019 Plataformatec.
|
707
743
|
|
708
|
-
|
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/).
|
@@ -39,6 +39,7 @@ class Devise::PasswordsController < DeviseController
|
|
39
39
|
if Devise.sign_in_after_reset_password
|
40
40
|
flash_message = resource.active_for_authentication? ? :updated : :updated_not_active
|
41
41
|
set_flash_message!(:notice, flash_message)
|
42
|
+
resource.after_database_authentication
|
42
43
|
sign_in(resource_name, resource)
|
43
44
|
else
|
44
45
|
set_flash_message!(:notice, :updated_not_active)
|
@@ -50,12 +50,9 @@ class Devise::RegistrationsController < DeviseController
|
|
50
50
|
resource_updated = update_resource(resource, account_update_params)
|
51
51
|
yield resource if block_given?
|
52
52
|
if resource_updated
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
set_flash_message :notice, flash_key
|
57
|
-
end
|
58
|
-
bypass_sign_in resource, scope: resource_name
|
53
|
+
set_flash_message_for_update(resource, prev_unconfirmed_email)
|
54
|
+
bypass_sign_in resource, scope: resource_name if sign_in_after_change_password?
|
55
|
+
|
59
56
|
respond_with resource, location: after_update_path_for(resource)
|
60
57
|
else
|
61
58
|
clean_up_passwords resource
|
@@ -112,7 +109,7 @@ class Devise::RegistrationsController < DeviseController
|
|
112
109
|
# The path used after sign up. You need to overwrite this method
|
113
110
|
# in your own RegistrationsController.
|
114
111
|
def after_sign_up_path_for(resource)
|
115
|
-
after_sign_in_path_for(resource)
|
112
|
+
after_sign_in_path_for(resource) if is_navigational_format?
|
116
113
|
end
|
117
114
|
|
118
115
|
# The path used after sign up for inactive accounts. You need to overwrite
|
@@ -127,7 +124,7 @@ class Devise::RegistrationsController < DeviseController
|
|
127
124
|
# The default url to be used after updating a resource. You need to overwrite
|
128
125
|
# this method in your own RegistrationsController.
|
129
126
|
def after_update_path_for(resource)
|
130
|
-
signed_in_root_path(resource)
|
127
|
+
sign_in_after_change_password? ? signed_in_root_path(resource) : new_session_path(resource_name)
|
131
128
|
end
|
132
129
|
|
133
130
|
# Authenticates the current scope and gets the current resource from the session.
|
@@ -147,4 +144,25 @@ class Devise::RegistrationsController < DeviseController
|
|
147
144
|
def translation_scope
|
148
145
|
'devise.registrations'
|
149
146
|
end
|
147
|
+
|
148
|
+
private
|
149
|
+
|
150
|
+
def set_flash_message_for_update(resource, prev_unconfirmed_email)
|
151
|
+
return unless is_flashing_format?
|
152
|
+
|
153
|
+
flash_key = if update_needs_confirmation?(resource, prev_unconfirmed_email)
|
154
|
+
:update_needs_confirmation
|
155
|
+
elsif sign_in_after_change_password?
|
156
|
+
:updated
|
157
|
+
else
|
158
|
+
:updated_but_not_signed_in
|
159
|
+
end
|
160
|
+
set_flash_message :notice, flash_key
|
161
|
+
end
|
162
|
+
|
163
|
+
def sign_in_after_change_password?
|
164
|
+
return true if account_update_params[:password].blank?
|
165
|
+
|
166
|
+
Devise.sign_in_after_change_password
|
167
|
+
end
|
150
168
|
end
|
@@ -22,7 +22,7 @@ class DeviseController < Devise.parent_controller.constantize
|
|
22
22
|
# Action Controller tests that forces _prefixes to be
|
23
23
|
# loaded before even having a request object.
|
24
24
|
#
|
25
|
-
# This method should be public as it is
|
25
|
+
# This method should be public as it is in ActionPack
|
26
26
|
# itself. Changing its visibility may break other gems.
|
27
27
|
def _prefixes #:nodoc:
|
28
28
|
@_prefixes ||= if self.class.scoped_views? && request && devise_mapping
|
@@ -112,7 +112,7 @@ MESSAGE
|
|
112
112
|
end
|
113
113
|
|
114
114
|
if authenticated && resource = warden.user(resource_name)
|
115
|
-
|
115
|
+
set_flash_message(:alert, 'already_authenticated', scope: 'devise.failure')
|
116
116
|
redirect_to after_sign_in_path_for(resource)
|
117
117
|
end
|
118
118
|
end
|
@@ -184,7 +184,7 @@ MESSAGE
|
|
184
184
|
options[:default] = Array(options[:default]).unshift(kind.to_sym)
|
185
185
|
options[:resource_name] = resource_name
|
186
186
|
options = devise_i18n_options(options)
|
187
|
-
I18n.t("#{options[:resource_name]}.#{kind}", options)
|
187
|
+
I18n.t("#{options[:resource_name]}.#{kind}", **options)
|
188
188
|
end
|
189
189
|
|
190
190
|
# Controllers inheriting DeviseController are advised to override this
|