casino_core 0.0.4 → 0.0.5

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/casino_core.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "casino_core"
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nils Caspar"]

data/lib/casino_core/model/login_ticket.rb

@@ -8,4 +8,8 @@ class CASinoCore::Model::LoginTicket < ActiveRecord::Base
   def self.cleanup
     self.delete_all(['created_at < ?', CASinoCore::Settings.login_ticket[:lifetime].seconds.ago])
   end
+
+  def to_s
+    self.ticket
+  end
 end

data/lib/casino_core/processor/legacy_validator.rb

@@ -2,10 +2,16 @@ require 'casino_core/processor'
 require 'casino_core/helper'
 require 'casino_core/model'
 
+# The LegacyValidator processor should be used for GET requests to /validate
 class CASinoCore::Processor::LegacyValidator < CASinoCore::Processor
   include CASinoCore::Helper::Logger
   include CASinoCore::Helper::ServiceTickets
 
+  # This method will call `#validation_succeeded` or `#validation_failed`. In both cases, it supplies
+  # a string as argument. The webapplication should present that string (and nothing else) to the
+  # requestor.
+  #
+  # @param [Hash] params parameters supplied by requestor (a service)
   def process(params = nil)
     params ||= {}
     ticket = CASinoCore::Model::ServiceTicket.where(ticket: params[:ticket]).first

data/lib/casino_core/processor/login_credential_acceptor.rb

@@ -1,11 +1,24 @@
 require 'casino_core/processor'
 require 'casino_core/helper'
 
+# This processor should be used for POST requests to /login
 class CASinoCore::Processor::LoginCredentialAcceptor < CASinoCore::Processor
   include CASinoCore::Helper::Logger
   include CASinoCore::Helper::LoginTickets
   include CASinoCore::Helper::ServiceTickets
 
+  # 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`: The first argument (String) is the URL (if any), the user should be redirected to.
+  #   The second argument (String) is the ticket-granting ticket. It should be stored in a cookie named "tgt".
+  # * `#invalid_login_ticket` and `#invalid_login_credentials`: The first argument is a LoginTicket.
+  #   See {CASinoCore::Processor::LoginCredentialRequestor} for details.
+  #
+  # @param [Hash] params parameters supplied by user
+  # @param [Hash] cookies cookies supplied by user
+  # @param [String] user_agent user-agent delivered by the client
   def process(params = nil, cookies = nil, user_agent = nil)
     params ||= {}
     cookies ||= {}

data/lib/casino_core/processor/login_credential_requestor.rb

@@ -1,6 +1,7 @@
 require 'casino_core/processor'
 require 'casino_core/helper'
 
+# This processor should be used for GET requests to /login
 class CASinoCore::Processor::LoginCredentialRequestor < CASinoCore::Processor
   include CASinoCore::Helper::Browser
   include CASinoCore::Helper::Logger
@@ -8,6 +9,15 @@ class CASinoCore::Processor::LoginCredentialRequestor < 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:
+  # * `#user_logged_in`: The first argument (String) is the URL (if any), the user should be redirected to.
+  # * `#user_not_logged_in`: The first argument is a LoginTicket. It should be stored in a hidden field with name "lt".
+  #
+  # @param [Hash] params parameters supplied by user
+  # @param [Hash] cookies cookies supplied by user
+  # @param [String] user_agent user-agent delivered by the client
   def process(params = nil, cookies = nil, user_agent = nil)
     params ||= {}
     cookies ||= {}

data/lib/casino_core/processor/logout.rb

@@ -2,9 +2,18 @@ require 'casino_core/processor'
 require 'casino_core/helper'
 require 'casino_core/model'
 
+# The Logout processor should be used to process GET requests to /logout.
 class CASinoCore::Processor::Logout < CASinoCore::Processor
   include CASinoCore::Helper::TicketGrantingTickets
 
+  # This method will call `#user_logged_out` and may supply an URL that should be presented to the user.
+  # As per specification, the URL specified by "url" SHOULD be on the logout page with descriptive text.
+  # For example, "The application you just logged out of has provided a link it would like you to follow.
+  # Please click here to access http://www.go-back.edu/."
+  #
+  # @param [Hash] params parameters supplied by user
+  # @param [Hash] cookies cookies supplied by user
+  # @param [String] user_agent user-agent delivered by the client
   def process(params = nil, cookies = nil, user_agent = nil)
     params ||= {}
     cookies ||= {}

metadata

@@ -2,7 +2,7 @@
 name: casino_core
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Nils Caspar
@@ -219,7 +219,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3879793628887711018
+      hash: -263623959609363885
       segments: 
       - 0
       version: "0"