Devise-Imapable is a imap based authentication strategy for the Devise authentication framework.
If you are building applications for use within your organisation which require authentication and don't have access to a LDAP server, using imap can be a great alternative.
Please note that this fork of devise-imapable was modified for Rails 3 and Devise 1.1rc1
To install, add the following to your Gemfile:
gem 'devise_imapable', :git => 'git://github.com/LouisStAmour/devise_imapable.git'
And don't forget to add Devise!
gem 'devise', :git => 'git://github.com/plataformatec/devise.git'
Once devise-imapable is installed, all you need to do is setup the user model which includes a small addition to the model itself and to the schema.
First the schema :
create_table :users do |t| t.imap_authenticatable end
and indexes (optional) :
add_index :users, :email, :unique => true
and don’t forget to migrate :
then finally the model :
class User < ActiveRecord::Base devise :rememberable, :trackable, :timeoutable, :imap_authenticatable # Setup accessible (or protected) attributes for your model attr_accessible :email, :password, :remember_me ... end
I recommend using :rememberable, :trackable, :timeoutable along with :imap_authenticatable as it gives a full feature set for logins.
Devise-Imapable works in replacement of Authenticatable, allowing for user name (or email) and password authentication. The standard sign_in routes and views work out of the box as these are just reused from devise. I recommend you run :
so you can customize your login pages.
This devise plugin has not been tested with Authenticatable enabled at the same time. This is meant as a drop in replacement for Authenticatable allowing for a semi single sign on approach.
Devise.setup do |config| # ... config.imap_server = 'bigcorporation.com' config.default_email_suffix = 'friendly-corporation.com' # ... end
Imap servers usually allow a user to login using their full email address or just the identifier part, eg: josh.kalderimis and firstname.lastname@example.org will both work. It is recommend that you set the default_email_suffix so the login is kept consistent and the users email is correctly stored in the User model.
don't use Authenticatable
add imap_server and default_email_suffix settings in the devise initializer
generate the devise views and make them pretty
add notes about gem
add update_with_password to the model, similar to Authenticatable
assert Authenticatable is not being used
assert imap_server is present, and warn if default_email_suffix isn't present
tests, tests, tests
allow for setups which require profile information before creating a user
investigate how well this works with other devise modules like http_authenticatable, token_authenticatable lockable, confirmable, and activatable
Released under the MIT license
Copyright (c) 2010 Josh Kalderimis,