cassy 1.0.0 → 1.0.2

data/README.markdown

@@ -2,3 +2,42 @@
 
 This project is designed to be a Rails 3.0 engine that uses a large portion of the code from the [rubycas-server][https://github.com/gunark/rubycas-server] project. Certain portions of this code belong to the rubycas-server project owners.
 
+## Installation
+
+This engine currently only works with Rails 3.0. To have it work with the application you must do three things:
+
+**Install as a gem**
+
+Put this line in your project's `Gemfile`:
+
+    gem 'cassy'
+
+Create a new initializer (probably called `config/initializers/cassy.rb`) and point cassy at the correct configuration file of your application:
+
+    Cassy::Engine.config.config_file = Rails.root + "config/cassy.yml"
+    
+Create this configuration file at `config/cassy.yml`. Fill it with these values:
+
+    # Times are in seconds.
+    maximum_unused_login_ticket_lifetime: 300
+    maximum_unused_service_ticket_lifetime: 300
+
+    authenticator:
+      class: Cassy::Authenticators::Devise
+
+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.
+
+Boom, done. Now this application will act as a CAS server.
+
+## 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.
+
+These configuration options are detailed here for your convenience. For specific term definitions, please consult the CAS spec.
+
+`authenticator`: Must specify at least one key, `class`, which is a string version of a constant that will be used for authentication in the system. This constant *must* respond to `validate`.
+`maximum_unused_login_ticket_lifetime`: The time before a login ticket would expire.
+`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.
+ 

data/lib/cassy/authenticators/devise.rb

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

data/lib/cassy/cas.rb

@@ -8,6 +8,19 @@ require 'cassy/utils'
 # the Cassy::Controllers module.
 module Cassy
   module CAS
+
+    class Error
+      attr_reader :code, :message
+
+      def initialize(code, message)
+        @code = code
+        @message = message
+      end
+
+      def to_s
+        message
+      end
+    end
     
     def settings
       Cassy.config
@@ -147,7 +160,7 @@ module Cassy
         error = "No ticket granting ticket given."
         logger.debug error
       elsif tgt = TicketGrantingTicket.find_by_ticket(ticket)
-        if settings.config[:maximum_session_lifetime] && Time.now - tgt.created_on > settings.config[:maximum_session_lifetime]
+        if settings[:maximum_session_lifetime] && Time.now - tgt.created_on > settings[:maximum_session_lifetime]
   	tgt.destroy
           error = "Your session has expired. Please log in again."
           logger.info "Ticket granting ticket '#{ticket}' for user '#{tgt.username}' expired."

metadata

@@ -2,7 +2,7 @@
 name: cassy
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors: 
 - ryan@rubyx.com
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 +10:00
+date: 2011-06-28 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -137,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3009467735426729429
+      hash: -1080296284138574585
       segments: 
       - 0
       version: "0"
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3009467735426729429
+      hash: -1080296284138574585
       segments: 
       - 0
       version: "0"