p8-casablanca 0.0.1 → 0.0.2

data/README.textile

@@ -2,21 +2,25 @@ h1. Casablanca
 
 h2. Description
 
-A single sign-on client based on the CAS 2.0 protocol.
-Has a filter for Rails so it can be used as a Rails plugin.
+Casablanca is a single sign-on client for the CAS 2.0 protocol.
+It can be run from the commandline and as a filter for Rails.
 
   sudo gem install p8-casablanca
     
 h2. TODO
 
-* Add flag to turn on/off mock request
-* Add extra attributes
+* Add logging
+* Add extra attributes returned from the server
 * Implement gateway and proxy
 * Check for single signout
 * Check for endless redirects
 
 h2. Usage
 
+Commandline:
+
+  casablanca
+
 In IRB:
 
   require 'casablanca'
@@ -31,12 +35,15 @@ In IRB:
 In a Rails project:
 - environment.rb:
 
-  Casablanca::RailsFilter.client = Casablanca::Client.new(:cas_server_url => "http://localhost:4567", :service_url => "http://localhost:3000")
+  Casablanca::RailsFilter.config do |config|
+     config[:cas_server_url]  = "http://localhost:4567"
+     config[:service_url]     = "http://localhost:3000"
+  end
   
 - Add the following to application.rb:
 
   before_filter Casablanca::RailsFilter
-
+  
   def current_person
     @current_person ||= login_from_cas unless @current_person == false
   end

data/bin/casablanca

@@ -3,6 +3,7 @@ irb = RUBY_PLATFORM =~ /mswin32/ ? 'irb.bat' : 'irb'
 options = { :sandbox => false, :irb => irb }
 
 libs =  " -r irb/completion"
+libs << " -r #{File.dirname(__FILE__)}/../lib/casablanca/version.rb"
 libs << " -r #{File.dirname(__FILE__)}/../lib/casablanca/client.rb"
 libs << " -r #{File.dirname(__FILE__)}/../lib/casablanca/cli.rb"
 libs << " -r #{File.dirname(__FILE__)}/../lib/casablanca/response_parsers.rb"

data/lib/casablanca/cli.rb

