casino_core 1.0.4 → 1.0.5

data/VERSION

@@ -1 +1 @@
-1.0.4
+1.0.5

data/casino_core.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "casino_core"
-  s.version = "1.0.4"
+  s.version = "1.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nils Caspar"]
@@ -56,6 +56,7 @@ Gem::Specification.new do |s|
     "lib/casino_core/builder.rb",
     "lib/casino_core/builder/ticket_validation_response.rb",
     "lib/casino_core/helper.rb",
+    "lib/casino_core/helper/authentication.rb",
     "lib/casino_core/helper/browser.rb",
     "lib/casino_core/helper/logger.rb",
     "lib/casino_core/helper/login_tickets.rb",
@@ -72,6 +73,10 @@ Gem::Specification.new do |s|
     "lib/casino_core/model/service_ticket/single_sign_out_notifier.rb",
     "lib/casino_core/model/ticket_granting_ticket.rb",
     "lib/casino_core/processor.rb",
+    "lib/casino_core/processor/api.rb",
+    "lib/casino_core/processor/api/login_credential_acceptor.rb",
+    "lib/casino_core/processor/api/logout.rb",
+    "lib/casino_core/processor/api/service_ticket_provider.rb",
     "lib/casino_core/processor/legacy_validator.rb",
     "lib/casino_core/processor/login_credential_acceptor.rb",
     "lib/casino_core/processor/login_credential_requestor.rb",
@@ -93,6 +98,9 @@ Gem::Specification.new do |s|
     "spec/model/service_ticket/single_sign_out_notifier_spec.rb",
     "spec/model/service_ticket_spec.rb",
     "spec/model/ticket_granting_ticket_spec.rb",
+    "spec/processor/api/login_credential_acceptor_spec.rb",
+    "spec/processor/api/logout_spec.rb",
+    "spec/processor/api/service_ticket_provider_spec.rb",
     "spec/processor/legacy_validator_spec.rb",
     "spec/processor/login_credential_acceptor_spec.rb",
     "spec/processor/login_credential_requestor_spec.rb",

data/lib/casino_core/helper/authentication.rb

@@ -0,0 +1,20 @@
+module CASinoCore
+  module Helper
+    module Authentication
+
+      def validate_login_credentials(username, password)
+        authentication_result = nil
+        CASinoCore::Settings.authenticators.each do |authenticator_name, authenticator|
+          data = authenticator.validate(username, password)
+          if data
+            authentication_result = { authenticator: authenticator_name, user_data: data }
+            logger.info("Credentials for username '#{data[:username]}' successfully validated using authenticator '#{authenticator_name}' (#{authenticator.class})")
+            break
+          end
+        end
+        authentication_result
+      end
+
+    end
+  end
+end

data/lib/casino_core/helper/ticket_granting_tickets.rb

@@ -3,6 +3,7 @@ require 'addressable/uri'
 module CASinoCore
   module Helper
     module TicketGrantingTickets
+
       include CASinoCore::Helper::Browser
       include CASinoCore::Helper::Logger
 
@@ -19,6 +20,25 @@ module CASinoCore
           end
         end
       end
+
+      def acquire_ticket_granting_ticket(authentication_result, user_agent = nil)
+        user_data = authentication_result[:user_data]
+        CASinoCore::Model::TicketGrantingTicket.create!({
+          ticket: random_ticket_string('TGC'),
+          authenticator: authentication_result[:authenticator],
+          username: user_data[:username],
+          extra_attributes: user_data[:extra_attributes],
+          user_agent: user_agent
+        })
+      end
+
+      def remove_ticket_granting_ticket(ticket_granting_ticket, user_agent = nil)
+        tgt = find_valid_ticket_granting_ticket(ticket_granting_ticket, user_agent)
+        unless tgt.nil?
+          tgt.destroy
+        end
+      end
+
     end
   end
 end

data/lib/casino_core/helper.rb

@@ -3,6 +3,7 @@ require 'useragent'
 
 module CASinoCore
   module Helper
+    autoload :Authentication, 'casino_core/helper/authentication.rb'
     autoload :Browser, 'casino_core/helper/browser.rb'
     autoload :Logger, 'casino_core/helper/logger.rb'
     autoload :LoginTickets, 'casino_core/helper/login_tickets.rb'

data/lib/casino_core/processor/api/login_credential_acceptor.rb

