devise_imap_authenticatable 0.6.0

data/LICENSE

@@ -0,0 +1,21 @@
+
+    Copyright (C) 2011 Black Square Media Ltd
+
+	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/lib/devise_imap_authenticatable.rb

@@ -0,0 +1,32 @@
+$: << File.expand_path('../', __FILE__)
+
+require 'devise'
+require 'devise_imap_authenticatable/strategy'
+require 'devise_imap_authenticatable/model'
+require 'devise_imap_authenticatable/adapter'
+require 'devise_imap_authenticatable/version'
+
+module Devise
+
+  # IMAP Host address for authentication.
+  mattr_accessor :imap_host
+  @@imap_host = 'localhost'
+
+  # IMAP Host address for authentication.
+  mattr_accessor :imap_port
+  @@imap_port = 143
+
+  # Use SSL for IMAP for authentication.
+  mattr_accessor :imap_ssl
+  @@imap_ssl = false
+
+  mattr_accessor :imap_mechanism
+  @@imap_mechanism = "login"
+end
+
+# Add imap_authenticatable module
+Devise.add_module :imap_authenticatable,
+  :route      => :session,
+  :strategy   => true,
+  :controller => :sessions,
+  :model      => 'devise_imap_authenticatable/model'

data/lib/devise_imap_authenticatable/adapter.rb

@@ -0,0 +1,32 @@
+require 'net/imap'
+
+module Devise
+
+  # Simple adapter for imap credential checking
+  module ImapAdapter
+    extend self
+
+    def valid_credentials?(username, password)
+      imap = new_connection
+      imap.authenticate ::Devise.imap_mechanism, username, password
+      true
+    rescue Net::IMAP::ResponseError
+      false
+    ensure
+      imap.try(:disconnect)
+    end
+
+    def new_connection
+      if previous_version?
+        Net::IMAP.new ::Devise.imap_host, ::Devise.imap_port, ::Devise.imap_ssl
+      else
+        Net::IMAP.new ::Devise.imap_host, :port => ::Devise.imap_port, :ssl => ::Devise.imap_ssl
+      end
+    end
+
+    def previous_version?
+      Net::IMAP::VERSION < "1.1.0"
+    end
+
+  end
+end

data/lib/devise_imap_authenticatable/model.rb

@@ -0,0 +1,56 @@
+require 'devise_imap_authenticatable/strategy'
+
+module Devise
+  module Models
+
+    # IMAP Authenticatable Module
+    #
+    # == Examples
+    #
+    #    User.find(1).valid_password?('password123')         # returns true/false
+    #
+    module ImapAuthenticatable
+      extend ActiveSupport::Concern
+
+      included do
+        attr_accessor     :password
+        before_validation :downcase_keys
+        before_validation :strip_whitespace
+      end
+
+      # Verifies a given password
+      def valid_password?(password)
+        Devise::ImapAdapter.valid_credentials? send(::Devise.authentication_keys.first), password
+      end
+
+      # Callback, override in your model
+      def after_imap_authentication
+      end
+
+      protected
+
+        # Downcase case-insensitive keys
+        def downcase_keys
+          (self.class.case_insensitive_keys || []).each { |k| self[k].try(:downcase!) }
+        end
+
+        def strip_whitespace
+          (self.class.strip_whitespace_keys || []).each { |k| self[k].try(:strip!) }
+        end
+
+      module ClassMethods
+
+        # Override in your models if you want to auto-create users
+        def build_for_imap_authentication(conditions)
+        end
+
+        # We assume this method already gets a sanitized conditions hash
+        def find_for_imap_authentication(conditions)
+          find_for_authentication(conditions)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/devise_imap_authenticatable/strategy.rb

@@ -0,0 +1,33 @@
+require 'devise/strategies/authenticatable'
+
+module Devise
+  module Strategies
+
+    # Strategy for signing in a user based on his login and password using IMAP.
+    # Redirects to sign_in page if it's not authenticated
+    class ImapAuthenticatable < Authenticatable
+
+      def authenticate!
+        resource = valid_password? && (find_resource || build_resource)
+
+        if validate(resource){ resource.valid_password?(password) }
+          resource.after_imap_authentication
+          success!(resource)
+        elsif !halted?
+          fail(:invalid)
+        end
+      end
+
+      private
+
+        def find_resource
+          mapping.to.find_for_imap_authentication(authentication_hash)
+        end
+
+        def build_resource
+          mapping.to.build_for_imap_authentication(authentication_hash)
+        end
+
+    end
+  end
+end

data/lib/devise_imap_authenticatable/version.rb

@@ -0,0 +1,5 @@
+module Devise
+  module ImapAuthenticatable
+    VERSION = "0.6.0" unless const_defined?(:VERSION)
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: devise_imap_authenticatable
+version: !ruby/object:Gem::Version 
+  hash: 7
+  prerelease: 
+  segments: 
+  - 0
+  - 6
+  - 0
+  version: 0.6.0
+platform: ruby
+authors: 
+- John Medforth
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-06 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: devise
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+description: Authenticate users against an IMAP server
+email: dimitrij@blacksquaremedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README
+- lib/devise_imap_authenticatable/adapter.rb
+- lib/devise_imap_authenticatable/version.rb
+- lib/devise_imap_authenticatable/strategy.rb
+- lib/devise_imap_authenticatable/model.rb
+- lib/devise_imap_authenticatable.rb
+has_rdoc: true
+homepage: https://github.com/bsm/devise_imap_authenticatable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: IMAP authentication for Devise
+test_files: []
+