Module: Devise::Controllers::Helpers
- Extended by:
- ActiveSupport::Concern
- Defined in:
- lib/devise/controllers/helpers.rb
Overview
Those helpers are convenience methods added to ApplicationController.
Class Method Summary collapse
-
.define_helpers(mapping) ⇒ Object
Define authentication filters and accessor helpers based on mappings.
Instance Method Summary collapse
-
#after_sign_in_path_for(resource_or_scope) ⇒ Object
The default url to be used after signing in.
-
#after_sign_out_path_for(resource_or_scope) ⇒ Object
Method used by sessions controller to sign out a user.
-
#devise_controller? ⇒ Boolean
Return true if it’s a devise_controller.
-
#expire_session_data_after_sign_in! ⇒ Object
A hook called to expire session data after sign up/in.
-
#handle_unverified_request ⇒ Object
Overwrite Rails’ handle unverified request to sign out all scopes.
-
#redirect_location(scope, resource) ⇒ Object
:nodoc:.
-
#sign_in(resource_or_scope, *args) ⇒ Object
Sign in a user that already was authenticated.
-
#sign_in_and_redirect(resource_or_scope, *args) ⇒ Object
Sign in a user and tries to redirect first to the stored location and then to the url specified by after_sign_in_path_for.
-
#sign_out(resource_or_scope = nil) ⇒ Object
Sign out a given user or scope.
-
#sign_out_all_scopes ⇒ Object
Sign out all active users or scopes.
-
#sign_out_and_redirect(resource_or_scope) ⇒ Object
Sign out a user and tries to redirect to the url specified by after_sign_out_path_for.
-
#signed_in?(scope = nil) ⇒ Boolean
Return true if the given scope is signed in session.
-
#stored_location_for(resource_or_scope) ⇒ Object
Returns and delete the url stored in the session for the given scope.
-
#warden ⇒ Object
The main accessor for the warden proxy instance.
Class Method Details
.define_helpers(mapping) ⇒ Object
Define authentication filters and accessor helpers based on mappings. These filters should be used inside the controllers as before_filters, so you can control the scope of the user who should be signed in to access that specific controller/action. Example:
Roles:
User
Admin
Generated methods:
authenticate_user! # Signs user in or redirect
authenticate_admin! # Signs admin in or redirect
user_signed_in? # Checks whether there is a user signed in or not
admin_signed_in? # Checks whether there is an admin signed in or not
current_user # Current signed in user
current_admin # Current signed in admin
user_session # Session data available only to the user scope
admin_session # Session data available only to the admin scope
Use:
before_filter :authenticate_user! # Tell devise to use :user map
before_filter :authenticate_admin! # Tell devise to use :admin map
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
# File 'lib/devise/controllers/helpers.rb', line 35 def self.define_helpers(mapping) #:nodoc: mapping = mapping.name class_eval <<-METHODS, __FILE__, __LINE__ + 1 def authenticate_#{mapping}!(force = false) warden.authenticate!(:scope => :#{mapping}) if !devise_controller? || force end def #{mapping}_signed_in? !!current_#{mapping} end def current_#{mapping} @current_#{mapping} ||= warden.authenticate(:scope => :#{mapping}) end def #{mapping}_session current_#{mapping} && warden.session(:#{mapping}) end METHODS ActiveSupport.on_load(:action_controller) do helper_method "current_#{mapping}", "#{mapping}_signed_in?", "#{mapping}_session" end end |
Instance Method Details
#after_sign_in_path_for(resource_or_scope) ⇒ Object
The default url to be used after signing in. This is used by all Devise controllers and you can overwrite it in your ApplicationController to provide a custom hook for a custom resource.
By default, it first tries to find a resource_root_path, otherwise it uses the root path. For a user scope, you can define the default url in the following way:
map.user_root '/users', :controller => 'users' # creates user_root_path
map.namespace :user do |user|
user.root :controller => 'users' # creates user_root_path
end
If the resource root path is not defined, root_path is used. However, if this default is not enough, you can customize it, for example:
def after_sign_in_path_for(resource)
if resource.is_a?(User) && resource.can_publish?
publisher_url
else
super
end
end
176 177 178 179 180 |
# File 'lib/devise/controllers/helpers.rb', line 176 def after_sign_in_path_for(resource_or_scope) scope = Devise::Mapping.find_scope!(resource_or_scope) home_path = "#{scope}_root_path" respond_to?(home_path, true) ? send(home_path) : root_path end |
#after_sign_out_path_for(resource_or_scope) ⇒ Object
Method used by sessions controller to sign out a user. You can overwrite it in your ApplicationController to provide a custom hook for a custom scope. Notice that differently from after_sign_in_path_for
this method receives a symbol with the scope, and not the resource.
By default is the root_path.
188 189 190 |
# File 'lib/devise/controllers/helpers.rb', line 188 def after_sign_out_path_for(resource_or_scope) root_path end |
#devise_controller? ⇒ Boolean
Return true if it’s a devise_controller. false to all controllers unless the controllers defined inside devise. Useful if you want to apply a before filter to all controllers, except the ones in devise:
before_filter :my_filter, :unless => { |c| c.devise_controller? }
71 72 73 |
# File 'lib/devise/controllers/helpers.rb', line 71 def devise_controller? false end |
#expire_session_data_after_sign_in! ⇒ Object
A hook called to expire session data after sign up/in. All keys stored under “devise.” namespace are removed after sign in.
217 218 219 |
# File 'lib/devise/controllers/helpers.rb', line 217 def expire_session_data_after_sign_in! session.keys.grep(/^devise\./).each { |k| session.delete(k) } end |
#handle_unverified_request ⇒ Object
Overwrite Rails’ handle unverified request to sign out all scopes.
222 223 224 225 |
# File 'lib/devise/controllers/helpers.rb', line 222 def handle_unverified_request sign_out_all_scopes super # call the default behaviour which resets the session end |
#redirect_location(scope, resource) ⇒ Object
:nodoc:
203 204 205 |
# File 'lib/devise/controllers/helpers.rb', line 203 def redirect_location(scope, resource) #:nodoc: stored_location_for(scope) || after_sign_in_path_for(resource) 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. The only exception is the :bypass option, which bypass 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:
sign_in :user, @user # sign_in(scope, resource)
sign_in @user # sign_in(resource)
sign_in @user, :event => :authentication # sign_in(resource, options)
sign_in @user, :bypass => true # sign_in(resource, options)
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/devise/controllers/helpers.rb', line 98 def sign_in(resource_or_scope, *args) = args. scope = Devise::Mapping.find_scope!(resource_or_scope) resource = args.last || resource_or_scope expire_session_data_after_sign_in! if [:bypass] warden.session_serializer.store(resource, scope) elsif warden.user(scope) == resource && !.delete(:force) # Do nothing. User already signed in and we are not forcing it. else warden.set_user(resource, .merge!(:scope => scope)) end end |
#sign_in_and_redirect(resource_or_scope, *args) ⇒ Object
Sign in a user and tries to redirect first to the stored location and then to the url specified by after_sign_in_path_for. It accepts the same parameters as the sign_in method.
195 196 197 198 199 200 201 |
# File 'lib/devise/controllers/helpers.rb', line 195 def sign_in_and_redirect(resource_or_scope, *args) = args. scope = Devise::Mapping.find_scope!(resource_or_scope) resource = args.last || resource_or_scope sign_in(scope, resource, ) redirect_to redirect_location(scope, resource) 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.
Examples:
sign_out :user # sign_out(scope)
sign_out @user # sign_out(resource)
122 123 124 125 126 127 128 |
# File 'lib/devise/controllers/helpers.rb', line 122 def sign_out(resource_or_scope=nil) return sign_out_all_scopes unless resource_or_scope scope = Devise::Mapping.find_scope!(resource_or_scope) warden.user(scope) # Without loading user here, before_logout hook is not called warden.raw_session.inspect # Without this inspect here. The session does not clear. warden.logout(scope) end |
#sign_out_all_scopes ⇒ 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.
132 133 134 135 136 |
# File 'lib/devise/controllers/helpers.rb', line 132 def sign_out_all_scopes Devise.mappings.keys.each { |s| warden.user(s) } warden.raw_session.inspect warden.logout end |
#sign_out_and_redirect(resource_or_scope) ⇒ Object
Sign out a user and tries to redirect to the url specified by after_sign_out_path_for.
209 210 211 212 213 |
# File 'lib/devise/controllers/helpers.rb', line 209 def sign_out_and_redirect(resource_or_scope) scope = Devise::Mapping.find_scope!(resource_or_scope) Devise.sign_out_all_scopes ? sign_out : sign_out(scope) redirect_to after_sign_out_path_for(scope) 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. Does not run authentication hooks.
77 78 79 80 81 |
# File 'lib/devise/controllers/helpers.rb', line 77 def signed_in?(scope=nil) [ scope || Devise.mappings.keys ].flatten.any? do |scope| warden.authenticate?(:scope => scope) end end |
#stored_location_for(resource_or_scope) ⇒ Object
Returns and delete the url stored in the session for the given scope. Useful for giving redirect backs after sign up:
Example:
redirect_to stored_location_for(:user) || root_path
145 146 147 148 |
# File 'lib/devise/controllers/helpers.rb', line 145 def stored_location_for(resource_or_scope) scope = Devise::Mapping.find_scope!(resource_or_scope) session.delete("#{scope}_return_to") end |
#warden ⇒ Object
The main accessor for the warden proxy instance
62 63 64 |
# File 'lib/devise/controllers/helpers.rb', line 62 def warden request.env['warden'] end |