Merge pull request #4 from vasilakisfil/refactor/various_enhancements

refactor module methods, fix tests

Author: vasilakisfil

lib/rubycas-server-core.rb

@@ -6,6 +6,7 @@
 require "rubycas-server-core/settings"
 require "rubycas-server-core/database"
 require "rubycas-server-core/util"
+require "rubycas-server-core/tickets/generations"
 require "rubycas-server-core/tickets/validations"
 require "rubycas-server-core/tickets"
 

lib/rubycas-server-core/error.rb

@@ -14,5 +14,11 @@ def to_s
         message
       end
     end
+
+    class RubyCASServerCoreError < StandardError
+    end
+
+    class RecordNotFound < RubyCASServerCoreError
+    end
   end
 end

lib/rubycas-server-core/tickets.rb

@@ -4,20 +4,18 @@ module RubyCAS
   module Server
     module Core
       module Tickets
-
         class LT
-          include ::RubyCAS::Server::Core
-          include ::RubyCAS::Server::Core::Tickets
+          extend ::RubyCAS::Server::Core::Tickets::Generations
           extend ::RubyCAS::Server::Core::Tickets::Validations
 
           def self.create!(client = "localhost")
-            lt = Tickets.generate_login_ticket(client)
+            lt = generate_login_ticket(client)
             raise 'error that should be handled by rubycas-server-core gem' if !lt
             return lt
           end
 
           def self.create(client = "localhost")
-            Tickets.generate_login_ticket(client)
+            generate_login_ticket(client)
           end
 
           def self.validate(lt)
@@ -40,20 +38,19 @@ def self.find_by!(options)
         end
 
         class TGT
-          include ::RubyCAS::Server::Core
-          include ::RubyCAS::Server::Core::Tickets
+          extend ::RubyCAS::Server::Core::Tickets::Generations
           extend ::RubyCAS::Server::Core::Tickets::Validations
 
