letmein 0.1.1 → 0.1.2

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.8.7
+  - 1.9.2

data/Gemfile.lock

@@ -1,75 +1,90 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    abstract (1.0.0)
-    actionmailer (3.0.5)
-      actionpack (= 3.0.5)
-      mail (~> 2.2.15)
-    actionpack (3.0.5)
-      activemodel (= 3.0.5)
-      activesupport (= 3.0.5)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.4)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.13)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.5)
-      activesupport (= 3.0.5)
-      builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activerecord (3.0.5)
-      activemodel (= 3.0.5)
-      activesupport (= 3.0.5)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.5)
-      activemodel (= 3.0.5)
-      activesupport (= 3.0.5)
-    activesupport (3.0.5)
-    arel (2.0.9)
-    bcrypt-ruby (2.1.4)
-    builder (2.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
+    actionmailer (3.1.0)
+      actionpack (= 3.1.0)
+      mail (~> 2.3.0)
+    actionpack (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.0.3)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.0)
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    bcrypt-ruby (3.0.0)
+    builder (3.0.0)
+    erubis (2.7.0)
     git (1.2.5)
-    i18n (0.5.0)
+    hike (1.2.1)
+    i18n (0.6.0)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    mail (2.2.15)
-      activesupport (>= 2.3.6)
+    mail (2.3.0)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.16)
-    polyglot (0.3.1)
-    rack (1.2.2)
-    rack-mount (0.6.13)
+    multi_json (1.0.3)
+    polyglot (0.3.2)
+    rack (1.3.2)
+    rack-cache (1.0.3)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
       rack (>= 1.0.0)
-    rack-test (0.5.7)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.0.5)
-      actionmailer (= 3.0.5)
-      actionpack (= 3.0.5)
-      activerecord (= 3.0.5)
-      activeresource (= 3.0.5)
-      activesupport (= 3.0.5)
+    rails (3.1.0)
+      actionmailer (= 3.1.0)
+      actionpack (= 3.1.0)
+      activerecord (= 3.1.0)
+      activeresource (= 3.1.0)
+      activesupport (= 3.1.0)
       bundler (~> 1.0)
-      railties (= 3.0.5)
-    railties (3.0.5)
-      actionpack (= 3.0.5)
-      activesupport (= 3.0.5)
+      railties (= 3.1.0)
+    railties (3.1.0)
+      actionpack (= 3.1.0)
+      activesupport (= 3.1.0)
+      rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
-      thor (~> 0.14.4)
-    rake (0.8.7)
-    sqlite3 (1.3.3)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2)
+    rdoc (3.9.4)
+    sprockets (2.0.0)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    sqlite3 (1.3.4)
     thor (0.14.6)
-    treetop (1.4.9)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.25)
+    tzinfo (0.3.29)
 
 PLATFORMS
   ruby

data/README.md

@@ -14,7 +14,7 @@ If you want to authenticate *User* with database fields *email*, *password_hash*
     
     LetMeIn.configure do |conf|
       conf.model      = 'Account'
-      conf.identifier = 'username'
+      conf.attribute  = 'username'
       conf.password   = 'password_crypt'
       conf.salt       = 'salty_salt
     end
@@ -75,11 +75,27 @@ Yes, you can do that too. Let's assume you also want to authenticate admins that
 
     LetMeIn.configure do |conf|
       conf.models     = ['User', 'Admin']
-      conf.identifier = ['email', 'username']
+      conf.attributes = ['email', 'username']
     end
     
 Bam! You're done. Now you have an AdminSession object that will use *username* and *password* to authenticate.
 
+Overriding Session Authentication
+=================================
+By default user will be logged in if provided email and password match. If you need to add a bit more logic to that you'll need to create your own session object. In the following example we do an additional check to see if user is 'approved' before letting him in.
+
+    class MySession < LetMeIn::Session
+      @model, @attribute = 'User', 'email' # need to know what model we're validating
+      
+      def authenticate
+        super # need to authenticate with email/password first
+        if user && user.is_approved?
+          # adding a validation error will prevent login
+          errors.add :base, 'You are not approved yet' 
+        end
+      end
+    end
+
 Copyright
 =========
 (c) 2011 Oleg Khabarov, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/letmein.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{letmein}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Oleg Khabarov"]
