rubycas-client 2.3.8 → 2.3.9.rc1

data/rubycas-client.gemspec

@@ -5,21 +5,23 @@
 
 Gem::Specification.new do |s|
   s.name = "rubycas-client"
-  s.version = "2.3.8"
+  s.version = "2.3.9.rc1"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Zukowski", "Matt Walker", "Matt Campbell"]
-  s.date = "2011-12-19"
+  s.date = "2012-03-24"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
   ]
   s.files = [
     ".rspec",
+    ".simplecov",
     ".travis.yml",
     "CHANGELOG.txt",
     "Gemfile",
     "Gemfile.lock",
+    "Guardfile",
     "History.txt",
     "LICENSE.txt",
     "README.rdoc",
@@ -63,15 +65,25 @@ Gem::Specification.new do |s|
     "rails_generators/active_record_ticket_store/templates/README",
     "rails_generators/active_record_ticket_store/templates/migration.rb",
     "rubycas-client.gemspec",
+    "spec/.gitignore",
+    "spec/casclient/client_spec.rb",
     "spec/casclient/frameworks/rails/filter_spec.rb",
+    "spec/casclient/tickets/storage/active_record_ticket_store_spec.rb",
+    "spec/casclient/tickets/storage_spec.rb",
     "spec/casclient/validation_response_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/database.yml",
+    "spec/spec_helper.rb",
+    "spec/support/action_controller_helpers.rb",
+    "spec/support/active_record_helpers.rb",
+    "spec/support/local_hash_ticket_store.rb",
+    "spec/support/local_hash_ticket_store_spec.rb",
+    "spec/support/shared_examples_for_ticket_stores.rb"
   ]
   s.homepage = "http://github.com/rubycas/rubycas-client"
   s.licenses = ["MIT"]
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.11"
   s.summary = "Client library for the Central Authentication Service (CAS) protocol."
 
   if s.respond_to? :specification_version then
