cassiopeia 0.0.5 → 0.0.6

data/README.rdoc

@@ -4,15 +4,28 @@
 
 == DESCRIPTION:
 
-- Yet another custom CAS client/server implementation
+- Yet another custom CAS client/server implementation. This plugin allows you to perform single-server authorization between two different rails applications. 
 
 = Changelog:
+- 0.0.6: Tiny refactoring.
 - 0.0.5: Some important fixes for configuration exceptions handling.
 - 0.0.4: Fixed problem with default config.
 - 0.0.3: Added required dependency simple_rest. Doc extended.
 - 0.0.2: Added some doc.
 
 
+== INSTALL:
+
+=== Add these lines to environment.rb:
+
+  config.gem 'cassiopeia'
+  config.gem 'simple_rest'
+
+=== Run this from console:
+
+  rake gems:install
+
+
 == SYNOPSIS:
 === Client configuration
 <b>Create a file named config/cassiopeia.yml:</b>
@@ -34,8 +47,8 @@ This will force your application to request authorization from cassiopeia server
 You can also check required roles to access some controllers. To do this, you should add the following line to your controller:
   cas_require_roles :doctor, :admin
 
-This will raise the Cassiopeia::AccessDeniedException if user try to access this controller. You can rescue from this exception by adding the following to application_controller.rb:
-  rescue_from 'Cassiopeia::AccessDeniedException', :with => :access_denied
+This will raise the Cassiopeia::Exception::AccessDenied if user try to access this controller. You can rescue from this exception by adding the following to application_controller.rb:
+  rescue_from 'Cassiopeia::Exception::AccessDenied', :with => :access_denied
   def access_denied
     flash[:notice] = 'Access denied. You dont have permissions to access this page'
     redirect_to root_path
@@ -81,19 +94,11 @@ You should also provide the ability to extract user roles to array by calling ro
   end
 One more thing that might be useful to make everything work properly. Add these lines to routes.rb:
   map.resource :cas
-  map.root :controller => "cas", :action => :index
   map.connect ':controller/:action.:format'
  
+==== Note:
+Server's application controller should has helper method called "current_user".
 
-== INSTALL:
-
-=== Add this line to environment.rb:
-
-  config.gem 'cassiopeia'
-
-=== Run this from console:
-
-  rake gems:install
 
 == LICENSE:
 

data/Rakefile

@@ -10,7 +10,7 @@ PKG_FILES = FileList[ '[a-zA-Z]*',  'lib/**/*' ]
 
 spec = Gem::Specification.new do |s|
   s.name = "cassiopeia"
-  s.version = "0.0.5"
+  s.version = "0.0.6"
   s.author = "smecsia"
   s.email = "smecsia@gmail.com"
   #s.homepage = ""

data/lib/cassiopeia/action_controller_client_mixin.rb

@@ -1,6 +1,7 @@
 module Cassiopeia
   module ActionControllerClientMixin
     module ActionControllerMethods
+      private
       ::CAS_USER_KEY = Cassiopeia::CONFIG[:current_user_key]
       ::CAS_TICKET_ID_KEY = Cassiopeia::CONFIG[:ticket_id_key] 
       ::CAS_TICKET_KEY = Cassiopeia::CONFIG[:ticket_key]

data/lib/cassiopeia/action_controller_server_mixin.rb

@@ -3,12 +3,6 @@ module Cassiopeia
 
   module ActionControllerServerMixin
     module ActionControllerMethods
-      def ActionControllerMethods.rolesMethod=(m)
-        @@rolesMethod = m
-      end
-      def ActionControllerMethods.ticketClass=(c)
-        @@ticketClass = c
-      end
       def cas_ticket_id
         params[@ticket_id_key] || session[@ticket_id_key]
       end
@@ -20,7 +14,7 @@ module Cassiopeia
       end
 
       def cas_require_config
-        unless @@ticketClass
+        unless Cassiopeia::CONFIG[:ticketClass]
           raise ConfigRequired.new "ticketClass should be set to use this functionality"
         end
       end
@@ -36,7 +30,7 @@ module Cassiopeia
 
       def cas_create_or_find_ticket
         if current_user && !(cas_current_ticket_exists?) 
-          @ticket = @@ticketClass.new(:user_id => current_user.id)
+          @ticket = Cassiopeia::CONFIG[:ticketClass].new(:user_id => current_user.id)
           @ticket.user = current_user
           @ticket.service = cas_service_id
           if @ticket.save
@@ -46,20 +40,18 @@ module Cassiopeia
             @ticket = nil
           end
         else
-          @ticket = @@ticketClass.find_by_identity(cas_ticket_id.to_s)
+          @ticket = Cassiopeia::CONFIG[:ticketClass].find_by_identity(cas_ticket_id.to_s)
         end
         @ticket
       end
 
       def cas_current_ticket
         @ticket = cas_create_or_find_ticket unless @ticket
-        logger.debug "\nCurrentTicket = #{@ticket.identity if @ticket}\n" + "="*50
         @ticket
       end
 
       def cas_current_ticket_exists?