@@ -1,7 +1,7 @@
 config = { :cas_server_url => "http://localhost:4567", :service_url => "http://localhost:3000" }
 INFO = %(
 =====================================================
-CASABLANCA CLIENT CONSOLE
+CASABLANCA CLIENT CONSOLE (#{Casablanca::VERSION})
 
 Use C for a configured client (#{config.inspect})
 Example:
@@ -9,6 +9,7 @@ Example:
 t = C.get_service_ticket('admin', 'admin')
 C.authenticate_ticket(t)
 
+The configuration can be changed:
 C.cas_server_url = "http://example.com/cas_server"
 C.service_url = "http://example.com/application"
 

data/lib/casablanca/client.rb

@@ -6,7 +6,8 @@ require 'rexml/document'
 module Casablanca
 
   class Client
-    attr_reader :service_url  
+    attr_accessor :cas_server_url, :service_url
+
     def initialize(config)
       raise ":cas_server_url is required" unless config[:cas_server_url]
       @cas_server_url = config[:cas_server_url]
@@ -65,7 +66,7 @@ module Casablanca
   end
 
   class CommandLineClient < Client
-    attr_accessor :cas_server_url, :service_url
+
     def login(username, password)
       post(URI.parse(login_url), {:username => username, :password => password, :service => service_url})
     end
@@ -90,7 +91,7 @@ module Casablanca
 
   class Ticket
     attr_accessor :user, :failure_code, :failure_message
-    attr_reader :service_url
+    attr_reader :service_url, :ticket
     
     def initialize(ticket, service_url, renew = false)      
       @service_url = service_url

data/lib/casablanca/filters/rails.rb

@@ -8,11 +8,21 @@ module Casablanca
         @@client = client
       end
       
+      def client
+        @@client
+      end
+            
+      def config
+        config = {}
+        yield config
+        @@client = Client.new(config)
+      end
+      
       def filter(controller)
         return true if previous_ticket(controller) && !controller.params[:renew]     
         ticket = Ticket.new(controller.params[:ticket], @@client.service_url, controller.params[:renew])
         if @@client.authenticate_ticket(ticket)
-          puts "Ticket authenticated #{ticket.failure_message}"
+          puts "Ticket authenticated"
           controller.session[:cas_user] = ticket.user
           controller.session[:cas_ticket] = ticket.to_hash
           return true

data/lib/casablanca/version.rb

@@ -1,3 +1,3 @@
 module Casablanca
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/test/test_client.rb

@@ -16,14 +16,15 @@ class TestClient < Test::Unit::TestCase
   end
 
   def test_authenticate_ticket
-    cli = CommandLineClient.new(:cas_server_url => "http://localhost:4567", :service_url => "http://localhost:3000")
-    ticket = cli.login_ticket('admin', 'admin') #'ST-1231341579r871C5757B79767C21E'
-    service_ticket = Ticket.new(ticket, 'http://localhost:3000', true)
+    service_ticket = get_service_ticket
+    @client = Client.new(:cas_server_url => "http://localhost:4567", :service_url => "http://localhost:3000")    
+    mock_authenticate_ticket(VALID_REQUEST)    
     @client.authenticate_ticket(service_ticket)
     assert_equal 'admin', service_ticket.user
   end
   
   def test_validate_expired_ticket
+    mock_authenticate_ticket(INVALID_TICKET)
     ticket = 'ST-1231341579r871C5757B79767C21E'
     service_ticket = Ticket.new(ticket, 'http://localhost:3000', true)
     @client.authenticate_ticket(service_ticket)
@@ -32,11 +33,12 @@ class TestClient < Test::Unit::TestCase
   end  
 
   def test_validate_invalid_ticket
-    ticket = '1231341579r871C5757B79767C21E'
+    mock_authenticate_ticket(INVALID_TICKET)
+    ticket = 'ST-1231242314r72465638160B31E8D1'
     service_ticket =  Ticket.new(ticket, 'http://localhost:3000', true)
     @client.authenticate_ticket(service_ticket)
     assert_equal 'INVALID_TICKET', service_ticket.failure_code
-    assert_equal "Ticket 1231341579r871C5757B79767C21E not recognized.", service_ticket.failure_message
+    assert_equal "Ticket ST-1231242314r72465638160B31E8D1 not recognized.", service_ticket.failure_message
   end
 
   def test_authenticate_ticket_with_empty_service_url
@@ -66,17 +68,19 @@ class TestCommandLineClient < Test::Unit::TestCase
   end
 
   def test_login
-    @client.expects(:post).returns(MockResponse.new('', '303', :location => 'http://localhost:3000?ticket=ST-1231341579r871C5757B79767C21E'))
+    mock_get_service_ticket
     res = @client.login('admin', 'admin')
     assert_equal '', res.body
     assert_equal '303', res.code
-    assert_equal 'http://localhost:3000?ticket=ST-1231341579r871C5757B79767C21E', res['location']
+    assert_equal 0, res['location'] =~ /^http:\/\/localhost:3000\?ticket=ST-/
+    assert_equal 61, res['location'].size
   end
 
   def test_get_service_ticket
-    @client.expects(:post).returns(MockResponse.new('', '303', :location => 'http://localhost:3000?ticket=ST-1231341579r871C5757B79767C21E'))
-    ticket = @client.get_login_ticket('admin', 'admin')
-    assert_equal 'ST-1231341579r871C5757B79767C21E', ticket
+    mock_get_service_ticket
+    ticket = @client.get_service_ticket('admin', 'admin')
+    assert_equal 0, ticket.ticket =~ /^ST-/
+    assert_equal 32, ticket.ticket.size    
   end
   
 end

data/test/test_helper.rb

@@ -4,8 +4,31 @@ require 'test/unit'
 require 'rubygems'
 require 'mocha'
 
+# set to false if you're integration testing against a real server
+MOCK_REQUESTS = true
+
 class Test::Unit::TestCase
   include Casablanca
+  
+  def mock_authenticate_ticket(body)
+    if MOCK_REQUESTS
+      @client.expects(:get).returns(MockResponse.new(body, '200', :location => 'http://localhost:3000?ticket=ST-1231341579r871C5757B79767C21E'))
+    end
+  end
+  
+  def mock_get_service_ticket
+    if MOCK_REQUESTS
+      @client.expects(:post).returns(MockResponse.new('', '303', :location => 'http://localhost:3000?ticket=ST-1231341579r871C5757B79767C21E'))
+    end
+  end
+
+  def get_service_ticket
+    cli = CommandLineClient.new(:cas_server_url => "http://localhost:4567", :service_url => "http://localhost:3000")
+    if MOCK_REQUESTS
+      cli.expects(:post).returns(MockResponse.new('', '303', :location => 'http://localhost:3000?ticket=ST-1231341579r871C5757B79767C21E'))
+    end
+    cli.get_service_ticket('admin', 'admin')
+  end 
 end
 
 class MockResponse < Net::HTTPResponse

data/test/test_rails_filter.rb

@@ -12,6 +12,14 @@ class TestRailsFilter < Test::Unit::TestCase
     assert_equal 'http://localhost:4567/login?service=http://localhost:3000', RailsFilter.login_url
   end  
   
+  def test_config
+    Casablanca::RailsFilter.config do |config|
+       config[:cas_server_url]  = "http://example.com/cas_server"
+       config[:service_url]     = "http://example.com/application"
+    end
+    assert_equal "http://example.com/cas_server", RailsFilter.client.cas_server_url
+    assert_equal "http://example.com/application", RailsFilter.client.service_url    
+  end
   # def test_filter_requires_config
   #   RailsFilter.config = nil
   #   assert_raises(RuntimeError) do
@@ -25,16 +33,18 @@ class TestRailsFilter < Test::Unit::TestCase
   end
 
   def test_filter_invalid_attempt
+    mock_authenticate_ticket(INVALID_TICKET)
     @controller.session = {}    
     assert_equal false, RailsFilter.filter(@controller)
   end
 
   def test_filter_authenticated
-    params = {:ticket => 'a'}
-    @client.expects(:authenticate_ticket).returns(true)
+    service_ticket = get_service_ticket    
+    params = {:ticket => service_ticket.ticket}
+    mock_authenticate_ticket(VALID_REQUEST)
     @controller.params = params
     assert_equal true, RailsFilter.filter(@controller)
-    assert_session(nil, { :ticket => 'a', :service_url => 'http://localhost:3000' })
+    assert_session('admin', { :ticket => service_ticket.ticket, :user => 'admin', :service_url => 'http://localhost:3000' })
   end
 
   def test_filter_same_ticket
@@ -46,6 +56,7 @@ class TestRailsFilter < Test::Unit::TestCase
   end
 
   def test_filter_resets_sessions_for_renew
+    mock_authenticate_ticket(INVALID_TICKET)
     @controller.session[:cas_ticket] = { :ticket => 'a', :service_url => 'b'   }
     @controller.params = {:renew => true }    
     assert_equal false, RailsFilter.filter(@controller)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: p8-casablanca
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Petrik de Heus
@@ -55,7 +55,7 @@ homepage:
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.textile
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -76,7 +76,7 @@ rubyforge_project: casablanca
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: A single sign-on client based on the CAS 2.0 protocol.
+summary: A single sign-on client for the CAS 2.0 protocol
 test_files: 
 - test/test_client.rb
 - test/test_helper.rb