rack-cas 0.2.0 → 0.3.0

data/README.markdown

@@ -6,7 +6,7 @@ Features
 ========
 * __Rack based__
 * __Framework independent__  
-Works with but doesn't depend on Rails, Sinatra, etc.
+Works with, but doesn't depend on Rails, Sinatra, etc.
 * __Minimal dependencies__  
 Current gem dependencies are [rack](http://rubygems.org/gems/rack), [addressable](http://rubygems.org/gems/addressable) and [nokogiri](http://rubygems.org/gems/nokogiri).
 * __Supports CAS extra attributes__  
@@ -14,10 +14,6 @@ Extra attributes are a mess though. So let me know if your brand of CAS server i
 * __Single sign out__  
 One of the included session stores must be used.
 
-Coming Soon
-===========
-* __Single sign out compatible session store for Active Record__
-
 Requirements
 ============
 * Ruby >= 1.9.2
@@ -26,38 +22,68 @@ Requirements
 Installation
 ============
 
-    gem install rack-cas
+Rails
+-----
+
+Add `gem 'rack-cas'` to your [`Gemfile`](http://gembundler.com/gemfile.html) and run `bundle install`
+
+Create `config/initializers/rack-cas.rb` with the following:
+
+    require 'rack/cas'
+    YourApp::Application.config.middleware.use Rack::CAS, server_url: 'https://login.example.com/cas'
+
+### Single Sign Out ###
 
-Or for [Bundler](http://gembundler.com):
+If you wish to enable [single sign out](https://wiki.jasig.org/display/CASUM/Single+Sign+Out) you'll need to modify your configuration as below.
 
-    gem 'rack-cas'
+#### Active Record ####
 
-Then in your `config.ru` file add
+Set the `session_store` in `config/initialiers/rack-cas.rb`
 
     require 'rack/cas'
-    use Rack::CAS, server_url: 'https://login.example.com/cas'
+    require 'rack-cas/session_store/active_record'
+    YourApp::Application.config.middleware.use Rack::CAS,
+      server_url: 'https://login.example.com/cas',
+      session_store: RackCAS::ActiveRecordStore
+
+Edit your `config/initializers/session_store.rb` file with the following:
+
+    require 'rack-cas/session_store/rails/active_record'
+    YourApp::Application.config.session_store :rack_cas_active_record_store
 
-Single Sign Out
----------------
-Support for [single sign out](https://wiki.jasig.org/display/CASUM/Single+Sign+Out) requires the use of one of the included session stores listed below.
+Run:
 
-* Mongoid
+    rails generate cas_session_store_migration
+    rake db:migrate
 
-To use the session store with Rails add the following to your `config/initializers/session_store.rb` file:
+#### Mongoid ####
+
+Set the `session_store` in `config/initialiers/rack-cas.rb`
+
+    require 'rack/cas'
+    require 'rack-cas/session_store/mongoid'
+    YourApp::Application.config.middleware.use Rack::CAS,
+      server_url: 'https://login.example.com/cas',
+      session_store: RackCAS::MongoidStore
+
+Edit your `config/initializers/session_store.rb` file with the following:
 
     require 'rack-cas/session_store/rails/mongoid'
-    YourApp::Application.config.session_store :mongoid_store
+    YourApp::Application.config.session_store :rack_cas_mongoid_store
 
-For other Rack-compatible frameworks, add the following to your config.ru file:
+Sinatra and Other Rack-Compatible Frameworks
+--------------------------------------------
 
-    requre 'rack-cas/sessions_store/rack/mongoid'
-    use Rack::Session::MongoidStore
+Add `gem 'rack-cas'` to your [`Gemfile`](http://gembundler.com/gemfile.html) and run `bundle install`
 
-Then tell the RackCAS where to find your sessions:
+Add the following to your `config.ru` file:
 
     require 'rack/cas'
-    require 'rack-cas/session_store/mongoid'
-    use Rack::CAS server_url: 'http://login.example.com/cas', session_store: RackCAS:MongoidStore
+    use Rack::CAS, server_url: 'https://login.example.com/cas'
+
+### Single Sign Out ###
+
+Single sign out support outside of Rails is currently untested. We'll be adding instructions here soon.
 
 Integration
 ===========

data/lib/generators/cas_session_store_migration_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class CasSessionStoreMigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  desc 'Creates a new CAS session store migration file'
+
+  def self.source_root
+    File.expand_path('../templates', __FILE__)
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+      migration_number += 1
+      migration_number.to_s
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_rack_cas_sessions'
+  end
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,18 @@
+class CreateRackCasSessions < ActiveRecord::Migration
+  def self.up
+    create_table :sessions do |t|
+      t.string :session_id, :null => false
+      t.string :cas_ticket
+      t.text :data
+      t.timestamps
+    end
+
+    add_index :sessions, :session_id
+    add_index :sessions, :cas_ticket
+    add_index :sessions, :updated_at
+  end
+
+  def self.down
+    drop_table :sessions
+  end
+end

data/lib/rack-cas/cas_request.rb

@@ -7,10 +7,8 @@ class CASRequest
 
   def ticket
     @ticket ||= if single_sign_out?
-      xml = Nokogiri::XML(@request.params['logoutRequest']).tap do |xml|
-        xml.remove_namespaces!
-      end
-      node = xml.at('/LogoutRequest/SessionIndex')
+      xml = Nokogiri::XML(@request.params['logoutRequest'])
+      node = xml.root.children.find { |c| c.name =~ /SessionIndex/i }
       node.text unless node.nil?
     else
       @request.params['ticket']

data/lib/rack-cas/session_store/active_record.rb

@@ -0,0 +1,49 @@
+module RackCAS
+  module ActiveRecordStore
+    class Session < ActiveRecord::Base
+      attr_accessible :id, :data, :cas_ticket
+    end
+
+    def self.destroy_session_by_cas_ticket(cas_ticket)
+      affected = Session.delete_all(cas_ticket: cas_ticket)
+      affected == 1
+    end
+
+    private
+
+    def get_session(env, sid)
+      if sid.nil?
+        sid = generate_sid
+        data = nil
+      else
+        session = Session.where(session_id: sid).first || {}
+        data = unpack(session['data'])
+      end
+
+      [sid, data]
+    end
+
+    def set_session(env, sid, session_data, options)
+      cas_ticket = (session_data['cas']['ticket'] unless session_data['cas'].nil?)
+
+      session = Session.find_or_initialize_by_session_id(sid)
+      success = session.update_attributes(data: pack(session_data), cas_ticket: cas_ticket)
+
+      success ? session.session_id : false
+    end
+
+    def destroy_session(env, sid, options)
+      session = Session.where(session_id: sid).delete
+      
+      options[:drop] ? nil : generate_sid
+    end
+
+    def pack(data)
+      ::Base64.encode64(Marshal.dump(data)) if data
+    end
+
+    def unpack(data)
+      Marshal.load(::Base64.decode64(data)) if data
+    end
+  end
+end

data/lib/rack-cas/session_store/rack/mongo.rb

@@ -3,7 +3,7 @@ require 'rack/session/abstract/id'
 
 module Rack
   module Session
-    class MongoStore < Rack::Session::Abstract::ID
+    class RackCASMongoStore < Rack::Session::Abstract::ID
       include RackCAS::MongoStore
     end
   end

data/lib/rack-cas/session_store/rack/mongoid.rb

@@ -3,7 +3,7 @@ require 'rack/session/abstract/id'
 
 module Rack
   module Session
-    class MongoidStore < Rack::Session::Abstract::ID
+    class RackCASMongoidStore < Rack::Session::Abstract::ID
       include RackCAS::MongoidStore
     end
   end

data/lib/rack-cas/session_store/rails/active_record.rb

@@ -0,0 +1,10 @@
+require 'rack-cas/session_store/active_record'
+require 'action_dispatch/middleware/session/abstract_store'
+
+module ActionDispatch
+  module Session
+    class RackCasActiveRecordStore < AbstractStore
+      include RackCAS::ActiveRecordStore
+    end
+  end
+end

data/lib/rack-cas/session_store/rails/mongo.rb

@@ -3,7 +3,7 @@ require 'action_dispatch/middleware/session/abstract_store'
 
 module ActionDispatch
   module Session
-    class MongoStore < AbstractStore
+    class RackCasMongoStore < AbstractStore
       include RackCAS::MongoStore
     end
   end

data/lib/rack-cas/session_store/rails/mongoid.rb

@@ -3,7 +3,7 @@ require 'action_dispatch/middleware/session/abstract_store'
 
 module ActionDispatch
   module Session
-    class MongoidStore < AbstractStore
+    class RackCasMongoidStore < AbstractStore
       include RackCAS::MongoidStore
     end
   end

data/lib/rack-cas/version.rb

@@ -1,3 +1,3 @@
 module RackCAS
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-cas
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-17 00:00:00.000000000 Z
+date: 2012-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -67,12 +67,16 @@ extra_rdoc_files: []
 files:
 - README.markdown
 - MIT-LICENSE
+- lib/generators/templates/migration.rb
+- lib/generators/cas_session_store_migration_generator.rb
 - lib/rack-cas.rb
 - lib/rack-cas/url.rb
 - lib/rack-cas/version.rb
 - lib/rack-cas/session_store/rails/mongo.rb
+- lib/rack-cas/session_store/rails/active_record.rb
 - lib/rack-cas/session_store/rails/mongoid.rb
 - lib/rack-cas/session_store/mongo.rb
+- lib/rack-cas/session_store/active_record.rb
 - lib/rack-cas/session_store/rack/mongo.rb
 - lib/rack-cas/session_store/rack/mongoid.rb
 - lib/rack-cas/session_store/mongoid.rb