devise_cas_authenticatable 1.3.8 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b1bd33da3b198cecce4b3171a7196919f392228
-  data.tar.gz: 00269482f2b15ceca12481571bd8a7c60f7aaebf
+  metadata.gz: 5045437ac67c0de59651c56e17ef93d148d0c3ce
+  data.tar.gz: 8e103d5ea3b58c6920d7f913e495686389358c16
 SHA512:
-  metadata.gz: 3b2a3f29488dbdc223ad2c05c66541d8928d8186612f17e3e5aeb4ccd8614ce0ded09fc31ff5e29b98aa314f65abe0b6adbc27fba9b2502ca1e4b982bc35b8ac
-  data.tar.gz: d8dcb99e7567345dc6ebeba7a84d139444a7ac9d5177cba311496801e9db8312828716a62e685ff7730d5661eaaa2be6d1053c3acac52c115020177992a09012
+  metadata.gz: 33ca2e7317e10bfcba93ab009c24466f63cf16b58848c73af13682988e1b216864cc81aa9290f397340f22e82431fa5117643ec8cb24e9e023b690167da9ccca
+  data.tar.gz: 051b51fd7c164a1f3fde624a43c3272d840845ca2f6c53f4f0c588e70fe88f836895320a33d4b807158999792e8bb7ecb89617f8d89102b4dde3f4865041aa82

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog for devise\_cas\_authenticatable
 
+## Version 1.4.0 - May 8, 2015
+
+* Allow changing the CAS response field used as the unique key for finding users (thanks once again to @gmoore!)
+
 ## Version 1.3.8 - April 24, 2015
 
 * Remove a deprecated dependency (thanks to @gmoore)

data/README.md

