devise_custom_authenticatable 0.1.0 → 0.1.1

checksums.yaml

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+script: "bundle exec rspec spec"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode

data/CHANGELOG.md

@@ -9,3 +9,7 @@
 ## v0.1.0
 
 * Feature: generate session routes for :custom_authenticatable strategy
+
+## v0.1.1
+
+* Checked and confirmed that all functionality work with devise >= 2.0

data/README.md

@@ -1,8 +1,9 @@
 # DeviseCustomAuthenticatable
 
-Simple way how to customize devise authentication logic and still be inline with all other devise parts
+[![Build Status](https://travis-ci.org/AMekss/devise_custom_authenticatable.png?branch=master)](https://travis-ci.org/AMekss/devise_custom_authenticatable)
+[![Gem Version](https://badge.fury.io/rb/devise_custom_authenticatable.png)](http://badge.fury.io/rb/devise_custom_authenticatable)
 
-Extends Devise with new module `:custom_authenticatable`, when enabled it will 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 method isn't defined for model or 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.
+This gem is extension for [Devise](http://github.com/plataformatec/devise) authentication. It provides custom strategy via extended module `:custom_authenticatable` which is simple way how to customize Devise authentication logic but stay inline with all other features e.g. modules `:rememberable`, `:lockable`, `:timeoutable`, default controllers and even views if you like. `:custom_authenticatable` can work together with Devise default authentication strategy `:database_authenticatable` or on its own.
 
 ## Installation
 
@@ -18,9 +19,66 @@ Or install it yourself as:
 
     $ gem install devise_custom_authenticatable
 
+##Prerequisites
+
+* devise >= 2.0
+
 ## Usage
 
-TODO: Write usage instructions here
+[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:
+
+```ruby
+    devise :custom_authenticatable, :database_authenticatable, :trackable, :lockable, :timeoutable
+    # OR
+    devise :custom_authenticatable, :trackable, :lockable, :timeoutable
+
+    # AND
+
+    def valid_for_custom_authentication?(password)
+      # Your authentication logic goes here and returns either true or false
+      LDAP.authenticate(self.username, password)
+    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:
+
+```ruby
+    class User
+      devise :custom_authenticatable, :trackable, :lockable, :timeoutable
+      # ...
+
+      def valid_for_custom_authentication?(password)
+        authenticated_by_any_custom_strategy?(password, :development, :ldap)
+      end
+
+      def authenticated_by_development_strategy?(password)
+        if %w{development test demo}.include?(Rails.env)
+          password == 'dummy'
+        end
+      end
+
+      def authenticated_by_ldap_strategy?(password)
+        logger.info "  Authenticate user '#{self.user_name}' with Active Directory..."
+        !!Ldap.authenticate(self.username, password)
+      end
+    end
+```
+
+It will call all `authenticated_by_<strategy_name>_strategy?(password)` in turn if any of strategy methods return true authentication succeed otherwise fail.
+
+**Note!** If you are using development strategies in your app always cover it with unit tests so it never get used in production by mistake, something like this for rspec:
+
+```ruby
+    it "development strategy shouldn't be enabled for Production environment" do
+      Rails.stub(env: ActiveSupport::StringInquirer.new("production"))
+      expect(@user.authenticated_by_development_strategy?('dummy')).not_to be_true
+    end
+```
+
+
+## TODO
+
+* Write Integration tests
 
 ## Contributing
 

data/devise_custom_authenticatable.gemspec

@@ -19,9 +19,8 @@ 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"
+  spec.add_development_dependency "rspec", "~> 2.0"
 
-  spec.add_dependency "devise", "~> 3.0"
+  spec.add_dependency "devise", ">= 2", "< 4"
 
 end

data/lib/devise_custom_authenticatable/version.rb

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

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: devise_custom_authenticatable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - Artūrs Mekšs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-29 00:00:00.000000000 Z
+date: 2014-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,59 +20,44 @@ 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
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - <
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4'
 description: Simple way to customize devise authentication logic and still be inline
   with all other devise parts
 email:
@@ -85,6 +68,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -100,28 +84,27 @@ files:
 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'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
-summary: ! 'Extends Devise with new module :custom_authenticatable, when enabled it
+specification_version: 4
+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