RubyGems - devise - Versions diffs - 4.4.3 → 4.7.3 - Mend

devise 4.4.3 → 4.7.3

Files changed (222) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +98 -4
data/MIT-LICENSE +2 -1
data/README.md +96 -59
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 +7 -7
data/app/views/devise/unlocks/new.html.erb +1 -1
data/config/locales/en.yml +3 -2
data/lib/devise.rb +4 -4
data/lib/devise/controllers/helpers.rb +8 -8
data/lib/devise/controllers/sign_in_out.rb +6 -3
data/lib/devise/controllers/url_helpers.rb +1 -1
data/lib/devise/failure_app.rb +25 -5
data/lib/devise/hooks/timeoutable.rb +2 -2
data/lib/devise/mapping.rb +1 -1
data/lib/devise/models/authenticatable.rb +44 -45
data/lib/devise/models/confirmable.rb +18 -3
data/lib/devise/models/database_authenticatable.rb +50 -12
data/lib/devise/models/lockable.rb +3 -3
data/lib/devise/models/recoverable.rb +2 -2
data/lib/devise/models/registerable.rb +2 -0
data/lib/devise/models/rememberable.rb +1 -1
data/lib/devise/models/trackable.rb +9 -2
data/lib/devise/models/validatable.rb +1 -1
data/lib/devise/parameter_filter.rb +2 -0
data/lib/devise/parameter_sanitizer.rb +13 -1
data/lib/devise/rails/routes.rb +6 -6
data/lib/devise/secret_key_finder.rb +2 -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/generators/active_record/devise_generator.rb +9 -9
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 +7 -312
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.ru +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/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/secret_key_finder_test.rb +0 -97
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 @@
 ---
 SHA256:
-  metadata.gz: 554c50f7db4c13beb0b2eb9ee1dbdd863aef2e7647de61d7070adac0b60fd1c7
-  data.tar.gz: 7624cffe7f3383660d08bca3c10b4f0c3ce2d5696b1f52cfe2e8b2b023c79fed
+  metadata.gz: '056338b76007de25ec62deff781ba493d0d063184f70373d31406faf1fc8a219'
+  data.tar.gz: 43919f99b2b775b213bf40d5849138339b99462700e58ce5e4a843ab5a63c22f
 SHA512:
-  metadata.gz: fa0cacb024cecbfb7a031f0dd5b5e8cf2ea518ecbd89b3f2d3994614bf8d859548984b4675f4cd1be1f73b17c0a07214e9d62e08e4d7362450664b27083bc1a4
-  data.tar.gz: e249d22cc464e7b04b53e990ff0c6e15b3c48a1bb7e8d9ef0a10722b867649840b7b5d48b30f234e9963400b773608b31c3732aeb5665287cea940d568bb5abe
+  metadata.gz: b21e1c4b5658dc2077d4eeb4fa70fa25c108bcdbe03b1b1f587d1a8f5c49a2c3b0fa299dc5a45af8b743ba8d8dc968bab768587df12350d41beeb163f6d80af3
+  data.tar.gz: c12702819c331ce7739ee30a34cdf550d85db4edbe90ad1c3adffe51c910a27f969938dc098940637c49acc31da0195cc351b56558bf4c2be69961f3071a23c6

data/CHANGELOG.md CHANGED

