mini_auth 0.1.0.pre

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+log/*
+

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rails", "~> 3.1.0"

data/README.md

@@ -0,0 +1,58 @@
+mini_auth
+=========
+
+A minimal authentication module for Rails
+
+Install
+-------
+
+Add to your Gemfile:
+
+    gem "mini_auth"
+
+or install as a plugin
+
+    $ cd RAILS_ROOT
+    $ rails plugin install git://github.com/kuroda/mini_auth.git
+
+Usage
+-----
+
+    class CreateUsers < ActiveRecord::Migration
+      def change
+        create_table :users do |t|
+          t.string :name, :null => false
+          t.string :password_digest, :null => true
+    
+          t.timestamps
+        end
+      end
+    end
+    
+    class User < ActiveRecord::Base
+      include MiniAuth
+    end
+    
+    a = User.new(:name => "alice", :password => "hotyoga")
+    
+    a.save                              # => true
+    a.password_digest                   # => "$2a$10$F5YbEd..."
+    a.authenticate("hotyoga)            # => true
+    
+    a.update_attributes :name => "Alice"
+    a.authenticate("hotyoga")           # => true
+    
+    b = User.new(:name => "bob")
+    
+    b.password = ""
+    b.valid?                            # => false
+    b.errors[:password]                 # => "can't be blank"
+
+    b.password = nil
+    b.valid?                            # => true
+    b.save!
+    b.password_digest                   # => nil
+    b.authenticate(nil)                 # => false
+
+    b.update_attributes :password_digest => 'dummy'
+    b.password_digest                   # => nil (unchanged)

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/lib/mini_auth/version.rb

@@ -0,0 +1,3 @@
+module MiniAuth
+  VERSION = "0.1.0.pre"
+end

data/lib/mini_auth.rb

@@ -0,0 +1,26 @@
+require "mini_auth/version"
+require "bcrypt"
+
+module MiniAuth
+  extend ActiveSupport::Concern
+  
+  included do
+    attr_accessor :password
+    
+    validate do
+      if password && password.blank?
+        errors.add(:password, :blank)
+      end
+    end
+    
+    before_save do
+      if password
+        self.password_digest = BCrypt::Password.create(password)
+      end
+    end
+  end
+  
+  def authenticate(password)
+    password_digest && BCrypt::Password.new(password_digest) == password
+  end
+end

data/mini_auth.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "mini_auth/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mini_auth"
+  s.version     = MiniAuth::VERSION
+  s.authors     = ["Tsutomu Kuroda"]
+  s.email       = ["t-kuroda@oiax.jp"]
+  s.homepage    = ""
+  s.summary     = %q{A minimal authentication module for Rails}
+  s.description = %q{A minimal authentication module for Rails}
+
+  s.rubyforge_project = "mini_auth"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
+  s.add_runtime_dependency "bcrypt-ruby"
+end

data/spec/fake_app.rb

@@ -0,0 +1,25 @@
+# Establish connection to the database running on memory
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => ":memory:"
+)
+
+# Discard ActiveRecord's log
+ActiveRecord::Base.logger = Logger.new('/dev/null')
+
+# Define migration class
+class CreateAllTables < ActiveRecord::Migration
+  def change
+    create_table(:users) { |t| t.string :name; t.string :password_digest }
+  end
+end
+
+# Run migrations
+migration = CreateAllTables.new
+migration.verbose = false
+migration.change
+
+# Models
+class User < ActiveRecord::Base
+  include MiniAuth
+end

data/spec/mini_auth/authenticate_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe "authenticate" do
+  it "should authenticate with a valid password" do
+    u = User.new(:name => 'alice', :password => 'hotyoga')
+    u.save!
+    
+    u.authenticate('hotyoga').should be_true
+  end
+  
+  it "should not authenticate with a wrong password" do
+    u = User.new(:name => 'alice', :password => 'hotyoga')
+    u.save!
+    
+    u.authenticate('wrong').should be_false
+  end
+  
+  it "should not authenticate with ni; password" do
+    u = User.new(:name => 'alice', :password => nil)
+    u.save!
+    
+    u.authenticate(nil).should be_false
+  end
+end

data/spec/mini_auth/password_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe "password" do
+  it "should accept nil password" do
+    u = User.new(:name => 'alice', :password => nil)
+    u.should be_valid
+  end
+  
+  it "should reject blank password" do
+    u = User.new(:name => 'alice', :password => '')
+    u.should_not be_valid
+    u.should have(1).error_on(:password)
+    u.errors[:password].first.should == "can't be blank"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# Configure Rails envinronment
+ENV["RAILS_ENV"] = "test"
+
+require "rails/all"
+require "rspec/rails"
+require "mini_auth"
+
+# Pull in the fake rails app
+require 'fake_app'
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Configure RSpec
+RSpec.configure do |config|
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: mini_auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Tsutomu Kuroda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &11513420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11513420
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &11512560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11512560
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &11510640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11510640
+- !ruby/object:Gem::Dependency
+  name: bcrypt-ruby
+  requirement: &11509260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11509260
+description: A minimal authentication module for Rails
+email:
+- t-kuroda@oiax.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/mini_auth.rb
+- lib/mini_auth/version.rb
+- mini_auth.gemspec
+- spec/fake_app.rb
+- spec/mini_auth/authenticate_spec.rb
+- spec/mini_auth/password_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: mini_auth
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A minimal authentication module for Rails
+test_files: []