deadbolt 0.1.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'mongo_mapper'
+gem 'bcrypt-ruby'

data/Gemfile.lock

@@ -0,0 +1,27 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activesupport (3.0.7)
+    bcrypt-ruby (2.1.4)
+    bson (1.3.0)
+    builder (2.1.2)
+    i18n (0.5.0)
+    mongo (1.3.0)
+      bson (>= 1.3.0)
+    mongo_mapper (0.9.0)
+      activemodel (~> 3.0.0)
+      activesupport (~> 3.0.0)
+      plucky (~> 0.3.6)
+    plucky (0.3.8)
+      mongo (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bcrypt-ruby
+  mongo_mapper

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2011 J-P Teti
+
+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/Manifest

@@ -0,0 +1,8 @@
+Gemfile
+Gemfile.lock
+LICENSE.txt
+Manifest
+README.md
+README.rdoc
+Rakefile
+lib/deadbolt.rb

data/README.md

@@ -0,0 +1,42 @@
+deadbolt
+===================================================
+
+Deadbolt is a plugin for MongoMapper that lets you easily create super simple (and secure) user models.
+
+Usage
+---------------------------
+
+Using deadbolt is really easy. Just require it in your gemfile (gem 'deadbolt'). Then write your user model like this:
+
+	require 'bcrypt'
+
+	class User
+	  include MongoMapper::Document
+	  plugin Deadbolt
+	end
+	
+That's all you have to do. 
+
+Assumptions
+---------------------------
+Deadbolt assumes that:
+
+* You want users to confirm their password.
+* Your users are identified by their email address.
+
+It **does not** assume that you want to validate the uniqueness of each user's email address. If do you want to, simply add the line `validates_uniqueness_of :email` to your model. You can add whatever other keys and validations you want to your model.
+
+To check that a user successfully logged in, use `User.authenticate(email, password)`. Assuming that the email and password match up, this will return the full user object, including any custom data you've defined. If the email and password do not match up, it will return `nil`.
+
+Contributing
+---------------------------
+
+1. Fork the project.
+2. Make whatever changes you plan on making.
+3. Submit a pull request that accurately describes what you've added or changed and why. NOTE: This does not mean to say *how* you did it. I can read the code.
+
+Credits
+---------------------------
+Original code by J-P Teti.
+
+Special thanks to John Nunemaker for creating MongoMapper and to everyone who has contributed to that project.

data/README.rdoc

@@ -0,0 +1,40 @@
+= deadbolt
+
+Deadbolt is a plugin for MongoMapper that lets you easily create super simple (and secure) user models.
+
+= Usage
+
+Using deadbolt is really easy. Just require it in your gemfile (<tt>gem 'deadbolt'</tt>). Then write your user model like this:
+
+	require 'bcrypt'
+
+	class User
+	  include MongoMapper::Document
+	  plugin Deadbolt
+	end
+	
+That's it!
+
+= Assumptions
+Deadbolt assumes that:
+
+* You want users to confirm their password.
+* Your users are identified by their email address.
+
+It **does not** assume that you want to validate the uniqueness of each user's email address. If do you want to, simply add the line <tt>validates_uniqueness_of :email</tt> to your model. You can add whatever other keys and validations you want to your model.
+
+To check that a user successfully logged in, use <tt>User.authenticate(email, password)</tt>. Assuming that the email and password match up, this will return the full user object, including any custom data you've defined. If the email and password do not match up, it will return <tt>nil</tt>.
+
+= Contributing
+
+1. Fork the project.
+2. Make whatever changes you plan on making.
+3. Submit a pull request that accurately describes what you've added or changed and why. NOTE: This does not mean to say <i>how</i> you did it. I can read the code.
+
+= Credits
+
+Written by J-P Teti.
+Special thanks to John Nunemaker for creating MongoMapper and to everyone who has contributed to that project.
+
+= License
+Licensed under the MIT License, which is found in the file LICENSE.txt. In short: do whatever you feel like with this code.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('deadbolt', '0.1.1') do |g|
+  g.description               = 'Very basic user model as a MongoMapper plugin'
+  g.url                       = 'http://github.com/roboteti/deadbolt'
+  g.author                    = 'J-P Teti'
+  g.email                     = 'roboteti@gmail.com'
+  g.ignore_pattern            = []
+  g.development_dependencies  = ['mongo_mapper', 'bcrypt-ruby']
+  g.runtime_dependencies      = ['mongo_mapper', 'bcrypt-ruby']
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/deadbolt.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{deadbolt}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["J-P Teti"]
+  s.date = %q{2011-04-27}
+  s.description = %q{Very basic user model as a MongoMapper plugin}
+  s.email = %q{roboteti@gmail.com}
+  s.extra_rdoc_files = ["LICENSE.txt", "README.md", "README.rdoc", "lib/deadbolt.rb"]
+  s.files = ["Gemfile", "Gemfile.lock", "LICENSE.txt", "Manifest", "README.md", "README.rdoc", "Rakefile", "lib/deadbolt.rb", "deadbolt.gemspec"]
+  s.homepage = %q{http://github.com/roboteti/deadbolt}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Deadbolt", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{deadbolt}
+  s.rubygems_version = %q{1.7.2}
+  s.summary = %q{Very basic user model as a MongoMapper plugin}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongo_mapper>, [">= 0"])
+      s.add_runtime_dependency(%q<bcrypt-ruby>, [">= 0"])
+      s.add_development_dependency(%q<mongo_mapper>, [">= 0"])
+      s.add_development_dependency(%q<bcrypt-ruby>, [">= 0"])
+    else
+      s.add_dependency(%q<mongo_mapper>, [">= 0"])
+      s.add_dependency(%q<bcrypt-ruby>, [">= 0"])
+      s.add_dependency(%q<mongo_mapper>, [">= 0"])
+      s.add_dependency(%q<bcrypt-ruby>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mongo_mapper>, [">= 0"])
+    s.add_dependency(%q<bcrypt-ruby>, [">= 0"])
+    s.add_dependency(%q<mongo_mapper>, [">= 0"])
+    s.add_dependency(%q<bcrypt-ruby>, [">= 0"])
+  end
+end

data/lib/deadbolt.rb

@@ -0,0 +1,36 @@
+module Deadbolt
+  extend ActiveSupport::Concern
+  
+  included do    
+    attr_accessor   :password
+    attr_protected  :password_hash, :password_salt
+    
+    before_save :encrypt_password
+    
+    key :email,         String, :required => true
+    key :password_hash, String
+    key :password_salt, String
+    
+    validates_presence_of     :password
+    validates_confirmation_of :password
+    
+    self.ensure_index(:email)
+    
+    def self.authenticate(email, password)
+      user = find_by_email(email)
+      if user && user.password_hash == BCrypt::Engine.hash_secret(password, user.password_salt)
+        user
+      else
+        nil
+      end
+    end
+    
+    def encrypt_password
+      if password.present?
+        self.password_salt = BCrypt::Engine.generate_salt
+        self.password_hash = BCrypt::Engine.hash_secret(password, password_salt)
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: deadbolt
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- J-P Teti
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bcrypt-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bcrypt-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Very basic user model as a MongoMapper plugin
+email: roboteti@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+- README.rdoc
+- lib/deadbolt.rb
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Manifest
+- README.md
+- README.rdoc
+- Rakefile
+- lib/deadbolt.rb
+- deadbolt.gemspec
+homepage: http://github.com/roboteti/deadbolt
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Deadbolt
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: deadbolt
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Very basic user model as a MongoMapper plugin
+test_files: []
+