-  s.date = %q{2011-08-10}
+  s.date = %q{2011-09-09}
   s.description = %q{minimalistic authentication}
   s.email = %q{oleg@khabarov.ca}
   s.extra_rdoc_files = [
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",

data/lib/letmein.rb

@@ -17,11 +17,11 @@ module LetMeIn
   #     conf.identifier = 'username'
   #   end
   class Config
-    ACCESSORS = %w(models identifiers passwords salts)
+    ACCESSORS = %w(models attributes passwords salts)
     attr_accessor *ACCESSORS
     def initialize
       @models       = ['User']
-      @identifiers  = ['email']
+      @attributes   = ['email']
       @passwords    = ['password_hash']
       @salts        = ['password_salt']
     end
@@ -32,84 +32,73 @@ module LetMeIn
     end
   end
   
-  def self.config
-    @config ||= Config.new
-  end
-  
-  def self.configure
-    yield config
-  end
-  
-  def self.initialize
+  # LetMeIn::Session object. Things like UserSession are created
+  # automatically after the initialization
+  class Session
     
-    def self.accessor(name, index = 0)
-      name = name.to_s.pluralize
-      self.config.send(name)[index] || self.config.send(name)[0]
+    # class MySession < LetMeIn::Session
+    #   @model      = 'User'
+    #   @attribute  = 'email'
+    # end
+    class << self
+      attr_accessor :model, :attribute
     end
     
-    self.config.models.each do |model|
-      klass = model.constantize rescue next
-      
-      klass.send :include, LetMeIn::Model
+    include ActiveModel::Validations
+    
+    attr_accessor :login,       # test@test.test
+                  :password,    # secretpassword
+                  :object       # authenticated object
+                  
+    validate :authenticate
+    
+    def initialize(params = { })
+      self.class.model      ||= self.class.to_s.gsub('Session', '') || LetMeIn.config.models.first
+      self.class.attribute  ||= LetMeIn.accessor(:attribute, LetMeIn.config.models.index(self.class.model))
+      self.login      = params[:login] || params[self.class.attribute.to_sym]
+      self.password   = params[:password]
+    end
+    
+    def save
+      self.valid?
+    end
+    
+    def save!
+      save || raise(LetMeIn::Error, 'Failed to authenticate')
+    end
+    
+    def self.create(params = {})
+      object = self.new(params); object.save; object
+    end
+    
+    def self.create!(params = {})
+      object = self.new(params); object.save!; object
+    end
+    
+    def method_missing(method_name, *args)
+      case method_name.to_s
+        when self.class.attribute         then self.login
+        when "#{self.class.attribute}="   then self.login = args[0]
+        when self.class.model.underscore  then self.object
+        else super
+      end
+    end
+    
+    def authenticate
+      p = LetMeIn.accessor(:password, LetMeIn.config.models.index(self.class.model))
+      s = LetMeIn.accessor(:salt, LetMeIn.config.models.index(self.class.model))
       
-      Object.const_set("#{model.to_s.camelize}Session", Class.new do
-        include ActiveModel::Validations
-        attr_accessor :identifier, :password, :authenticated_object
-        validate :authenticate
-        
-        def initialize(params = { })
-          unless params.blank?
-            i = LetMeIn.accessor(:identifier, LetMeIn.config.models.index(self.class.to_s.gsub('Session','')))
-            self.identifier = params[:identifier] || params[i.to_sym]
-            self.password   = params[:password]
-          end
-        end
-        
-        def save
-          self.valid?
-        end
-        
-        def save!
-          save || raise(LetMeIn::Error, 'Failed to authenticate')
-        end
-        
-        def self.create(params = {})
-          object = self.new(params); object.save; object
-        end
-        
-        def self.create!(params = {})
-          object = self.new(params); object.save!; object
-        end
-        
-        def method_missing(method_name, *args)
-          m = self.class.to_s.gsub('Session','')
-          i = LetMeIn.accessor(:identifier, LetMeIn.config.models.index(m))
-          case method_name.to_s
-            when i            then self.identifier
-            when "#{i}="      then self.identifier = args[0]
-            when m.underscore then self.authenticated_object
-            else super
-          end
-        end
-        
-        def authenticate
-          m = self.class.to_s.gsub('Session','')
-          i = LetMeIn.accessor(:identifier, LetMeIn.config.models.index(m))
-          p = LetMeIn.accessor(:password, LetMeIn.config.models.index(m))
-          s = LetMeIn.accessor(:password, LetMeIn.config.models.index(m))
-          object = m.constantize.send("find_by_#{i}", self.identifier)
-          self.authenticated_object = if object && !object.send(p).blank? && object.send(p) == BCrypt::Engine.hash_secret(self.password, object.send(s))
-            object
-          else
-            errors.add :base, 'Failed to authenticate'
-            nil
-          end
-        end
-        
-        def to_key
-          nil
-        end
-      end)
+      object = self.class.model.constantize.send("find_by_#{self.class.attribute}", self.login)
+      self.object = if object && !object.send(p).blank? && object.send(p) == BCrypt::Engine.hash_secret(self.password, object.send(s))
+        object
+      else
+        errors.add :base, 'Failed to authenticate'
+        nil
+      end
+    end
+    
+    def to_key
+      nil
     end
   end
   
@@ -130,4 +119,25 @@ module LetMeIn
       end
     end
   end
+  
+  def self.config
+    @config ||= Config.new
+  end
+  
+  def self.configure
+    yield config
+  end
+  
+  def self.initialize
+    def self.accessor(name, index = 0)
+      name = name.to_s.pluralize
+      self.config.send(name)[index] || self.config.send(name)[0]
+    end
+    
+    self.config.models.each do |model|
+      klass = model.constantize rescue next
+      klass.send :include, LetMeIn::Model
+      Object.const_set("#{model.to_s.camelize}Session", Class.new(LetMeIn::Session))
+    end
+  end
 end

data/test/letmein_test.rb

@@ -10,7 +10,23 @@ $stdout = StringIO.new
 class User  < ActiveRecord::Base ; end
 class Admin < ActiveRecord::Base ; end
 
+class OpenSession < LetMeIn::Session
+  @model, @attribute = 'User', 'email'
+  def authenticate
+    super
+  end
+end
+
+class ClosedSession < LetMeIn::Session
+  @model, @attribute = 'User', 'email'
+  def authenticate
+    super
+    errors.add :base, "You shall not pass #{user.email}"
+  end
+end
+
 class LetMeInTest < Test::Unit::TestCase
+  
   def setup
     ActiveRecord::Base.logger
     ActiveRecord::Schema.define(:version => 1) do
@@ -32,7 +48,7 @@ class LetMeInTest < Test::Unit::TestCase
     remove_session_classes
     LetMeIn.configure do |c|
       c.models      = ['User']
-      c.identifiers = ['email']
+      c.attributes  = ['email']
       c.passwords   = ['password_hash']
       c.salts       = ['password_salt']
     end
@@ -43,7 +59,7 @@ class LetMeInTest < Test::Unit::TestCase
     remove_session_classes
     LetMeIn.configure do |c|
       c.models      = ['User', 'Admin']
-      c.identifiers = ['email', 'username']
+      c.attributes  = ['email', 'username']
       c.passwords   = ['password_hash', 'pass_hash']
       c.salts       = ['password_salt', 'pass_salt']
     end
@@ -65,7 +81,7 @@ class LetMeInTest < Test::Unit::TestCase
   # -- Tests ----------------------------------------------------------------
   def test_default_configuration_initialization
     assert_equal ['User'],          LetMeIn.config.models
-    assert_equal ['email'],         LetMeIn.config.identifiers
+    assert_equal ['email'],         LetMeIn.config.attributes
     assert_equal ['password_hash'], LetMeIn.config.passwords
     assert_equal ['password_salt'], LetMeIn.config.salts
   end
@@ -73,12 +89,12 @@ class LetMeInTest < Test::Unit::TestCase
   def test_custom_configuration_initialization
     LetMeIn.configure do |c|
       c.model       = 'Account'
-      c.identifier  = 'username'
+      c.attribute   = 'username'
       c.password    = 'encrypted_pass'
       c.salt        = 'salt'
     end
     assert_equal ['Account'],         LetMeIn.config.models
-    assert_equal ['username'],        LetMeIn.config.identifiers
+    assert_equal ['username'],        LetMeIn.config.attributes
     assert_equal ['encrypted_pass'],  LetMeIn.config.passwords
     assert_equal ['salt'],            LetMeIn.config.salts
   end
@@ -101,15 +117,15 @@ class LetMeInTest < Test::Unit::TestCase
   def test_session_initialization
     assert defined?(UserSession)
     session = UserSession.new(:email => 'test@test.test', :password => 'pass')
-    assert_equal 'test@test.test', session.identifier
+    assert_equal 'test@test.test', session.login
     assert_equal 'test@test.test', session.email
     assert_equal 'pass', session.password
     
     session.email = 'new_user@test.test'
-    assert_equal 'new_user@test.test', session.identifier
+    assert_equal 'new_user@test.test', session.login
     assert_equal 'new_user@test.test', session.email
     
-    assert_equal nil, session.authenticated_object
+    assert_equal nil, session.object
     assert_equal nil, session.user
   end
   
@@ -117,15 +133,15 @@ class LetMeInTest < Test::Unit::TestCase
     init_custom_configuration
     assert defined?(AdminSession)
     session = AdminSession.new(:username => 'admin', :password => 'test_pass')
-    assert_equal 'admin', session.identifier
+    assert_equal 'admin', session.login
     assert_equal 'admin', session.username
     assert_equal 'test_pass', session.password
     
     session.username = 'new_admin'
-    assert_equal 'new_admin', session.identifier
+    assert_equal 'new_admin', session.login
     assert_equal 'new_admin', session.username
     
-    assert_equal nil, session.authenticated_object
+    assert_equal nil, session.object
     assert_equal nil, session.admin
   end
   
@@ -133,7 +149,7 @@ class LetMeInTest < Test::Unit::TestCase
     user = User.create!(:email => 'test@test.test', :password => 'pass')
     session = UserSession.create(:email => user.email, :password => 'pass')
     assert session.errors.blank?
-    assert_equal user, session.authenticated_object
+    assert_equal user, session.object
     assert_equal user, session.user
   end
   
@@ -142,7 +158,7 @@ class LetMeInTest < Test::Unit::TestCase
     admin = Admin.create!(:username => 'admin', :password => 'pass')
     session = AdminSession.create(:username => admin.username, :password => 'pass')
     assert session.errors.blank?
-    assert_equal admin, session.authenticated_object
+    assert_equal admin, session.object
     assert_equal admin, session.admin
   end
   
@@ -151,7 +167,7 @@ class LetMeInTest < Test::Unit::TestCase
     session = UserSession.create(:email => user.email, :password => 'bad_pass')
     assert session.errors.present?
     assert_equal 'Failed to authenticate', session.errors[:base].first
-    assert_equal nil, session.authenticated_object
+    assert_equal nil, session.object
     assert_equal nil, session.user
   end
   
@@ -163,7 +179,7 @@ class LetMeInTest < Test::Unit::TestCase
     rescue LetMeIn::Error => e
       assert_equal 'Failed to authenticate', e.to_s
     end
-    assert_equal nil, session.authenticated_object
+    assert_equal nil, session.object
   end
   
   def test_session_authentication_on_blank_object
@@ -174,6 +190,23 @@ class LetMeInTest < Test::Unit::TestCase
     rescue LetMeIn::Error => e
       assert_equal 'Failed to authenticate', e.to_s
     end
-    assert_equal nil, session.authenticated_object
+    assert_equal nil, session.object
+  end
+  
+  def test_custom_open_session
+    user = User.create!(:email => 'test@test.test', :password => 'pass')
+    session = OpenSession.new(:email => 'test@test.test', :password => 'bad_pass')
+    assert session.invalid?
+    assert_equal 'Failed to authenticate', session.errors[:base].first
+    session = OpenSession.new(:email => 'test@test.test', :password => 'pass')
+    assert session.valid?
+    assert_equal user, session.user
+  end
+  
+  def test_custom_closed_session
+    user = User.create!(:email => 'test@test.test', :password => 'pass')
+    session = ClosedSession.new(:email => 'test@test.test', :password => 'pass')
+    assert session.invalid?
+    assert_equal 'You shall not pass test@test.test', session.errors[:base].first
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: letmein
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-10 00:00:00.000000000 -04:00
+date: 2011-09-09 00:00:00.000000000 -04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70220938849600 !ruby/object:Gem::Requirement
+  requirement: &70224158884440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70220938849600
+  version_requirements: *70224158884440
 - !ruby/object:Gem::Dependency
   name: bcrypt-ruby
-  requirement: &70220938849040 !ruby/object:Gem::Requirement
+  requirement: &70224158883640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70220938849040
+  version_requirements: *70224158883640
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70220938848460 !ruby/object:Gem::Requirement
+  requirement: &70224158882120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70220938848460
+  version_requirements: *70224158882120
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70220938847900 !ruby/object:Gem::Requirement
+  requirement: &70224158880380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,7 +55,7 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *70220938847900
+  version_requirements: *70224158880380
 description: minimalistic authentication
 email: oleg@khabarov.ca
 executables: []
@@ -64,6 +64,7 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -89,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2973203238153488042
+      hash: -1283525767596471732
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: