mini_auth 0.2.0 → 0.3.0.beta

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.0
+
+* Add the class method `token` that defines "generate_#{name}_token" and
+  "verify_#{name}_token" methods dynamically.  
+
 ## 0.2.0 (2011-12-19)
 
 * Two attributes `changing_password` and `setting_password` are introduced.

data/README.md

@@ -233,6 +233,33 @@ If your class has a _role_ such as :admin, you should enumerate the accessible a
 For more information about mass assignment security, please refer to the 
 [Mass Assignment](http://guides.rubyonrails.org/security.html#mass-assignment) section of Rails Guides.
 
+
+### Random token
+
+`MiniAuth` module provides an easy way to generate a random token and verify it. 
+
+The class method `token` takes a list of names and defines "generate\_#{name}\_token" and "verify\_#{name}\_token" methods dynamically.
+
+    class User < ActiveRecord::Base
+      include MiniAuth
+      
+      attr_accessible :name, :address, :phone
+      token :auto_login, :mail_confirmation
+    end
+
+By calling `generate_auto_login_token`, you can generate a random hex string of 32 letters and set it to the `auto_login_token` column.
+
+    d = User.new(:name => "david")
+    d.generate_auto_login_token
+    d.auto_login_token                 # => "8d21d3830a3ef2aafe8a7c0388493883"
+
+Call `verify_auto_login_token` to verify it. For example, 
+
+    d.verify_auto_login_token(params[:token])
+
+returns `true` if `params[:token]` equals to the generated token. Otherwise it returns `false`.
+
+
 License
 -------
 

data/lib/mini_auth.rb

@@ -52,19 +52,39 @@ module MiniAuth
     end
   end
   
-  def authenticate(raw_password)
-    if password_digest && BCrypt::Password.new(password_digest) == raw_password
-      self
-    else
-      false
+  module InstanceMethods
+    def authenticate(raw_password)
+      if password_digest && BCrypt::Password.new(password_digest) == raw_password
+        self
+      else
+        false
+      end
     end
-  end
   
-  def changing_password?
-    !!changing_password
+    def changing_password?
+      !!changing_password
+    end
+    
+    def setting_password?
+      !!setting_password
+    end
   end
   
-  def setting_password?
-    !!setting_password
+  module ClassMethods
+    def token(*names)
+      names.each do |name|
+        self.class_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def generate_#{name}_token
+            send("#{name}_token=", SecureRandom.hex)
+          end
+        METHOD
+        
+        self.class_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def verify_#{name}_token(token)
+            token && token == self.send("#{name}_token")
+          end
+        METHOD
+      end
+    end
   end
 end

data/lib/mini_auth/version.rb

@@ -1,3 +1,3 @@
 module MiniAuth
-  VERSION = "0.2.0"
+  VERSION = "0.3.0.beta"
 end

data/mini_auth.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "bcrypt-ruby"
   s.add_development_dependency "rspec-rails", "~> 2.7.0"
   s.add_development_dependency "sqlite3"
+  s.add_development_dependency "database_cleaner"
 end

data/spec/fake_app.rb

@@ -10,8 +10,12 @@ 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 }
-    create_table(:administrators) { |t| t.string :name; t.string :password_digest, :null => false }
+    create_table(:users) do |t|
+      t.string :name
+      t.string :password_digest
+      t.string :auto_login_token
+      t.string :mail_confirmation_token
+    end
   end
 end
 
@@ -25,4 +29,5 @@ class User < ActiveRecord::Base
   include MiniAuth
   
   attr_accessible :name
+  token :auto_login, :mail_confirmation
 end

data/spec/mini_auth/change_password_spec.rb

@@ -2,7 +2,9 @@ require 'spec_helper'
 
 describe "change_password" do
   let(:user) do
-    u = User.create!(:name => 'alice', :new_password => 'password')
+    u = User.new(:name => 'alice', :password => 'password')
+    u.setting_password = true
+    u.save!
     u.changing_password = true
     u
   end

data/spec/mini_auth/token_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe "MiniAuth.token" do
+  let(:user) do
+    User.create!(:name => 'alice')
+  end
+  
+  it "should generate auto_login_token" do
+    expect {
+      user.generate_auto_login_token
+    }.to change { user.auto_login_token }
+    
+    user.auto_login_token.should_not be_nil
+    user.auto_login_token.length.should == 32
+  end
+  
+  it "should generate mail_confirmation_token" do
+    expect {
+      user.generate_mail_confirmation_token
+    }.to change { user.mail_confirmation_token }
+    
+    user.mail_confirmation_token.should_not be_nil
+    user.mail_confirmation_token.length.should == 32
+  end
+  
+  it "should verify auto_login_token" do
+    user.generate_auto_login_token
+    
+    user.verify_auto_login_token(user.auto_login_token).should be_true
+  end
+  
+  it "should reject wrong token" do
+    user.verify_auto_login_token('z' * 32).should be_false
+  end
+end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ ENV["RAILS_ENV"] = "test"
 
 require "rails/all"
 require "rspec/rails"
+require 'database_cleaner'
 require "mini_auth"
 
 # Pull in the fake rails app
@@ -16,4 +17,17 @@ RSpec.configure do |config|
   require 'rspec/expectations'
   config.include RSpec::Matchers
   config.mock_with :rspec
+  
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation, :except => %w())
+  end
+  
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+  
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: mini_auth
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0.beta
+  prerelease: 6
 platform: ruby
 authors:
 - Tsutomu Kuroda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-19 00:00:00.000000000 Z
+date: 2011-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &17342020 !ruby/object:Gem::Requirement
+  requirement: &21780380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *17342020
+  version_requirements: *21780380
 - !ruby/object:Gem::Dependency
   name: bcrypt-ruby
-  requirement: &17268340 !ruby/object:Gem::Requirement
+  requirement: &21779500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17268340
+  version_requirements: *21779500
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &17267280 !ruby/object:Gem::Requirement
+  requirement: &21778600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *17267280
+  version_requirements: *21778600
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &17266540 !ruby/object:Gem::Requirement
+  requirement: &21778080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17266540
+  version_requirements: *21778080
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &21777360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21777360
 description: A minimal authentication module for Rails
 email:
 - t-kuroda@oiax.jp
@@ -76,6 +87,7 @@ files:
 - spec/mini_auth/change_password_spec.rb
 - spec/mini_auth/password_digest_spec.rb
 - spec/mini_auth/setting_password_spec.rb
+- spec/mini_auth/token_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
@@ -92,9 +104,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: mini_auth
 rubygems_version: 1.8.10