devise_custom_authenticatable 0.1.1 → 0.2.0

data/.travis.yml

@@ -4,4 +4,4 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-  - jruby-19mode
+  - jruby

data/CHANGELOG.md

@@ -13,3 +13,8 @@
 ## v0.1.1
 
 * Checked and confirmed that all functionality work with devise >= 2.0
+
+## v0.2.0
+
+* Feature: fail authentication if `#valid_for_custom_authentication?` returns false (use `#skip_custom_strategies` in order to pass to another stategy)
+* Feature: `#after_custom_authentication` method added

data/README.md

@@ -25,7 +25,7 @@ Or install it yourself as:
 
 ## Usage
 
-[Devise](http://github.com/plataformatec/devise) should be already installed and enabled for any resource in your app. Open Devise enabled model and add `:custom_authenticatable`. When strategy is enabled it'll try to call `#valid_for_custom_authentication?` method on resource model with password. Define this method and return true in order to authenticate user. If there is no such method for model or it returns false/nil then authentication handling will be passed to next strategy e.g. `:database_authenticatable`, if there is no other strategies left for resource then authentication will be failed. For example:
+[Devise](http://github.com/plataformatec/devise) should be already installed and enabled for any resource in your app. Open Devise enabled model and add `:custom_authenticatable`. When strategy is enabled it'll try to call `#valid_for_custom_authentication?` method on resource model with password. Define this method and return true in order to authenticate user or false in order to fail authentication. If there is no such method for model then authentication handling will be passed to next strategy e.g. `:database_authenticatable`, if there is no other strategies left for resource then authentication will be failed. For example:
 
 ```ruby
     devise :custom_authenticatable, :database_authenticatable, :trackable, :lockable, :timeoutable
@@ -40,7 +40,9 @@ Or install it yourself as:
     end
 ```
 
-This gem also provide handy helper `#authenticated_by_any_custom_strategy?` for managing your custom authentication methods. For example you would like to provide LDAP authentication for users, but also would like to have some dummy password in development environments. You can write something like this:
+###This gem also provide few handy helpers
+
+Use `#authenticated_by_any_custom_strategy?` when for example you would like to provide LDAP authentication for users, but also would like to have some dummy password in development environments. You can write something like this:
 
 ```ruby
     class User
@@ -75,6 +77,25 @@ It will call all `authenticated_by_<strategy_name>_strategy?(password)` in turn
     end
 ```
 
+Use `#skip_custom_strategies` when you would like to conditionaly skip entire custom authentication, so for example in order to provide some custom care for admin users you could write something like this:
+
+```ruby
+    class User
+      devise :custom_authenticatable, :trackable, :lockable, :timeoutable
+      # ...
+
+      def valid_for_custom_authentication?(password)
+        if self.has_role?(:admin)
+          # Your admin user authentication logic goes here and returns either true or false
+        else
+          skip_custom_strategies
+        end
+      end
+    end
+```
+
+Use `#after_custom_authentication` in order to insert your own logic that is only run after the user successfully authenticates
+
 
 ## TODO
 

data/devise_custom_authenticatable.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 2.0"
 
   spec.add_dependency "devise", ">= 2", "< 4"

data/lib/devise/models/custom_authenticatable.rb

@@ -14,5 +14,16 @@ module Devise::Models
       end
     end
 
+    def skip_custom_strategies
+      throw :skip_custom_strategies
+    end
+
+    # A callback initiated after successfully authenticating. This can be
+    # used to insert your own logic that is only run after the user successfully
+    # authenticates.
+    def after_custom_authentication
+
+    end
+
   end
 end

data/lib/devise/strategies/custom_authenticatable.rb

@@ -8,22 +8,11 @@ module Devise::Strategies
       resource  = valid_password? && mapping.to.find_for_authentication(authentication_hash)
       return pass unless resource.respond_to?(:valid_for_custom_authentication?)
 
-      if validate(resource){ resource.valid_for_custom_authentication?(password) }
-        success!(resource)
-      else
-        pass
-      end
-    end
-
-    # Override default Devise::Strategies::Authenticatable#validate method in order to *not* return fail! on flase,
-    # but pass handling to other strategies in stack, e.g default :database_authenticatable or other similar
-    # authentication will be failed with default message anyway if there are no strategies left
-    def validate(resource, &block)
-      if resource && resource.valid_for_authentication?(&block)
-        decorate(resource)
-        true
-      else
-        false
+      catch(:skip_custom_strategies) do
+        if validate(resource){ resource.valid_for_custom_authentication?(password) }
+          resource.after_custom_authentication
+          success!(resource)
+        end
       end
     end
 

data/lib/devise_custom_authenticatable/version.rb

@@ -1,3 +1,3 @@
 module DeviseCustomAuthenticatable
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/devise/models/custom_authenticatable_spec.rb

@@ -1,9 +1,5 @@
 require 'spec_helper'
 
-class CustomAuthenticatableTestClass
-  include Devise::Models::CustomAuthenticatable
-end
-
 describe Devise::Models::CustomAuthenticatable do
   before(:each) do
     @it = CustomAuthenticatableTestClass.new

data/spec/devise/strategies/custom_authenticatable_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Devise::Models::CustomAuthenticatable do
+  before(:each) do
+    @resource = CustomAuthenticatableTestClass.new
+    @it = Devise::Strategies::CustomAuthenticatable.new(env_with_params, :user)
+  end
+
+  describe "#authenticate!" do
+    before(:each) do
+      password_hash = { password: 'password' }
+      @it.stub( password_hash )
+      @it.stub(authentication_hash: password_hash)
+      @it.stub_chain(:mapping, :to, :find_for_authentication).and_return(@resource)
+      @it.stub(:validate) do |resource, &block|
+        expect(resource).to eq @resource
+        block.call
+      end
+    end
+
+    it "should pass to another strategy if #valid_for_custom_authentication? is not defined" do
+      expect(@resource).to receive(:after_custom_authentication).never
+      expect(@it).to receive(:validate).never
+      expect(@it).to receive(:pass).once.and_return('skip')
+      expect(@it.authenticate!).to eq 'skip'
+    end
+
+    it "should pass to another strategy if #skip_custom_strategies called in #valid_for_custom_authentication?" do
+      expect(@resource).to receive(:valid_for_custom_authentication?).with('password') do
+        @resource.skip_custom_strategies
+      end
+      expect(@resource).to receive(:after_custom_authentication).never
+      expect(@it).to receive(:success!).never
+      @it.authenticate!
+    end
+
+    it "should fail if #valid_for_custom_authentication? is defined and return false" do
+      expect(@resource).to receive(:valid_for_custom_authentication?).with('password').and_return(false)
+      expect(@resource).to receive(:after_custom_authentication).never
+      expect(@it).to receive(:pass).never
+      expect(@it).to receive(:success!).never
+      @it.authenticate!
+    end
+
+    it "should return with success! if #valid_for_custom_authentication? is defined and return true" do
+      expect(@resource).to receive(:valid_for_custom_authentication?).with('password').and_return(true)
+      expect(@it).to receive(:pass).never
+      expect(@resource).to receive(:after_custom_authentication).once
+      expect(@it).to receive(:success!).once.with(@resource).and_return('success')
+      expect(@it.authenticate!).to eq 'success'
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -1 +1,2 @@
 require 'devise_custom_authenticatable'
+require 'support/helpers'

data/spec/support/helpers.rb

@@ -0,0 +1,9 @@
+class CustomAuthenticatableTestClass
+  include Devise::Models::CustomAuthenticatable
+end
+
+def env_with_params(path = "/", params = {}, env = {})
+  method = params.delete(:method) || "GET"
+  env = { 'HTTP_VERSION' => '1.1', 'REQUEST_METHOD' => "#{method}" }.merge(env)
+  Rack::MockRequest.env_for("#{path}?#{Rack::Utils.build_query(params)}", env)
+end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: devise_custom_authenticatable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Artūrs Mekšs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-09 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,13 +22,31 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,8 +62,9 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '2'
     - - <
@@ -51,8 +73,9 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '2'
     - - <
@@ -80,32 +103,43 @@ files:
 - lib/devise_custom_authenticatable.rb
 - lib/devise_custom_authenticatable/version.rb
 - spec/devise/models/custom_authenticatable_spec.rb
+- spec/devise/strategies/custom_authenticatable_spec.rb
 - spec/spec_helper.rb
+- spec/support/helpers.rb
 homepage: https://github.com/AMekss/devise_custom_authenticatable
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1558931694658309700
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1558931694658309700
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
-summary: 'Extends Devise with new module :custom_authenticatable, when enabled it
+specification_version: 3
+summary: ! 'Extends Devise with new module :custom_authenticatable, when enabled it
   will call #valid_for_custom_authentication? method on resource model for your customizations'
 test_files:
 - spec/devise/models/custom_authenticatable_spec.rb
+- spec/devise/strategies/custom_authenticatable_spec.rb
 - spec/spec_helper.rb
+- spec/support/helpers.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 12bd7f8777135a62852d2ba22efd0f7cec1a16e6
-  data.tar.gz: 26405720e35ba421a11e456f164096eeb2567527
-SHA512:
-  metadata.gz: 87ced17afe13cdf57cce3938a046045651f06ff7498fa9a0341d2e284fdae4b54b08f5be835db149ad07209ecd87f0baeb8a6dffb32aeb5e2452bcaa470b0a21
-  data.tar.gz: 6bb9e8176658e0aa3d5551071555077c734547b7b4bc606fad84f5c82cad7c7e6b64a432eb9e61554e6a35be7333e636b5057ea6eb19f59a083f3172ae282528