devise-radius-authenticatable 0.0.4 → 0.0.5

data/.travis.yml

@@ -2,5 +2,6 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.0.0
 bundler_args: --binstubs
 script: bundle exec rspec spec

data/README.md

@@ -1,7 +1,9 @@
 Devise Radius Authenticatable
 =============================
 
+[![Gem Version](https://badge.fury.io/rb/devise-radius-authenticatable.png)](http://badge.fury.io/rb/devise-radius-authenticatable)
 [![Build Status](https://travis-ci.org/cbascom/devise-radius-authenticatable.png)](https://travis-ci.org/cbascom/devise-radius-authenticatable)
+[![Code Climate](https://codeclimate.com/github/cbascom/devise-radius-authenticatable.png)](https://codeclimate.com/github/cbascom/devise-radius-authenticatable)
 
 Devise Radius Authenticatable is a Radius authentication strategy for [Devise](http://github.com/plataformatec/devise).
 
@@ -10,7 +12,7 @@ Dependencies
 
 - Rails ~> 3.2
 - Devise ~> 2.0
-- radiustar ~> 0.0.6
+- radiustar ~> 0.0.8
 
 Installation
 ------------
@@ -36,15 +38,17 @@ This will update the devise.rb initializer. The IP and SECRET parameters specify
 
 Options:
 
-    [--uid-field=UID_FIELD]              # What database column to use for the UID
-                                         # Default: uid
-    [--port=PORT]                        # The port to connect to the radius server on
-                                         # Default: 1812
-    [--timeout=TIMEOUT]                  # How long to wait for a response from the radius server
-                                         # Default: 60
-    [--retries=RETRIES]                  # How many times to retry a radius request
-                                         # Default: 0
-    [--dictionary-path=DICTIONARY_PATH]  # The path to load radius dictionary files from
+    [--uid-field=UID_FIELD]                                  # What database column to use for the UID
+                                                             # Default: uid
+    [--port=PORT]                                            # The port to connect to the radius server on
+                                                             # Default: 1812
+    [--timeout=TIMEOUT]                                      # How long to wait for a response from the radius server
+                                                             # Default: 60
+    [--retries=RETRIES]                                      # How many times to retry a radius request
+                                                             # Default: 0
+    [--dictionary-path=DICTIONARY_PATH]                      # The path to load radius dictionary files from
+    [--handle-timeout-as-failure=HANDLE_TIMEOUT_AS_FAILURE]  # Option to handle radius timeout as authentication failure
+                                                             # Default: false
 
 Documentation
 -------------
@@ -70,7 +74,7 @@ The field that is used for logins is the first key that's configured in the Devi
 Configuration
 -------------
 
-The radius_authenticatable module is configured through the normal devise initializer `config/initializers/devise.rb`.  The initial values are added to the file when you run the devise_radius_authenticatable:install generator as describe previously.
+The radius_authenticatable module is configured through the normal devise initializer `config/initializers/devise.rb`.  The initial values are added to the file when you run the devise_radius_authenticatable:install generator as described previously.
 
 References
 ----------
@@ -79,4 +83,4 @@ References
 * [Devise](http://github.com/plataformatec/devise)
 * [Warden](http://github.com/hassox/warden)
 
-Copyright (c) 2012 Calvin Bascom Released under the MIT license
+Copyright (c) 2012-2013 Calvin Bascom Released under the MIT license

data/devise-radius-authenticatable.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency('devise', '~> 2.0')
-  s.add_dependency('radiustar', '~> 0.0.6')
+  s.add_dependency('radiustar', '~> 0.0.8')
 
   s.add_development_dependency('rake', '~> 0.9')
   s.add_development_dependency('rails', '~> 3.2')

data/lib/devise/models/radius_authenticatable.rb

@@ -36,6 +36,7 @@ module Devise
     # * +radius_uid_generator+: A proc that takes the username and server as parameters
     #   and returns a string representing the UID
     # * +radius_dictionary_path+: The path containing the radius dictionary files to load
+    # * +handle_radius_timeout_as_failure+: Option to handle radius timeout as authentication failure
     #
     # == Callbacks
     #
@@ -74,7 +75,15 @@ module Devise
         end
 
         req = Radiustar::Request.new("#{server}:#{port}", options)
-        reply = req.authenticate(username, password, secret)
+
+        # The authenticate method will raise a RuntimeError if we time
+        # out waiting for a response from the server.
+        begin
+          reply = req.authenticate(username, password, secret)
+        rescue
+          return false if self.class.handle_radius_timeout_as_failure
+          raise
+        end
 
         if reply[:code] == 'Access-Accept'
           reply.extract!(:code)
@@ -98,7 +107,8 @@ module Devise
         Devise::Models.config(self, :radius_server, :radius_server_port,
                               :radius_server_secret, :radius_server_timeout,
                               :radius_server_retries, :radius_uid_field,
-                              :radius_uid_generator, :radius_dictionary_path)
+                              :radius_uid_generator, :radius_dictionary_path,
+                              :handle_radius_timeout_as_failure)
 
         # Invoked by the RadiusAuthenticatable stratgey to perform the authentication
         # against the radius server.  The username is extracted from the authentication

data/lib/devise/radius_authenticatable.rb

@@ -29,6 +29,11 @@ module Devise
 
   # The path to load radius dictionary files from
   mattr_accessor :radius_dictionary_path
+
+  # Option to handle radius timeout as authentication failure
+  mattr_accessor :handle_radius_timeout_as_failure
+  @@handle_radius_timeout_as_failure = false
+
 end
 
 Devise.add_module(:radius_authenticatable, :route => :session, :strategy => true,

data/lib/devise/radius_authenticatable/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module RadiusAuthenticatable
-    VERSION = "0.0.4".freeze
+    VERSION = "0.0.5".freeze
   end
 end

data/lib/generators/devise_radius_authenticatable/install_generator.rb

@@ -24,6 +24,8 @@ module DeviseRadiusAuthenticatable
                  :desc => 'How many times to retry a radius request')
     class_option(:dictionary_path, :default => nil,
                  :desc => 'The path to load radius dictionary files from')
+    class_option(:handle_timeout_as_failure, :default => false,
+                 :desc => 'Option to handle radius timeout as authentication failure')
 
     def install
       inject_into_file("config/initializers/devise.rb", default_devise_settings,
@@ -81,6 +83,10 @@ module DeviseRadiusAuthenticatable
         # be loaded.
         #
         # config.radius_dictionary_path = '#{options[:dictionary_path]}'
+
+        # Option to handle radius timeout as authentication failure
+        #
+        config.handle_radius_timeout_as_failure = #{options[:handle_timeout_as_failure]}
       CONFIG
     end
   end

data/spec/devise/models/radius_authenticatable_spec.rb

@@ -8,7 +8,8 @@ class Configurable < Admin
          :radius_uid_generator => Proc.new { |username, server|
            "#{username}_#{server}"
          },
-         :radius_dictionary_path => Rails.root.join('config/dictionaries'))
+         :radius_dictionary_path => Rails.root.join('config/dictionaries'),
+         :handle_radius_timeout_as_failure => true)
 end
 
 describe Devise::Models::RadiusAuthenticatable do
@@ -46,6 +47,10 @@ describe Devise::Models::RadiusAuthenticatable do
     Configurable.radius_dictionary_path.should == Rails.root.join('config/dictionaries')
   end
 
+  it "allows configuration of the radius exception handling" do
+    Configurable.handle_radius_timeout_as_failure.should == true
+  end
+
   it "extracts radius credentials based on the configured authentication keys" do
     swap(Devise, :authentication_keys => [:username, :domain]) do
       auth_hash = { :username => 'cbascom', :password => 'testing' }
@@ -142,5 +147,24 @@ describe Devise::Models::RadiusAuthenticatable do
       @admin.valid_radius_password?('testuser', 'password')
       @admin.radius_attributes.should == radius_server.attributes('testuser')
     end
+
+    context "when handle_radius_timeout_as_failure is false" do
+      it "does not catch the RuntimeError exception" do
+        Radiustar::Request.any_instance.stub(:authenticate).
+          and_raise(RuntimeError)
+        expect { @admin.valid_radius_password?('testuser', 'password') }.
+          to raise_error(RuntimeError)
+      end
+    end
+
+    context "when handle_radius_timeout_as_failure is true" do
+      it "returns false when the authentication times out" do
+        swap(Devise, :handle_radius_timeout_as_failure => true) do
+          Radiustar::Request.any_instance.stub(:authenticate).
+            and_raise(RuntimeError)
+          @admin.valid_radius_password?('testuser', 'password').should be_false
+        end
+      end
+    end
   end
 end

data/spec/generators/install_generator_spec.rb

@@ -2,14 +2,22 @@ require 'spec_helper'
 require 'generators/devise_radius_authenticatable/install_generator'
 
 describe DeviseRadiusAuthenticatable::InstallGenerator do
+  destination File.expand_path("../../../tmp", __FILE__)
+
+  before do
+    prepare_devise
+  end
+
   it "requires the radius server IP to be specified" do
     expect { run_generator }.
-      to raise_error(Thor::RequiredArgumentMissingError, /required arguments 'server'/)
+      to raise_error(Thor::RequiredArgumentMissingError,
+                     /required arguments 'server'/)
   end
 
   it "requires the radius server shared secret to be specified" do
     expect { run_generator ['1.1.1.1'] }.
-      to raise_error(Thor::RequiredArgumentMissingError, /required arguments 'secret'/)
+      to raise_error(Thor::RequiredArgumentMissingError,
+                     /required arguments 'secret'/)
   end
 
   context "with required arguments" do
@@ -17,8 +25,11 @@ describe DeviseRadiusAuthenticatable::InstallGenerator do
     subject { file('config/initializers/devise.rb') }
 
     context "with default options" do
-      before { run_generator ['1.1.1.1', 'secret'] }
+      before do
+        run_generator ['1.1.1.1', 'secret']
+      end
 
+      it { should exist }
       it { should contain('==> Configuration for radius_authenticatable') }
       it { should contain("config.radius_server = '1.1.1.1'") }
       it { should contain("config.radius_server_port = 1812") }
@@ -28,13 +39,18 @@ describe DeviseRadiusAuthenticatable::InstallGenerator do
       it { should contain("config.radius_uid_field = :uid") }
       it { should contain("config.radius_uid_generator =") }
       it { should contain("config.radius_dictionary_path =") }
+      it { should contain("config.handle_radius_timeout_as_failure = false") }
     end
 
     context "with custom options" do
-      before { run_generator ['1.1.1.2', 'password', '--port=1813', '--timeout=120',
-                              '--retries=3', '--uid_field=email',
-                              '--dictionary_path=/tmp/dictionaries'] }
+      before do
+        run_generator ['1.1.1.2', 'password', '--port=1813',
+          '--timeout=120', '--retries=3', '--uid_field=email',
+          '--dictionary_path=/tmp/dictionaries',
+          '--handle_timeout_as_failure=true']
+      end
 
+      it { should exist }
       it { should contain('==> Configuration for radius_authenticatable') }
       it { should contain("config.radius_server = '1.1.1.2'") }
       it { should contain("config.radius_server_port = 1813") }
@@ -44,6 +60,7 @@ describe DeviseRadiusAuthenticatable::InstallGenerator do
       it { should contain("config.radius_uid_field = :email") }
       it { should contain("config.radius_uid_generator =") }
       it { should contain("config.radius_dictionary_path = '/tmp/dictionaries'") }
+      it { should contain("config.handle_radius_timeout_as_failure = true") }
     end
   end
 end

data/spec/support/generator_helpers.rb

@@ -13,7 +13,4 @@ RSpec::configure do |c|
   c.include GeneratorHelpers, :type => :generator, :example_group => {
     :file_path => /spec[\\\/]generators/
   }
-
-  c.before(:all, :type => :generator) { destination GeneratorHelpers::DESTINATION_PATH }
-  c.before(:each, :type => :generator) { prepare_devise }
 end

metadata

@@ -2,14 +2,14 @@
 name: devise-radius-authenticatable
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Calvin Bascom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-27 00:00:00.000000000 Z
+date: 2013-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   type: :runtime
@@ -35,13 +35,13 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 0.0.8
     none: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 0.0.8
     none: false
 - !ruby/object:Gem::Dependency
   type: :development