@@ -0,0 +1,49 @@
+require 'casino_core/processor/api'
+require 'casino_core/helper'
+
+# This processor should be used for API calls: POST /cas/v1/tickets
+class CASinoCore::Processor::API::LoginCredentialAcceptor < CASinoCore::Processor
+  include CASinoCore::Helper::Logger
+  include CASinoCore::Helper::ServiceTickets
+  include CASinoCore::Helper::Authentication
+  include CASinoCore::Helper::TicketGrantingTickets
+
+  # Use this method to process the request. It expects the username in the parameter "username" and the password
+  # in "password".
+  #
+  # The method will call one of the following methods on the listener:
+  # * `#user_logged_in_via_api`: First and only argument is a String with the TGT-id
+  # * `#invalid_login_credentials_via_api`: No argument
+  #
+  # @param [Hash] login_data parameters supplied by user (username and password)
+  def process(login_data)
+    @login_data = login_data
+
+    validate_login_data
+
+    unless @authentication_result.nil?
+      generate_ticket_granting_ticket
+      callback_user_logged_in
+    else
+      callback_invalid_login_credentials
+    end
+  end
+
+  private
+  def validate_login_data
+    @authentication_result = validate_login_credentials(@login_data[:username], @login_data[:password])
+  end
+
+  def callback_user_logged_in
+    @listener.user_logged_in_via_api @ticket_granting_ticket.ticket
+  end
+
+  def generate_ticket_granting_ticket
+    @ticket_granting_ticket = acquire_ticket_granting_ticket(@authentication_result)
+  end
+
+  def callback_invalid_login_credentials
+    @listener.invalid_login_credentials_via_api
+  end
+
+end

data/lib/casino_core/processor/api/logout.rb

@@ -0,0 +1,22 @@
+require 'casino_core/processor'
+require 'casino_core/helper'
+require 'casino_core/model'
+
+# The Logout processor should be used to process API DELET requests to /cas/v1/tickets/TGT-fdsjfsdfjkalfewrihfdhfaie
+class CASinoCore::Processor::API::Logout < CASinoCore::Processor
+  include CASinoCore::Helper::TicketGrantingTickets
+
+  # This method will call `#user_logged_out_via_api`
+  #
+  # @param [String] ticket_granting_ticket Ticket granting ticket to logout
+  def process(ticket_granting_ticket)
+
+    remove_ticket_granting_ticket(ticket_granting_ticket)
+    callback_user_logged_out
+  end
+
+  def callback_user_logged_out
+    @listener.user_logged_out_via_api
+  end
+
+end

data/lib/casino_core/processor/api/service_ticket_provider.rb

@@ -0,0 +1,61 @@
+require 'casino_core/processor'
+require 'casino_core/helper'
+require 'casino_core/model'
+require 'casino_core/builder'
+
+# The ServiceTicketProvider processor should be used to handle API calls: POST requests to /cas/v1/tickets/<ticket_granting_ticket>
+class CASinoCore::Processor::API::ServiceTicketProvider < CASinoCore::Processor
+  include CASinoCore::Helper::ServiceTickets
+  include CASinoCore::Helper::TicketGrantingTickets
+
+  # Use this method to process the request.
+  #
+  # The method will call one of the following methods on the listener:
+  # * `#granted_service_ticket_via_api`: First and only argument is a String with the ST-id
+  # * `#invalid_ticket_granting_ticket_via_api`: No argument
+  # * `#no_service_provided_via_api`: No argument
+  #
+  # @param [String] ticket_granting_ticket ticket_granting_ticket supplied by the user in the URL
+  # @param [Hash] parameters parameters supplied by user (ticket granting ticket and service url)
+  def process(ticket_granting_ticket, parameters)
+    @client_ticket_granting_ticket = ticket_granting_ticket
+    @service_url = parameters[:service]
+
+    fetch_valid_ticket_granting_ticket
+    handle_ticket_granting_ticket
+  end
+
+  private
+  def fetch_valid_ticket_granting_ticket
+    @ticket_granting_ticket = find_valid_ticket_granting_ticket(@client_ticket_granting_ticket, nil)
+  end
+
+  def handle_ticket_granting_ticket
+    case
+    when (@service_url and @ticket_granting_ticket)
+      create_service_ticket
+      callback_granted_service_ticket
+    when (@service_url and not @ticket_granting_ticket)
+      callback_invalid_tgt
+    when (not @service_url and @ticket_granting_ticket)
+      callback_empty_service
+    end
+  end
+
+  def create_service_ticket
+    @service_ticket = acquire_service_ticket(@ticket_granting_ticket, @service_url)
+  end
+
+  def callback_granted_service_ticket
+    @listener.granted_service_ticket_via_api @service_ticket.ticket
+  end
+
+  def callback_invalid_tgt
+    @listener.invalid_ticket_granting_ticket_via_api
+  end
+
+  def callback_empty_service
+    @listener.no_service_provided_via_api
+  end
+
+end