@@ -1,4 +1,98 @@
-### Unreleased
+### 4.7.3 - 2020-09-20
+* bug fixes
+  * Do not modify `:except` option given to `#serializable_hash`. (by @dpep)
+  * Fix thor deprecation when running the devise generator. (by @deivid-rodriguez)
+  * Fix hanging tests for streaming controllers using Devise. (by @afn)
+### 4.7.2 - 2020-06-10
+* enhancements
+  * Increase default stretches to 12 (by @sergey-alekseev)
+  * Ruby 2.7 support (kwarg warnings removed)
+* bug fixes
+  * Generate scoped views with proper scoped errors partial (by @shobhitic)
+  * Allow to set scoped `already_authenticated` error messages (by @gurgelrenan)
+### 4.7.1 - 2019-09-06
+* bug fixes
+  * Fix an edge case where records with a blank `confirmation_token` could be confirmed (by @tegon)
+  * Fix typo inside `update_needs_confirmation` i18n key (by @lslm)
+### 4.7.0 - 2019-08-19
+* enhancements
+  * Support Rails 6.0
+  * Update CI to rails 6.0.0.beta3 (by @tunnes)
+  * refactor method name to be more consistent (by @saiqulhaq)
+  * Fix rails 6.0.rc1 email uniqueness validation deprecation warning (by @Vasfed)
+* bug fixes
+  * Add `autocomplete="new-password"` to `password_confirmation` fields (by @ferrl)
+  * Fix rails_51_and_up? method for Rails 6.rc1 (by @igorkasyanchuk)
+### 4.6.2 - 2019-03-26
+* bug fixes
+  * 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)
+### 4.6.1 - 2019-02-11
+* bug fixes
+  * Check if `root_path` is defined with `#respond_to?` instead of `#present` (by @tegon)
+### 4.6.0 - 2019-02-07
+* enhancements
+  * Allow to skip email and password change notifications (by @iorme1)
+  * Include the use of `nil` for `allow_unconfirmed_access_for` in the docs (by @joaumg)
+  * Ignore useless files into the `.gem` file (by @huacnlee)
+  * Explain the code that prevents enumeration attacks inside `Devise::Strategies::DatabaseAuthenticatable` (by @tegon)
+  * Refactor the `devise_error_messages!` helper to render a partial (by @prograhamer)
+  * Add an option (`Devise.sign_in_after_change_password`) to not automatically sign in a user after changing a password (by @knjko)
+* bug fixes
+  * Fix missing comma in Simple Form generator (by @colinross)
+  * Fix error with migration generator in Rails 6 (by @oystersauce8)
+  * Set `encrypted_password` to `nil` when `password` is set to `nil` (by @sivagollapalli)
+  * Consider whether the request supports flash messages inside `Devise::Controllers::Helpers#is_flashing_format?` (by @colinross)
+  * Fix typo inside `Devise::Generators::ControllersGenerator` (by @kopylovvlad)
+  * Sanitize parameters inside `Devise::Models::Authenticatable#find_or_initialize_with_errors` (by @rlue)
+  * `#after_database_authentication` callback was not called after authentication on password reset (by @kanmaniselvan)
+  * 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)
+  * Fix unclosed `li` tag in `error_messages` partial (by @mracos)
+  * Fix Routes issue when devise engine is mounted in another engine on Rails versions lower than 5.1 (by @a-barbieri)
+  * Make `#increment_failed_attempts` concurrency safe (by @tegon)
+  * Apply Test Helper fix to Rails 6.0 as well as 5.x (by @matthewrudy)
+* deprecations
+  * 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)
+  * 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)
+### 4.5.0 - 2018-08-15
+* enhancements
+  * Use `before_action` instead of `before_filter` (by @edenthecat)
+  *  Allow people to extend devise failure app, through invoking `ActiveSupport.run_load_hooks` once `Devise::FailureApp` is loaded (by @wnm)
+  * Use `update` instead of `update_attributes` (by @koic)
+  * Split IP resolution from `update_tracked_fields` (by @mckramer)
+  * upgrade dependencies for rails and responders (by @lancecarlson)
+  * Add `autocomplete="new-password"` to new password fields (by @gssbzn)
+  * Add `autocomplete="current-password"` to current password fields (by @gssbzn)
+  * Remove redundant `self` from `database_authenticatable` module (by @abhishekkanojia)
+  * Update `simple_form` templates with changes from https://github.com/heartcombo/devise/commit/16b3d6d67c7e017d461ea17ed29ea9738dc77e83 and https://github.com/heartcombo/devise/commit/6260c29a867b9a656f1e1557abe347a523178fab (by @gssbzn)
+  * Remove `:trackable` from the default modules in the generators, to be more GDPR-friendly (by @fakenine)
+* bug fixes
+  * Use same string on failed login regardless of whether account exists when in paranoid mode (by @TonyMK9068)
+  * Fix error when params is not a hash inside `Devise::ParameterSanitizer` (by @b0nn1e)
+  * Look for `secret_key_base` inside `Rails.application` (by @gencer)
+  * Ensure `Devise::ParameterFilter` does not add missing keys when called with a hash that has a `default` / `default_proc`
+configured (by @joshpencheon)
+  * Adds `is_navigational_format?` check to `after_sign_up_path_for` to keep consistency (by @iorme1)
 ### 4.4.3 - 2018-03-17
