devise_pg_authenticatable 0.1.0

data/.gitignore

@@ -0,0 +1,12 @@
+## VIM
+*.swp
+
+## GIT
+.gitconfig
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

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,90 @@
+Devise PG Authenticatable
+=================
+
+Devise PG Authenticatable is a PostgreSQL based authentication strategy for the [Devise](http://github.com/plataformatec/devise) authentication framework. PG Authenticatable is replacement for module :database\_authenticatable from Devise. This module authenticate users against PostgreSQL system database.
+
+This module is based on Devise-Imapable and Devise-LDAP-ldap\_authenticatable.
+
+Requirements
+------------
+
+- Rails 2.3.5
+- Devise 1.0.7
+
+Installation
+------------
+
+    script/plugin install git://github.com/boblin/devise_pg_authenticatable.git
+
+
+Setup
+-----
+
+Once devise\_pg\_authenticatable 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.pg_authenticatable, :null => false
+    end
+
+and indexes (optional) :
+
+    add_index :login, :unique => true
+
+and don’t forget to migrate :
+
+    rake db:migrate.
+
+then the model :
+
+    class User < ActiveRecord::Base
+      devise :pg_authenticatable, :rememberable, :trackable, :timeoutable
+
+      # Setup accessible (or protected) attributes for your model
+      attr_accessible :login, :password, :remember_me
+      ...
+    end
+
+and finally change the authentication key in the devise initializer :
+
+	Devise.setup do |config|
+	  ...
+	  config.authentication_keys = [ :login ]
+	  ...
+	end
+
+I recommend using :rememberable, :trackable, :timeoutable as it gives a full feature set for logins.
+
+Usage
+-----
+
+Devise PG Authenticatable works in replacement of Authenticatable, 
+but because we have to change the authentication\_keys, you'll need to run:
+
+    script/generate devise_views
+
+and customize your login pages to use :login, instead of :email.
+
+------------------------------------------------------------
+
+**_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.
+
+
+References
+----------
+
+* [Devise](http://github.com/plataformatec/devise)
+* [Warden](http://github.com/hassox/warden)
+
+
+TODO
+----
+
+- Tests
+
+Released under the MIT license
+
+Copyright (c) 2010 Bohuslav Blin

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the devise_pg_authenticatable 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_pg_authenticatable plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DevisePgAuthenticatable'
+  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_pg_authenticatable"
+    gemspec.summary = "Devise PostgreSQL authentication module"
+    gemspec.description = "Devise PostgreSQL authentication module"
+    gemspec.email = "bohuslav@blin.cz"
+    gemspec.homepage = "http://github.com/boblin/devise_pg_authenticatable"
+    gemspec.authors = ["Bohuslav Blin"]
+    gemspec.add_runtime_dependency "devise", "> 1.0.5"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/devise_pg_authenticatable.gemspec

@@ -0,0 +1,58 @@
+# 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_pg_authenticatable}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bohuslav Blin"]
+  s.date = %q{2010-06-11}
+  s.description = %q{Devise PostgreSQL authentication module}
+  s.email = %q{bohuslav@blin.cz}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "devise_pg_authenticatable.gemspec",
+     "lib/devise_pg_authenticatable.rb",
+     "lib/devise_pg_authenticatable/model.rb",
+     "lib/devise_pg_authenticatable/pg_adapter.rb",
+     "lib/devise_pg_authenticatable/routes.rb",
+     "lib/devise_pg_authenticatable/schema.rb",
+     "lib/devise_pg_authenticatable/strategy.rb",
+     "rails/init.rb",
+     "test/devise_pg_authenticatable_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/boblin/devise_pg_authenticatable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Devise PostgreSQL authentication module}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/devise_pg_authenticatable_test.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.5"])
+    else
+      s.add_dependency(%q<devise>, ["> 1.0.5"])
+    end
+  else
+    s.add_dependency(%q<devise>, ["> 1.0.5"])
+  end
+end
+

data/lib/devise_pg_authenticatable/model.rb

@@ -0,0 +1,70 @@
+require 'devise_pg_authenticatable/strategy'
+
+module Devise
+  module Models
+    # PG Module, responsible for validating the user credentials via postgresql users.
+    #
+    # Examples:
+    #
+    # Person.authenticate_with_pg(:login => 'user1',:password => 'pass')
+    # 
+    module PgAuthenticatable
+      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_pg_authentication?(password)
+        Devise::PgAdapter.valid_credentials?(self.login, 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_pg(attributes={})
+          return unless attributes[:login].present? 
+          conditions = attributes.slice(:login)
+
+          unless conditions[:login]
+            conditions[:login] = "#{conditions[:login]}"
+          end
+
+          resource = find_for_pg_authentication(conditions)
+          # resource = new(conditions) if resource.nil?
+
+          # resource = find_for_pg_authentication(conditions) || new(conditions)
+
+           
+          if resource.try(:valid_pg_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_pg_authentication(conditions)
+          find(:first, :conditions => conditions)
+        end
+      end
+    end
+  end
+end

data/lib/devise_pg_authenticatable/pg_adapter.rb

@@ -0,0 +1,16 @@
+module Devise
+  # simple adapter for postgresql credential checking
+  module PgAdapter
+    def self.valid_credentials?(login, password)
+      abcs = ActiveRecord::Base.configurations[RAILS_ENV]
+      host = abcs[:host]
+      port = abcs[:port] || 5432
+      conn = PGconn.connect(host, port, '', '', "template1", login, password)
+      conn.close()
+      true
+    rescue PGError, NoMethodError
+      false
+    end
+  end
+
+end

data/lib/devise_pg_authenticatable/routes.rb

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

data/lib/devise_pg_authenticatable/schema.rb

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

data/lib/devise_pg_authenticatable/strategy.rb

@@ -0,0 +1,36 @@
+require 'devise/strategies/base'
+
+module Devise
+  module Strategies
+    # Strategy for signing in a user based on his login and password using postgresql users
+    # Redirects to sign_in page if it's not authenticated
+    class PgAuthenticatable < Base
+      def valid?
+        valid_controller? && valid_params? && mapping.to.respond_to?(:authenticate_with_pg)
+      end
+
+      # Authenticate a user based on login 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_pg(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(:pg_authenticatable, Devise::Strategies::PgAuthenticatable)

data/lib/devise_pg_authenticatable.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+require 'devise'
+
+require 'devise_pg_authenticatable/schema'
+require 'devise_pg_authenticatable/pg_adapter'
+require 'devise_pg_authenticatable/routes'
+
+module Devise
+  # database
+  # mattr_accessor :pg_database
+  # @@pg_database = nil
+end
+
+# Add pg_authenticatable strategy to defaults.
+#
+Devise.add_module(:pg_authenticatable,
+                  :strategy   => true,
+                  :controller => :sessions,
+                  :model  => 'devise_pg_authenticatable/model')

data/rails/init.rb

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

data/test/devise_pg_authenticatable_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class DevisePgAuthenticatableTest < 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,90 @@
+--- !ruby/object:Gem::Specification 
+name: devise_pg_authenticatable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bohuslav Blin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-11 00:00:00 +02: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
+        - 5
+        version: 1.0.5
+  type: :runtime
+  version_requirements: *id001
+description: Devise PostgreSQL authentication module
+email: bohuslav@blin.cz
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- devise_pg_authenticatable.gemspec
+- lib/devise_pg_authenticatable.rb
+- lib/devise_pg_authenticatable/model.rb
+- lib/devise_pg_authenticatable/pg_adapter.rb
+- lib/devise_pg_authenticatable/routes.rb
+- lib/devise_pg_authenticatable/schema.rb
+- lib/devise_pg_authenticatable/strategy.rb
+- rails/init.rb
+- test/devise_pg_authenticatable_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/boblin/devise_pg_authenticatable
+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 PostgreSQL authentication module
+test_files: 
+- test/test_helper.rb
+- test/devise_pg_authenticatable_test.rb