module Sorcery::Controller::Config

Attributes

after_failed_login[RW]
after_login[RW]
after_logout[RW]
after_remember_me[RW]
before_logout[RW]
login_sources[RW]
not_authenticated_action[RW]

what controller action to call for non-authenticated users.

save_return_to_url[RW]

when a non logged in user tries to enter a page that requires login, save the URL he wanted to reach, and send him there after login.

submodules[RW]
user_class[RW]

what class to use as the user class.

Public Class Methods

configure(&blk) click to toggle source
# File lib/sorcery/controller/config.rb, line 56
def configure(&blk)
  @configure_blk = blk
end
configure!() click to toggle source
# File lib/sorcery/controller/config.rb, line 60
def configure!
  @configure_blk.call(self) if @configure_blk
end
init!() click to toggle source
# File lib/sorcery/controller/config.rb, line 23
def init!
  @defaults = {
    :@user_class                           => nil,
    :@submodules                           => [],
    :@not_authenticated_action             => :not_authenticated,
    :@login_sources                        => Set.new,
    :@after_login                          => Set.new,
    :@after_failed_login                   => Set.new,
    :@before_logout                        => Set.new,
    :@after_logout                         => Set.new,
    :@after_remember_me                    => Set.new,
    :@save_return_to_url                   => true,
    :@cookie_domain                        => nil
  }
end
reset!() click to toggle source

Resets all configuration options to their default values.

# File lib/sorcery/controller/config.rb, line 40
def reset!
  @defaults.each do |k, v|
    instance_variable_set(k, v)
  end
end
update!() click to toggle source
# File lib/sorcery/controller/config.rb, line 46
def update!
  @defaults.each do |k, v|
    instance_variable_set(k, v) unless instance_variable_defined?(k)
  end
end
user_config(&blk) click to toggle source
# File lib/sorcery/controller/config.rb, line 52
def user_config(&blk)
  block_given? ? @user_config = blk : @user_config
end