@@ -44,7 +138,7 @@
   * Validations were being ignored on singup in the `Trackable#update_tracked_fields!` method. (by @AshleyFoster)
   * Do not modify options for `#serializable_hash`. (by @guigs)
   * 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)
 ### 4.3.0 - 2017-05-14
 * Enhancements
@@ -233,8 +327,8 @@
     end
     ```
-    You can check more examples and explanations on the [README section](/plataformatec/devise#strong-parameters)
+    You can check more examples and explanations on the [README section](README.md#strong-parameters)
     and on the [ParameterSanitizer docs](lib/devise/parameter_sanitizer.rb).
-Please check [3-stable](https://github.com/plataformatec/devise/blob/3-stable/CHANGELOG.md)
+Please check [3-stable](https://github.com/heartcombo/devise/blob/3-stable/CHANGELOG.md)
 for previous changes.

data/MIT-LICENSE CHANGED

@@ -1,4 +1,5 @@
-Copyright 2009-2017 Plataformatec. http://plataformatec.com.br
+Copyright 2020 Rafael França, Leonardo Tegon, Carlos Antônio da Silva.
+Copyright 2009-2019 Plataformatec.
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md CHANGED

@@ -1,11 +1,7 @@
-![Devise Logo](https://raw.github.com/plataformatec/devise/master/devise.png)
+![Devise Logo](https://raw.github.com/heartcombo/devise/master/devise.png)
-By [Plataformatec](http://plataformatec.com.br/).
-[![Build Status](https://api.travis-ci.org/plataformatec/devise.svg?branch=master)](http://travis-ci.org/plataformatec/devise)
-[![Code Climate](https://codeclimate.com/github/plataformatec/devise.svg)](https://codeclimate.com/github/plataformatec/devise)
-This README is [also available in a friendly navigable format](http://devise.plataformatec.com.br/).
+[![Build Status](https://api.travis-ci.org/heartcombo/devise.svg?branch=master)](http://travis-ci.org/heartcombo/devise)
+[![Code Climate](https://codeclimate.com/github/heartcombo/devise.svg)](https://codeclimate.com/github/heartcombo/devise)
 Devise is a flexible authentication solution for Rails based on Warden. It:
@@ -16,16 +12,16 @@ Devise is a flexible authentication solution for Rails based on Warden. It:
 It's composed of 10 modules:
-* [Database Authenticatable](http://rubydoc.info/github/plataformatec/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.
-* [Omniauthable](http://rubydoc.info/github/plataformatec/devise/master/Devise/Models/Omniauthable): adds OmniAuth (https://github.com/omniauth/omniauth) support.
-* [Confirmable](http://rubydoc.info/github/plataformatec/devise/master/Devise/Models/Confirmable): sends emails with confirmation instructions and verifies whether an account is already confirmed during sign in.
-* [Recoverable](http://rubydoc.info/github/plataformatec/devise/master/Devise/Models/Recoverable): resets the user password and sends reset instructions.
-* [Registerable](http://rubydoc.info/github/plataformatec/devise/master/Devise/Models/Registerable): handles signing up users through a registration process, also allowing them to edit and destroy their account.
-* [Rememberable](http://rubydoc.info/github/plataformatec/devise/master/Devise/Models/Rememberable): manages generating and clearing a token for remembering the user from a saved cookie.
-* [Trackable](http://rubydoc.info/github/plataformatec/devise/master/Devise/Models/Trackable): tracks sign in count, timestamps and IP address.
-* [Timeoutable](http://rubydoc.info/github/plataformatec/devise/master/Devise/Models/Timeoutable): expires sessions that have not been active in a specified period of time.
-* [Validatable](http://rubydoc.info/github/plataformatec/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.
-* [Lockable](http://rubydoc.info/github/plataformatec/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.
+* [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.
+* [Omniauthable](http://www.rubydoc.info/github/heartcombo/devise/master/Devise/Models/Omniauthable): adds OmniAuth (https://github.com/omniauth/omniauth) support.
+* [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.
+* [Recoverable](http://www.rubydoc.info/github/heartcombo/devise/master/Devise/Models/Recoverable): resets the user password and sends reset instructions.
+* [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.
+* [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.
+* [Trackable](http://www.rubydoc.info/github/heartcombo/devise/master/Devise/Models/Trackable): tracks sign in count, timestamps and IP address.
+* [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.
+* [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.
+* [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.
 ## Table of Contents
@@ -53,16 +49,11 @@ It's composed of 10 modules:
 	- [Integration tests](#integration-tests)
 	- [OmniAuth](#omniauth)
 	- [Configuring multiple models](#configuring-multiple-models)
-- [Create a migration with the required fields](#create-a-migration-with-the-required-fields)
-- [Inside your Admin model](#inside-your-admin-model)
-- [Inside your routes](#inside-your-routes)
-- [Inside your protected controller](#inside-your-protected-controller)
-- [Inside your controllers and views](#inside-your-controllers-and-views)
 	- [ActiveJob Integration](#activejob-integration)
 	- [Password reset tokens and Rails logs](#password-reset-tokens-and-rails-logs)
 	- [Other ORMs](#other-orms)
+	- [Rails API mode](#rails-api-mode)
 - [Additional information](#additional-information)
-	- [Heroku](#heroku)
 	- [Warden](#warden)
 	- [Contributors](#contributors)
 - [License](#license)
@@ -77,15 +68,15 @@ It's composed of 10 modules:
 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:
-https://github.com/plataformatec/devise/wiki
+https://github.com/heartcombo/devise/wiki
 ### Bug reports
 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:
-https://github.com/plataformatec/devise/wiki/Bug-reports
+https://github.com/heartcombo/devise/wiki/Bug-reports
-If you have discovered a security related bug, please do *NOT* use the GitHub issue tracker. Send an email to opensource@plataformatec.com.br.
+If you have discovered a security related bug, please do *NOT* use the GitHub issue tracker. Send an email to heartcombo@googlegroups.com.
 ### StackOverflow and Mailing List
@@ -101,7 +92,7 @@ https://groups.google.com/group/plataformatec-devise
 You can view the Devise documentation in RDoc format here:
-http://rubydoc.info/github/plataformatec/devise/master/frames
+http://rubydoc.info/github/heartcombo/devise/master/frames
 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.
@@ -109,26 +100,26 @@ If you need to use Devise with previous versions of Rails, you can always run "g
 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:
-https://github.com/plataformatec/devise/wiki/Example-Applications
+https://github.com/heartcombo/devise/wiki/Example-Applications
 ### Extensions
 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:
-https://github.com/plataformatec/devise/wiki/Extensions
+https://github.com/heartcombo/devise/wiki/Extensions
 ### Contributing
 We hope that you will consider contributing to Devise. Please read this short overview for some information about how to get started:
-https://github.com/plataformatec/devise/wiki/Contributing
+https://github.com/heartcombo/devise/wiki/Contributing
 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`.
 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`.
 ### DEVISE_ORM
 Since Devise support both Mongoid and ActiveRecord, we rely on this variable to run specific code for each ORM.
-The default value of `DEVISE_ORM` is `active_record`. To run the tests for mongoid, you can pass `mongoid`:
+The default value of `DEVISE_ORM` is `active_record`. To run the tests for Mongoid, you can pass `mongoid`:
 ```
 DEVISE_ORM=mongoid bin/test
