Class: Sorcery::Model::Config
- Inherits:
-
Object
- Object
- Sorcery::Model::Config
- Defined in:
- lib/sorcery/model.rb
Overview
Each class which calls ‘activate_sorcery!’ receives an instance of this class. Every submodule which gets loaded may add accessors to this class so that all options will be configured from a single place.
Instance Attribute Summary collapse
-
#after_config ⇒ Object
change default username attribute, for example, to use :email.
-
#before_authenticate ⇒ Object
change default username attribute, for example, to use :email.
-
#crypted_password_attribute_name ⇒ Object
change default username attribute, for example, to use :email.
-
#custom_encryption_provider ⇒ Object
an array of method names to call after configuration by user.
-
#email_attribute_name ⇒ Object
change default username attribute, for example, to use :email.
-
#encryption_algorithm ⇒ Object
an array of method names to call after configuration by user.
-
#encryption_key ⇒ Object
change default username attribute, for example, to use :email.
-
#encryption_provider ⇒ Object
readonly
an array of method names to call after configuration by user.
-
#password_attribute_name ⇒ Object
change default username attribute, for example, to use :email.
-
#salt_attribute_name ⇒ Object
change default username attribute, for example, to use :email.
-
#salt_join_token ⇒ Object
change default username attribute, for example, to use :email.
-
#stretches ⇒ Object
change default username attribute, for example, to use :email.
-
#subclasses_inherit_config ⇒ Object
change default username attribute, for example, to use :email.
-
#submodules ⇒ Object
change default username attribute, for example, to use :email.
-
#username_attribute_names ⇒ Object
change default username attribute, for example, to use :email.
Instance Method Summary collapse
-
#initialize ⇒ Config
constructor
encryption algorithm name.
-
#reset! ⇒ Object
Resets all configuration options to their default values.
Constructor Details
#initialize ⇒ Config
encryption algorithm name. See ‘encryption_algorithm=’ below for available options.
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 |
# File 'lib/sorcery/model.rb', line 218 def initialize @defaults = { :@submodules => [], :@username_attribute_names => [:username], :@password_attribute_name => :password, :@email_attribute_name => :email, :@crypted_password_attribute_name => :crypted_password, :@encryption_algorithm => :bcrypt, :@encryption_provider => CryptoProviders::BCrypt, :@custom_encryption_provider => nil, :@encryption_key => nil, :@salt_join_token => "", :@salt_attribute_name => :salt, :@stretches => nil, :@subclasses_inherit_config => false, :@before_authenticate => [], :@after_config => [] } reset! end |
Instance Attribute Details
#after_config ⇒ Object
change default username attribute, for example, to use :email
189 190 191 |
# File 'lib/sorcery/model.rb', line 189 def after_config @after_config end |
#before_authenticate ⇒ Object
change default username attribute, for example, to use :email
189 190 191 |
# File 'lib/sorcery/model.rb', line 189 def before_authenticate @before_authenticate end |
#crypted_password_attribute_name ⇒ Object
change default username attribute, for example, to use :email
189 190 191 |
# File 'lib/sorcery/model.rb', line 189 def crypted_password_attribute_name @crypted_password_attribute_name end |
#custom_encryption_provider ⇒ Object
an array of method names to call after configuration by user. used internally.
213 214 215 |
# File 'lib/sorcery/model.rb', line 213 def custom_encryption_provider @custom_encryption_provider end |
#email_attribute_name ⇒ Object
change default username attribute, for example, to use :email
189 190 191 |
# File 'lib/sorcery/model.rb', line 189 def email_attribute_name @email_attribute_name end |
#encryption_algorithm ⇒ Object
an array of method names to call after configuration by user. used internally.
213 214 215 |
# File 'lib/sorcery/model.rb', line 213 def encryption_algorithm @encryption_algorithm end |
#encryption_key ⇒ Object
change default username attribute, for example, to use :email
189 190 191 |
# File 'lib/sorcery/model.rb', line 189 def encryption_key @encryption_key end |
#encryption_provider ⇒ Object (readonly)
an array of method names to call after configuration by user. used internally.
213 214 215 |
# File 'lib/sorcery/model.rb', line 213 def encryption_provider @encryption_provider end |
#password_attribute_name ⇒ Object
change default username attribute, for example, to use :email
189 190 191 |
# File 'lib/sorcery/model.rb', line 189 def password_attribute_name @password_attribute_name end |
#salt_attribute_name ⇒ Object
change default username attribute, for example, to use :email
189 190 191 |
# File 'lib/sorcery/model.rb', line 189 def salt_attribute_name @salt_attribute_name end |
#salt_join_token ⇒ Object
change default username attribute, for example, to use :email
189 190 191 |
# File 'lib/sorcery/model.rb', line 189 def salt_join_token @salt_join_token end |
#stretches ⇒ Object
change default username attribute, for example, to use :email
189 190 191 |
# File 'lib/sorcery/model.rb', line 189 def stretches @stretches end |
#subclasses_inherit_config ⇒ Object
change default username attribute, for example, to use :email
189 190 191 |
# File 'lib/sorcery/model.rb', line 189 def subclasses_inherit_config @subclasses_inherit_config end |
#submodules ⇒ Object
change default username attribute, for example, to use :email
189 190 191 |
# File 'lib/sorcery/model.rb', line 189 def submodules @submodules end |
#username_attribute_names ⇒ Object
change default username attribute, for example, to use :email
189 190 191 |
# File 'lib/sorcery/model.rb', line 189 def username_attribute_names @username_attribute_names end |
Instance Method Details
#reset! ⇒ Object
Resets all configuration options to their default values.
240 241 242 243 244 |
# File 'lib/sorcery/model.rb', line 240 def reset! @defaults.each do |k,v| instance_variable_set(k,v) end end |