cassy 1.0.2 → 1.1.0

data/README.markdown

@@ -27,11 +27,21 @@ Create this configuration file at `config/cassy.yml`. Fill it with these values:
 
 The first two keys are the time-to-expiry for the login and service tickets respectively. The class for the authentication can be any constant which responds to a `validates` method. By default, only Devise authentication is supported at the moment.
 
+Next, you will need to tell Cassy to load its routes in your application which you can do by calling `cassy` in `config/routes.rb`:
+
+    Rails.application.routes.draw do
+      cassy
+      
+      # your routes go here
+    end
+
 Boom, done. Now this application will act as a CAS server.
 
+For customization options please see the "Customization" section below.
+
 ## Configuration
 
-The configuration options for this gem go into a file, probably `config/cassy.yml` at the root of the project if you've set it up as advised, and allow the engine to be customised.
+The configuration options for this gem goes into a file called `config/cassy.yml` at the root of the project if you've set it up as advised, and this allows the engine to be configured.
 
 These configuration options are detailed here for your convenience. For specific term definitions, please consult the CAS spec.
 
@@ -40,4 +50,21 @@ These configuration options are detailed here for your convenience. For specific
 `maximum_unused_service_ticket_lifetime`: The time before a service ticket would expire.
 `username_field`: Defines the field on the users table which is used for the lookup for the username. Defaults to "username".
 `username_label`: Allows for the "Username" label on the sign in page to be given a different value. Helpful if you want to call it "Email" or "User Name" instead.
+
+## Customization
+
+### Sessions Controller
+
+In Cassy, it is possible to override the controller which is used for authentication. To do this, the controller can be configured in `config/routes.rb`:
+
+    cassy :controllers => "sessions"
+
+By doing this, it will point at the `SessionsController` rather than the default of `Cassy::SessionsController`. This controller then should inherit from `Cassy::SessionsController` to inherit the original behaviour and will need to point to the views of Cassy:
+
+    class SessionsController < Cassy::SessionsController
+      def new
+        # custom behaviour goes here
+        super
+      end
+        
  

data/lib/cassy.rb

@@ -1,22 +1,12 @@
+require 'cassy/generators/views_generator'
+require 'cassy/routes'
+
 module Cassy
   extend ActiveSupport::Autoload
   
   autoload :CAS
   autoload :Utils
   autoload :Engine
-
-  def self.draw_routes
-    Rails.application.routes.draw do
-      scope(:path => "cas") do
-        get 'login', :to => "cassy/sessions#new"
-        post 'login', :to => "cassy/sessions#create"
-        
-        get 'logout', :to => "cassy/sessions#destroy"
-        
-        get 'serviceValidate', :to => "cassy/sessions#service_validate"
-      end
-    end
-  end
   
   def self.root
     Pathname.new(File.dirname(__FILE__) + "../..")

data/lib/cassy/authenticators/base.rb

@@ -13,6 +13,10 @@ module Cassy
       # You can leave this empty if you don't need to set up anything.
       def self.setup(options)
       end
+      
+      def self.find_user(credentials)
+        raise NotImplementedError
+      end
 
       # This is called prior to #validate (i.e. each time the user tries to log in).
       # Any per-instance initialization for the authenticator should be done here.
@@ -25,6 +29,22 @@ module Cassy
         @extra_attributes = {}
       end
 
+      def self.extra_attributes
+        @extra_attributes
+      end
+      
+      def self.extra_attributes_to_extract
+        if @options[:extra_attributes].kind_of? Array
+          attrs = @options[:extra_attributes]
+        elsif @options[:extra_attributes].kind_of? String
+          attrs = @options[:extra_attributes].split(',').collect{|col| col.strip}
+        else
+          attrs = []
+        end
+
+        attrs
+      end
+
       # Override this to implement your authentication credential validation.
       # This is called each time the user tries to log in. The credentials hash
       # holds the credentials as entered by the user (generally under :username
@@ -36,10 +56,6 @@ module Cassy
         raise NotImplementedError, "This method must be implemented by a class extending #{self.class}"
       end
 
