SimpleAuth is an authentication library to be used when Authlogic & Devise are just too complicated.
This library only supports in-site authentication and won't implement OpenID, Facebook Connect and like. Rails 3.0+ required.
sudo gem install simple_auth
Then run rails generate simple_auth:install
to copy the initializer file.
Your user model should have the attributes password_hash
and password_salt
. The credential field can be anything you want, but SimpleAuth uses [:email, :login]
by default.
class CreateUsers < ActiveRecord::Migration
def self.up
create_table :users do |t|
t.string :email
t.string :login
t.string :password_hash
t.string :password_salt
t.timestamps
end
add_index :users, :email
add_index :users, :login
add_index :users, [:email, :login]
end
def self.down
drop_table :users
end
end
In your model, use the authentication
macro.
class User < ActiveRecord::Base
authentication
end
This will add some callbacks and password validations. It will also inject helper methods like Model.authenticate
.
Session is valid only when both Model#authorized?
and Controller#authorized?
methods return true
, which is the default behavior. You can override these methods with your own rules:
class User < ActiveRecord::Base
authentication
def authorized?
deleted_at.nil?
end
end
class Admin::DashboardController < ApplicationController
private
def authorized?
current_user.admin?
end
end
After you set up the model, you can go to the controller.
class SessionsController < ApplicationController
def new
@user_session = SimpleAuth::Session.new
end
def create
@user_session = SimpleAuth::Session.new(params[:session])
if @user_session.save
redirect_to return_to(dashboard_path)
else
flash[:alert] = "Invalid username or password"
render :new
end
end
def destroy
current_session.destroy if logged_in?
redirect_to root_path
end
end
The return_to
helper will give you the requested url (before the user logged in) or the default url.
You can restrict access by using 2 macros:
class SignupController < ApplicationController
redirect_logged_user :to => "/"
end
Here's some usage examples:
redirect_logged_user :to => proc { login_path }
redirect_logged_user :to => {:controller => "dashboard"}
redirect_logged_user :only => [:index], :to => login_path
redirect_logged_user :except => [:public], :to => login_path
You can skip the :to
option if you set it globally on your initializer:
SimpleAuth::Config.logged_url = {:controller => "session", :action => "new"}
SimpleAuth::Config.logged_url = proc { login_path }
To require a logged user, use the require_logged_user
macro:
class DashboardController < ApplicationController
require_logged_user :to => proc { login_path }
end
Here's some usage examples:
require_logged_user :to => proc { login_path }
require_logged_user :to => {:controller => "session", :action => "new"}
require_logged_user :only => [:index], :to => login_path
require_logged_user :except => [:public], :to => login_path
You can skip the :to
option if you set it globally on your initializer:
SimpleAuth::Config.login_url = {:controller => "session", :action => "new"}
SimpleAuth::Config.login_url = proc { login_path }
There are some helpers:
logged_in? # controller & views
current_user # controller & views
current_session # controller & views
when_logged(&block) # views
find_by_credential # model
find_by_credential! # model
If you're having problems to use any helper, include the module SimpleAuth::Helper
on your ApplicationHelper
.
module ApplicationHelper
include SimpleAuth::Helper
end
You can use SimpleAuth with MongoMapper. Just include the module SimpleAuth::Orm::MongoMapper
and
set up your model with the authentication
macro.
class User
include MongoMapper::Document
include SimpleAuth::Orm::MongoMapper
authentication
end
These are the translations you'll need:
en:
simple_auth:
sessions:
need_to_be_logged: "You need to be logged"
invalid_credentials: "Invalid username or password"
You may receive strange errors related to can't dup NilClass
or You have a nil object when you didn't expect it!
. This will occur only on development mode and is an ActiveRecord bug that hasn't been fixed. Open the ActiveRecord file activerecord-2.3.5/lib/active_record/base.rb
and comment the lines 411-412:
klass.instance_variables.each { |var| klass.send(:remove_instance_variable, var) }
klass.instance_methods(false).each { |m| klass.send :undef_method, m }
Dirty, but it works. Here's the ticket for this issue: Issue #1290
- Nando Vieira (http://simplesideias.com.br)
(The MIT License)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.