@@ -79,32 +91,53 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_development_dependency(%q<json>, ["~> 1.6.1"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.7.0"])
+      s.add_development_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<bundler>, [">= 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<actionpack>, [">= 0"])
+      s.add_development_dependency(%q<activerecord>, [">= 0"])
       s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<guard>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<database_cleaner>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<jruby-openssl>, [">= 0"])
+      s.add_development_dependency(%q<activerecord-jdbcsqlite3-adapter>, [">= 0"])
     else
       s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<json>, ["~> 1.6.1"])
-      s.add_dependency(%q<rspec>, ["~> 2.7.0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<bundler>, [">= 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<actionpack>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
       s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<database_cleaner>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<jruby-openssl>, [">= 0"])
+      s.add_dependency(%q<activerecord-jdbcsqlite3-adapter>, [">= 0"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<json>, ["~> 1.6.1"])
-    s.add_dependency(%q<rspec>, ["~> 2.7.0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<bundler>, [">= 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<actionpack>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<database_cleaner>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<jruby-openssl>, [">= 0"])
+    s.add_dependency(%q<activerecord-jdbcsqlite3-adapter>, [">= 0"])
   end
 end
 

data/spec/.gitignore

@@ -0,0 +1 @@
+test.*.db

data/spec/casclient/client_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe CASClient::Client do
+  let(:client)     { CASClient::Client.new(:login_url => login_url, :cas_base_url => '')}
+  let(:login_url)  { "http://localhost:3443/"}
+  let(:uri)        { URI.parse(login_url) }
+  let(:session)    { double('session', :use_ssl= => true, :verify_mode= => true) }
+
+  context "https connection" do
+    let(:proxy)      { double('proxy', :new => session) }
+
+    before :each do
+      Net::HTTP.stub :Proxy => proxy
+    end
+
+    it "sets up the session with the login url host and port" do
+      proxy.should_receive(:new).with('localhost', 3443).and_return(session)
+      client.send(:https_connection, uri)
+    end
+    
+    it "sets up the proxy with the known proxy host and port" do
+      client = CASClient::Client.new(:login_url => login_url, :cas_base_url => '', :proxy_host => 'foo', :proxy_port => 1234)
+      Net::HTTP.should_receive(:Proxy).with('foo', 1234).and_return(proxy)
+      client.send(:https_connection, uri)
+    end
+  end
+  
+  context "cas server requests" do
+    let(:response)   { double('response', :body => 'HTTP BODY', :code => '200') }
+    let(:connection) { double('connection', :get => response, :post => response, :request => response) }
+
+    before :each do
+      client.stub(:https_connection).and_return(session)
+      session.stub(:start).and_yield(connection)
+    end
+    
+    context "cas server is up" do
+      it "returns false if the server cannot be connected to" do
+        connection.stub(:get).and_raise(Errno::ECONNREFUSED)
+        client.cas_server_is_up?.should be_false
+      end
+    
+      it "returns false if the request was not a success" do
+        response.stub :kind_of? => false
+        client.cas_server_is_up?.should be_false
+      end
+      
+      it "returns true when the server is running" do
+        response.stub :kind_of? => true
+        client.cas_server_is_up?.should be_true
+      end
+    end
+    
+    context "request login ticket" do
+      it "raises an exception when the request was not a success" do
+        session.stub(:post).with("/Ticket", ";").and_return(response)
+        response.stub :kind_of? => false
+        lambda {
+          client.request_login_ticket
+        }.should raise_error(CASClient::CASException)
+      end
+      
+      it "returns the response body when the request is a success" do
+        session.stub(:post).with("/Ticket", ";").and_return(response)
+        response.stub :kind_of? => true
+        client.request_login_ticket.should == "HTTP BODY"
+      end
+    end
+    
+    context "request cas response" do
+      let(:validation_response) { double('validation_response') }
+      
+      it "should raise an exception when the request is not a success or 422" do
+        response.stub :kind_of? => false
+        lambda {
+          client.send(:request_cas_response, uri, CASClient::ValidationResponse)
+        }.should raise_error(RuntimeError)
+      end
+      
+      it "should return a ValidationResponse object when the request is a success or 422" do
+        CASClient::ValidationResponse.stub(:new).and_return(validation_response)
+        response.stub :kind_of? => true
+        client.send(:request_cas_response, uri, CASClient::ValidationResponse).should == validation_response
+      end
+    end
+    
+    context "submit data to cas" do
+      it "should return an HTTPResponse" do
+        client.send(:submit_data_to_cas, uri, {}).should == response
+      end
+    end
+  end
+end

data/spec/casclient/frameworks/rails/filter_spec.rb

@@ -4,32 +4,6 @@ require 'casclient/frameworks/rails/filter'
 
 describe CASClient::Frameworks::Rails::Filter do
 
-  def controller_with_session(request = nil, session={})
-
-    query_parameters = {:ticket => "bogusticket", :renew => false}
-    parameters = query_parameters.dup
-
-    #TODO this really need to be replaced with a "real" rails controller
-    request ||= mock_post_request
-    request.stub(:query_parameters) {query_parameters}
-    request.stub(:path_parameters) {{}}
-    controller = double("Controller")
-    controller.stub(:session) {session}
-    controller.stub(:request) {request}
-    controller.stub(:url_for) {"bogusurl"}
-    controller.stub(:query_parameters) {query_parameters}
-    controller.stub(:path_parameters) {{}}
-    controller.stub(:parameters) {parameters}
-    controller.stub(:params) {parameters}
-    controller
-  end
-
-  def mock_post_request
-      mock_request = ActionController::Request.new({})
-      mock_request.stub(:post?) {true}
-      mock_request
-  end
-
   before(:each) do
     CASClient::Frameworks::Rails::Filter.configure(
       :cas_base_url => 'http://test.local/',
@@ -42,7 +16,7 @@ describe CASClient::Frameworks::Rails::Filter do
     context "faking user without attributes" do
       before { CASClient::Frameworks::Rails::Filter.fake('tester@test.com') }
       it 'should set the session user' do
-        CASClient::Frameworks::Rails::Filter.filter(controller_with_session(nil, subject))
+        CASClient::Frameworks::Rails::Filter.filter(mock_controller_with_session(nil, subject))
         subject.should eq({:cas_user => 'tester@test.com', :casfilteruser => 'tester@test.com'})
       end
       after { CASClient::Frameworks::Rails::Filter.fake(nil,nil) }
@@ -51,7 +25,7 @@ describe CASClient::Frameworks::Rails::Filter do
     context "faking user with attributes" do
       before { CASClient::Frameworks::Rails::Filter.fake('tester@test.com', {:test => 'stuff', :this => 'that'}) }
       it 'should set the session user and attributes' do
-        CASClient::Frameworks::Rails::Filter.filter(controller_with_session(nil, subject))
+        CASClient::Frameworks::Rails::Filter.filter(mock_controller_with_session(nil, subject))
         subject.should eq({ :cas_user => 'tester@test.com', :casfilteruser => 'tester@test.com', :cas_extra_attributes => {:test => 'stuff', :this => 'that' }})
       end
       after { CASClient::Frameworks::Rails::Filter.fake(nil,nil) }
@@ -76,7 +50,7 @@ describe CASClient::Frameworks::Rails::Filter do
       CASClient::Client.any_instance.stub(:request_cas_response).and_return(response)
       CASClient::Client.any_instance.stub(:retrieve_proxy_granting_ticket).and_return(pgt)
 
-      controller = controller_with_session()
+      controller = mock_controller_with_session()
       CASClient::Frameworks::Rails::Filter.filter(controller).should eq(true)
      end
   end
@@ -92,7 +66,7 @@ describe CASClient::Frameworks::Rails::Filter do
       CASClient::Client.any_instance.stub(:request_cas_response).and_return(response)
       CASClient::Frameworks::Rails::Filter.stub(:unauthorized!) {"bogusresponse"}
 
-      controller = controller_with_session()
+      controller = mock_controller_with_session()
       CASClient::Frameworks::Rails::Filter.filter(controller).should eq(false)
      end
   end
@@ -103,7 +77,7 @@ describe CASClient::Frameworks::Rails::Filter do
 
         CASClient::Frameworks::Rails::Filter.stub(:unauthorized!) {"bogusresponse"}
 
-        controller = controller_with_session()
+        controller = mock_controller_with_session()
         controller.stub(:params) {{}}
         CASClient::Frameworks::Rails::Filter.filter(controller).should eq(false)
        end
@@ -116,7 +90,7 @@ describe CASClient::Frameworks::Rails::Filter do
           CASClient::Frameworks::Rails::Filter.stub(:unauthorized!) {"bogusresponse"}
 
           CASClient::Frameworks::Rails::Filter.config[:use_gatewaying] = false 
-          controller = controller_with_session()
+          controller = mock_controller_with_session()
           controller.session[:cas_sent_to_gateway] = true
           controller.stub(:params) {{}}
           CASClient::Frameworks::Rails::Filter.filter(controller).should eq(false)
@@ -127,7 +101,7 @@ describe CASClient::Frameworks::Rails::Filter do
          it "should return failure from filter" do
 
           CASClient::Frameworks::Rails::Filter.config[:use_gatewaying] = true 
-          controller = controller_with_session()
+          controller = mock_controller_with_session()
           controller.session[:cas_sent_to_gateway] = true
           controller.stub(:params) {{}}
           CASClient::Frameworks::Rails::Filter.filter(controller).should eq(true)
@@ -151,7 +125,7 @@ describe CASClient::Frameworks::Rails::Filter do
         CASClient::Client.any_instance.stub(:request_cas_response).and_return(response)
         CASClient::Client.any_instance.stub(:retrieve_proxy_granting_ticket).and_raise CASClient::CASException
 
-        controller = controller_with_session()
+        controller = mock_controller_with_session()
         expect { CASClient::Frameworks::Rails::Filter.filter(controller) }.to raise_error(CASClient::CASException)
        end
     end
@@ -161,7 +135,7 @@ describe CASClient::Frameworks::Rails::Filter do
 
         CASClient::Client.any_instance.stub(:request_cas_response).and_raise "Some exception"
 
-        controller = controller_with_session()
+        controller = mock_controller_with_session()
         expect { CASClient::Frameworks::Rails::Filter.filter(controller) }.to raise_error(RuntimeError)
        end
     end
@@ -177,9 +151,26 @@ describe CASClient::Frameworks::Rails::Filter do
 
         subject[:cas_last_valid_ticket] = 'bogusticket'
         subject[:cas_last_valid_ticket_service] = 'bogusurl'
-        controller = controller_with_session(mock_post_request(), subject)
+        controller = mock_controller_with_session(mock_post_request(), subject)
         CASClient::Frameworks::Rails::Filter.filter(controller).should eq(true)
       end
     end
   end
+
+  context "controller request is missing format" do
+    context "#unauthorized!" do
+      it 'should not crash' do
+        request = double('mock request')
+        request.stub(:format).and_return(nil)
+
+        controller = mock_controller_with_session(request)
+
+        CASClient::Frameworks::Rails::Filter.
+          should_receive(:redirect_to_cas_for_authentication).
+          with(controller)
+          
+        CASClient::Frameworks::Rails::Filter.unauthorized!(controller)
+      end
+    end
+  end
 end

data/spec/casclient/tickets/storage/active_record_ticket_store_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'casclient/tickets/storage/active_record_ticket_store'
+
+describe CASClient::Tickets::Storage::ActiveRecordTicketStore do
+  it_should_behave_like "a ticket store"
+end

data/spec/casclient/tickets/storage_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'support/local_hash_ticket_store'
+require 'fileutils'
+
+describe CASClient::Tickets::Storage::AbstractTicketStore do
+  describe "#store_service_session_lookup" do
+    it "should raise an exception" do
+      expect { subject.store_service_session_lookup("service_ticket", mock_controller_with_session) }.to raise_exception 'Implement this in a subclass!'
+    end
+  end
+  describe "#cleanup_service_session_lookup" do
+    it "should raise an exception" do
+      expect { subject.cleanup_service_session_lookup("service_ticket") }.to raise_exception 'Implement this in a subclass!'
+    end
+  end
+  describe "#save_pgt_iou" do
+    it "should raise an exception" do
+      expect { subject.save_pgt_iou("pgt_iou", "pgt") }.to raise_exception 'Implement this in a subclass!'
+    end
+  end
+  describe "#retrieve_pgt" do
+    it "should raise an exception" do
+      expect { subject.retrieve_pgt("pgt_iou") }.to raise_exception 'Implement this in a subclass!'
+    end
+  end
+  describe "#get_session_for_service_ticket" do
+    it "should raise an exception" do
+      expect { subject.get_session_for_service_ticket("service_ticket") }.to raise_exception 'Implement this in a subclass!'
+    end
+  end
+end
+
+describe CASClient::Tickets::Storage::LocalDirTicketStore do
+  let(:dir) {File.join(SPEC_TMP_DIR, "local_dir_ticket_store")}
+  before do
+    FileUtils.mkdir_p(File.join(dir, "sessions"))
+  end
+  after do
+    FileUtils.remove_dir(dir)
+  end
+  it_should_behave_like "a ticket store" do
+    let(:ticket_store) {described_class.new(:storage_dir => dir)}
+  end
+end

data/spec/casclient/validation_response_spec.rb

@@ -2,6 +2,72 @@ require 'spec_helper'
 require 'casclient/responses.rb'
 
 describe CASClient::ValidationResponse do
+  context "when parsing extra attributes as raw" do
+    let(:response_text) do
+<<RESPONSE_TEXT
+<cas:serviceResponse xmlns:cas="http://www.yale.edu/tp/cas">
+  <cas:authenticationSuccess>
+    <cas:attributes>
+      <cas:name>Jimmy Bob</cas:name>
+      <cas:status><![CDATA[stuff
+]]></cas:status>
+      <cas:yaml><![CDATA[--- true
+]]></cas:yaml>
+      <cas:json><![CDATA[{"id":10529}]]></cas:json>
+    </cas:attributes>
+  </cas:authenticationSuccess>
+</cas:serviceResponse>
+RESPONSE_TEXT
+    end
+
+    subject { CASClient::ValidationResponse.new response_text, :encode_extra_attributes_as => :raw }
+
+    it "sets text attributes to their string value" do
+      subject.extra_attributes["name"].should == "Jimmy Bob"
+    end
+
+    it "preserves whitespace for CDATA" do
+      subject.extra_attributes["status"].should == "stuff\n"
+    end
+
+    it "passes yaml through as is" do
+      subject.extra_attributes["yaml"].should == "--- true\n"
+    end
+    it "passes json through as is" do
+      subject.extra_attributes["json"].should == "{\"id\":10529}"
+    end
+  end
+
+  context "when parsing extra attributes as yaml" do
+    let(:response_text) do
+<<RESPONSE_TEXT
+<cas:serviceResponse xmlns:cas="http://www.yale.edu/tp/cas">
+  <cas:authenticationSuccess>
+    <cas:attributes>
+      <cas:name>Jimmy Bob</cas:name>
+      <cas:status><![CDATA[stuff
+]]></cas:status>
+      <cas:truthy><![CDATA[--- true
+]]></cas:truthy>
+      <cas:falsy><![CDATA[#{false.to_yaml}]]></cas:falsy>
+    </cas:attributes>
+  </cas:authenticationSuccess>
+</cas:serviceResponse>
+RESPONSE_TEXT
+    end
+
+    subject { CASClient::ValidationResponse.new response_text, :encode_extra_attributes_as => :yaml }
+
+    it "sets text attributes to their string value" do
+      subject.extra_attributes["name"].should == "Jimmy Bob"
+    end
+
+    it "sets the value of boolean attributes to their boolean value" do
+      subject.extra_attributes["falsy"].should == false
+      subject.extra_attributes["truthy"].should == true
+    end
+  end
+
   context "when parsing extra attributes as JSON" do
     let(:response_text) do
 <<RESPONSE_TEXT
@@ -12,16 +78,20 @@ describe CASClient::ValidationResponse do
       <cas:last_name>92.5</cas:last_name>
       <cas:mobile_phone></cas:mobile_phone>
       <cas:global_roles><![CDATA[]]></cas:global_roles>
-      <cas:foo_data> <![CDATA[[{"id":10529}]]]></cas:foo_data>
-      <cas:food_data> <![CDATA[{"id":10529}]]></cas:food_data>
+      <cas:foo_data><![CDATA[[{"id":10529}]]]></cas:foo_data>
+      <cas:food_data><![CDATA[{"id":10529}]]></cas:food_data>
       <cas:allegedly_yaml>- 10</cas:allegedly_yaml>
+      <cas:truthy><![CDATA[--- true
+]]></cas:truthy>
+      <cas:falsy><![CDATA[--- false
+]]></cas:falsy>
     </cas:attributes>
   </cas:authenticationSuccess>
 </cas:serviceResponse>
 RESPONSE_TEXT
     end
 
-    let(:subject) { CASClient::ValidationResponse.new response_text, :encode_extra_attributes_as => :json }
+    subject { CASClient::ValidationResponse.new response_text, :encode_extra_attributes_as => :json }
 
     it "sets the value of non-CDATA escaped empty attribute to nil" do
       subject.extra_attributes["mobile_phone"].should be_nil
@@ -51,4 +121,28 @@ RESPONSE_TEXT
       subject.extra_attributes["allegedly_yaml"].should == '- 10'
     end
   end
+
+  context "When parsing extra attributes from xml attributes" do
+    let(:response_text) do
+<<RESPONSE_TEXT
+<?xml version="1.0" encoding="UTF-8"?>
+<cas:serviceResponse xmlns:cas="http://www.yale.edu/tp/cas">
+  <cas:authenticationSuccess>
+    <cas:user>myuser</cas:user>
+    <cas:attribute name="username" value="myuser"/>
+    <cas:attribute name="name" value="My User"/>
+    <cas:attribute name="email" value="myuser@mail.example.com"/>
+  </cas:authenticationSuccess>
+</cas:serviceResponse>
+RESPONSE_TEXT
+    end
+
+    subject { CASClient::ValidationResponse.new response_text }
+
+    it "sets attributes for other type of format" do
+      expected = {"username" => "myuser", "name" => 'My User', "email" => 'myuser@mail.example.com'}
+      subject.user.should == 'myuser'
+      subject.extra_attributes.should == expected
+    end
+  end
 end