Rails & Devise: Override SessionsController

20,383

Solution 1

You have to override your custom failure devise Class.

Add this custom failure class under lib/custom_failure.rb

class CustomFailure < Devise::FailureApp
  def respond
    if http_auth?
      http_auth
    elsif warden_options[:recall]
        recall
    else
      redirect
    end
  end

  def redirect
      store_location!
      flash[:alert] = i18n_message unless flash[:notice]
      redirect_to "/"
  end

  def recall
    env["PATH_INFO"] = attempted_path
    flash.now[:alert] = i18n_message(:invalid)
    self.response = recall_controller.action(warden_options[:recall]).call(env)
  end

  protected

  def i18n_message(default = nil)
    message = warden.message || warden_options[:message] || default || :unauthenticated

    if message.is_a?(Symbol)
      I18n.t(:"#{scope}.#{message}", :resource_name => scope,
             :scope => "devise.failure", :default => [message, message.to_s])
    else
      message.to_s
    end
  end

  def warden_options
    env['warden.options']
  end

  def warden
    env['warden']
  end

  def recall_controller
    "#{params[:controller].camelize}Controller".constantize
  end


  def attempted_path
    warden_options[:attempted_path]
  end

  def store_location!
    session[:"#{scope}_return_to"] = attempted_path if request.get? && !http_auth?
  end

  def attempted_path
    warden_options[:attempted_path]
  end

  def http_auth?
    !Devise.navigational_formats.include?(request_format) || (request.xhr? && Devise.http_authenticatable_on_xhr)
  end
end

Write this under config/application.rb

config.autoload_paths += %W(#{config.root}/lib)

_________________Edit __________________

You said when the 'sign up goes wrong', this means the control should be in registrations_controller create method. Something must be wrong there, I guess. Try to add these routes.

devise_for :users

  devise_scope :user do
    root :to => "devise/sessions#new"
    get "sign_in", :to => "devise/sessions#new"
    get "sign_out", :to => "devise/sessions#destroy"
    get "sign_up", :to => "devise/registrations#new"
  end

________________Edit 2 ________________

Add this in views/devise/registrations/new.html.erb

<%= devise_error_messages! %>

Solution 2

If you're running into the error undefined method 'users_url' for #<SessionsController:0x5072c88> when overriding the devise sessions controller you can provide a path name as below. The important addition that you missed is the , :as => :users.

  devise_scope :user do
    root :to => "devise/sessions#new", :as => :users
    get "sign_in", :to => "devise/sessions#new"
    get "sign_out", :to => "devise/sessions#destroy"
    get "sign_up", :to => "devise/registrations#new"
  end

The above route name might conflict with existing or future routes. As an alternative, I have found that this setup tends to work well:

  devise_for :users,
    :path_names  => { :sign_out => 'logout', 
                      :sign_in  => 'login', 
                      :sign_up  => 'register' },
    :controllers => { :sessions => 'users/sessions' } do

      # Sessions
      post '/login'         => 'users/sessions#create',       :as => :user_session
      get  '/login'         => 'users/sessions#new',          :as => :new_user_session
      get  '/logout'        => 'users/sessions#destroy',      :as => :destroy_user_session

      # Passwords
      post '/password'      => 'devise/passwords#create',     :as => :user_password
      put  '/password'      => 'devise/passwords#update'
      get  '/password/new'  => 'devise/passwords#new',        :as => :new_user_password
      get  '/password/edit' => 'devise/passwords#edit',       :as => :edit_user_password

      # Registrations
      post   '/register'    => 'devise/registrations#create', :as => :user_registration
      get    '/register'    => 'devise/registrations#new',    :as => :new_user_registration
      get    '/account'     => 'devise/registrations#edit',   :as => :edit_user_registration
      put    '/account'     => 'devise/registrations#update'
      delete '/account'     => 'devise/registrations#destroy'

  end
Share:
20,383
Lucas
Author by

Lucas

UX @ Algolia

Updated on October 11, 2020

Comments

  • Lucas
    Lucas over 3 years

    I'm trying to set up a sign in form on my home page. I managed to do it by following the Wiki

    Except, if the login infos are incorrect, the /devise/session/new.html.erb is rendered. I don't want that. I want my user to be redirected to the root_url WITH the errors in a flash message.

    I was able to override registrations_controller.rb for another feature but override sessions_controller.rb gives me a lot of trouble.

    What am I suppose to change to do what I want ? I still want the user to be redirected to after_sign_in_path if the sign in went right. The original controller is here

    So far, I know I have to do that in my routes.rb

    devise_for :users, :controllers => { :registrations => "registrations", :sessions => "sessions" }

    And I also set up controller/sessions_controller.rb

    class SessionsController < Devise::SessionsController
    
      # GET /resource/sign_in
      def new
        resource = build_resource
        clean_up_passwords(resource)
        respond_with_navigational(resource, stub_options(resource)){ render_with_scope :new }
      end
    
    end
    

    I have the feeling that I have to change the render_with_scope :new but ...how? With that version, I get the error undefined method 'users_url' for #<SessionsController:0x5072c88>

    Well, I'll wait for your precious help

    PS: That post helped me a lot for handling errors on subscription. Maybe it'll help for sign in errors?

    ==== EDIT ====

    Following the 1rst answer advice, I also added to initializers/devise.rb:

    config.warden do |manager|
      manager.failure_app = CustomFailure
     end
    

    When the user is not logged and tries to access a "restricted" area, he gets redirected to root_url but when the sign in goes wrong, I now have the following error :

    The action 'devise/sessions#new' could not be found for Devise::SessionsController
    

    (PS: I deleted everything I did with Session Controller and the log in works if successful)

    === EDIT 2 ===

    Following this Wiki the redirection works perfectly BUT I don't have any error notification.

    And I'm displaying the alert/notice flash message with that if that changes anything

    <% flash.each do |name, msg| %>          
      <% if msg.class == Array %>
        <% msg.each do |message| %>
        <%= content_tag :p, message, :id => "flash_#{name}" %>
      <% end %>
      <% else %>          
        <%= content_tag :p, msg, :id => "flash_#{name}" %>          
      <% end %>
    <% end %>
    

    === FINAL UPDATE ===

    The accepted answer works. Just don't forget to display flash alerts

  • Lucas
    Lucas almost 13 years
    Didn't work. Am I suppose to add anything for Rails to take into account this file?
  • Muhammad Sannan Khalid
    Muhammad Sannan Khalid almost 13 years
    you have to add config.autoload_paths += %W(#{config.root}/lib) into config/application.rb file whats the error? You just have to install devise gem..
  • Muhammad Sannan Khalid
    Muhammad Sannan Khalid almost 13 years
    whts in your registration controller ?
  • Lucas
    Lucas almost 13 years
    Your Custom Failure works too if you overwrite the respond to delete the recall. But I don't have any errors message. Almost there! :)
  • Lucas
    Lucas almost 13 years
    Everything worked great, I just "forgot" to display flash "alerts" and was displaying only "notice". Thanks for your time and your perfect help.