devise 3.2.4 → 4.7.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +259 -994
- data/MIT-LICENSE +1 -1
- data/README.md +336 -99
- data/app/controllers/devise/confirmations_controller.rb +9 -3
- data/app/controllers/devise/omniauth_callbacks_controller.rb +12 -6
- data/app/controllers/devise/passwords_controller.rb +19 -6
- data/app/controllers/devise/registrations_controller.rb +55 -22
- data/app/controllers/devise/sessions_controller.rb +44 -14
- data/app/controllers/devise/unlocks_controller.rb +7 -2
- data/app/controllers/devise_controller.rb +65 -29
- data/app/helpers/devise_helper.rb +12 -19
- data/app/mailers/devise/mailer.rb +10 -0
- data/app/views/devise/confirmations/new.html.erb +8 -4
- data/app/views/devise/mailer/email_changed.html.erb +7 -0
- data/app/views/devise/mailer/password_change.html.erb +3 -0
- data/app/views/devise/passwords/edit.html.erb +15 -6
- data/app/views/devise/passwords/new.html.erb +8 -4
- data/app/views/devise/registrations/edit.html.erb +27 -13
- data/app/views/devise/registrations/new.html.erb +19 -8
- data/app/views/devise/sessions/new.html.erb +18 -9
- data/app/views/devise/shared/_error_messages.html.erb +15 -0
- data/app/views/devise/shared/{_links.erb → _links.html.erb} +9 -9
- data/app/views/devise/unlocks/new.html.erb +8 -4
- data/config/locales/en.yml +22 -16
- data/lib/devise/controllers/helpers.rb +109 -29
- data/lib/devise/controllers/rememberable.rb +12 -3
- data/lib/devise/controllers/scoped_views.rb +2 -0
- data/lib/devise/controllers/sign_in_out.rb +36 -20
- data/lib/devise/controllers/store_location.rb +31 -5
- data/lib/devise/controllers/url_helpers.rb +9 -7
- data/lib/devise/delegator.rb +2 -0
- data/lib/devise/encryptor.rb +24 -0
- data/lib/devise/failure_app.rb +116 -36
- data/lib/devise/hooks/activatable.rb +5 -4
- data/lib/devise/hooks/csrf_cleaner.rb +5 -1
- data/lib/devise/hooks/forgetable.rb +2 -0
- data/lib/devise/hooks/lockable.rb +6 -1
- data/lib/devise/hooks/proxy.rb +3 -1
- data/lib/devise/hooks/rememberable.rb +2 -0
- data/lib/devise/hooks/timeoutable.rb +15 -8
- data/lib/devise/hooks/trackable.rb +2 -0
- data/lib/devise/mailers/helpers.rb +7 -4
- data/lib/devise/mapping.rb +8 -2
- data/lib/devise/models/authenticatable.rb +76 -51
- data/lib/devise/models/confirmable.rb +129 -34
- data/lib/devise/models/database_authenticatable.rb +107 -30
- data/lib/devise/models/lockable.rb +19 -9
- data/lib/devise/models/omniauthable.rb +2 -0
- data/lib/devise/models/recoverable.rb +62 -26
- data/lib/devise/models/registerable.rb +4 -0
- data/lib/devise/models/rememberable.rb +58 -29
- data/lib/devise/models/timeoutable.rb +2 -6
- data/lib/devise/models/trackable.rb +20 -4
- data/lib/devise/models/validatable.rb +12 -5
- data/lib/devise/models.rb +3 -1
- data/lib/devise/modules.rb +2 -0
- data/lib/devise/omniauth/config.rb +2 -0
- data/lib/devise/omniauth/url_helpers.rb +14 -5
- data/lib/devise/omniauth.rb +2 -0
- data/lib/devise/orm/active_record.rb +5 -1
- data/lib/devise/orm/mongoid.rb +6 -2
- data/lib/devise/parameter_filter.rb +4 -0
- data/lib/devise/parameter_sanitizer.rb +139 -65
- data/lib/devise/rails/routes.rb +80 -61
- data/lib/devise/rails/warden_compat.rb +3 -10
- data/lib/devise/rails.rb +8 -17
- data/lib/devise/secret_key_finder.rb +27 -0
- data/lib/devise/strategies/authenticatable.rb +18 -7
- data/lib/devise/strategies/base.rb +2 -0
- data/lib/devise/strategies/database_authenticatable.rb +13 -5
- data/lib/devise/strategies/rememberable.rb +15 -3
- data/lib/devise/test/controller_helpers.rb +165 -0
- data/lib/devise/test/integration_helpers.rb +63 -0
- data/lib/devise/test_helpers.rb +7 -124
- data/lib/devise/time_inflector.rb +2 -0
- data/lib/devise/token_generator.rb +3 -41
- data/lib/devise/version.rb +3 -1
- data/lib/devise.rb +106 -79
- data/lib/generators/active_record/devise_generator.rb +44 -7
- data/lib/generators/active_record/templates/migration.rb +5 -3
- data/lib/generators/active_record/templates/migration_existing.rb +5 -3
- data/lib/generators/devise/controllers_generator.rb +46 -0
- data/lib/generators/devise/devise_generator.rb +4 -2
- data/lib/generators/devise/install_generator.rb +17 -0
- data/lib/generators/devise/orm_helpers.rb +10 -21
- data/lib/generators/devise/views_generator.rb +21 -11
- data/lib/generators/mongoid/devise_generator.rb +7 -5
- data/lib/generators/templates/README +2 -9
- data/lib/generators/templates/controllers/README +14 -0
- data/lib/generators/templates/controllers/confirmations_controller.rb +30 -0
- data/lib/generators/templates/controllers/omniauth_callbacks_controller.rb +30 -0
- data/lib/generators/templates/controllers/passwords_controller.rb +34 -0
- data/lib/generators/templates/controllers/registrations_controller.rb +62 -0
- data/lib/generators/templates/controllers/sessions_controller.rb +27 -0
- data/lib/generators/templates/controllers/unlocks_controller.rb +30 -0
- data/lib/generators/templates/devise.rb +69 -30
- data/lib/generators/templates/markerb/confirmation_instructions.markerb +1 -1
- data/lib/generators/templates/markerb/email_changed.markerb +7 -0
- data/lib/generators/templates/markerb/password_change.markerb +3 -0
- data/lib/generators/templates/markerb/reset_password_instructions.markerb +1 -1
- data/lib/generators/templates/markerb/unlock_instructions.markerb +1 -1
- data/lib/generators/templates/simple_form_for/confirmations/new.html.erb +5 -1
- data/lib/generators/templates/simple_form_for/passwords/edit.html.erb +10 -2
- data/lib/generators/templates/simple_form_for/passwords/new.html.erb +4 -1
- data/lib/generators/templates/simple_form_for/registrations/edit.html.erb +11 -3
- data/lib/generators/templates/simple_form_for/registrations/new.html.erb +11 -3
- data/lib/generators/templates/simple_form_for/sessions/new.html.erb +9 -4
- data/lib/generators/templates/simple_form_for/unlocks/new.html.erb +4 -1
- metadata +31 -259
- data/.gitignore +0 -11
- data/.travis.yml +0 -28
- data/.yardopts +0 -9
- data/CONTRIBUTING.md +0 -14
- data/Gemfile +0 -29
- data/Gemfile.lock +0 -160
- data/Rakefile +0 -35
- data/devise.gemspec +0 -27
- data/devise.png +0 -0
- data/gemfiles/Gemfile.rails-3.2-stable +0 -29
- data/gemfiles/Gemfile.rails-4.0-stable +0 -29
- data/gemfiles/Gemfile.rails-head +0 -29
- data/test/controllers/custom_strategy_test.rb +0 -62
- data/test/controllers/helpers_test.rb +0 -276
- data/test/controllers/internal_helpers_test.rb +0 -123
- data/test/controllers/passwords_controller_test.rb +0 -31
- data/test/controllers/sessions_controller_test.rb +0 -103
- data/test/controllers/url_helpers_test.rb +0 -59
- data/test/delegator_test.rb +0 -19
- data/test/devise_test.rb +0 -94
- data/test/failure_app_test.rb +0 -232
- data/test/generators/active_record_generator_test.rb +0 -103
- data/test/generators/devise_generator_test.rb +0 -39
- data/test/generators/install_generator_test.rb +0 -13
- data/test/generators/mongoid_generator_test.rb +0 -23
- data/test/generators/views_generator_test.rb +0 -96
- data/test/helpers/devise_helper_test.rb +0 -51
- data/test/integration/authenticatable_test.rb +0 -713
- data/test/integration/confirmable_test.rb +0 -284
- data/test/integration/database_authenticatable_test.rb +0 -84
- data/test/integration/http_authenticatable_test.rb +0 -105
- data/test/integration/lockable_test.rb +0 -239
- data/test/integration/omniauthable_test.rb +0 -133
- data/test/integration/recoverable_test.rb +0 -334
- data/test/integration/registerable_test.rb +0 -349
- data/test/integration/rememberable_test.rb +0 -167
- data/test/integration/timeoutable_test.rb +0 -183
- data/test/integration/trackable_test.rb +0 -92
- data/test/mailers/confirmation_instructions_test.rb +0 -115
- data/test/mailers/reset_password_instructions_test.rb +0 -96
- data/test/mailers/unlock_instructions_test.rb +0 -91
- data/test/mapping_test.rb +0 -127
- data/test/models/authenticatable_test.rb +0 -13
- data/test/models/confirmable_test.rb +0 -454
- data/test/models/database_authenticatable_test.rb +0 -249
- data/test/models/lockable_test.rb +0 -316
- data/test/models/omniauthable_test.rb +0 -7
- data/test/models/recoverable_test.rb +0 -184
- data/test/models/registerable_test.rb +0 -7
- data/test/models/rememberable_test.rb +0 -183
- data/test/models/serializable_test.rb +0 -49
- data/test/models/timeoutable_test.rb +0 -51
- data/test/models/trackable_test.rb +0 -13
- data/test/models/validatable_test.rb +0 -127
- data/test/models_test.rb +0 -144
- data/test/omniauth/config_test.rb +0 -57
- data/test/omniauth/url_helpers_test.rb +0 -54
- data/test/orm/active_record.rb +0 -10
- data/test/orm/mongoid.rb +0 -13
- data/test/parameter_sanitizer_test.rb +0 -81
- data/test/rails_app/Rakefile +0 -6
- data/test/rails_app/app/active_record/admin.rb +0 -6
- data/test/rails_app/app/active_record/shim.rb +0 -2
- data/test/rails_app/app/active_record/user.rb +0 -6
- data/test/rails_app/app/controllers/admins/sessions_controller.rb +0 -6
- data/test/rails_app/app/controllers/admins_controller.rb +0 -11
- data/test/rails_app/app/controllers/application_controller.rb +0 -9
- data/test/rails_app/app/controllers/home_controller.rb +0 -25
- data/test/rails_app/app/controllers/publisher/registrations_controller.rb +0 -2
- data/test/rails_app/app/controllers/publisher/sessions_controller.rb +0 -2
- data/test/rails_app/app/controllers/users/omniauth_callbacks_controller.rb +0 -14
- data/test/rails_app/app/controllers/users_controller.rb +0 -31
- data/test/rails_app/app/helpers/application_helper.rb +0 -3
- data/test/rails_app/app/mailers/users/mailer.rb +0 -12
- data/test/rails_app/app/mongoid/admin.rb +0 -29
- data/test/rails_app/app/mongoid/shim.rb +0 -23
- data/test/rails_app/app/mongoid/user.rb +0 -39
- data/test/rails_app/app/views/admins/index.html.erb +0 -1
- data/test/rails_app/app/views/admins/sessions/new.html.erb +0 -2
- data/test/rails_app/app/views/home/admin_dashboard.html.erb +0 -1
- data/test/rails_app/app/views/home/index.html.erb +0 -1
- data/test/rails_app/app/views/home/join.html.erb +0 -1
- data/test/rails_app/app/views/home/private.html.erb +0 -1
- data/test/rails_app/app/views/home/user_dashboard.html.erb +0 -1
- data/test/rails_app/app/views/layouts/application.html.erb +0 -24
- data/test/rails_app/app/views/users/edit_form.html.erb +0 -1
- data/test/rails_app/app/views/users/index.html.erb +0 -1
- data/test/rails_app/app/views/users/mailer/confirmation_instructions.erb +0 -1
- data/test/rails_app/app/views/users/sessions/new.html.erb +0 -1
- data/test/rails_app/bin/bundle +0 -3
- data/test/rails_app/bin/rails +0 -4
- data/test/rails_app/bin/rake +0 -4
- data/test/rails_app/config/application.rb +0 -40
- data/test/rails_app/config/boot.rb +0 -14
- data/test/rails_app/config/database.yml +0 -18
- data/test/rails_app/config/environment.rb +0 -5
- data/test/rails_app/config/environments/development.rb +0 -30
- data/test/rails_app/config/environments/production.rb +0 -80
- data/test/rails_app/config/environments/test.rb +0 -36
- data/test/rails_app/config/initializers/backtrace_silencers.rb +0 -7
- data/test/rails_app/config/initializers/devise.rb +0 -181
- data/test/rails_app/config/initializers/inflections.rb +0 -2
- data/test/rails_app/config/initializers/secret_token.rb +0 -8
- data/test/rails_app/config/initializers/session_store.rb +0 -1
- data/test/rails_app/config/routes.rb +0 -105
- data/test/rails_app/config.ru +0 -4
- data/test/rails_app/db/migrate/20100401102949_create_tables.rb +0 -71
- data/test/rails_app/db/schema.rb +0 -55
- data/test/rails_app/lib/shared_admin.rb +0 -17
- data/test/rails_app/lib/shared_user.rb +0 -29
- data/test/rails_app/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/routes_test.rb +0 -262
- data/test/support/action_controller/record_identifier.rb +0 -10
- data/test/support/assertions.rb +0 -40
- data/test/support/helpers.rb +0 -70
- data/test/support/integration.rb +0 -92
- data/test/support/locale/en.yml +0 -8
- data/test/support/mongoid.yml +0 -6
- data/test/support/webrat/integrations/rails.rb +0 -24
- data/test/test_helper.rb +0 -27
- data/test/test_helpers_test.rb +0 -173
- data/test/test_models.rb +0 -33
data/lib/devise/version.rb
CHANGED
data/lib/devise.rb
CHANGED
@@ -1,28 +1,32 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
require 'rails'
|
2
4
|
require 'active_support/core_ext/numeric/time'
|
3
5
|
require 'active_support/dependencies'
|
4
6
|
require 'orm_adapter'
|
5
7
|
require 'set'
|
6
8
|
require 'securerandom'
|
9
|
+
require 'responders'
|
7
10
|
|
8
11
|
module Devise
|
9
12
|
autoload :Delegator, 'devise/delegator'
|
13
|
+
autoload :Encryptor, 'devise/encryptor'
|
10
14
|
autoload :FailureApp, 'devise/failure_app'
|
11
15
|
autoload :OmniAuth, 'devise/omniauth'
|
12
16
|
autoload :ParameterFilter, 'devise/parameter_filter'
|
13
|
-
autoload :BaseSanitizer, 'devise/parameter_sanitizer'
|
14
17
|
autoload :ParameterSanitizer, 'devise/parameter_sanitizer'
|
15
18
|
autoload :TestHelpers, 'devise/test_helpers'
|
16
19
|
autoload :TimeInflector, 'devise/time_inflector'
|
17
20
|
autoload :TokenGenerator, 'devise/token_generator'
|
21
|
+
autoload :SecretKeyFinder, 'devise/secret_key_finder'
|
18
22
|
|
19
23
|
module Controllers
|
20
|
-
autoload :Helpers,
|
21
|
-
autoload :Rememberable,
|
22
|
-
autoload :ScopedViews,
|
23
|
-
autoload :SignInOut,
|
24
|
-
autoload :StoreLocation,
|
25
|
-
autoload :UrlHelpers,
|
24
|
+
autoload :Helpers, 'devise/controllers/helpers'
|
25
|
+
autoload :Rememberable, 'devise/controllers/rememberable'
|
26
|
+
autoload :ScopedViews, 'devise/controllers/scoped_views'
|
27
|
+
autoload :SignInOut, 'devise/controllers/sign_in_out'
|
28
|
+
autoload :StoreLocation, 'devise/controllers/store_location'
|
29
|
+
autoload :UrlHelpers, 'devise/controllers/url_helpers'
|
26
30
|
end
|
27
31
|
|
28
32
|
module Hooks
|
@@ -34,17 +38,22 @@ module Devise
|
|
34
38
|
end
|
35
39
|
|
36
40
|
module Strategies
|
37
|
-
autoload :Base,
|
41
|
+
autoload :Base, 'devise/strategies/base'
|
38
42
|
autoload :Authenticatable, 'devise/strategies/authenticatable'
|
39
43
|
end
|
40
44
|
|
45
|
+
module Test
|
46
|
+
autoload :ControllerHelpers, 'devise/test/controller_helpers'
|
47
|
+
autoload :IntegrationHelpers, 'devise/test/integration_helpers'
|
48
|
+
end
|
49
|
+
|
41
50
|
# Constants which holds devise configuration for extensions. Those should
|
42
51
|
# not be modified by the "end user" (this is why they are constants).
|
43
52
|
ALL = []
|
44
|
-
CONTROLLERS =
|
45
|
-
ROUTES =
|
46
|
-
STRATEGIES =
|
47
|
-
URL_HELPERS =
|
53
|
+
CONTROLLERS = {}
|
54
|
+
ROUTES = {}
|
55
|
+
STRATEGIES = {}
|
56
|
+
URL_HELPERS = {}
|
48
57
|
|
49
58
|
# Strategies that do not require user input.
|
50
59
|
NO_INPUT = []
|
@@ -56,29 +65,13 @@ module Devise
|
|
56
65
|
mattr_accessor :secret_key
|
57
66
|
@@secret_key = nil
|
58
67
|
|
59
|
-
[ :allow_insecure_token_lookup,
|
60
|
-
:allow_insecure_sign_in_after_confirmation,
|
61
|
-
:token_authentication_key ].each do |method|
|
62
|
-
class_eval <<-RUBY
|
63
|
-
def self.#{method}
|
64
|
-
ActiveSupport::Deprecation.warn "Devise.#{method} is deprecated " \
|
65
|
-
"and has no effect"
|
66
|
-
end
|
67
|
-
|
68
|
-
def self.#{method}=(val)
|
69
|
-
ActiveSupport::Deprecation.warn "Devise.#{method}= is deprecated " \
|
70
|
-
"and has no effect"
|
71
|
-
end
|
72
|
-
RUBY
|
73
|
-
end
|
74
|
-
|
75
68
|
# Custom domain or key for cookies. Not set by default
|
76
69
|
mattr_accessor :rememberable_options
|
77
70
|
@@rememberable_options = {}
|
78
71
|
|
79
|
-
# The number of times to
|
72
|
+
# The number of times to hash the password.
|
80
73
|
mattr_accessor :stretches
|
81
|
-
@@stretches =
|
74
|
+
@@stretches = 11
|
82
75
|
|
83
76
|
# The default key used when authenticating over http auth.
|
84
77
|
mattr_accessor :http_authentication_key
|
@@ -86,7 +79,7 @@ module Devise
|
|
86
79
|
|
87
80
|
# Keys used when authenticating a user.
|
88
81
|
mattr_accessor :authentication_keys
|
89
|
-
@@authentication_keys = [
|
82
|
+
@@authentication_keys = [:email]
|
90
83
|
|
91
84
|
# Request keys used when authenticating a user.
|
92
85
|
mattr_accessor :request_keys
|
@@ -94,11 +87,11 @@ module Devise
|
|
94
87
|
|
95
88
|
# Keys that should be case-insensitive.
|
96
89
|
mattr_accessor :case_insensitive_keys
|
97
|
-
@@case_insensitive_keys = [
|
90
|
+
@@case_insensitive_keys = [:email]
|
98
91
|
|
99
92
|
# Keys that should have whitespace stripped.
|
100
93
|
mattr_accessor :strip_whitespace_keys
|
101
|
-
@@strip_whitespace_keys = []
|
94
|
+
@@strip_whitespace_keys = [:email]
|
102
95
|
|
103
96
|
# If http authentication is enabled by default.
|
104
97
|
mattr_accessor :http_authenticatable
|
@@ -116,11 +109,11 @@ module Devise
|
|
116
109
|
mattr_accessor :http_authentication_realm
|
117
110
|
@@http_authentication_realm = "Application"
|
118
111
|
|
119
|
-
# Email regex used to validate email formats. It
|
120
|
-
#
|
121
|
-
#
|
112
|
+
# Email regex used to validate email formats. It asserts that there are no
|
113
|
+
# @ symbols or whitespaces in either the localpart or the domain, and that
|
114
|
+
# there is a single @ symbol separating the localpart and the domain.
|
122
115
|
mattr_accessor :email_regexp
|
123
|
-
@@email_regexp = /\A[^@\s]+@
|
116
|
+
@@email_regexp = /\A[^@\s]+@[^@\s]+\z/
|
124
117
|
|
125
118
|
# Range validation for password length
|
126
119
|
mattr_accessor :password_length
|
@@ -134,6 +127,10 @@ module Devise
|
|
134
127
|
mattr_accessor :extend_remember_period
|
135
128
|
@@extend_remember_period = false
|
136
129
|
|
130
|
+
# If true, all the remember me tokens are going to be invalidated when the user signs out.
|
131
|
+
mattr_accessor :expire_all_remember_me_on_sign_out
|
132
|
+
@@expire_all_remember_me_on_sign_out = true
|
133
|
+
|
137
134
|
# Time interval you can access your account before confirming your account.
|
138
135
|
# nil - allows unconfirmed access for unlimited time
|
139
136
|
mattr_accessor :allow_unconfirmed_access_for
|
@@ -145,25 +142,28 @@ module Devise
|
|
145
142
|
|
146
143
|
# Defines which key will be used when confirming an account.
|
147
144
|
mattr_accessor :confirmation_keys
|
148
|
-
@@confirmation_keys = [
|
145
|
+
@@confirmation_keys = [:email]
|
149
146
|
|
150
147
|
# Defines if email should be reconfirmable.
|
151
|
-
# False by default for backwards compatibility.
|
152
148
|
mattr_accessor :reconfirmable
|
153
|
-
@@reconfirmable =
|
149
|
+
@@reconfirmable = true
|
154
150
|
|
155
151
|
# Time interval to timeout the user session without activity.
|
156
152
|
mattr_accessor :timeout_in
|
157
153
|
@@timeout_in = 30.minutes
|
158
154
|
|
159
|
-
#
|
160
|
-
mattr_accessor :expire_auth_token_on_timeout
|
161
|
-
@@expire_auth_token_on_timeout = false
|
162
|
-
|
163
|
-
# Used to encrypt password. Please generate one with rake secret.
|
155
|
+
# Used to hash the password. Please generate one with rails secret.
|
164
156
|
mattr_accessor :pepper
|
165
157
|
@@pepper = nil
|
166
158
|
|
159
|
+
# Used to send notification to the original user email when their email is changed.
|
160
|
+
mattr_accessor :send_email_changed_notification
|
161
|
+
@@send_email_changed_notification = false
|
162
|
+
|
163
|
+
# Used to enable sending notification to user when their password is changed.
|
164
|
+
mattr_accessor :send_password_change_notification
|
165
|
+
@@send_password_change_notification = false
|
166
|
+
|
167
167
|
# Scoped views. Since it relies on fallbacks to render default views, it's
|
168
168
|
# turned off by default.
|
169
169
|
mattr_accessor :scoped_views
|
@@ -176,7 +176,7 @@ module Devise
|
|
176
176
|
|
177
177
|
# Defines which key will be used when locking and unlocking an account
|
178
178
|
mattr_accessor :unlock_keys
|
179
|
-
@@unlock_keys = [
|
179
|
+
@@unlock_keys = [:email]
|
180
180
|
|
181
181
|
# Defines which strategy can be used to unlock an account.
|
182
182
|
# Values: :email, :time, :both
|
@@ -193,12 +193,16 @@ module Devise
|
|
193
193
|
|
194
194
|
# Defines which key will be used when recovering the password for an account
|
195
195
|
mattr_accessor :reset_password_keys
|
196
|
-
@@reset_password_keys = [
|
196
|
+
@@reset_password_keys = [:email]
|
197
197
|
|
198
198
|
# Time interval you can reset your password with a reset password key
|
199
199
|
mattr_accessor :reset_password_within
|
200
200
|
@@reset_password_within = 6.hours
|
201
201
|
|
202
|
+
# When set to false, resetting a password does not automatically sign in a user
|
203
|
+
mattr_accessor :sign_in_after_reset_password
|
204
|
+
@@sign_in_after_reset_password = true
|
205
|
+
|
202
206
|
# The default scope which is used by warden.
|
203
207
|
mattr_accessor :default_scope
|
204
208
|
@@default_scope = nil
|
@@ -209,7 +213,7 @@ module Devise
|
|
209
213
|
|
210
214
|
# Skip session storage for the following strategies
|
211
215
|
mattr_accessor :skip_session_storage
|
212
|
-
@@skip_session_storage = []
|
216
|
+
@@skip_session_storage = [:http_auth]
|
213
217
|
|
214
218
|
# Which formats should be treated as navigational.
|
215
219
|
mattr_accessor :navigational_formats
|
@@ -221,7 +225,7 @@ module Devise
|
|
221
225
|
|
222
226
|
# The default method used while signing out
|
223
227
|
mattr_accessor :sign_out_via
|
224
|
-
@@sign_out_via = :
|
228
|
+
@@sign_out_via = :delete
|
225
229
|
|
226
230
|
# The parent controller all Devise controllers inherits from.
|
227
231
|
# Defaults to ApplicationController. This should be set early
|
@@ -241,7 +245,7 @@ module Devise
|
|
241
245
|
mattr_accessor :router_name
|
242
246
|
@@router_name = nil
|
243
247
|
|
244
|
-
# Set the
|
248
|
+
# Set the OmniAuth path prefix so it can be overridden when
|
245
249
|
# Devise is used in a mountable engine
|
246
250
|
mattr_accessor :omniauth_path_prefix
|
247
251
|
@@omniauth_path_prefix = nil
|
@@ -250,15 +254,22 @@ module Devise
|
|
250
254
|
mattr_accessor :clean_up_csrf_token_on_authentication
|
251
255
|
@@clean_up_csrf_token_on_authentication = true
|
252
256
|
|
257
|
+
# When false, Devise will not attempt to reload routes on eager load.
|
258
|
+
# This can reduce the time taken to boot the app but if your application
|
259
|
+
# requires the Devise mappings to be loaded during boot time the application
|
260
|
+
# won't boot properly.
|
261
|
+
mattr_accessor :reload_routes
|
262
|
+
@@reload_routes = true
|
263
|
+
|
253
264
|
# PRIVATE CONFIGURATION
|
254
265
|
|
255
266
|
# Store scopes mappings.
|
256
267
|
mattr_reader :mappings
|
257
|
-
@@mappings =
|
268
|
+
@@mappings = {}
|
258
269
|
|
259
|
-
#
|
270
|
+
# OmniAuth configurations.
|
260
271
|
mattr_reader :omniauth_configs
|
261
|
-
@@omniauth_configs =
|
272
|
+
@@omniauth_configs = {}
|
262
273
|
|
263
274
|
# Define a set of modules that are called when a mapping is added.
|
264
275
|
mattr_reader :helpers
|
@@ -268,7 +279,7 @@ module Devise
|
|
268
279
|
# Private methods to interface with Warden.
|
269
280
|
mattr_accessor :warden_config
|
270
281
|
@@warden_config = nil
|
271
|
-
@@
|
282
|
+
@@warden_config_blocks = []
|
272
283
|
|
273
284
|
# When true, enter in paranoid mode to avoid user enumeration.
|
274
285
|
mattr_accessor :paranoid
|
@@ -276,20 +287,32 @@ module Devise
|
|
276
287
|
|
277
288
|
# When true, warn user if they just used next-to-last attempt of authentication
|
278
289
|
mattr_accessor :last_attempt_warning
|
279
|
-
@@last_attempt_warning =
|
290
|
+
@@last_attempt_warning = true
|
280
291
|
|
281
292
|
# Stores the token generator
|
282
293
|
mattr_accessor :token_generator
|
283
294
|
@@token_generator = nil
|
284
295
|
|
285
|
-
#
|
296
|
+
# When set to false, changing a password does not automatically sign in a user
|
297
|
+
mattr_accessor :sign_in_after_change_password
|
298
|
+
@@sign_in_after_change_password = true
|
299
|
+
|
300
|
+
def self.rails51? # :nodoc:
|
301
|
+
Rails.gem_version >= Gem::Version.new("5.1.x")
|
302
|
+
end
|
303
|
+
|
304
|
+
def self.activerecord51? # :nodoc:
|
305
|
+
defined?(ActiveRecord) && ActiveRecord.gem_version >= Gem::Version.new("5.1.x")
|
306
|
+
end
|
307
|
+
|
308
|
+
# Default way to set up Devise. Run rails generate devise_install to create
|
286
309
|
# a fresh initializer with all configuration values.
|
287
310
|
def self.setup
|
288
311
|
yield self
|
289
312
|
end
|
290
313
|
|
291
314
|
class Getter
|
292
|
-
def initialize
|
315
|
+
def initialize(name)
|
293
316
|
@name = name
|
294
317
|
end
|
295
318
|
|
@@ -299,12 +322,8 @@ module Devise
|
|
299
322
|
end
|
300
323
|
|
301
324
|
def self.ref(arg)
|
302
|
-
|
303
|
-
|
304
|
-
Getter.new(arg)
|
305
|
-
else
|
306
|
-
ActiveSupport::Dependencies.ref(arg)
|
307
|
-
end
|
325
|
+
ActiveSupport::Dependencies.reference(arg)
|
326
|
+
Getter.new(arg)
|
308
327
|
end
|
309
328
|
|
310
329
|
def self.available_router_name
|
@@ -335,7 +354,12 @@ module Devise
|
|
335
354
|
mapping
|
336
355
|
end
|
337
356
|
|
338
|
-
#
|
357
|
+
# Register available devise modules. For the standard modules that Devise provides, this method is
|
358
|
+
# called from lib/devise/modules.rb. Third-party modules need to be added explicitly using this method.
|
359
|
+
#
|
360
|
+
# Note that adding a module using this method does not cause it to be used in the authentication
|
361
|
+
# process. That requires that the module be listed in the arguments passed to the 'devise' method
|
362
|
+
# in the model class definition.
|
339
363
|
#
|
340
364
|
# == Options:
|
341
365
|
#
|
@@ -343,6 +367,7 @@ module Devise
|
|
343
367
|
# +controller+ - Symbol representing the name of an existing or custom *controller* for this module.
|
344
368
|
# +route+ - Symbol representing the named *route* helper for this module.
|
345
369
|
# +strategy+ - Symbol representing if this module got a custom *strategy*.
|
370
|
+
# +insert_at+ - Integer representing the order in which this module's model will be included
|
346
371
|
#
|
347
372
|
# All values, except :model, accept also a boolean and will have the same name as the given module
|
348
373
|
# name.
|
@@ -352,10 +377,12 @@ module Devise
|
|
352
377
|
# Devise.add_module(:party_module)
|
353
378
|
# Devise.add_module(:party_module, strategy: true, controller: :sessions)
|
354
379
|
# Devise.add_module(:party_module, model: 'party_module/model')
|
380
|
+
# Devise.add_module(:party_module, insert_at: 0)
|
355
381
|
#
|
356
382
|
def self.add_module(module_name, options = {})
|
357
|
-
|
358
|
-
|
383
|
+
options.assert_valid_keys(:strategy, :model, :controller, :route, :no_input, :insert_at)
|
384
|
+
|
385
|
+
ALL.insert (options[:insert_at] || -1), module_name
|
359
386
|
|
360
387
|
if strategy = options[:strategy]
|
361
388
|
strategy = (strategy == true ? module_name : strategy)
|
@@ -400,7 +427,7 @@ module Devise
|
|
400
427
|
# Sets warden configuration using a block that will be invoked on warden
|
401
428
|
# initialization.
|
402
429
|
#
|
403
|
-
# Devise.
|
430
|
+
# Devise.setup do |config|
|
404
431
|
# config.allow_unconfirmed_access_for = 2.days
|
405
432
|
#
|
406
433
|
# config.warden do |manager|
|
@@ -409,15 +436,14 @@ module Devise
|
|
409
436
|
# end
|
410
437
|
# end
|
411
438
|
def self.warden(&block)
|
412
|
-
@@
|
439
|
+
@@warden_config_blocks << block
|
413
440
|
end
|
414
441
|
|
415
|
-
# Specify an
|
442
|
+
# Specify an OmniAuth provider.
|
416
443
|
#
|
417
444
|
# config.omniauth :github, APP_ID, APP_SECRET
|
418
445
|
#
|
419
446
|
def self.omniauth(provider, *args)
|
420
|
-
@@helpers << Devise::OmniAuth::UrlHelpers
|
421
447
|
config = Devise::OmniAuth::Config.new(provider, args)
|
422
448
|
@@omniauth_configs[config.strategy_name.to_sym] = config
|
423
449
|
end
|
@@ -440,8 +466,8 @@ module Devise
|
|
440
466
|
Devise::Controllers::UrlHelpers.generate_helpers!
|
441
467
|
end
|
442
468
|
|
443
|
-
# A method used internally to setup warden manager
|
444
|
-
#
|
469
|
+
# A method used internally to complete the setup of warden manager after routes are loaded.
|
470
|
+
# See lib/devise/rails/routes.rb - ActionDispatch::Routing::RouteSet#finalize_with_devise!
|
445
471
|
def self.configure_warden! #:nodoc:
|
446
472
|
@@warden_configured ||= begin
|
447
473
|
warden_config.failure_app = Devise::Delegator.new
|
@@ -455,22 +481,23 @@ module Devise
|
|
455
481
|
mapping.to.serialize_into_session(record)
|
456
482
|
end
|
457
483
|
|
458
|
-
warden_config.serialize_from_session(mapping.name) do |
|
459
|
-
# Previous versions contained an additional entry at the beginning of
|
460
|
-
# key with the record's class name.
|
461
|
-
args = key[-2, 2]
|
484
|
+
warden_config.serialize_from_session(mapping.name) do |args|
|
462
485
|
mapping.to.serialize_from_session(*args)
|
463
486
|
end
|
464
487
|
end
|
465
488
|
|
466
|
-
@@
|
489
|
+
@@warden_config_blocks.map { |block| block.call Devise.warden_config }
|
467
490
|
true
|
468
491
|
end
|
469
492
|
end
|
470
493
|
|
471
494
|
# Generate a friendly string randomly to be used as token.
|
472
|
-
|
473
|
-
|
495
|
+
# By default, length is 20 characters.
|
496
|
+
def self.friendly_token(length = 20)
|
497
|
+
# To calculate real characters, we must perform this operation.
|
498
|
+
# See SecureRandom.urlsafe_base64
|
499
|
+
rlength = (length * 3) / 4
|
500
|
+
SecureRandom.urlsafe_base64(rlength).tr('lIO0', 'sxyz')
|
474
501
|
end
|
475
502
|
|
476
503
|
# constant-time comparison algorithm to prevent timing attacks
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
require 'rails/generators/active_record'
|
2
4
|
require 'generators/devise/orm_helpers'
|
3
5
|
|
@@ -6,14 +8,16 @@ module ActiveRecord
|
|
6
8
|
class DeviseGenerator < ActiveRecord::Generators::Base
|
7
9
|
argument :attributes, type: :array, default: [], banner: "field:type field:type"
|
8
10
|
|
11
|
+
class_option :primary_key_type, type: :string, desc: "The type for primary key"
|
12
|
+
|
9
13
|
include Devise::Generators::OrmHelpers
|
10
14
|
source_root File.expand_path("../templates", __FILE__)
|
11
15
|
|
12
16
|
def copy_devise_migration
|
13
17
|
if (behavior == :invoke && model_exists?) || (behavior == :revoke && migration_exists?(table_name))
|
14
|
-
migration_template "migration_existing.rb", "
|
18
|
+
migration_template "migration_existing.rb", "#{migration_path}/add_devise_to_#{table_name}.rb", migration_version: migration_version
|
15
19
|
else
|
16
|
-
migration_template "migration.rb", "
|
20
|
+
migration_template "migration.rb", "#{migration_path}/devise_create_#{table_name}.rb", migration_version: migration_version
|
17
21
|
end
|
18
22
|
end
|
19
23
|
|
@@ -50,11 +54,11 @@ module ActiveRecord
|
|
50
54
|
t.datetime :remember_created_at
|
51
55
|
|
52
56
|
## Trackable
|
53
|
-
t.integer :sign_in_count, default: 0, null: false
|
54
|
-
t.datetime :current_sign_in_at
|
55
|
-
t.datetime :last_sign_in_at
|
56
|
-
t
|
57
|
-
t
|
57
|
+
# t.integer :sign_in_count, default: 0, null: false
|
58
|
+
# t.datetime :current_sign_in_at
|
59
|
+
# t.datetime :last_sign_in_at
|
60
|
+
# t.#{ip_column} :current_sign_in_ip
|
61
|
+
# t.#{ip_column} :last_sign_in_ip
|
58
62
|
|
59
63
|
## Confirmable
|
60
64
|
# t.string :confirmation_token
|
@@ -68,6 +72,39 @@ module ActiveRecord
|
|
68
72
|
# t.datetime :locked_at
|
69
73
|
RUBY
|
70
74
|
end
|
75
|
+
|
76
|
+
def ip_column
|
77
|
+
# Padded with spaces so it aligns nicely with the rest of the columns.
|
78
|
+
"%-8s" % (inet? ? "inet" : "string")
|
79
|
+
end
|
80
|
+
|
81
|
+
def inet?
|
82
|
+
postgresql?
|
83
|
+
end
|
84
|
+
|
85
|
+
def rails5_and_up?
|
86
|
+
Rails::VERSION::MAJOR >= 5
|
87
|
+
end
|
88
|
+
|
89
|
+
def postgresql?
|
90
|
+
config = ActiveRecord::Base.configurations[Rails.env]
|
91
|
+
config && config['adapter'] == 'postgresql'
|
92
|
+
end
|
93
|
+
|
94
|
+
def migration_version
|
95
|
+
if rails5_and_up?
|
96
|
+
"[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
|
97
|
+
end
|
98
|
+
end
|
99
|
+
|
100
|
+
def primary_key_type
|
101
|
+
primary_key_string if rails5_and_up?
|
102
|
+
end
|
103
|
+
|
104
|
+
def primary_key_string
|
105
|
+
key_string = options[:primary_key_type]
|
106
|
+
", id: :#{key_string}" if key_string
|
107
|
+
end
|
71
108
|
end
|
72
109
|
end
|
73
110
|
end
|
@@ -1,13 +1,15 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
class DeviseCreate<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
|
2
4
|
def change
|
3
|
-
create_table
|
5
|
+
create_table :<%= table_name %><%= primary_key_type %> do |t|
|
4
6
|
<%= migration_data -%>
|
5
7
|
|
6
8
|
<% attributes.each do |attribute| -%>
|
7
9
|
t.<%= attribute.type %> :<%= attribute.name %>
|
8
10
|
<% end -%>
|
9
11
|
|
10
|
-
t.timestamps
|
12
|
+
t.timestamps null: false
|
11
13
|
end
|
12
14
|
|
13
15
|
add_index :<%= table_name %>, :email, unique: true
|
@@ -1,6 +1,8 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
class AddDeviseTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
|
2
4
|
def self.up
|
3
|
-
change_table
|
5
|
+
change_table :<%= table_name %> do |t|
|
4
6
|
<%= migration_data -%>
|
5
7
|
|
6
8
|
<% attributes.each do |attribute| -%>
|
@@ -8,7 +10,7 @@ class AddDeviseTo<%= table_name.camelize %> < ActiveRecord::Migration
|
|
8
10
|
<% end -%>
|
9
11
|
|
10
12
|
# Uncomment below if timestamps were not included in your original model.
|
11
|
-
# t.timestamps
|
13
|
+
# t.timestamps null: false
|
12
14
|
end
|
13
15
|
|
14
16
|
add_index :<%= table_name %>, :email, unique: true
|
@@ -0,0 +1,46 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'rails/generators/base'
|
4
|
+
|
5
|
+
module Devise
|
6
|
+
module Generators
|
7
|
+
class ControllersGenerator < Rails::Generators::Base
|
8
|
+
CONTROLLERS = %w(confirmations passwords registrations sessions unlocks omniauth_callbacks).freeze
|
9
|
+
|
10
|
+
desc <<-DESC.strip_heredoc
|
11
|
+
Create inherited Devise controllers in your app/controllers folder.
|
12
|
+
|
13
|
+
Use -c to specify which controller you want to overwrite.
|
14
|
+
If you do no specify a controller, all controllers will be created.
|
15
|
+
For example:
|
16
|
+
|
17
|
+
rails generate devise:controllers users -c=sessions
|
18
|
+
|
19
|
+
This will create a controller class at app/controllers/users/sessions_controller.rb like this:
|
20
|
+
|
21
|
+
class Users::SessionsController < Devise::SessionsController
|
22
|
+
content...
|
23
|
+
end
|
24
|
+
DESC
|
25
|
+
|
26
|
+
source_root File.expand_path("../../templates/controllers", __FILE__)
|
27
|
+
argument :scope, required: true,
|
28
|
+
desc: "The scope to create controllers in, e.g. users, admins"
|
29
|
+
class_option :controllers, aliases: "-c", type: :array,
|
30
|
+
desc: "Select specific controllers to generate (#{CONTROLLERS.join(', ')})"
|
31
|
+
|
32
|
+
def create_controllers
|
33
|
+
@scope_prefix = scope.blank? ? '' : (scope.camelize + '::')
|
34
|
+
controllers = options[:controllers] || CONTROLLERS
|
35
|
+
controllers.each do |name|
|
36
|
+
template "#{name}_controller.rb",
|
37
|
+
"app/controllers/#{scope}/#{name}_controller.rb"
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
def show_readme
|
42
|
+
readme "README" if behavior == :invoke
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
require 'rails/generators/named_base'
|
2
4
|
|
3
5
|
module Devise
|
@@ -8,7 +10,7 @@ module Devise
|
|
8
10
|
namespace "devise"
|
9
11
|
source_root File.expand_path("../templates", __FILE__)
|
10
12
|
|
11
|
-
desc "Generates a model with the given NAME (if one does not exist) with devise "
|
13
|
+
desc "Generates a model with the given NAME (if one does not exist) with devise " \
|
12
14
|
"configuration plus a migration file and devise routes."
|
13
15
|
|
14
16
|
hook_for :orm
|
@@ -16,7 +18,7 @@ module Devise
|
|
16
18
|
class_option :routes, desc: "Generate routes", type: :boolean, default: true
|
17
19
|
|
18
20
|
def add_devise_routes
|
19
|
-
devise_route = "devise_for :#{plural_name}"
|
21
|
+
devise_route = "devise_for :#{plural_name}".dup
|
20
22
|
devise_route << %Q(, class_name: "#{class_name}") if class_name.include?("::")
|
21
23
|
devise_route << %Q(, skip: :all) unless options.routes?
|
22
24
|
route devise_route
|
@@ -1,8 +1,12 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
require 'rails/generators/base'
|
2
4
|
require 'securerandom'
|
3
5
|
|
4
6
|
module Devise
|
5
7
|
module Generators
|
8
|
+
MissingORMError = Class.new(Thor::Error)
|
9
|
+
|
6
10
|
class InstallGenerator < Rails::Generators::Base
|
7
11
|
source_root File.expand_path("../../templates", __FILE__)
|
8
12
|
|
@@ -10,6 +14,19 @@ module Devise
|
|
10
14
|
class_option :orm
|
11
15
|
|
12
16
|
def copy_initializer
|
17
|
+
unless options[:orm]
|
18
|
+
raise MissingORMError, <<-ERROR.strip_heredoc
|
19
|
+
An ORM must be set to install Devise in your application.
|
20
|
+
|
21
|
+
Be sure to have an ORM like Active Record or Mongoid loaded in your
|
22
|
+
app or configure your own at `config/application.rb`.
|
23
|
+
|
24
|
+
config.generators do |g|
|
25
|
+
g.orm :your_orm_gem
|
26
|
+
end
|
27
|
+
ERROR
|
28
|
+
end
|
29
|
+
|
13
30
|
template "devise.rb", "config/initializers/devise.rb"
|
14
31
|
end
|
15
32
|
|