@@ -140,7 +131,7 @@ Please note that the command output will show the variable value being used.
 ### BUNDLE_GEMFILE
 We can use this variable to tell bundler what Gemfile it should use (instead of the one in the current directory).
-Inside the [gemfiles](https://github.com/plataformatec/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 brakes on Travis using some of them. If that's the case, you can simulate the same environment using the `BUNDLE_GEMFILE` variable.
+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 on Travis using some of them. If that's the case, you can simulate the same environment using the `BUNDLE_GEMFILE` variable.
 For example, if the tests broke using Ruby 2.4.2 and Rails 4.1, you can do the following:
 ```bash
 rbenv shell 2.4.2 # or rvm use 2.4.2
@@ -154,19 +145,37 @@ BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.1-stable bundle install
 BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.1-stable DEVISE_ORM=mongoid bin/test
 ```
+### Running tests
+Devise uses [Mini Test](https://github.com/seattlerb/minitest) as test framework.
+* Running all tests:
+```bash
+bin/test
+```
+* Running tests for an specific file:
+```bash
+bin/test test/models/trackable_test.rb
+```
+* Running a specific test given a regex:
+```bash
+bin/test test/models/trackable_test.rb:16
+```
 ## Starting with Rails?
-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. Today, we have three resources that should help you get started:
+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:
 * Michael Hartl's online book: https://www.railstutorial.org/book/modeling_users
-* Ryan Bates' Railscast: http://railscasts.com/episodes/250-authentication-from-scratch
-* Codecademy's Ruby on Rails: Authentication and Authorization: http://www.codecademy.com/en/learn/rails-auth
+* Ryan Bates' Railscasts: http://railscasts.com/episodes/250-authentication-from-scratch and http://railscasts.com/episodes/250-authentication-from-scratch-revised
+* Codecademy's Ruby on Rails: Authentication and Authorization: https://www.codecademy.com/learn/rails-auth
 Once you have solidified your understanding of Rails and authentication mechanisms, we assure you Devise will be very pleasant to work with. :smiley:
 ## Getting started
-Devise 4.0 works with Rails 4.1 onwards. You can add it to your Gemfile with:
+Devise 4.0 works with Rails 4.1 onwards. Add the following line to your Gemfile:
 ```ruby
 gem 'devise'
@@ -195,7 +204,7 @@ In the following command you will replace `MODEL` with the class name used for t
 $ rails generate devise MODEL
 ```
-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.
+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 `rails db:migrate`
@@ -256,16 +265,16 @@ member_session
 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:
 ```ruby
-devise :database_authenticatable, :registerable, :confirmable, :recoverable, stretches: 12
+devise :database_authenticatable, :registerable, :confirmable, :recoverable, stretches: 13
 ```
 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`.
 ### Strong Parameters
-![The Parameter Sanitizer API has changed for Devise 4](http://messages.hellobits.com/warning.svg?message=The%20Parameter%20Sanitizer%20API%20has%20changed%20for%20Devise%204)
+The Parameter Sanitizer API has changed for Devise 4 :warning:
-*For previous Devise versions see https://github.com/plataformatec/devise/tree/3-stable#strong-parameters*
+*For previous Devise versions see https://github.com/heartcombo/devise/tree/3-stable#strong-parameters*
 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.
@@ -275,7 +284,7 @@ There are just three actions in Devise that allow any set of parameters to be pa
 * `sign_up` (`Devise::RegistrationsController#create`) - Permits authentication keys plus `password` and `password_confirmation`
 * `account_update` (`Devise::RegistrationsController#update`) - Permits authentication keys plus `password`, `password_confirmation` and `current_password`
-In case you want to permit additional parameters (the lazy way™), you can do so using a simple before filter in your `ApplicationController`:
+In case you want to permit additional parameters (the lazy way™), you can do so using a simple before action in your `ApplicationController`:
 ```ruby
 class ApplicationController < ActionController::Base
@@ -303,7 +312,7 @@ class ApplicationController < ActionController::Base
 end
 ```
-Devise allows you to completely change Devise defaults or invoke custom behaviour by passing a block:
+Devise allows you to completely change Devise defaults or invoke custom behavior by passing a block:
 To permit simple scalar values for username and email, use this
@@ -404,6 +413,7 @@ If the customization at the views level is not enough, you can customize each co
       ...
     end
     ```
+    (Use the -c flag to specify a controller, for example: `rails generate devise:controllers users -c=sessions`)
 2. Tell the router to use this controller:
@@ -425,7 +435,7 @@ If the customization at the views level is not enough, you can customize each co
     end
     ```
-    Or you can simply add new behaviour to it:
+    Or you can simply add new behavior to it:
     ```ruby
     class Users::SessionsController < Devise::SessionsController
@@ -449,7 +459,7 @@ Devise also ships with default routes. If you need to customize them, you should
 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' }
 ```
-Be sure to check `devise_for` [documentation](http://www.rubydoc.info/github/plataformatec/devise/master/ActionDispatch/Routing/Mapper%3Adevise_for) for details.
+Be sure to check `devise_for` [documentation](http://www.rubydoc.info/github/heartcombo/devise/master/ActionDispatch/Routing/Mapper%3Adevise_for) for details.
 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:
@@ -505,7 +515,7 @@ en:
 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:
-https://github.com/plataformatec/devise/wiki/I18n
+https://github.com/heartcombo/devise/wiki/I18n
 Caution: Devise Controllers inherit from ApplicationController. If your app uses multiple locales, you should be sure to set I18n.locale in ApplicationController.
@@ -517,12 +527,21 @@ cases/specs.
 ### Controller tests
-Controller tests require that you include `Devise::Test::ControllerHelpers` on
+Controller tests require that you include `Devise::Test::IntegrationHelpers` on
 your test case or its parent `ActionController::TestCase` superclass.
+For Rails versions prior to 5, include `Devise::Test::ControllerHelpers` instead, since the superclass
+for controller tests was changed to ActionDispatch::IntegrationTest
+(for more details, see the [Integration tests](#integration-tests) section).
 ```ruby
 class PostsControllerTest < ActionController::TestCase
-  include Devise::Test::ControllerHelpers
+  include Devise::Test::IntegrationHelpers # Rails >= 5
+end
+```
+```ruby
+class PostsControllerTest < ActionController::TestCase
+  include Devise::Test::ControllerHelpers # Rails < 5
 end
 ```
@@ -602,7 +621,7 @@ are executed in your tests.
 You can read more about testing your Rails 3 - Rails 4 controllers with RSpec in the wiki:
-* https://github.com/plataformatec/devise/wiki/How-To:-Test-controllers-with-Rails-3-and-4-%28and-RSpec%29
+* https://github.com/heartcombo/devise/wiki/How-To:-Test-controllers-with-Rails-(and-RSpec)
 ### OmniAuth
@@ -614,7 +633,7 @@ config.omniauth :github, 'APP_ID', 'APP_SECRET', scope: 'user,public_repo'
 You can read more about OmniAuth support in the wiki:
-* https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview
+* https://github.com/heartcombo/devise/wiki/OmniAuth:-Overview
 ### Configuring multiple models
@@ -661,7 +680,7 @@ end
 ### Password reset tokens and Rails logs
-If you enable the [Recoverable](http://rubydoc.info/github/plataformatec/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:
+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:
 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.
 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.
@@ -677,32 +696,50 @@ config.log_level = :warn
 Devise supports ActiveRecord (default) and Mongoid. To select another ORM, simply require it in the initializer file.
-## Additional information
+### Rails API Mode
-### Heroku
+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/))
-Using Devise on Heroku with Ruby on Rails 3.2 requires setting:
+#### Supported Authentication Strategies
+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))
+The devise default for HTTP Auth is disabled, so it will need to be enabled in the devise initializer for the database strategy:
 ```ruby
-config.assets.initialize_on_precompile = false
+config.http_authenticatable = [:database]
 ```
-Read more about the potential issues at http://guides.rubyonrails.org/asset_pipeline.html
+This restriction does not limit you from implementing custom warden strategies, either in your application or via gem-based extensions for devise.
+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/).
+#### Testing
+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:
+```ruby
+Rails.application.config.middleware.insert_before Warden::Manager, ActionDispatch::Cookies
+Rails.application.config.middleware.insert_before Warden::Manager, ActionDispatch::Session::CookieStore
+```
+For a deeper understanding of this, review [this issue](https://github.com/heartcombo/devise/issues/4696).
+Additionally be mindful that without views supported, some email-based flows from Confirmable, Recoverable and Lockable are not supported directly at this time.
+## Additional information
 ### Warden
 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:
-https://github.com/hassox/warden
+https://github.com/wardencommunity/warden
 ### Contributors
 We have a long list of valued contributors. Check them all at:
-https://github.com/plataformatec/devise/graphs/contributors
+https://github.com/heartcombo/devise/graphs/contributors
 ## License
-MIT License. Copyright 2009-2018 Plataformatec. http://plataformatec.com.br
+MIT License. Copyright 2020 Rafael França, Leonardo Tegon, Carlos Antônio da Silva. Copyright 2009-2019 Plataformatec.
-You are not granted rights or licenses to the trademarks of Plataformatec, including without limitation the Devise name or logo.
+The Devise logo is licensed under [Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License](https://creativecommons.org/licenses/by-nc-nd/4.0/).