rubycas-client 2.2.1 → 2.3.0.rc1

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "riot"
+  gem "rr"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov"
+  gem "actionpack"
+end
+
+gem "activesupport"
+

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (2.3.11)
+      activesupport (= 2.3.11)
+      rack (~> 1.1.0)
+    activesupport (2.3.11)
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rack (1.1.2)
+    rake (0.9.2)
+    rcov (0.9.9)
+    riot (0.12.5)
+      rr
+    rr (1.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack
+  activesupport
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  rcov
+  riot
+  rr

data/History.txt

@@ -1,5 +1,26 @@
 = RubyCAS-Client Changelog
 
+== Version 2.3.0 :: Prerelease
+
+* New Functionality
+  * Add configuration option to expect complex extra attributes to be encoded
+    in json instead of yaml
+  * Split out storage mechanism for single sign out and proxy ticket storage so
+    that it is modular
+
+* Changes to existing functionality
+  * Change gem building from hoe to jeweler
+  * expect extra attributes to be nested under a cas:attributes elemenet to
+    improve compatibility with other extra attribute implementations
+  * Unauthorized requests to URLs ending in .json now show an JSON formatted
+    response
+
+* Bug Fixes
+  * Fixed bug introduced by upstream patch that broke proxy ticket validation
+    when using extra attributes
+  * Fixed bug where extra attributes key was set on the session with a null
+    value when faking with no extra attributes
+
 == Version 2.2.1 :: 2010-06-24
 
 * Removed a 3rd party patch to the logging mechanism that broke the client under

data/README.rdoc

@@ -1,13 +1,13 @@
 = RubyCAS-Client
 
-Author::    Matt Zukowski <matt AT roughest DOT net>; inspired by code by Ola Bini <ola.bini AT ki DOT se> and Matt Walker <mwalker AT tamu DOT edu>
+Authors::   Matt Zukowski <matt AT roughest DOT net> and Matt Campbell <matt AT soupmatt DOT com>; inspired by code by Ola Bini <ola.bini AT ki DOT se> and Matt Walker <mwalker AT tamu DOT edu>
 Copyright:: Portions contributed by Matt Zukowski are copyright (c) 2009 Urbacon Ltd.
+            Portions contributed by Matt Campbell, Rich Yarger and Rahul Joshi are copyright (c) 2011 Vibes Media LLC.
             Other portions are copyright of their respective authors.
 License::   MIT License
-Websites::  http://github.com/gunark/rubycas-client
-            http://code.google.com/p/rubycas-client
-            http://rubyforge.org/projects/rubycas-client
-            
+Websites::  http://github.com/rubycas/rubycas-client
+            http://github.com/rubycas/rubycas-client/wiki
+            http://rubydoc.info/github/rubycas/rubycas-client/master/frames
 
 
 === RubyCAS-Client is a Ruby client library for Yale's Central Authentication Service (CAS) protocol.
@@ -36,13 +36,18 @@ API documentation (i.e. the RDocs) are available at http://rubycas-client.rubyfo
 
 == Installation
 
+<b>NOTE:</b> For compatibility with Rails 3 have a look at https://github.com/zuk/rubycas-client-rails
+
+The current version of RubyCAS-Client should work with Rails 2.3.6 and up. For compatibility with
+older Rails try using an older version of the client.
+
 You can download the latest version of RubyCAS-Client from the project's rubyforge page at 
 http://rubyforge.org/projects/rubycas-client.
 
 However, if you're using Rails, it's easier to install the CAS client as a plugin:
 
   cd <your rails app>
-  ./script/plugin install http://rubycas-client.googlecode.com/svn/trunk/rubycas-client
+  ./script/plugin install git://github.com/gunark/rubycas-client.git
 
 Alternatively, the library is also installable as a RubyGem[http://rubygems.org]:
 
@@ -51,11 +56,8 @@ Alternatively, the library is also installable as a RubyGem[http://rubygems.org]
 If your Rails application is under Subversion control, you can also install the plugin as an svn:external, ensuring that
 you always have the latest bleeding-edge version of RubyCAS-Client:
 
-  ./script/plugin install -x http://rubycas-client.googlecode.com/svn/trunk/rubycas-client
+  ./script/plugin install -x http://svn.github.com/gunark/rubycas-client.git
 
-With Rails 2.1 or newer, it is also possible to install the plugin directly from the bleeding-edge git repository:
-
-  ./script/plugin install git://github.com/gunark/rubycas-client.git
 
 == Usage Examples
 
@@ -108,7 +110,7 @@ Here is a more complicated configuration showing most of the configuration optio
 (this does not show proxy options, which are covered in the next section):
 
   # enable detailed CAS logging
-  cas_logger = CASClient::Logger.new(RAILS_ROOT+'/log/cas.log')
+  cas_logger = CASClient::Logger.new(::Rails.root+'/log/cas.log')
   cas_logger.level = Logger::DEBUG
 
   CASClient::Frameworks::Rails::Filter.configure(
@@ -149,7 +151,7 @@ notify the client application that the CAS session is closed. The client will au
 requsts from the CAS server, but in order for this to work you must configure your Rails application as follows:
 
 1. The Rails session store must be set to ActiveRecord: <tt>config.action_controller.session_store = :active_record_store</tt>
-2. The server must be able to read and write to RAILS_ROOT/tmp/sessions. If you are in a clustered environment,
+2. The server must be able to read and write to Rails.root/tmp/sessions. If you are in a clustered environment,
    the contents of this directory must be shared between all server instances. 
 3. Cross-site request forgery protection must be disabled. In your <tt>application.rb</tt>: <tt>self.allow_forgery_protection = false</tt>.
    (Or rather you may want to disable forgery protection only for actions that are behind the CAS filter.)
@@ -230,12 +232,11 @@ all you need to do is this:
 In your <tt>config/environment.rb</tt>:
 
   # enable detailed CAS logging for easier troubleshooting
-  cas_logger = CASClient::Logger.new(RAILS_ROOT+'/log/cas.log')
+  cas_logger = CASClient::Logger.new(::Rails.root+'/log/cas.log')
   cas_logger.level = Logger::DEBUG
 
   CASClient::Frameworks::Rails::Filter.configure(
     :cas_base_url => "https://cas.example.foo/",
-    :proxy_retrieval_url => "https://cas-proxy-callback.example.foo/cas_proxy_callback/retrieve_pgt",
     :proxy_callback_url => "https://cas-proxy-callback.example.foo/cas_proxy_callback/receive_pgt",
     :logger => cas_logger
   )
@@ -255,12 +256,9 @@ but your Rails server wouldn't respond to the CAS server's callback until the CA
 
 The simplest workaround is this:
 
-1. Create an empty rails app (i.e. something like <tt>rails cas_proxy_callback</tt>)
-2. Make sure that you have the CAS plugin installed. If you installed it as a gem, you don't have to do anything since
-   it is already installed. If you want to install as a plugin, see the instructions in the "Installing" section above.
-3. Make sure that the server is up and running, and configure your proxy_callback_url and proxy_retrieval_url to point
-   to the new server as described above (or rather, make Pound point to the new server, if that's how you're handling https).
-   
+Run rails using a server that handles multiple concurrent requests. In development, you can use Phusion Passenger Standalone,
+POW (http://pow.cx/), unicorn and many others. In production, I imagine you already support multiple concurrent requests.
+
 That's it. The proxy_callback_controller doesn't require any additional configuration. It doesn't access the database
 or anything of that sort.
 
@@ -316,6 +314,12 @@ In your test or Cucumber step definition, simply fake out CAS.
 This functionality was present in the original version of this plugin.
 The value of the username is stored in session[:cas_user] (or the user specified field) and session[:casfilteruser] for backwards-compatibility.
 
+If you need to fake out extra attributes, you can do so like this:
+
+  CASClient::Frameworks::Rails::Filter.fake("homer", {:role => "user", :email => "homer@test.foo"})
+
+And the extra attributes will get put in the proper place in the session.
+
 == License
 
 RubyCAS-Client is licensed for use under the terms of the MIT License.

data/Rakefile

@@ -1,63 +1,52 @@
+# encoding: utf-8
+
 require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
 require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'rake/contrib/rubyforgepublisher'
-require 'fileutils'
-require 'hoe'
-include FileUtils
-require File.join(File.dirname(__FILE__), 'lib', 'casclient', 'version')
-
-AUTHOR = ["Matt Zukowski", "Matt Walker"]  # can also be an array of Authors
-EMAIL = "matt at roughest dot net"
-DESCRIPTION = "Client library for the Central Authentication Service (CAS) protocol."
-GEM_NAME = "rubycas-client" # what ppl will type to install your gem
-RUBYFORGE_PROJECT = "rubycas-client" # The unix name for your project
-HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
-
-ENV['NODOT'] = '1'
 
-NAME = "rubycas-client"
-REV = nil
-#REV = `svn info`[/Revision: (\d+)/, 1] rescue nil
-VERS = ENV['VERSION'] || (CASClient::VERSION::STRING + (REV ? ".#{REV}" : ""))
-                          CLEAN.include ['**/.*.sw?', '*.gem', '.config']
-RDOC_OPTS = ['--quiet', '--title', "rubycas-client documentation",
-    "--opname", "index.html",
-    "--line-numbers", 
-    "--main", "README",
-    "--inline-source"]
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "rubycas-client"
+  gem.homepage = "http://github.com/rubycas/rubycas-client"
+  gem.license = "MIT"
+  gem.summary = "Client library for the Central Authentication Service (CAS) protocol."
+  gem.authors = ["Matt Zukowski", "Matt Walker", "Matt Campbell"]
+  gem.rdoc_options = ['--main', 'README.rdoc']
+  gem.files.exclude '.rvmrc', '.infinity_test'
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
 
-class Hoe
-  def extra_deps 
-    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
-  end 
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
 end
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-hoe = Hoe.new(GEM_NAME, VERS) do |p|
-  p.author = AUTHOR 
-  p.description = DESCRIPTION
-  p.email = EMAIL
-  p.summary = DESCRIPTION
-  p.url = HOMEPATH
-  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.test_globs = ["test/**/*_test.rb"]
-  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
-  
-  # == Optional
-  #p.changes        - A description of the release's latest changes.
-  #p.extra_deps     - An array of rubygem dependencies.
-  #p.spec_extras    - A hash of extra values to set in the gemspec.
-  p.extra_deps = ['activesupport']
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
 end
 
-desc 'Build and install rubycas-client'
-task :install do
-  system "gem build rubycas-client.gemspec"
-  system "sudo gem install rubycas-client-#{VERS}.gem"
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rubycas-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -0,0 +1 @@
+2.3.0.rc1

data/examples/rails/README

@@ -0,0 +1,16 @@
+This is a skeleton Rails application hooked up for CAS authentication.
+
+To try this out:
+
+1. If you have an existing CAS server, modify the CAS client settings in 
+   config/environment.rb to point to your server. If you do not yet 
+   have a CAS server, install rubycas-server, and configure it to run on
+   http://localhost:7777 (or modify environment.rb to your likings).
+
+2. Run `ruby script/server`
+
+3. Point your web browser to http://localhost:3000
+
+4. Have a look at the source code in app/controllers/simple_example_controller.rb
+   and app/controllers/advanced_example_controller.rb. The 
+   corresponding views under app/views might also be worth looking at.

data/examples/rails/app/controllers/advanced_example_controller.rb

@@ -0,0 +1,31 @@
+# A more advanced example.
+# For basic usage see the SimpleExampleController.
+class AdvancedExampleController < ApplicationController
+  # This will allow the user to view the index page without authentication
+  # but will process CAS authentication data if the user already
+  # has an SSO session open.
+  before_filter CASClient::Frameworks::Rails::GatewayFilter, :only => :index
+
+  # This requires the user to be authenticated for viewing allother pages.
+  before_filter CASClient::Frameworks::Rails::Filter, :except => :index
+
+  def index
+    @username = session[:cas_user]
+    
+    @login_url = CASClient::Frameworks::Rails::Filter.login_url(self)
+  end
+
+  def my_account
+    @username = session[:cas_user]
+
+    # Additional user attributes are available if your
+    # CAS server is configured to provide them.
+    # See http://code.google.com/p/rubycas-server/wiki/HowToSendExtraUserAttributes
+    @extra_attributes = session[:cas_extra_attributes]
+  end
+
+  def logout
+    CASClient::Frameworks::Rails::Filter.logout(self)
+  end
+
+end

data/examples/rails/app/controllers/application.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/examples/rails/app/controllers/simple_example_controller.rb

@@ -0,0 +1,16 @@
+# This is the most basic, bare-bones example.
+# For advanced usage see the AdvancedExampleController.
+class SimpleExampleController < ApplicationController
+  # This will force CAS authentication before the user
+  # is allowed to access any action in this controller. 
+  before_filter CASClient::Frameworks::Rails::Filter
+
+  def index
+    @username = session[:cas_user]
+  end
+
+  def logout
+    CASClient::Frameworks::Rails::Filter.logout(self)
+  end
+
+end

data/examples/rails/app/views/advanced_example/index.html.erb

@@ -0,0 +1,13 @@
+<h1>AdvancedExample#index</h1>
+
+<% if @username %>
+  <p>Hello, <%= @username %>! You are authenticated.</p>
+<% else %>
+  <p>You are not yet authenticated. <%= link_to("Login", @login_url) %>
+<% end %>
+
+<p>&raquo; <%= link_to("Go To My Account", :action => 'my_account') %></p>
+
+<% if @username %>
+<p>[ <%= link_to("Logout", :action => 'logout') %> ]</p>
+<% end %>

data/examples/rails/app/views/advanced_example/my_account.html.erb

@@ -0,0 +1,11 @@
+<h1>AdvancedExample#my_account</h1>
+<p><%= @username %>'s Account page</p>
+
+<p>
+<strong>Extra Attributes</strong>:<br />
+<% unless @extra_attributes.blank? %>
+  <%= debug(@extra_attributes) %>
+<% end %>
+</p>
+
+<p>[ <%= link_to("Logout", :action => 'logout') %> ]</p>

data/examples/rails/app/views/simple_example/index.html.erb

@@ -0,0 +1,6 @@
+<h1>SimpleExample#index</h1>
+<p>Hello, <%= @username %>!</p>
+
+<p>&raquo; <%= link_to("Go To AdvancedExample", :controller => 'advanced_example') %></p>
+
+<p>[ <%= link_to("Logout", :action => 'logout') %> ]</p>

data/examples/rails/config/boot.rb

@@ -0,0 +1,109 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+Rails.root = "#{File.dirname(__FILE__)}/.." unless defined?(Rails.root)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{Rails.root}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{Rails.root}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{Rails.root}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion if defined? Gem::RubyGemsVersion
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.1.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{Rails.root}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!