data/lib/casino_core/processor/api.rb

@@ -0,0 +1,9 @@
+module CASinoCore
+  class Processor
+    module API
+      autoload :LoginCredentialAcceptor, 'casino_core/processor/api/login_credential_acceptor.rb'
+      autoload :ServiceTicketProvider, 'casino_core/processor/api/service_ticket_provider.rb'
+      autoload :Logout, 'casino_core/processor/api/logout.rb'
+    end
+  end
+end

data/lib/casino_core/processor/login_credential_acceptor.rb

@@ -6,6 +6,8 @@ class CASinoCore::Processor::LoginCredentialAcceptor < CASinoCore::Processor
   include CASinoCore::Helper::Logger
   include CASinoCore::Helper::LoginTickets
   include CASinoCore::Helper::ServiceTickets
+  include CASinoCore::Helper::Authentication
+  include CASinoCore::Helper::TicketGrantingTickets
 
   # Use this method to process the request. It expects the username in the parameter "username" and the password
   # in "password".
@@ -54,27 +56,4 @@ class CASinoCore::Processor::LoginCredentialAcceptor < CASinoCore::Processor
     end
   end
 
-  def validate_login_credentials(username, password)
-    authentication_result = nil
-    CASinoCore::Settings.authenticators.each do |authenticator_name, authenticator|
-      data = authenticator.validate(username, password)
-      if data
-        authentication_result = { authenticator: authenticator_name, user_data: data }
-        logger.info("Credentials for username '#{data[:username]}' successfully validated using authenticator '#{authenticator_name}' (#{authenticator.class})")
-        break
-      end
-    end
-    authentication_result
-  end
-
-  def acquire_ticket_granting_ticket(authentication_result, user_agent = nil)
-    user_data = authentication_result[:user_data]
-    CASinoCore::Model::TicketGrantingTicket.create!({
-      ticket: random_ticket_string('TGC'),
-      authenticator: authentication_result[:authenticator],
-      username: user_data[:username],
-      extra_attributes: user_data[:extra_attributes],
-      user_agent: user_agent
-    })
-  end
 end

data/lib/casino_core/processor/logout.rb

@@ -17,10 +17,7 @@ class CASinoCore::Processor::Logout < CASinoCore::Processor
   def process(params = nil, cookies = nil, user_agent = nil)
     params ||= {}
     cookies ||= {}
-    ticket_granting_ticket = find_valid_ticket_granting_ticket(cookies[:tgt], user_agent)
-    unless ticket_granting_ticket.nil?
-      ticket_granting_ticket.destroy
-    end
+    remove_ticket_granting_ticket(cookies[:tgt], user_agent)
     @listener.user_logged_out(params[:url])
   end
 end

data/lib/casino_core/processor.rb

@@ -12,6 +12,8 @@ module CASinoCore
     autoload :SessionDestroyer, 'casino_core/processor/session_destroyer.rb'
     autoload :SessionOverview, 'casino_core/processor/session_overview.rb'
 
+    autoload :API, 'casino_core/processor/api.rb'
+
     def initialize(listener)
       @listener = listener
     end

data/spec/processor/api/login_credential_acceptor_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe CASinoCore::Processor::API::LoginCredentialAcceptor do
+  describe '#process' do
+    let(:listener) { Object.new }
+    let(:processor) { described_class.new(listener) }
+
+    context 'with invalid credentials' do
+      let(:login_data) { {username: 'testuser', password: 'wrong'} }
+
+      it 'calls the #invalid_login_credentials method on the listener' do
+        listener.should_receive(:invalid_login_credentials_via_api)
+        processor.process(login_data).should be_false
+      end
+    end
+
+    context 'with valid credentials' do
+      let(:login_data) { {username: 'testuser', password: 'foobar123'} }
+
+      before(:each) do
+        listener.stub(:user_logged_in)
+      end
+
+      it 'calls the #user_logged_in method on the listener' do
+        listener.should_receive(:user_logged_in_via_api).with(/^TGC\-/)
+        processor.process(login_data)
+      end
+
+      it 'generates a ticket-granting ticket' do
+        listener.should_receive(:user_logged_in_via_api).with(/^TGC\-/)
+        expect {
+          processor.process(login_data)
+        }.to change(CASinoCore::Model::TicketGrantingTicket, :count).by(1)
+      end
+    end
+  end
+end