-      def extra_attributes
-        @extra_attributes
-      end
-
       protected
       def self.read_standard_credentials(credentials)
         @username = credentials[:username]

data/lib/cassy/authenticators/devise.rb

@@ -1,10 +1,15 @@
 module Cassy
   module Authenticators
     class Devise < Base
-      def self.validate(credentials)
+      
+      def self.find_user(credentials)
         # Find the user with the given email
         method = "find_by_#{Cassy.config[:username_field] || 'email'}"
-        user = User.send(method, credentials[:username])
+        User.send(method, credentials[:username])
+      end
+      
+      def self.validate(credentials)
+        user = find_user(credentials)
         # Did we find a user, and is their password valid?
         user && user.valid_password?(credentials[:password])
       end

data/lib/cassy/authenticators/test.rb

@@ -11,12 +11,17 @@ class Cassy::Authenticators::Test < Cassy::Authenticators::Base
 
     raise Cassy::AuthenticatorError, "Username is 'do_error'!" if @username == 'do_error'
 
-    # @extra_attributes[:test_utf_string] = "Ютф"
-    # @extra_attributes[:test_numeric] = 123.45
-    # @extra_attributes[:test_serialized] = {:foo => 'bar', :alpha => [1,2,3]}
-
     valid_password = options[:password] || "testpassword"
 
     return @password == valid_password
   end
+  
+  def self.find_user(*args)
+    # To stop NotImplementedError raising
+    @user = Object.new
+    def @user.full_name
+      "Example User"
+    end
+    @user
+  end
 end

data/lib/cassy/cas.rb

@@ -43,11 +43,12 @@ module Cassy
     # 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)
+    def generate_ticket_granting_ticket(username, extra_attributes={})
       # 3.6 (ticket granting cookie/ticket)
       tgt = Cassy::TicketGrantingTicket.new
       tgt.ticket = "TGC-" + Cassy::Utils.random_string
       tgt.username = username
+      tgt.extra_attributes = extra_attributes
       tgt.client_hostname = env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_HOST'] || env['REMOTE_ADDR']
       tgt.save!
       tgt

data/lib/cassy/generators/views_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+require 'tmpdir'
+
+# "Borrowed" from Devise
+module Cassy
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../app/views", __FILE__)
+      desc "Copies all Cassy views to your application."
+
+      def copy_views
+        directory "cassy", "app/views/cassy"
+      end
+    end
+  end
+end

data/lib/cassy/routes.rb

@@ -0,0 +1,18 @@
+module ActionDispatch::Routing
+  class Mapper
+    def cassy(options={})
+      options[:controllers] ||= HashWithIndifferentAccess.new
+      options[:controllers][:sessions] ||= "cassy/sessions"
+      scope(:path => "cas") do
+        root :to => "#{options[:controllers][:sessions]}#new"
+        get 'login', :to => "#{options[:controllers][:sessions]}#new"
+        post 'login', :to => "#{options[:controllers][:sessions]}#create"
+        
+        get 'logout', :to => "#{options[:controllers][:sessions]}#destroy"
+        
+        get 'serviceValidate', :to => "#{options[:controllers][:sessions]}#service_validate"
+        get 'proxyValidate',   :to => "#{options[:controllers][:sessions]}#proxy_validate"
+      end
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: cassy
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors: 
 - ryan@rubyx.com
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-28 00:00:00 +10:00
+date: 2011-08-01 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -116,7 +116,9 @@ files:
 - lib/cassy/authenticators.rb
 - lib/cassy/cas.rb
 - lib/cassy/engine.rb
+- lib/cassy/generators/views_generator.rb
 - lib/cassy/models.rb
+- lib/cassy/routes.rb
 - lib/cassy/utils.rb
 - lib/cassy.rb
 - lib/tasks/cassy_tasks.rake
@@ -137,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1080296284138574585
+      hash: 2685991807394344055
       segments: 
       - 0
       version: "0"
@@ -146,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1080296284138574585
+      hash: 2685991807394344055
       segments: 
       - 0
       version: "0"