-          def self.create!(user, client = "localhost", remember_me = false, extra_attributes)
-            tgt = Tickets.generate_ticket_granting_ticket(
+          def self.create!(user, client = "localhost", remember_me = false, extra_attributes = {})
+            tgt = generate_ticket_granting_ticket(
               user, client, remember_me, extra_attributes
             )
             raise 'error that should be handled by rubycas-server-core gem' if !tgt
             return tgt
           end
 
-          def self.create(user, client = "localhost", remember_me = false, extra_attributes)
-            Tickets.generate_ticket_granting_ticket(
+          def self.create(user, client = "localhost", remember_me = false, extra_attributes = {})
+            generate_ticket_granting_ticket(
               user, client, remember_me, extra_attributes
             )
           end
@@ -79,18 +76,17 @@ def self.find_by!(options)
         end
 
         class ST
-          include ::RubyCAS::Server::Core
-          include ::RubyCAS::Server::Core::Tickets
+          extend ::RubyCAS::Server::Core::Tickets::Generations
           extend ::RubyCAS::Server::Core::Tickets::Validations
 
           def self.create!(service, user, tgt, client="localhost")
-            st = Tickets.generate_service_ticket(service, user, tgt, client)
+            st = generate_service_ticket(service, user, tgt, client)
             raise 'error that should be handled by rubycas-server-core gem' if !st
             return st
           end
 
           def self.create(service, user, tgt, client="localhost")
-            Tickets.generate_service_ticket(service, user, tgt, client)
+            generate_service_ticket(service, user, tgt, client)
           end
 
           def self.validate(service, ticket)
@@ -126,72 +122,6 @@ def self.build_ticketed_url(service, ticket)
             Util.build_ticketed_url(service, ticket)
           end
         end
-
-
-        # One time login ticket for given client
-        def self.generate_login_ticket(client)
-          lt = LoginTicket.new
-          lt.ticket = "LT-" + Util.random_string
-          lt.client_hostname = client
-          if lt.save!
-            $LOG.debug("Login ticket '#{lt.ticket} has been created for '#{lt.client_hostname}'")
-            return lt
-          else
-            return nil
-          end
-        end
-
-        # Creates a TicketGrantingTicket for the given username. This is done when the user logs in
-        # for the first time to establish their SSO session (after their credentials have been validated).
-        #
-        # The optional 'extra_attributes' parameter takes a hash of additional attributes
-        # that will be sent along with the username in the CAS response to subsequent
-        # validation requests from clients.
-        def self.generate_ticket_granting_ticket(
-          username,
-          client,
-          remember_me = false,
-          extra_attributes = {}
-        )
-          tgt = TicketGrantingTicket.new
-          tgt.ticket = "TGC-" + Util.random_string
-          tgt.username = username
-          tgt.remember_me = remember_me
-          tgt.extra_attributes = extra_attributes.to_s
-          tgt.client_hostname = client
-          if tgt.save!
-            $LOG.debug("Generated ticket granting ticket '#{tgt.ticket}' for user" +
-              " '#{tgt.username}' at '#{tgt.client_hostname}'" +
-              (extra_attributes.empty? ? "" : " with extra attributes #{extra_attributes.inspect}"))
-            return tgt
-          else
-            return nil
-          end
-        end
-
-        def self.generate_service_ticket(service, username, tgt, client)
-          st = tgt.service_tickets.new
-          st.ticket = "ST-" + Util.random_string
-          st.service = service
-          st.username = username
-          st.ticket_granting_ticket = tgt
-          st.client_hostname = client
-          if st.save
-            $LOG.debug("Generated service ticket '#{st.ticket}' for service '#{st.service}'" +
-              " for user '#{st.username}' at '#{st.client_hostname}'")
-            return st
-          else
-            return nil
-          end
-        end
-
-        def self.generate_proxy_ticket(target_service, pgt, client)
-          raise NotImplementedError
-        end
-
-        def self.generate_proxy_granting_ticket(pgt_url, st, client)
-          raise NotImplementedError
-        end
       end
     end
   end

lib/rubycas-server-core/tickets/generations.rb

@@ -0,0 +1,76 @@
+require 'rubycas-server-core/util'
+
+module RubyCAS
+  module Server
+    module Core
+      module Tickets
+        module Generations
+          # One time login ticket for given client
+          def generate_login_ticket(client)
+            lt = LoginTicket.new
+            lt.ticket = "LT-" + Util.random_string
+            lt.client_hostname = client
+            if lt.save!
+              $LOG.debug("Login ticket '#{lt.ticket} has been created for '#{lt.client_hostname}'")
+              return lt
+            else
+              return nil
+            end
+          end
+
+          # Creates a TicketGrantingTicket for the given username. This is done when the user logs in
+          # for the first time to establish their SSO session (after their credentials have been validated).
+          #
+          # The optional 'extra_attributes' parameter takes a hash of additional attributes
+          # that will be sent along with the username in the CAS response to subsequent
+          # validation requests from clients.
+          def generate_ticket_granting_ticket(
+            username,
+            client,
+            remember_me = false,
+            extra_attributes = {}
+          )
+            tgt = TicketGrantingTicket.new
+            tgt.ticket = "TGC-" + Util.random_string
+            tgt.username = username
+            tgt.remember_me = remember_me
+            tgt.extra_attributes = extra_attributes.to_s
+            tgt.client_hostname = client
+            if tgt.save!
+              $LOG.debug("Generated ticket granting ticket '#{tgt.ticket}' for user" +
+                " '#{tgt.username}' at '#{tgt.client_hostname}'" +
+                (extra_attributes.empty? ? "" : " with extra attributes #{extra_attributes.inspect}"))
+              return tgt
+            else
+              return nil
+            end
+          end
+
+          def generate_service_ticket(service, username, tgt, client)
+            st = tgt.service_tickets.new
+            st.ticket = "ST-" + Util.random_string
+            st.service = service
+            st.username = username
+            st.ticket_granting_ticket = tgt
+            st.client_hostname = client
+            if st.save
+              $LOG.debug("Generated service ticket '#{st.ticket}' for service '#{st.service}'" +
+                " for user '#{st.username}' at '#{st.client_hostname}'")
+              return st
+            else
+              return nil
+            end
+          end
+
+          def generate_proxy_ticket(target_service, pgt, client)
+            raise NotImplementedError
+          end
+
+          def generate_proxy_granting_ticket(pgt_url, st, client)
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

spec/rubycas-server-core/tickets/generations_spec.rb

@@ -0,0 +1,109 @@
+require "spec_helper"
+
+module RubyCAS::Server::Core::Tickets
+  describe RubyCAS::Server::Core::Tickets::Generations do
+    let(:client_hostname) { 'myhost.test' }
+    let(:username) { 'myuser' }
+    let(:service) { 'https://myservice.test' }
+
+    before do
+      RubyCAS::Server::Core.setup("spec/config/config.yml")
+      @generations = Class.new
+      @generations.extend(RubyCAS::Server::Core::Tickets::Generations)
+    end
+
+    describe '.generate_login_ticket(client_hostname)' do
+      before do
+        @lt = @generations.generate_login_ticket(client_hostname)
+      end
+
+      it "should return a login ticket" do
+        @lt.class.should == LoginTicket
+      end
+
+      it "should set the client_hostname" do
+        @lt.client_hostname.should == client_hostname
+      end
+
+      it "should set the ticket string" do
+        @lt.ticket.should_not be_nil
+      end
+
+      it "should set the ticket string starting with 'LT'" do
+        @lt.ticket.should(match(/^LT/))
+      end
+
+      it "should not mark the ticket as consumed" do
+        @lt.consumed.should be_nil
+      end
+    end
+
+    describe ".generate_ticket_granting_ticket(username, extra_attributes = {})" do
+      before do
+        @tgt = @generations.generate_ticket_granting_ticket(username, client_hostname)
+      end
+
+      it "should return a TicketGrantingTicket" do
+        @tgt.class.should == TicketGrantingTicket
+      end
+
+      it "should set the tgt's ticket string" do
+        @tgt.ticket.should_not be_nil
+      end
+
+      it "should generate a ticket string starting with 'TGC'" do
+        @tgt.ticket.should(match(/^TGC/))
+      end
+
+      it "should set the tgt's username string" do
+        @tgt.username.should == username
+      end
+
+      it "should set the tgt's client_hostname" do
+        @tgt.client_hostname.should == client_hostname
+      end
+    end
+
+    describe ".generate_service_ticket(service, username, tgt)" do
+      before do
+        @tgt = @generations.generate_ticket_granting_ticket(username, client_hostname)
+        @st = @generations.generate_service_ticket(service, username, @tgt, client_hostname)
+      end
+
+      it "should return a ServiceTicket" do
+        @st.class.should == ServiceTicket
+      end
+
+      it "should not include the service identifer in the ticket string" do
+        @st.ticket.should_not(match(/#{service}/))
+      end
+
+      it "should not mark the ST as consumed" do
+        @st.consumed.should be_nil
+      end
+
+      it "must generate a ticket that starts with 'ST-'" do
+        @st.ticket.should(match(/^ST-/))
+      end
+
+      it "should assoicate the ST with the supplied TGT" do
+        @st.ticket_granting_ticket.id.should == @tgt.id
+      end
+    end
+
+    describe ".generate_proxy_ticket(target_service, pgt)" do
+      it "should return a ProxyGrantingTicket" do
+        skip('Not supported')
+      end
+
+      it "should not consume the generated ticket" do
+        skip('Not supported')
+      end
+
+      it "should start the ticket string with PT-" do
+        skip('Not supported')
+      end
+    end
+  end
+end
+