-        logger.debug "\nTicketExists = #{@@ticketClass.exists?(cas_ticket_id)}\n" + "="*50
-        @@ticketClass.exists?(cas_ticket_id)
+        Cassiopeia::CONFIG[:ticketClass].exists?(cas_ticket_id) if cas_ticket_id > ""
       end
 
       def cas_current_ticket_valid?
@@ -72,7 +64,7 @@ module Cassiopeia
         if cas_current_ticket.user
           user_hash = cas_current_ticket.user.attributes
           roles = []
-          roles = (cas_current_ticket.user.send @@rolesMethod) if cas_current_ticket.user.respond_to? @@rolesMethod
+          roles = (cas_current_ticket.user.send Cassiopeia::CONFIG[:rolesMethod]) if cas_current_ticket.user.respond_to? Cassiopeia::CONFIG[:rolesMethod]
           roles_hash = roles
           user_hash[:roles] = roles_hash
         else
@@ -85,9 +77,7 @@ module Cassiopeia
       end
 
       def cas_process_request
-        if current_user
-          cas_respond_current_ticket
-        elsif cas_current_ticket_exists?
+        if current_user || cas_current_ticket_exists?
           cas_respond_current_ticket
         else
           @res = {:error => "Ticket not found"}
@@ -104,14 +94,15 @@ module Cassiopeia
       end
 
       def cas_proceed_auth
+        service_url = Cassiopeia::Server::instance.service_url(session)
         if cas_current_ticket_valid? && current_user
           logger.debug "\nCurrentTicketValid, current_user exists redirecting to service...\n" + "="*50
-          return cas_redirect_to Cassiopeia::Server::instance.service_url(session)
+          return cas_redirect_to service_url
         elsif current_user
           logger.debug "\nCurrentTicketInvalid, but current_user exists, should create new ticket...\n" + "="*50
-          cas_current_ticket.destroy
+          cas_current_ticket.destroy if cas_current_ticket_exists?
           cas_create_or_find_ticket
-          return cas_redirect_to Cassiopeia::Server::instance.service_url(session)
+          return cas_redirect_to service_url
         elsif cas_current_ticket_exists?
           logger.debug "\nCurrentTicketInvalid, but current_user exists, destroying ticket, redirecting to login...\n" + "="*50
           cas_current_ticket.destroy
@@ -137,12 +128,14 @@ module Cassiopeia
       end
     end
     def acts_as_cas_controller
-      defaultTicketClass = Ticket if defined? Ticket
-      controllerConfig = Cassiopeia::TicketsControllerConfig.new defaultTicketClass, :roles
+      defaultTicketClass = ((defined? Ticket)?(Ticket):(Class))
+      defaultConfig = {
+        :ticketClass => defaultTicketClass, 
+        :rolesMethod => :roles
+      }
+      controllerConfig = Cassiopeia::TicketsControllerConfig.new defaultConfig
       yield controllerConfig
-      ActionControllerMethods.rolesMethod = controllerConfig.rolesMethod
-      ActionControllerMethods.ticketClass = controllerConfig.ticketClass
-      ActiveRecordServerMixin.ticketClass = controllerConfig.ticketClass
+      Cassiopeia::CONFIG[:rolesMethod], Cassiopeia::CONFIG[:ticketClass] = controllerConfig.rolesMethod, controllerConfig.ticketClass
       skip_before_filter :verify_authenticity_token, :only=> [:create, :index]
       before_filter :require_user, :except => [:create, :index]
       before_filter :cas_store_params, :cas_create_or_find_ticket, :cas_require_config

data/lib/cassiopeia/active_record_server_mixin.rb

@@ -2,8 +2,8 @@ require 'uuidtools'
 
 module Cassiopeia
   module ActiveRecordServerMixin 
-    def ActiveRecordServerMixin.ticketClass=(c)
-      @@ticketClass = c
+    def self.cassiopeia_ticketClass=(c)
+      @@cassiopeia_ticketClass = c
     end
     # cas ticket
     def acts_as_cas_ticket
@@ -13,7 +13,7 @@ module Cassiopeia
           (ticket = self.for_service service) && ticket.expires_at >= DateTime.now
         end
         def for_service(service)
-          @@ticketClass.find(:first, :conditions => {:service => service, :user_id => user.id })
+          @@cassiopeia_ticketClass.find(:first, :conditions => {:service => service, :user_id => user.id })
         end
       end
       instance_eval do

data/lib/cassiopeia/tickets_controller_config.rb

@@ -2,9 +2,8 @@ module Cassiopeia
   class TicketsControllerConfig
     attr_accessor :ticketClass
     attr_accessor :rolesMethod
-    def initialize(tClass, rMethod)
-      @ticketClass = tClass
-      @rolesMethod = rMethod
+    def initialize(opts={})
+      @ticketClass, @rolesMethod = opts[:ticketClass], opts[:rolesMethod]
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cassiopeia
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - smecsia
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-04 00:00:00 +03:00
+date: 2010-03-17 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency