dm-is-authenticatable 0.1.0

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'dm-is-authenticatable Documentation' --protected --files ChangeLog.md,LICENSE.txt

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2010-09-04
+
+* Initial release.
+

data/Gemfile

@@ -0,0 +1,151 @@
+# If you're working on more than one datamapper gem at a time, then it's
+# recommended to create a local Gemfile and use this instead of the git
+# sources. This will make sure that you are  developing against your
+# other local datamapper sources that you currently work on. Gemfile.local
+# will behave identically to the standard Gemfile apart from the fact that
+# it fetches the datamapper gems from local paths. This means that you can
+# use the same environment variables, like ADAPTER(S) or PLUGIN(S) when
+# running
+# bundle commands. Gemfile.local is added to .gitignore, so you don't need
+# to worry about accidentally checking local development paths into git.
+# In order to create a local Gemfile, all you need to do is run:
+#
+#   bundle exec rake local_gemfile
+#
+# This will give you a Gemfile.local file that points to your local clones
+# of the various datamapper gems. It's assumed that all datamapper repo
+# clones reside in the same directory. You can use the Gemfile.local like
+# so for running any bundle command:
+#
+#   BUNDLE_GEMFILE=Gemfile.local bundle foo
+#
+# You can also specify which adapter(s) should be part of the bundle by
+# setting an environment variable. This of course also works when using the
+# Gemfile.local
+#
+#   bundle foo                        # dm-sqlite-adapter
+#
+#   ADAPTER=mysql bundle foo          # dm-mysql-adapter
+#
+#   ADAPTERS=sqlite,mysql bundle foo  # dm-sqlite-adapter, dm-mysql-adapter
+#
+# Of course you can also use the ADAPTER(S) variable when using the
+# Gemfile.local and running specs against selected adapters.
+#
+# For easily working with adapters supported on your machine, it's
+# recommended that you first install all adapters that you are planning to
+# use or work on by doing something like
+#
+#   ADAPTERS=sqlite,mysql,postgres bundle install
+#
+# This will clone the various repositories and make them available to
+# bundler. Once you have them installed you can easily switch between
+# adapters for the various development tasks. Running something like
+#
+#   ADAPTER=mysql bundle exec rake spec
+#
+# will make sure that the dm-mysql-adapter is part of the bundle, and will
+# be used when running the specs.
+#
+# You can also specify which plugin(s) should be part of the bundle by
+# setting an environment variable. This also works when using the
+# Gemfile.local
+#
+#   bundle foo                                 # dm-migrations
+#
+#   PLUGINS=dm-validations bundle foo          # dm-migrations,
+#                                              # dm-validations
+#
+#   PLUGINS=dm-validations,dm-types bundle foo # dm-migrations,
+#                                              # dm-validations,
+#                                              # dm-types
+#
+# Of course you can combine the PLUGIN(S) and ADAPTER(S) env vars to run
+# specs for certain adapter/plugin combinations.
+#
+# Finally, to speed up running specs and other tasks, it's recommended to
+# run
+#
+#   bundle lock
+#
+# after running 'bundle install' for the first time. This will make
+# 'bundle exec' run a lot faster compared to the unlocked version. With an
+# unlocked bundle you would typically just run 'bundle install' from time
+# to time to fetch the latest sources from upstream. When you locked your
+# bundle, you need to run
+#
+#   bundle install --relock
+#
+# to make sure to fetch the latest updates and then lock the bundle again.
+# Gemfile.lock is added to the .gitignore file, so you don't need to worry
+# about accidentally checking it into version control.
+
+source :rubygems
+
+DATAMAPPER = 'http://github.com/datamapper'
+DM_VERSION = '~> 1.0.0'
+DO_VERSION = '~> 0.10.2'
+DM_DO_ADAPTERS = %w[ sqlite postgres mysql oracle sqlserver ]
+RAILS = 'http://github.com/rails/rails.git'
+
+if ENV['EXTLIB']
+  gem 'extlib',		'~> 0.9.15', :git => '#{DATAMAPPER}/extlib.git'
+else
+  gem 'activesupport',  '~> 3.0.0', :git => RAILS,
+                                    :branch => '3-0-stable',
+                                    :require => nil
+end
+
+gem 'bcrypt-ruby',	'~> 2.1.0'
+
+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
+  case RUBY_PLATFORM
+  when 'java'
+    gem 'maruku',	'~> 0.6.0'
+  else
+    gem 'rdiscount',	'~> 1.6.3'
+  end
+
+  gem 'rake',		'~> 0.8.7'
+  gem 'ore',		'~> 0.2.0'
+  gem 'ore-tasks',	'~> 0.1.2'
+  gem 'rspec',		'~> 2.0.0'
+  gem 'yard',		'~> 0.6.0'
+end
+
+group :datamapper do
+  # We need this because we want to pin these dependencies to their git
+  # master sources
+
+  adapters = ENV['ADAPTER'] || ENV['ADAPTERS']
+  adapters = adapters.to_s.tr(',', ' ').split.uniq - %w[ in_memory ]
+
+  if (do_adapters = DM_DO_ADAPTERS & adapters).any?
+    options = {}
+    options[:git] = "#{DATAMAPPER}/do.git" if ENV['DO_GIT'] == 'true'
+
+    gem 'data_objects',  DO_VERSION, options.dup
+
+    do_adapters.each do |adapter|
+      adapter = 'sqlite3' if adapter == 'sqlite'
+      gem "do_#{adapter}", DO_VERSION, options.dup
+    end
+
+    gem 'dm-do-adapter', DM_VERSION, :git => "#{DATAMAPPER}/dm-do-adapter.git"
+  end
+
+  adapters.each do |adapter|
+    gem "dm-#{adapter}-adapter", DM_VERSION, :git => "#{DATAMAPPER}/dm-#{adapter}-adapter.git"
+  end
+
+  plugins = ENV['PLUGINS'] || ENV['PLUGIN']
+  plugins = plugins.to_s.tr(',', ' ').split.push('dm-migrations').uniq
+
+  plugins.each do |plugin|
+    gem plugin, DM_VERSION, :git => "#{DATAMAPPER}/#{plugin}.git"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2010 Hal Brodigan
+
+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,69 @@
+# dm-is-authenticatable
+
+* [github.com/postmodern/dm-is-authenticatable](http://github.com/postmodern/dm-is-authenticatable)
+* [github.com/postmodern/dm-is-authenticatable/issues](http://github.com/postmodern/dm-is-authenticatable/issues)
+* Postmodern (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).
+
+## Example
+
+    require 'dm-core'
+    require 'dm-is-authenticatable'
+  
+    class User
+  
+      include DataMapper::Resource
+
+      is :authenticatable
+    
+      # Name of the Licence
+      property :name, String
+    
+    end
+  
+    user = User.new(:name => 'bob')
+    user.password = 'secret'
+    # => "secret"
+
+Validates confirmation of the password:
+
+    user.valid?
+    # => false
+
+    user.password_confirmation = 'secret'
+    # => "secret"
+
+    user.valid?
+    # => true
+
+Uses BCryptHash by default:
+
+    user.encrypted_password
+    # => "$2a$10$kC./7/ClA7mJwqqWhO02hu7//ybbsn7QKi4p5PZN0R1.XeQ/oYBAC"
+
+Handles finding and authenticating resources in the database:
+
+    user.save
+    # => true
+
+    User.authenticate(:name => 'bob', :password => 'secret')
+    # => #<User: ...>
+
+## Requirements
+
+* [dm-core](http://github.com/datamapper/dm-core/) ~> 1.0.0
+
+## Install
+
+    $ sudo gem install dm-is-authenticatable
+
+## License
+
+See {file:LICENSE.txt} for license information.
+

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'ore/tasks'
+Ore::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/dm-is-authenticatable.gemspec

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  STDERR.puts "The 'dm-is-authenticatable.gemspec' file requires Ore."
+  STDERR.puts "Run `gem install ore` to install Ore."
+end

data/gemspec.yml

@@ -0,0 +1,22 @@
+name: dm-is-authenticatable
+version: 0.1.0
+summary: DataMapper plugin for adding authentication to models.
+description:
+  A DataMapper plugin for adding authentication and encrypted passwords to
+  your DataMapper models.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/dm-is-authenticatable
+has_yard: true
+
+dependencies:
+  bcrypt-ruby: ~> 2.1.0
+  dm-core: ~> 1.0.0
+  dm-types: ~> 1.0.0
+  dm-validations: ~> 1.0.0
+
+development_dependencies:
+  bundler: ~> 1.0.0
+  yard: ~> 0.6.0

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

@@ -0,0 +1,80 @@
+require 'dm-types/bcrypt_hash'
+require 'dm-validations'
+
+module DataMapper
+  module Is
+    module Authenticatable
+      class UnknownResource < RuntimeError
+      end
+
+      def is_authenticatable
+        # The encrypted password
+        property :encrypted_password, DataMapper::Property::BCryptHash
+    
+        extend DataMapper::Is::Authenticatable::ClassMethods
+        include DataMapper::Is::Authenticatable::InstanceMethods
+
+        validates_confirmation_of :password
+      end
+
+      module ClassMethods
+        #
+        # Finds and authenticates a resource.
+        #
+        # @param [Hash] attributes
+        #   The attributes to search with.
+        #
+        # @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.
+        #
+        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
+          end
+        end
+      end
+
+      module InstanceMethods
+        # The clear-text password
+        attr_reader :password
+
+        # The confirmed clear-text password
+        attr_accessor :password_confirmation
+
+        #
+        # Updates the password of the resource.
+        #
+        # @param [String] new_password
+        #   The new password for the resource.
+        #
+        # @return [String]
+        #   The new password of the resource.
+        #
+        def password=(new_password)
+          self.encrypted_password = new_password
+          @password = new_password
+        end
+      end
+    end
+  end
+end

data/lib/dm-is-authenticatable.rb

@@ -0,0 +1,4 @@
+require 'dm-core'
+require 'dm-is-authenticatable/is/authenticatable'
+
+DataMapper::Model.append_extensions DataMapper::Is::Authenticatable

data/spec/integration/authenticatable_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+require 'integration/models/user'
+
+describe DataMapper::Is::Authenticatable do
+  before(:all) do
+    User.auto_migrate!
+  end
+
+  let(:password) { 'secret' }
+
+  subject { User.new(:name => 'bob') }
+
+  it "should define the encrypted_password property" do
+    subject.class.properties.should be_named(:encrypted_password)
+  end
+
+  it "should not have a default password" do
+    subject.password.should be_nil
+  end
+
+  it "should not have an encrypted password by default" do
+    subject.encrypted_password.should be_nil
+  end
+
+  it "should allow setting the password" do
+    subject.password = password
+    subject.password.should == password
+  end
+
+  it "should update the encrypted password when setting the password" do
+    subject.password = password
+    subject.encrypted_password.should == password
+  end
+
+  it "should require password confirmation" do
+    subject.password = password
+    subject.should_not be_valid
+  end
+
+  it "should require the confirmation password match the password" do
+    subject.password = password
+    subject.password_confirmation = 'fail'
+
+    subject.should_not be_valid
+  end
+
+  it "should validate confirmed passwords" do
+    subject.password = password
+    subject.password_confirmation = password
+
+    subject.should be_valid
+  end
+
+  describe "authenticate" do
+    before(:all) do
+      user = User.new(:name => 'joe')
+      user.password = password
+      user.save!
+    end
+
+    let(:name) { 'joe' }
+
+    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)
+    end
+
+    it "should allow authenticating with a password" do
+      user = subject.authenticate(:name => name, :password => password)
+      user.name.should == name
+    end
+
+    it "should not authenticate with an incorrect password" do
+      user = subject.authenticate(:name => name, :password => 'fail')
+
+      user.should be_nil
+    end
+  end
+end

data/spec/integration/models/user.rb

@@ -0,0 +1,14 @@
+require 'dm-core'
+require 'dm-is-authenticatable'
+
+class User
+
+  include DataMapper::Resource
+
+  is :authenticatable
+
+  property :id, Serial
+
+  property :name, String
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'dm-core/spec/setup'
+require 'dm-core/spec/lib/adapter_helpers'
+
+require 'dm-is-authenticatable'
+
+DataMapper::Spec.setup
+
+RSpec.configure do |config|
+  config.extend(DataMapper::Spec::Adapters::Helpers)
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification 
+name: dm-is-authenticatable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-05 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bcrypt-ruby
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: dm-types
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: dm-validations
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: A DataMapper plugin for adding authentication and encrypted passwords to your DataMapper models.
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .rspec
+- .yardopts
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dm-is-authenticatable.gemspec
+- gemspec.yml
+- lib/dm-is-authenticatable.rb
+- lib/dm-is-authenticatable/is/authenticatable.rb
+- spec/integration/authenticatable_spec.rb
+- spec/integration/models/user.rb
+- spec/spec_helper.rb
+has_rdoc: yard
+homepage: http://github.com/postmodern/dm-is-authenticatable
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: dm-is-authenticatable
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: DataMapper plugin for adding authentication to models.
+test_files: 
+- spec/integration/authenticatable_spec.rb