gcnovus-casrack_the_authenticator 1.0.0

data/README.rdoc

@@ -0,0 +1,51 @@
+Casrack the Authenticator is a
+Rack[http://github.com/chneukirchen/rack] middleware
+that provides CAS[http://www.jasig.org/cas] support.
+
+As of the current version, Casrack the Authenticator only supports the most basic
+of CAS scenarios: it requires CAS authentication if it receives a 401 Unauthorized
+response from lower-down in the Rack stack, and it stores the authentication token
+in the session (so logout happens when users close their browers).  Casrack the Authenticator
+is a very open-minded beast, though, so please contribute (well-tested) additions to do
+proxy-authentication and single-sign-out, or for anything else you desire.
+
+=== How-To
+
+==== 1: install
+
+  [sudo] gem install casrack_the_authenticator
+
+==== 2: set up the middleware:
+
+  # in your rackup:
+  use CasrackTheAuthenticator::Simple, :cas_server => "http://cas.mycompany.com/cas"
+  # or "config.middleware.use" if you're on Rails
+  
+See CasrackTheAuthenticator::Configuration for specifics on that Hash argument.
+
+==== 3: optionally install CasrackTheAuthenticator::RequireCAS if you want _every_ request to require CAS authentication:
+   
+  # in your rackup:
+  use CasrackTheAuthenticator::Simple, :cas_server => ...
+  use CasrackTheAuthenticator::RequireCAS
+  # or "config.middleware.use" if you're on Rails
+   
+==== 4: pull the authenticated CAS username out of the Rack session:
+
+  # in a Rack app:
+  def call(env)
+    user = cas_user(env)
+    ...
+  end
+  
+  def cas_user(env)
+    username = Rack::Request.new(env).session[CasrackTheAuthenticator::USERNAME_PARAM]
+    User.find_by_username(username)
+  end
+  
+  # or, in a Rails controller:
+  
+  def cas_user
+    username = Rack::Request.new(request.env).session[CasrackTheAuthenticator::USERNAME_PARAM]
+    User.find_by_username(username)
+  end

data/Rakefile

@@ -0,0 +1,67 @@
+desc "Default: run all tests, including features"
+task :default => [ 'test', 'features' ] 
+
+# PACKAGING
+
+require 'rake/gempackagetask'
+
+spec = eval File.read('casrack_the_authenticator.gemspec')
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+# DOCUMENTATION
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+desc "Generate RDoc"
+task :doc => ['doc:generate']
+
+namespace :doc do
+  
+  doc_dir = './doc/rdoc'
+  
+  YARD::Rake::YardocTask.new(:generate) do |yt|
+    yt.files   = ['lib/**/*.rb', 'README.rdoc']
+    yt.options = ['--output-dir', doc_dir]
+  end
+  
+  desc "Remove generated documenation"
+  task :clean do
+    rm_r doc_dir if File.exists?(doc_dir)
+  end
+  
+end
+
+# TESTING
+
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rake/testtask'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+PROJECT_ROOT = File.expand_path(File.dirname(__FILE__))
+
+LIB_DIRECTORIES = FileList.new do |fl|
+  fl.include "#{PROJECT_ROOT}/lib"
+  fl.include "#{PROJECT_ROOT}/test/lib"
+end
+ 
+TEST_FILES = FileList.new do |fl|
+  fl.include "#{PROJECT_ROOT}/test/**/*_test.rb"
+  fl.exclude "#{PROJECT_ROOT}/test/test_helper.rb"
+  fl.exclude "#{PROJECT_ROOT}/test/lib/**/*.rb"
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs = LIB_DIRECTORIES
+  t.test_files = TEST_FILES
+  t.verbose = true
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: gcnovus-casrack_the_authenticator
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- James Rosen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-30 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: CAS Authentication via Rack Middleware
+email: james.a.rosen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- Rakefile
+has_rdoc: false
+homepage: http://github.com/gcnovus/casrack_the_authenticator
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- "Casrack the Authenticator: RDoc"
+- --charset
+- utf-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: CAS Authentication via Rack Middleware
+test_files: []
+