Module: Devise::Controllers::SignInOut

Included in:
Helpers, Hooks::Proxy
Defined in:
lib/devise/controllers/sign_in_out.rb

Overview

Provide sign in and sign out functionality. Included by default in all controllers.

Instance Method Summary collapse

Instance Method Details

#bypass_sign_in(resource, scope: nil) ⇒ Object

Sign in a user bypassing the warden callbacks and stores the user straight in session. This option is useful in cases the user is already signed in, but we want to refresh the credentials in session.

Examples:

 @user, scope: :user
 @user



65
66
67
68
69
 
# File 'lib/devise/controllers/sign_in_out.rb', line 65

def (resource, scope: nil)
  scope ||= Devise::Mapping.find_scope!(resource)
  expire_data_after_sign_in!
  warden.session_serializer.store(resource, scope)
end

#sign_in(resource_or_scope, *args) ⇒ Object

Sign in a user that already was authenticated. This helper is useful for logging users in after sign up. All options given to sign_in is passed forward to the set_user method in warden. If you are using a custom warden strategy and the timeoutable module, you have to set ‘env = true` in the request to use this method, like we do in the sessions controller: github.com/heartcombo/devise/blob/main/app/controllers/devise/sessions_controller.rb#L7

Examples:

 :user, @user                      # sign_in(scope, resource)
 @user                             # sign_in(resource)
 @user, event: :authentication     # sign_in(resource, options)
 @user, store: false               # sign_in(resource, options)



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/devise/controllers/sign_in_out.rb', line 33

def (resource_or_scope, *args)
  options  = args.extract_options!
  scope    = Devise::Mapping.find_scope!(resource_or_scope)
  resource = args.last || resource_or_scope

  expire_data_after_sign_in!

  if options[:bypass]
    Devise.deprecator.warn(<<-DEPRECATION.strip_heredoc, caller)
    [Devise] bypass option is deprecated and it will be removed in future version of Devise.
    Please use bypass_sign_in method instead.
    Example:

      bypass_sign_in(user)
    DEPRECATION
    warden.session_serializer.store(resource, scope)
  elsif warden.user(scope) == resource && !options.delete(:force)
    # Do nothing. User already signed in and we are not forcing it.
    true
  else
    warden.set_user(resource, options.merge!(scope: scope))
  end
end

#sign_out(resource_or_scope = nil) ⇒ Object

Sign out a given user or scope. This helper is useful for signing out a user after deleting accounts. Returns true if there was a logout and false if there is no user logged in on the referred scope

Examples:

sign_out :user     # sign_out(scope)
sign_out @user     # sign_out(resource)



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/devise/controllers/sign_in_out.rb', line 80

def sign_out(resource_or_scope = nil)
  return sign_out_all_scopes unless resource_or_scope
  scope = Devise::Mapping.find_scope!(resource_or_scope)
  user = warden.user(scope: scope, run_callbacks: false) # If there is no user

  warden.logout(scope)
  warden.clear_strategies_cache!(scope: scope)
  instance_variable_set(:"@current_#{scope}", nil)

  !!user
end

#sign_out_all_scopes(lock = true) ⇒ Object

Sign out all active users or scopes. This helper is useful for signing out all roles in one click. This signs out ALL scopes in warden. Returns true if there was at least one logout and false if there was no user logged in on all scopes.



95
96
97
98
99
100
101
102
103
104
 
# File 'lib/devise/controllers/sign_in_out.rb', line 95

def sign_out_all_scopes(lock = true)
  users = Devise.mappings.keys.map { |s| warden.user(scope: s, run_callbacks: false) }

  warden.logout
  expire_data_after_sign_out!
  warden.clear_strategies_cache!
  warden.lock! if lock

  users.any?
end

#signed_in?(scope = nil) ⇒ Boolean

Return true if the given scope is signed in session. If no scope given, return true if any scope is signed in. This will run authentication hooks, which may cause exceptions to be thrown from this method; if you simply want to check if a scope has already previously been authenticated without running authentication hooks, you can directly call ‘warden.authenticated?(scope: scope)`

Returns:

  • (Boolean) 


13
14
15
16
17
 
# File 'lib/devise/controllers/sign_in_out.rb', line 13

def signed_in?(scope = nil)
  [scope || Devise.mappings.keys].flatten.any? do |_scope|
    warden.authenticate?(scope: _scope)
  end
end