devise_custom_authenticatable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5199866fec3da5794d0ad77e0c99b7270da070c2
+  data.tar.gz: 5a4fbcdd35b2e525e640850f92121376d313e69c
+SHA512:
+  metadata.gz: f3fcc76c27370b571b068f3dcaccf32eb96eaf07205fc4f5854edeeb6965cbb4fc2455fadf1567c07d3354f211b8edc18e88c2c1d9a0e9f541da8772bdf30576
+  data.tar.gz: d44cf55749739078861cfbbeabd330c9339e4c59ed70d6dfdc8952440b8c2a22a06426996d919ec9105adaea821f585101efb0c3160e5d262fb8b1a834089a90

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release, basic functionality

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in devise_custom_authenticatable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Artūrs Mekšs
+
+MIT License
+
+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/README.md

@@ -0,0 +1,31 @@
+# DeviseCustomAuthenticatable
+
+Simple way how to customize devise authentication logic and still be inline with all other devise parts
+
+Extends Devise with new module `:custom_authenticatable`, when used it will call `#valid_for_model_authentication?` method on resource model with password if such defined. Return true in order to authenticate user. If method isn't defined for model or return false/nil then authentication handling will be passed to next strategy e.g. `:database_authenticatable`, if there is no other strategies for resource left then authentication will be failed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'devise_custom_authenticatable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install devise_custom_authenticatable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/devise_custom_authenticatable.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'devise_custom_authenticatable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "devise_custom_authenticatable"
+  spec.version       = DeviseCustomAuthenticatable::VERSION
+  spec.authors       = ["Artūrs Mekšs"]
+  spec.email         = ["arturs.mekss@gmail.com"]
+  spec.description   = %q{Simple way to customize devise authentication logic and still be inline with all other devise parts}
+  spec.summary       = %q{Extends Devise with new module :custom_authenticatable, when used it will call #valid_for_model_authentication? method on resource model with password if such defined. Return true in order to authenticate user. If method isn't defined for model or return false/nil then authentication handling will be passed to next strategy e.g. :database_authenticatable, if there is no other strategies for resource then authentication will be failed}
+  spec.homepage      = "https://github.com/AMekss/devise_custom_authenticatable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "devise", "~> 3.0"
+
+end

data/lib/devise/models/custom_authenticatable.rb

@@ -0,0 +1,18 @@
+require 'devise/strategies/custom_authenticatable'
+
+module Devise::Models
+  module CustomAuthenticatable
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :password
+    end
+
+    def authenticated_by_any_custom_strategy?(password, *strategies)
+      strategies.any? do |strategy|
+        self.send(:"authenticated_by_#{strategy}_strategy?", password)
+      end
+    end
+
+  end
+end

data/lib/devise/strategies/custom_authenticatable.rb

@@ -0,0 +1,24 @@
+require 'devise/strategies/authenticatable'
+
+module Devise::Strategies
+  # Strategy for delegateing authentication logic to custom model's method
+  class CustomAuthenticatable < Authenticatable
+
+    def authenticate!
+      resource  = valid_password? && mapping.to.find_for_authentication(authentication_hash)
+
+      unless resource.respond_to?(:valid_for_custom_authentication?)
+        return pass
+      end
+
+      if validate(resource){ resource.valid_for_custom_authentication?(password) }
+        success!(resource)
+      else
+        pass
+      end
+    end
+
+  end
+end
+
+Warden::Strategies.add(:custom_authenticatable, Devise::Strategies::CustomAuthenticatable)

data/lib/devise_custom_authenticatable/version.rb

@@ -0,0 +1,3 @@
+module DeviseCustomAuthenticatable
+  VERSION = "0.0.1"
+end

data/lib/devise_custom_authenticatable.rb

@@ -0,0 +1,12 @@
+# coding: utf-8
+require 'devise'
+
+require 'devise/models/custom_authenticatable'
+require 'devise/strategies/custom_authenticatable'
+require 'devise_custom_authenticatable/version'
+
+Devise.add_module(:custom_authenticatable, {
+  strategy: true,
+  controller: :sessions,
+  model: 'devise/models/custom_authenticatable'
+})

data/spec/devise/models/custom_authenticatable_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+class CustomAuthenticatableTestClass
+  include Devise::Models::CustomAuthenticatable
+end
+
+describe Devise::Models::CustomAuthenticatable do
+  before(:each) do
+    @it = CustomAuthenticatableTestClass.new
+  end
+
+  it "password attribute accessors should be defined" do
+    @it.password = 'password'
+    expect(@it.password).to eq 'password'
+  end
+
+  describe "#authenticated_by_any_custom_strategy? helper" do
+    before(:each) do
+      @it.stub(authenticated_by_test1_strategy?: true)
+      @it.stub(authenticated_by_test2_strategy?: true)
+    end
+
+    context "should call all given strategy methods and" do
+      it "return false if all of them return false" do
+        expect(@it).to receive(:authenticated_by_test1_strategy?).with('password').and_return(false)
+        expect(@it).to receive(:authenticated_by_test2_strategy?).and_return(false)
+
+        expect(@it.authenticated_by_any_custom_strategy?('password', :test1, :test2)).to be_false
+      end
+
+      it "return true if any of them return true" do
+        expect(@it).to receive(:authenticated_by_test1_strategy?).with('password').and_return(false)
+        expect(@it).to receive(:authenticated_by_test2_strategy?).and_return(true)
+
+        expect(@it.authenticated_by_any_custom_strategy?('password', :test1, :test2)).to be_true
+      end
+
+      it "return true if all of them return true" do
+        expect(@it.authenticated_by_any_custom_strategy?('password', :test1, :test2)).to be_true
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'devise_custom_authenticatable'

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: devise_custom_authenticatable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Artūrs Mekšs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple way to customize devise authentication logic and still be inline
+  with all other devise parts
+email:
+- arturs.mekss@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- devise_custom_authenticatable.gemspec
+- lib/devise/models/custom_authenticatable.rb
+- lib/devise/strategies/custom_authenticatable.rb
+- lib/devise_custom_authenticatable.rb
+- lib/devise_custom_authenticatable/version.rb
+- spec/devise/models/custom_authenticatable_spec.rb
+- spec/spec_helper.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
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: 'Extends Devise with new module :custom_authenticatable, when used it will
+  call #valid_for_model_authentication? method on resource model with password if
+  such defined. Return true in order to authenticate user. If method isn''t defined
+  for model or return false/nil then authentication handling will be passed to next
+  strategy e.g. :database_authenticatable, if there is no other strategies for resource
+  then authentication will be failed'
+test_files:
+- spec/devise/models/custom_authenticatable_spec.rb
+- spec/spec_helper.rb