@@ -13,7 +13,7 @@ using [rubycas-server](http://github.com/gunark/rubycas-server)).
 Requirements
 ------------
 
-- Rails 2.3 or greater (works with 3.x versions as well)
+- Rails 2.3 or greater (works with 3.x and 4.x versions as well)
 - Devise 1.0 or greater
 - rubycas-client
 
@@ -81,7 +81,7 @@ to tell your app how to talk to your CAS server:
       # You can specify the name of the destination argument with the following option.
       # e.g. the following option will change it from 'destination' to 'url'
       # config.cas_destination_logout_param_name = 'url'
-
+      
       # By default, devise_cas_authenticatable will create users.  If you would rather
       # require user records to already exist locally before they can authenticate via
       # CAS, uncomment the following line.
@@ -89,6 +89,11 @@ to tell your app how to talk to your CAS server:
 
       # You can enable Single Sign Out, which by default is disabled.
       # config.cas_enable_single_sign_out = true
+      
+      # If you don't want to use the username returned from your CAS server as the unique
+      # identifier, but some other field passed in cas_extra_attributes, you can specify
+      # the field name here.
+      # config.cas_user_identifier = nil
 
       # If you want to use the Devise Timeoutable module with single sign out,
       # uncommenting this will redirect timeouts to the logout url, so that the CAS can

data/devise_cas_authenticatable.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{devise_cas_authenticatable}
-  s.version = "1.3.8"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nat Budin", "Jeremy Haile"]

data/lib/devise_cas_authenticatable.rb

@@ -66,6 +66,10 @@ module Devise
   # The model attribute used for query conditions. Should be the same as
   # the rubycas-server username_column. :username by default
   @@cas_username_column = :username
+  
+  # The CAS reponse value used to find users in the local database
+  # it is required that this field be in cas_extra_attributes
+  @@cas_user_identifier = nil
 
   # Name of the parameter passed in the logout query 
   @@cas_destination_logout_param_name = nil
@@ -73,7 +77,7 @@ module Devise
   # Additional options for CAS client object
   @@cas_client_config_options = {}
 
-  mattr_accessor :cas_base_url, :cas_login_url, :cas_logout_url, :cas_validate_url, :cas_destination_url, :cas_follow_url, :cas_logout_url_param, :cas_create_user, :cas_destination_logout_param_name, :cas_username_column, :cas_enable_single_sign_out, :cas_single_sign_out_mapping_strategy, :cas_client_config_options
+  mattr_accessor :cas_base_url, :cas_login_url, :cas_logout_url, :cas_validate_url, :cas_destination_url, :cas_follow_url, :cas_logout_url_param, :cas_create_user, :cas_destination_logout_param_name, :cas_username_column, :cas_enable_single_sign_out, :cas_single_sign_out_mapping_strategy, :cas_user_identifier, :cas_client_config_options
 
   def self.cas_create_user?
     cas_create_user

data/lib/devise_cas_authenticatable/model.rb

@@ -19,7 +19,24 @@ module Devise
           ::Devise.cas_client.validate_service_ticket(ticket) unless ticket.has_been_validated?
           
           if ticket.is_valid?
-           conditions = {::Devise.cas_username_column => ticket.respond_to?(:user) ? ticket.user : ticket.response.user} 
+            identifier = nil
+            ticket_response = ticket.respond_to?(:user) ? ticket : ticket.response
+
+            if ::Devise.cas_user_identifier.blank?
+              identifier = ticket_response.user
+            else
+              identifier = ticket_response.extra_attributes[::Devise.cas_user_identifier]
+            end
+
+            # If cas_user_identifier isn't in extra_attributes, or the value is blank, then we're done here
+            if identifier.nil?
+              logger.warn("Could not find a value for [#{::Devise.cas_user_identifier}] in cas_extra_attributes so we cannot find the User.")
+              logger.warn("Make sure config.cas_user_identifier is set to a field that appears in cas_extra_attributes")
+              return nil 
+            end
+
+            logger.debug("Using conditions {#{::Devise.cas_username_column} => #{identifier}} to find the User")
+            conditions = {::Devise.cas_username_column => identifier} 
             # We don't want to override Devise 1.1's find_for_authentication
             resource = if respond_to?(:find_for_authentication)
               find_for_authentication(conditions)
@@ -31,7 +48,7 @@ module Devise
             return nil unless resource
             
             if resource.respond_to? :cas_extra_attributes=
-              resource.cas_extra_attributes = ticket.respond_to?(:extra_attributes) ? ticket.extra_attributes : ticket.response.extra_attributes
+              resource.cas_extra_attributes = ticket_response.extra_attributes
             end
             resource.save
             resource

data/spec/model_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Devise::Models::CasAuthenticatable do  
+
+  describe "When the user lookup is by something other than username" do
+    before(:each) do
+      @ticket = CASClient::ServiceTicket.new("ST-test", nil)
+      @ticket.extra_attributes = {:id => 10}
+      @ticket.success = true
+      @ticket.user = "testusername"
+
+      Devise.cas_create_user = false
+
+      #
+      # We needed to stub :find_for_authentication to return false
+      # but wanted to allow other respond_to? calls to function
+      # normally 
+      #
+      User.stubs(:respond_to?) do |arg|
+        if arg == :find_for_authentication
+          return false
+        else
+          return User.respond_to? arg
+        end
+      end
+    end
+
+    it "should authenticate using whatever is specified in config.cas_user_identifier" do
+      Devise.cas_user_identifier = :id
+      Devise.cas_username_column = :id
+
+      User.expects(:find).with(:first, {:conditions => {:id => 10}})
+
+      User.authenticate_with_cas_ticket(@ticket)
+
+      #Reset this otherwise it'll blow up other specs
+      Devise.cas_user_identifier = nil
+    end
+
+    it "should authenticate as normal is config.cas_user_identifier is not set" do
+      Devise.cas_user_identifier = nil
+      Devise.cas_username_column = :username
+      User.expects(:find).with(:first, {:conditions => {:username => @ticket.user}})
+      User.authenticate_with_cas_ticket(@ticket)
+    end
+
+    it "should return nil if cas_user_identifier is not in cas_extra_attributes" do
+      Devise.cas_user_identifier = :unknown_ticket_field
+      Devise.cas_username_column = :username   
+      User.expects(:find).never
+      User.authenticate_with_cas_ticket(@ticket).should be_nil 
+
+      #Reset this otherwise it'll blow up other specs
+      Devise.cas_user_identifier = nil
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise_cas_authenticatable
 version: !ruby/object:Gem::Version
-  version: 1.3.8
+  version: 1.4.0
 platform: ruby
 authors:
 - Nat Budin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2015-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -234,6 +234,7 @@ files:
 - lib/devise_cas_authenticatable/strategy.rb
 - rails/init.rb
 - spec/config_spec.rb
+- spec/model_spec.rb
 - spec/routes_spec.rb
 - spec/scenario/.gitignore
 - spec/scenario/app/controllers/application_controller.rb
@@ -296,6 +297,7 @@ specification_version: 4
 summary: CAS authentication module for Devise
 test_files:
 - spec/config_spec.rb
+- spec/model_spec.rb
 - spec/routes_spec.rb
 - spec/scenario/.gitignore
 - spec/scenario/app/controllers/application_controller.rb