dm-is-authenticatable 0.1.2 → 0.2.0

data/ChangeLog.md

@@ -1,3 +1,11 @@
+### 0.2.0 / 2012-10-06
+
+* Added {DataMapper::Is::Authenticatable::InstanceMethods#password_required?}.
+* Added {DataMapper::Is::Authenticatable::InstanceMethods#has_password?}.
+* {DataMapper::Is::Authenticatable::ClassMethods#authenticate}:
+  * Simply return `nil` instead of raising exceptions in
+  * Support authenticating models without encrypted passwords.
+
 ### 0.1.2 / 2011-10-26
 
 * Require bcrypt-ruby ~> 3.0, >= 2.1.0.

data/Gemfile

@@ -88,16 +88,16 @@ DO_VERSION = '~> 0.10.2'
 DM_DO_ADAPTERS = %w[ sqlite postgres mysql oracle sqlserver ]
 RAILS = 'http://github.com/rails/rails.git'
 
-gem 'bcrypt-ruby',	  '~> 2.1'
+gem 'bcrypt-ruby',	  ['~> 3.0', '>= 2.1']
 
 gem 'dm-core',        DM_VERSION, :git => "#{DATAMAPPER}/dm-core.git"
 gem 'dm-types',		    DM_VERSION, :git => "#{DATAMAPPER}/dm-types.git"
 gem 'dm-validations',	DM_VERSION, :git => "#{DATAMAPPER}/dm-validations.git"
 
 group :development do
-  gem 'rake',		    '~> 0.8'
-  gem 'ore-tasks',	'~> 0.4'
-  gem 'rspec',		  '~> 2.4'
+  gem 'rake',		        '~> 0.8'
+  gem 'rubygems-tasks',	'~> 0.1'
+  gem 'rspec',		      '~> 2.4'
 
   gem 'kramdown',   '~> 0.12'
   gem 'yard',       '~> 0.7'

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2011 Hal Brodigan
+Copyright (c) 2010-2012 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,16 +1,15 @@
 # dm-is-authenticatable
 
-* [Source](http://github.com/postmodern/dm-is-authenticatable)
-* [Issues](http://github.com/postmodern/dm-is-authenticatable/issues)
+* [Source](https://github.com/postmodern/dm-is-authenticatable)
+* [Issues](https://github.com/postmodern/dm-is-authenticatable/issues)
 * [Documentation](http://rubydoc.info/gems/dm-is-authenticatable/frames)
 * [Email](mailto:postmodern.mod3 at gmail.com)
 
 ## Description
 
 A DataMapper plugin for adding authentication and encrypted passwords to
-your DataMapper models. Ideal for use with
-[warden](http://github.com/hassox/warden) or
-[sinatra_warden](http://github.com/jsmestad/sinatra_warden).
+your DataMapper models. Ideal for use with [warden], [sinatra_warden] or
+[padrino-warden].
 
 ## Example
 
@@ -59,7 +58,7 @@ Handles finding and authenticating resources in the database:
     User.authenticate(:name => 'bob', :password => 'secret')
     # => #<User: ...>
 
-Using dm-is-authenticatable with [Warden](http://github.com/hassox/warden#readme):
+Using dm-is-authenticatable with [warden]:
 
     Warden::Manager.serialize_into_session { |user| user.id }
     Warden::Manager.serialize_from_session { |id| User.get(id) }
@@ -72,7 +71,7 @@ Using dm-is-authenticatable with [Warden](http://github.com/hassox/warden#readme
  
       def authenticate!
         attributes = {
-          :name => params['name'],
+          :name     => params['name'],
           :password => params['password']
         }
 
@@ -86,10 +85,10 @@ Using dm-is-authenticatable with [Warden](http://github.com/hassox/warden#readme
 
 ## Requirements
 
-* [bcrypt-ruby](http://rubygems.org/gems/bcrypt-ruby) ~> 3.0, >= 2.1.0
-* [dm-core](http://github.com/datamapper/dm-core/) ~> 1.0
-* [dm-types](http://github.com/datamapper/dm-types/) ~> 1.0
-* [dm-validations](http://github.com/datamapper/dm-validations/) ~> 1.0
+* [bcrypt-ruby](https://github.com/codahale/bcrypt-ruby#readme) ~> 3.0, >= 2.1.0
+* [dm-core](https://github.com/datamapper/dm-core#readme) ~> 1.0
+* [dm-types](https://github.com/datamapper/dm-types#readme) ~> 1.0
+* [dm-validations](https://github.com/datamapper/dm-validations#readme) ~> 1.0
 
 ## Install
 
@@ -97,6 +96,10 @@ Using dm-is-authenticatable with [Warden](http://github.com/hassox/warden#readme
 
 ## License
 
-Copyright (c) 2010-2011 Hal Brodigan
+Copyright (c) 2010-2012 Hal Brodigan
 
 See {file:LICENSE.txt} for license information.
+
+[warden]: https://github.com/hassox/warden#readme
+[sinatra_warden]: https://github.com/jsmestad/sinatra_warden#readme
+[padrino-warden]: https://github.com/jondot/padrino-warden#readme

data/Rakefile

@@ -18,8 +18,8 @@ end
 
 require 'rake'
 
-require 'ore/tasks'
-Ore::Tasks.new
+require 'rubygems/tasks'
+Gem::Tasks.new
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: dm-is-authenticatable
-version: 0.1.2
+version: 0.2.0
 summary: DataMapper plugin for adding authentication to models.
 description:
   A DataMapper plugin for adding authentication and encrypted passwords to
@@ -8,7 +8,7 @@ description:
 license: MIT
 authors: Postmodern
 email: postmodern.mod3@gmail.com
-homepage: http://github.com/postmodern/dm-is-authenticatable
+homepage: https://github.com/postmodern/dm-is-authenticatable#readme
 has_yard: true
 
 dependencies:

data/lib/dm-is-authenticatable/is/authenticatable.rb

@@ -4,13 +4,10 @@ require 'dm-validations'
 module DataMapper
   module Is
     module Authenticatable
-      class UnknownResource < RuntimeError
-      end
-
-      def is_authenticatable
+      def is_authenticatable(options={})
         # The encrypted password
         property :encrypted_password, DataMapper::Property::BCryptHash
-    
+
         extend DataMapper::Is::Authenticatable::ClassMethods
         include DataMapper::Is::Authenticatable::InstanceMethods
 
@@ -27,29 +24,16 @@ module DataMapper
         # @option attributes [String] :password
         #   The clear-text password to authenticate with.
         #
-        # @return [DataMapper::Resource]
-        #   The authenticated resource.
-        #
-        # @raise [UnknownResource]
-        #   The authenticatable resource could not be found in the repository.
-        #
-        # @raise [ArgumentError]
-        #   The `:password` option was not specified.
+        # @return [DataMapper::Resource, nil]
+        #   The authenticated resource. If the resource could not be found,
+        #   or the password did not match, `nil` will be returned.
         #
         def authenticate(attributes)
           password = attributes.delete(:password)
           resource = self.first(attributes)
 
-          unless resource
-            raise(UnknownResource,"could not find the authenticatable resource",caller)
-          end
-
-          unless password
-            raise(ArgumentError,"must specify the :password option",caller)
-          end
-
-          if resource.encrypted_password == password
-            resource
+          if (resource && resource.has_password?(password))
+            return resource
           end
         end
       end
@@ -74,6 +58,33 @@ module DataMapper
           self.encrypted_password = new_password
           @password = new_password
         end
+
+        #
+        # Determines if a password is required for authentication.
+        #
+        # @return [Boolean]
+        #   Specifies whether a password is required or not.
+        #
+        # @since 0.2.0
+        #
+        def password_required?
+          !self.encrypted_password.nil?
+        end
+
+        #
+        # Determines if the submitted password matches the `encrypted_password`.
+        #
+        # @param [String] submitted_password
+        #   The submitted password.
+        #   
+        # @return [Boolean]
+        #   Specifies whether the submitted password matches.
+        #
+        # @since 0.2.0
+        #
+        def has_password?(submitted_password)
+          !password_required? || (self.encrypted_password == submitted_password)
+        end
       end
     end
   end

data/spec/integration/authenticatable_spec.rb

@@ -3,9 +3,7 @@ require 'spec_helper'
 require 'integration/models/user'
 
 describe DataMapper::Is::Authenticatable do
-  before(:all) do
-    User.auto_migrate!
-  end
+  before(:all) { User.auto_migrate! }
 
   let(:password) { 'secret' }
 
@@ -15,41 +13,80 @@ describe DataMapper::Is::Authenticatable do
     subject.class.properties.should be_named(:encrypted_password)
   end
 
-  it "should not have a default password" do
-    subject.password.should be_nil
-  end
+  describe "validations" do
+    before { subject.password = password }
 
-  it "should not have an encrypted password by default" do
-    subject.encrypted_password.should be_nil
-  end
+    it "should require password confirmation" do
+      subject.should_not be_valid
+    end
+
+    it "should require the confirmation password match the password" do
+      subject.password_confirmation = 'fail'
+
+      subject.should_not be_valid
+    end
 
-  it "should allow setting the password" do
-    subject.password = password
-    subject.password.should == password
+    it "should confirmed both passwords" do
+      subject.password_confirmation = password
+
+      subject.should be_valid
+    end
   end
 
-  it "should update the encrypted password when setting the password" do
-    subject.password = password
-    subject.encrypted_password.should == password
+  describe "#password" do
+    it "should not have a default password" do
+      subject.password.should be_nil
+    end
+
+    it "should allow setting the password" do
+      subject.password = password
+      subject.password.should == password
+    end
   end
 
-  it "should require password confirmation" do
-    subject.password = password
-    subject.should_not be_valid
+  describe "#password_required?" do
+    context "when encrypted_password is nil" do
+      before { subject.encrypted_password = nil }
+
+      it "should return false" do
+        subject.should_not be_password_required
+      end
+    end
+
+    context "when encrypted_password is set" do
+      before { subject.password = password }
+
+      it "should return true" do
+        subject.should be_password_required
+      end
+    end
   end
 
-  it "should require the confirmation password match the password" do
-    subject.password = password
-    subject.password_confirmation = 'fail'
+  describe "#has_password?" do
+    before { subject.password = password }
+
+    it "should compare the plain-text password against #encrypted_password" do
+      subject.should have_password(password)
+    end
+
+    context "when #password_required? is false" do
+      before { subject.stub(:password_required?).and_return(false) }
 
-    subject.should_not be_valid
+      it "should return true" do
+        subject.should have_password('does not matter')
+      end
+    end
   end
 
-  it "should validate confirmed passwords" do
-    subject.password = password
-    subject.password_confirmation = password
+  describe "#encrypted_password" do
+    it "should not have an encrypted password by default" do
+      subject.encrypted_password.should be_nil
+    end
 
-    subject.should be_valid
+    it "should update the encrypted password when setting the password" do
+      subject.password = password
+      subject.encrypted_password.should == password
+    end
   end
 
   describe "authenticate" do
@@ -64,13 +101,14 @@ describe DataMapper::Is::Authenticatable do
     subject { User }
 
     it "should not allow authenticating with unknown resources" do
-      lambda {
-        subject.authenticate(:name => 'alice', :password => password)
-      }.should raise_error(DataMapper::Is::Authenticatable::UnknownResource)
+      user = subject.authenticate(:name => 'alice', :password => password)
+
+      user.should be_nil
     end
 
     it "should allow authenticating with a password" do
       user = subject.authenticate(:name => name, :password => password)
+
       user.name.should == name
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dm-is-authenticatable
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-26 00:00:00.000000000Z
+date: 2012-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt-ruby
-  requirement: &16898840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -24,10 +24,18 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *16898840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: dm-core
-  requirement: &16896440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -35,10 +43,15 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *16896440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: dm-types
-  requirement: &16895180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,10 +59,15 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *16895180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: dm-validations
-  requirement: &16893980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -57,10 +75,15 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *16893980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &16893000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +91,15 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *16893000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &16891120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -79,7 +107,12 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *16891120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: A DataMapper plugin for adding authentication and encrypted passwords
   to your DataMapper models.
 email: postmodern.mod3@gmail.com
@@ -105,7 +138,7 @@ files:
 - spec/integration/authenticatable_spec.rb
 - spec/integration/models/user.rb
 - spec/spec_helper.rb
-homepage: http://github.com/postmodern/dm-is-authenticatable
+homepage: https://github.com/postmodern/dm-is-authenticatable#readme
 licenses:
 - MIT
 post_install_message: 
@@ -126,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: DataMapper plugin for adding authentication to models.