devise_imapable 0.5.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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.

data/README.md

@@ -0,0 +1,133 @@
+Devise - Imapable
+=================
+
+Devise-Imapable is a imap based authentication strategy for the [Devise](github.com/plataformatec/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.
+
+Installation
+------------
+
+Currently this can only be installed as a plugin.
+
+    script/plugin install git@github.com:joshk/devise_imapable.git
+
+*Gem coming soon!*
+
+
+**And don't forget to add [Devise](github.com/plataformatec/devise)!**
+
+either in config/environment.rb:
+
+    config.gem 'devise'
+
+or in bundler
+
+    gem 'devise'
+
+
+Setup
+-----
+
+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.facebook_connectable
+
+    end
+
+and indexes (optional) :
+
+    add_index :users, :email, :unique => true
+
+and don’t forget to migrate :
+
+    rake db:migrate.
+
+then finally the model :
+
+    class User < ActiveRecord::Base
+
+      devise :rememberable, :trackable, :timeoutable, :imapable
+
+      # Setup accessible (or protected) attributes for your model
+      attr_accessible :email, :password, :remember_me
+
+      ...
+    end
+
+I recommend using :rememberable, :trackable, :timeoutable along with :imapable as it gives a full feature set for logins.
+
+
+Usage
+-----
+
+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 :
+
+    script/generate devise_views
+
+so you can customize your login pages.
+
+------------------------------------------------------------
+
+**please note**
+
+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.
+
+
+Advanced Configuration
+----------------------
+
+In initializer  `config/initializers/devise.rb` :
+
+    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 josh.kalderimis@gmail.com 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.
+
+So remember ...
+---------------
+
+- don't use Authenticatable
+
+- add imap\_server and default\_email\_suffix settings in the devise initializer
+
+- generate the devise views and make them pretty
+
+
+References
+----------
+
+* [Devise](github.com/plataformatec/devise)
+* [Warden](github.com/hassox/warden)
+
+
+TODO
+----
+
+- email validation
+
+- 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,

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the devise_imapable plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the devise_imapable plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DeviseImapable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "devise_imapable"
+    gemspec.summary = "Devise Imap authentication module"
+    gemspec.description = "For when you don't have access to LDAP"
+    gemspec.email = "josh.kalderimis@gmail.com"
+    gemspec.homepage = "http://github.com/joshk/devise_imapable"
+    gemspec.authors = ["Josh Kalderimis"]
+    gemspec.add_runtime_dependency "devise", "> 1.0.4"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/devise_imapable.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{devise_imapable}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Josh Kalderimis"]
+  s.date = %q{2010-03-27}
+  s.description = %q{For when you don't have access to LDAP}
+  s.email = %q{josh.kalderimis@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "devise_imapable.gemspec",
+     "lib/devise_imapable.rb",
+     "lib/devise_imapable/imap_adapter.rb",
+     "lib/devise_imapable/model.rb",
+     "lib/devise_imapable/routes.rb",
+     "lib/devise_imapable/schema.rb",
+     "lib/devise_imapable/strategy.rb",
+     "rails/init.rb",
+     "test/devise_imapable_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/joshk/devise_imapable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Devise Imap authentication module}
+  s.test_files = [
+    "test/devise_imapable_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<devise>, ["> 1.0.4"])
+    else
+      s.add_dependency(%q<devise>, ["> 1.0.4"])
+    end
+  else
+    s.add_dependency(%q<devise>, ["> 1.0.4"])
+  end
+end
+

data/lib/devise_imapable.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require 'devise'
+
+require 'devise_imapable/schema'
+require 'devise_imapable/imap_adapter'
+require 'devise_imapable/routes'
+
+module Devise
+  # imap server address for authentication.
+  mattr_accessor :imap_server
+  @@imap_server = nil
+
+  # default email suffix
+  mattr_accessor :default_email_suffix
+  @@default_email_suffix = nil
+end
+
+# Add +:imapable+ strategy to defaults.
+#
+Devise.add_module(:imapable,
+                  :strategy   => true,
+                  :controller => :sessions,
+                  :model  => 'devise_imapable/model',
+                  :routes => :imapable)

data/lib/devise_imapable/imap_adapter.rb

@@ -0,0 +1,21 @@
+require 'net/imap'
+
+module Devise
+
+  # simple adapter for imap credential checking
+  # (i don't like to add stuff like this directly to the model)
+  module ImapAdapter
+
+    def self.valid_credentials?(username, password)
+      imap = Net::IMAP.new(::Devise.imap_server)
+      imap.authenticate("cram-md5", username, password)
+      true
+    rescue Net::IMAP::ResponseError => e
+      false
+    ensure
+      imap.disconnect
+    end
+
+  end
+
+end

data/lib/devise_imapable/model.rb

@@ -0,0 +1,68 @@
+require 'devise_imapable/strategy'
+
+module Devise
+  module Models
+    # Imapable Module, responsible for validating the user credentials via an imap server.
+    #
+    # Examples:
+    #
+    #    User.authenticate('email@test.com', 'password123')  # returns authenticated user or nil
+    #    User.find(1).valid_password?('password123')         # returns true/false
+    #
+    module Imapable
+      def self.included(base)
+        base.class_eval do
+          extend ClassMethods
+
+          attr_accessor :password
+        end
+      end
+
+      # Set password to nil
+      def clean_up_passwords
+        self.password = nil
+      end
+
+      # Checks if a resource is valid upon authentication.
+      def valid_imap_authentication?(password)
+        Devise::ImapAdapter.valid_credentials?(self.email, password)
+      end
+
+      module ClassMethods
+        # Authenticate a user based on configured attribute keys. Returns the
+        # authenticated user if it's valid or nil.
+        def authenticate_with_imap(attributes={})
+          return unless attributes[:email].present?
+          conditions = attributes.slice(:email)
+
+          unless conditions[:email] && conditions[:email].include?('@') && !Devise.default_email_suffix
+            conditions[:email] = "#{conditions[:email]}@#{Devise.default_email_suffix}"
+          end
+
+          resource = find_for_imap_authentication(conditions) || new(conditions)
+
+          if resource.try(:valid_imap_authentication?, attributes[:password])
+             resource.new_record? ? create(conditions) : resource
+          end
+        end
+
+
+      protected
+
+        # Find first record based on conditions given (ie by the sign in form).
+        # Overwrite to add customized conditions, create a join, or maybe use a
+        # namedscope to filter records while authenticating.
+        # Example:
+        #
+        #   def self.find_for_imap_authentication(conditions={})
+        #     conditions[:active] = true
+        #     find(:first, :conditions => conditions)
+        #   end
+        #
+        def find_for_imap_authentication(conditions)
+          find(:first, :conditions => conditions)
+        end
+      end
+    end
+  end
+end

data/lib/devise_imapable/routes.rb

@@ -0,0 +1,8 @@
+ActionController::Routing::RouteSet::Mapper.class_eval do
+
+  protected
+
+    # reuse the session routes and controller
+    alias :imapable :authenticatable
+
+end

data/lib/devise_imapable/schema.rb

@@ -0,0 +1,13 @@
+Devise::Schema.class_eval do
+
+    # Creates email
+    #
+    # == Options
+    # * :null - When true, allow columns to be null.
+    def imapable(options={})
+      null = options[:null] || false
+
+      apply_schema :email, String, :null => null
+    end
+
+end

data/lib/devise_imapable/strategy.rb

@@ -0,0 +1,36 @@
+require 'devise/strategies/base'
+
+module Devise
+  module Strategies
+    # Strategy for signing in a user based on his email and password using imap.
+    # Redirects to sign_in page if it's not authenticated
+    class Imapable < Base
+      def valid?
+        valid_controller? && valid_params? && mapping.to.respond_to?(:authenticate_with_imap)
+      end
+
+      # Authenticate a user based on email and password params, returning to warden
+      # success and the authenticated user if everything is okay. Otherwise redirect
+      # to sign in page.
+      def authenticate!
+        if resource = mapping.to.authenticate_with_imap(params[scope])
+          success!(resource)
+        else
+          fail!(:invalid)
+        end
+      end
+
+      protected
+
+        def valid_controller?
+          params[:controller] == 'sessions'
+        end
+
+        def valid_params?
+          params[scope] && params[scope][:password].present?
+        end
+    end
+  end
+end
+
+Warden::Strategies.add(:imapable, Devise::Strategies::Imapable)

data/rails/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'devise_imapable'

data/test/devise_imapable_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class DeviseImapableTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: devise_imapable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Josh Kalderimis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-27 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: devise
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 4
+        version: 1.0.4
+  type: :runtime
+  version_requirements: *id001
+description: For when you don't have access to LDAP
+email: josh.kalderimis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- devise_imapable.gemspec
+- lib/devise_imapable.rb
+- lib/devise_imapable/imap_adapter.rb
+- lib/devise_imapable/model.rb
+- lib/devise_imapable/routes.rb
+- lib/devise_imapable/schema.rb
+- lib/devise_imapable/strategy.rb
+- rails/init.rb
+- test/devise_imapable_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/joshk/devise_imapable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Devise Imap authentication module
+test_files: 
+- test/devise_imapable_test.rb
+- test/test_helper.rb