devise_cas_authenticatable 1.1.4 → 1.2.0

data/.travis.yml

@@ -1,6 +1,7 @@
 rvm:
   - 1.8.7 # (current default)
-  - 1.9.2
+  - 1.9.3
+  - 2.0.0
 gemfile:
   - Gemfile.devise10
   - Gemfile.devise11
@@ -11,3 +12,4 @@ gemfile:
   - Gemfile.devise20
   - Gemfile.devise21
 script: "bundle exec rake spec"
+

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog for devise\_cas\_authenticatable
 
+## Version 1.2.0 - March 6, 2013
+
+* Rewrite of the single sign-out module to improve compatibility with newer Devise versions, other ORMs, and be less complex overall (thanks [Jeremy Haile](https://github.com/jeremyhaile) and [Endel Dreyer](https://github.com/endel)!)
+
 ## Version 1.1.4 - January 23, 2013
 
 * Bug fix: don't modify request.protocol when generating a logout_url (thanks [Tse-Ching Ho](https://github.com/tsechingho)!)

data/app/controllers/devise/cas_sessions_controller.rb

@@ -1,6 +1,9 @@
-class Devise::CasSessionsController < Devise::SessionsController
+class Devise::CasSessionsController < Devise::SessionsController  
+  include DeviseCasAuthenticatable::SingleSignOut::DestroySession
   unloadable
 
+  skip_before_filter :verify_authenticity_token, :only => [:single_sign_out]
+
   def new
     unless returning_from_cas?
       redirect_to(cas_login_url)
@@ -15,11 +18,6 @@ class Devise::CasSessionsController < Devise::SessionsController
   end
 
   def destroy
-    # Delete the ticket->session ID mapping if one exists for this session
-    if ticket = session['cas_last_valid_ticket']
-      ::DeviseCasAuthenticatable::SingleSignOut::Strategies.current_strategy.delete_session_index(ticket)
-    end
-
     # if :cas_create_user is false a CAS session might be open but not signed_in
     # in such case we destroy the session here
     if signed_in?(resource_name)
@@ -64,23 +62,14 @@ class Devise::CasSessionsController < Devise::SessionsController
   end
 
   def destroy_cas_session(session_id, session_index)
-    if session_store && session_store.respond_to?(:destroy_session)
-      if session_store.destroy_session(session_id)
-        logger.debug "Destroyed session #{session_id} corresponding to service ticket #{session_index}."
-      else
-        logger.debug "Data for session #{session_id} was not found. It may have already been cleared by a local CAS logout request."
-      end
-    else
-      logger.warn "A single sign out request was received for ticket #{session_index} but the Rails session_store is not a type supported for single-sign-out by devise_cas_authenticatable."
+    logger.debug "Destroying cas session #{session_id} for ticket #{session_index}"
+    if destroy_session_by_id(session_id)
+      logger.debug "Destroyed session #{session_id} corresponding to service ticket #{session_index}."
     end
 
     ::DeviseCasAuthenticatable::SingleSignOut::Strategies.current_strategy.delete_session_index(session_index)
   end
 
-  def session_store
-  	@session_store ||= (Rails.respond_to?(:application) && Rails.application.config.session_store)
-  end
-
   def returning_from_cas?
     params[:ticket] || request.referer =~ /^#{::Devise.cas_client.cas_base_url}/ || request.referer =~ /^#{url_for :action => "service"}/
   end

data/devise_cas_authenticatable.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{devise_cas_authenticatable}
-  s.version = "1.1.4"
+  s.version = "1.2.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

@@ -7,16 +7,10 @@ require 'devise_cas_authenticatable/exceptions'
 
 require 'devise_cas_authenticatable/single_sign_out'
 
-if defined?(ActiveRecord::SessionStore)
-  require 'devise_cas_authenticatable/single_sign_out/session_store/active_record'
-end
-
-if defined?(Redis::Store)
-  require 'devise_cas_authenticatable/single_sign_out/session_store/redis'
-end
-
 require 'rubycas-client'
 
+require 'devise_cas_authenticatable/railtie' if defined?(Rails::Railtie)
+
 # Register as a Rails engine if Rails::Engine exists
 begin
   Rails::Engine

data/lib/devise_cas_authenticatable/railtie.rb

@@ -0,0 +1,10 @@
+require 'devise_cas_authenticatable'
+require 'rails'
+
+module DeviseCasAuthenticatable
+  class Railtie < ::Rails::Railtie
+    initializer "devise_cas_authenticatable.use_rack_middleware" do |app|
+      app.config.middleware.use "DeviseCasAuthenticatable::SingleSignOut::StoreSessionId"
+    end
+  end
+end

data/lib/devise_cas_authenticatable/single_sign_out.rb

@@ -1,22 +1,62 @@
 module DeviseCasAuthenticatable
   module SingleSignOut
-    module SetSession
-      def set_session_with_storage(env, sid, session_data, options={})
-        if session_data['cas_last_valid_ticket_store']
-          ::DeviseCasAuthenticatable::SingleSignOut::Strategies.current_strategy.store_session_id_for_index(session_data['cas_last_valid_ticket'], sid)
-          session_data['cas_last_valid_ticket_store'] = nil
-        end
 
-        if method(:set_session_without_storage).arity == 4
-          set_session_without_storage(env, sid, session_data, options)
+    def self.rails3?
+      defined?(::Rails) && ::Rails::VERSION::MAJOR == 3
+    end
+
+    # Supports destroying sessions by ID for ActiveRecord and Redis session stores
+    module DestroySession
+      def session_store_class
+        @session_store_class ||=
+          begin
+            if ::DeviseCasAuthenticatable::SingleSignOut.rails3?
+              # => Rails 3
+              Rails.configuration.session_store
+              ::Rails.application.config.session_store
+            else
+              # => Rails 2
+              ActionController::Base.session_store
+            end
+          rescue NameError => e
+            # for older versions of Rails (prior to 2.3)
+            ActionController::Base.session_options[:database_manager]
+          end
+      end
+
+      def current_session_store
+        app = Rails.application.app
+        begin
+          app = (app.instance_variable_get(:@backend) || app.instance_variable_get(:@app))
+        end until app.nil? or app.class == session_store_class
+        app
+      end
+
+      def destroy_session_by_id(sid)
+        logger.debug "Single Sign Out from session store: #{current_session_store.inspect}"
+
+        if session_store_class.name =~ /ActiveRecord::SessionStore/
+          session = session_store_class::Session.find_by_session_id(sid)
+          session.destroy if session
+          true
+        elsif session_store_class.name =~ /Redis/
+          current_session_store.instance_variable_get(:@pool).del(sid)
+          true
+        elsif session_store_class.name =~ /CacheStore/
+          current_session_store.destroy_session({}, sid, {})
+          true
         else
-          set_session_without_storage(env, sid, session_data)
-        end        
+          logger.error "Cannot process logout request because this Rails application's session store is "+
+                " #{current_session_store.name.inspect} and is not a support session store type for Single Sign-Out."
+          false
+        end
       end
     end
+
   end
 end
 
 require 'devise_cas_authenticatable/single_sign_out/strategies'
 require 'devise_cas_authenticatable/single_sign_out/strategies/base'
-require 'devise_cas_authenticatable/single_sign_out/strategies/rails_cache'
+require 'devise_cas_authenticatable/single_sign_out/strategies/rails_cache'
+require 'devise_cas_authenticatable/single_sign_out/rack'

data/lib/devise_cas_authenticatable/single_sign_out/rack.rb

@@ -0,0 +1,30 @@
+module DeviseCasAuthenticatable
+  module SingleSignOut
+
+    class StoreSessionId
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        store_session_id_for_cas_ticket(env)
+        @app.call(env)
+      end
+
+      private
+
+      def store_session_id_for_cas_ticket(env)
+        request = Rack::Request.new(env)
+        session = request.session
+
+        if session['cas_last_valid_ticket_store']
+          sid = env['rack.session.options'][:id]
+          Rails.logger.info "Storing sid #{sid} for ticket #{session['cas_last_valid_ticket']}"
+          ::DeviseCasAuthenticatable::SingleSignOut::Strategies.current_strategy.store_session_id_for_index(session['cas_last_valid_ticket'], sid)
+          session['cas_last_valid_ticket_store'] = false
+        end
+      end
+
+    end
+  end
+end

data/lib/devise_cas_authenticatable/single_sign_out/strategies/rails_cache.rb

@@ -28,4 +28,4 @@ module DeviseCasAuthenticatable
   end
 end
 
-::DeviseCasAuthenticatable::SingleSignOut::Strategies.add( :rails_cache, DeviseCasAuthenticatable::SingleSignOut::Strategies::RailsCache )
+::DeviseCasAuthenticatable::SingleSignOut::Strategies.add( :rails_cache, DeviseCasAuthenticatable::SingleSignOut::Strategies::RailsCache )

data/lib/devise_cas_authenticatable/strategy.rb

@@ -27,7 +27,6 @@ module Devise
           elsif ticket.is_valid?
             username = ticket.respond_to?(:user) ? ticket.user : ticket.response.user
             redirect!(::Devise.cas_unregistered_url(request.url, mapping), :username => username)
-            #fail!("The user #{ticket.response.user} is not registered with this site.  Please use a different account.")
           else
             fail!(:invalid)
           end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: devise_cas_authenticatable
 version: !ruby/object:Gem::Version
-  version: 1.1.4
   prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Nat Budin
@@ -10,195 +10,195 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-23 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.6
   name: devise
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.6
+- !ruby/object:Gem::Dependency
   type: :runtime
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.6
-- !ruby/object:Gem::Dependency
+        version: 2.2.1
   name: rubycas-client
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.2.1
-  type: :runtime
-  prerelease: false
+- !ruby/object:Gem::Dependency
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.2.1
-- !ruby/object:Gem::Dependency
+        version: 3.0.7
   name: rails
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.7
+- !ruby/object:Gem::Dependency
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.7
-- !ruby/object:Gem::Dependency
+        version: '0'
   name: rspec-rails
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   name: mocha
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   name: shoulda
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   name: sqlite3-ruby
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   name: sham_rack
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   name: capybara
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   name: crypt-isaac
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   name: launchy
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   name: pry
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -234,11 +234,11 @@ files:
 - lib/devise_cas_authenticatable.rb
 - lib/devise_cas_authenticatable/exceptions.rb
 - lib/devise_cas_authenticatable/model.rb
+- lib/devise_cas_authenticatable/railtie.rb
 - lib/devise_cas_authenticatable/routes.rb
 - lib/devise_cas_authenticatable/schema.rb
 - lib/devise_cas_authenticatable/single_sign_out.rb
-- lib/devise_cas_authenticatable/single_sign_out/session_store/active_record.rb
-- lib/devise_cas_authenticatable/single_sign_out/session_store/redis.rb
+- lib/devise_cas_authenticatable/single_sign_out/rack.rb
 - lib/devise_cas_authenticatable/single_sign_out/strategies.rb
 - lib/devise_cas_authenticatable/single_sign_out/strategies/base.rb
 - lib/devise_cas_authenticatable/single_sign_out/strategies/rails_cache.rb
@@ -290,10 +290,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
       segments:
       - 0
-      hash: -1377956398748229167
+      hash: -2741106234440343687
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/devise_cas_authenticatable/single_sign_out/session_store/active_record.rb

@@ -1,12 +0,0 @@
-ActiveRecord::SessionStore.class_eval do
-
-  include DeviseCasAuthenticatable::SingleSignOut::SetSession
-  alias_method_chain :set_session, :storage
-
-  #def destroy_session(env, session_id, options)
-  #  if session = Session::find_by_session_id(sid)
-  #    session.destroy
-  #  end
-  #end
-
-end

data/lib/devise_cas_authenticatable/single_sign_out/session_store/redis.rb

@@ -1,27 +0,0 @@
-require "action_controller/session/redis_session_store"
-
-module DeviseCasAuthenticatable
-  module SingleSignOut
-    module RedisSessionStore
-
-      include DeviseCasAuthenticatable::SingleSignOut::SetSession
-
-      def destroy_session(sid)
-        @pool.del(sid)
-      end
-    end
-  end
-end
-
-
-if ::Redis::Store.rails3?
-  ActionDispatch::Session::RedisSessionStore.class_eval do
-    include DeviseCasAuthenticatable::SingleSignOut::RedisSessionStore
-    alias_method_chain :set_session, :storage
-  end
-else
-  ActionController::Session::RedisSessionStore.class_eval do
-    include DeviseCasAuthenticatable::SingleSignOut::RedisSessionStore
-    alias_method_chain :set_session, :storage
-  end
-end