data/spec/processor/api/logout_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe CASinoCore::Processor::API::Logout do
+  describe '#process' do
+    let(:listener) { Object.new }
+    let(:processor) { described_class.new(listener) }
+
+    context 'with an existing ticket-granting ticket' do
+      let(:ticket_granting_ticket) { FactoryGirl.create(:ticket_granting_ticket, user_agent: nil) }
+
+      it 'deletes the ticket-granting ticket' do
+        listener.should_receive(:user_logged_out_via_api)
+        processor.process(ticket_granting_ticket.ticket)
+        CASinoCore::Model::TicketGrantingTicket.where(id: ticket_granting_ticket.id).first.should == nil
+      end
+
+      it 'calls the #user_logged_out_via_api method on the listener' do
+        listener.should_receive(:user_logged_out_via_api)
+        processor.process(ticket_granting_ticket)
+      end
+
+    end
+
+    context 'with an invlaid ticket-granting ticket' do
+      let(:tgt) { 'TGT-lalala' }
+
+      it 'calls the #user_logged_out method on the listener' do
+        listener.should_receive(:user_logged_out_via_api)
+        processor.process(tgt)
+      end
+    end
+  end
+end

data/spec/processor/api/service_ticket_provider_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe CASinoCore::Processor::API::ServiceTicketProvider do
+  describe '#process' do
+    let(:listener) { Object.new }
+    let(:processor) { described_class.new(listener) }
+
+    let(:parameters) { { service: 'http://example.org/' } }
+
+    context 'with an invalid ticket-granting ticket' do
+      let(:ticket_granting_ticket) { 'TGT-INVALID' }
+
+      it 'calls the #invalid_tgt_via_api method on the listener' do
+        listener.should_receive(:invalid_ticket_granting_ticket_via_api)
+        processor.process(ticket_granting_ticket, parameters).should be_false
+      end
+    end
+
+    context 'with a valid ticket-granting ticket' do
+      let(:ticket_granting_ticket) { FactoryGirl.create(:ticket_granting_ticket, user_agent: nil).ticket }
+
+      it 'calls the #granted_service_ticket_via_api method on the listener' do
+        listener.should_receive(:granted_service_ticket_via_api).with(/^ST\-/)
+        processor.process(ticket_granting_ticket, parameters)
+      end
+
+      it 'generates a ticket-granting ticket' do
+        listener.should_receive(:granted_service_ticket_via_api).with(/^ST\-/)
+        expect {
+          processor.process(ticket_granting_ticket, parameters)
+        }.to change(CASinoCore::Model::ServiceTicket, :count).by(1)
+      end
+
+      context 'without a service' do
+        let(:parameters) { { } }
+
+        it 'calls the #no_service_provided_via_api method on the listener' do
+          listener.should_receive(:no_service_provided_via_api)
+          processor.process(ticket_granting_ticket, parameters)
+        end
+      end
+
+    end
+  end
+end
+

data/spec/processor/logout_spec.rb

@@ -46,4 +46,4 @@ describe CASinoCore::Processor::Logout do
       end
     end
   end
-end
+end

metadata

@@ -2,7 +2,7 @@
 name: casino_core
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors: 
 - Nils Caspar
@@ -215,6 +215,7 @@ files:
 - lib/casino_core/builder.rb
 - lib/casino_core/builder/ticket_validation_response.rb
 - lib/casino_core/helper.rb
+- lib/casino_core/helper/authentication.rb
 - lib/casino_core/helper/browser.rb
 - lib/casino_core/helper/logger.rb
 - lib/casino_core/helper/login_tickets.rb
@@ -231,6 +232,10 @@ files:
 - lib/casino_core/model/service_ticket/single_sign_out_notifier.rb
 - lib/casino_core/model/ticket_granting_ticket.rb
 - lib/casino_core/processor.rb
+- lib/casino_core/processor/api.rb
+- lib/casino_core/processor/api/login_credential_acceptor.rb
+- lib/casino_core/processor/api/logout.rb
+- lib/casino_core/processor/api/service_ticket_provider.rb
 - lib/casino_core/processor/legacy_validator.rb
 - lib/casino_core/processor/login_credential_acceptor.rb
 - lib/casino_core/processor/login_credential_requestor.rb
@@ -252,6 +257,9 @@ files:
 - spec/model/service_ticket/single_sign_out_notifier_spec.rb
 - spec/model/service_ticket_spec.rb
 - spec/model/ticket_granting_ticket_spec.rb
+- spec/processor/api/login_credential_acceptor_spec.rb
+- spec/processor/api/logout_spec.rb
+- spec/processor/api/service_ticket_provider_spec.rb
 - spec/processor/legacy_validator_spec.rb
 - spec/processor/login_credential_acceptor_spec.rb
 - spec/processor/login_credential_requestor_spec.rb
@@ -280,7 +288,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1912000289096139821
+      hash: -2705901659147789141
       segments: 
       - 0
       version: "0"