# module Devise::Controllers::Helpers

Those helpers are convenience methods added to ApplicationController.

### Public Instance Methods

after_sign_in_path_for(resource_or_scope) click to toggle source

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 valid resource_return_to key in the session, then it fallbacks to 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)
      stored_location_for(resource) ||
        if resource.is_a?(User) && resource.can_publish?
          publisher_url
        else
          signed_in_root_path(resource)
        end
    end

    # File lib/devise/controllers/helpers.rb, line 207
    def after_sign_in_path_for(resource_or_scope)
      stored_location_for(resource_or_scope) || signed_in_root_path(resource_or_scope)
    end

after_sign_out_path_for(resource_or_scope) click to toggle source

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 it is the root_path.

    # File lib/devise/controllers/helpers.rb, line 217
    def after_sign_out_path_for(resource_or_scope)
      respond_to?(:root_path) ? root_path : "/"
    end

allow_params_authentication!() click to toggle source

Tell warden that params authentication is allowed for that specific page.

    # File lib/devise/controllers/helpers.rb, line 84
    def allow_params_authentication!
      request.env["devise.allow_params_authentication"] = true
    end

devise_controller?() click to toggle source

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? }

    # File lib/devise/controllers/helpers.rb, line 79
    def devise_controller?
      false
    end

expire_session_data_after_sign_in!() click to toggle source

    # File lib/devise/controllers/helpers.rb, line 237
    def expire_session_data_after_sign_in!
      session.keys.grep(%r^devise\./).each { |k| session.delete(k) }
    end

handle_unverified_request() click to toggle source

Overwrite Rails’ handle unverified request to sign out all scopes, clear run strategies and remove cached variables.

    # File lib/devise/controllers/helpers.rb, line 252
    def handle_unverified_request
      sign_out_all_scopes
      warden.clear_strategies_cache!
      expire_devise_cached_variables!
      super # call the default behaviour which resets the session
    end

sign_in(resource_or_scope, *args) click to toggle source

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)

    # File lib/devise/controllers/helpers.rb, line 111
    def sign_in(resource_or_scope, *args)
      options  = args.extract_options!
      scope    = Devise::Mapping.find_scope!(resource_or_scope)
      resource = args.last || resource_or_scope

      expire_session_data_after_sign_in!

      if options[:bypass]
        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_in_and_redirect(resource_or_scope, *args) click to toggle source

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.

    # File lib/devise/controllers/helpers.rb, line 224
    def sign_in_and_redirect(resource_or_scope, *args)
      options  = args.extract_options!
      scope    = Devise::Mapping.find_scope!(resource_or_scope)
      resource = args.last || resource_or_scope
      sign_in(scope, resource, options)
      redirect_to after_sign_in_path_for(resource)
    end

sign_out(resource_or_scope=nil) click to toggle source

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)

    # File lib/devise/controllers/helpers.rb, line 136
    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)
      instance_variable_set(:"@current_#{scope}", nil)
    end

sign_out_all_scopes() click to toggle source

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.

    # File lib/devise/controllers/helpers.rb, line 147
    def sign_out_all_scopes
      Devise.mappings.keys.each { |s| warden.user(s) }
      warden.raw_session.inspect
      warden.logout
      expire_devise_cached_variables!
    end

sign_out_and_redirect(resource_or_scope) click to toggle source

Sign out a user and tries to redirect to the url specified by after_sign_out_path_for.

    # File lib/devise/controllers/helpers.rb, line 243
    def sign_out_and_redirect(resource_or_scope)
      scope = Devise::Mapping.find_scope!(resource_or_scope)
      redirect_path = after_sign_out_path_for(scope)
      Devise.sign_out_all_scopes ? sign_out : sign_out(scope)
      redirect_to redirect_path
    end

signed_in?(scope=nil) click to toggle source

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.

    # File lib/devise/controllers/helpers.rb, line 90
    def signed_in?(scope=nil)
      [ scope || Devise.mappings.keys ].flatten.any? do |scope|
        warden.authenticate?(:scope => scope)
      end
    end

signed_in_root_path(resource_or_scope) click to toggle source

The scope root url to be used when he’s signed in. By default, it first tries to find a resource_root_path, otherwise it uses the root_path.

    # File lib/devise/controllers/helpers.rb, line 168
    def signed_in_root_path(resource_or_scope)
      scope = Devise::Mapping.find_scope!(resource_or_scope)
      home_path = "#{scope}_root_path"
      if respond_to?(home_path, true)
        send(home_path)
      elsif respond_to?(:root_path)
        root_path
      else
        "/"
      end
    end

stored_location_for(resource_or_scope) click to toggle source

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

    # File lib/devise/controllers/helpers.rb, line 161
    def stored_location_for(resource_or_scope)
      scope = Devise::Mapping.find_scope!(resource_or_scope)
      session.delete("#{scope}_return_to")
    end

warden() click to toggle source

The main accessor for the warden proxy instance

    # File lib/devise/controllers/helpers.rb, line 70
    def warden
      request.env['warden']
    end