eteos-client 0.2.0 → 0.3.0

data/lib/eteos-client.rb

@@ -1,48 +1,157 @@
-# eteos-client.rb
-#  eteos client for rails
-#  v0.2.0
-#
-# David Adams
-# March 10, 2005
-#
-
-require 'uri'
-require 'net/http'
-
-module EteosClient
-  EteosLoginURL = "http://www.eteos.com/login?url="
-  EteosServer = "www.eteos.com"
-  EteosTicketURI = "/ticket/"
-
-  # authenticate takes session hash and updates it
-  def authenticate
-    # check to see that EteosClientURL is set
-    if EteosClientURL.nil? or EteosClientURL.empty?
-      render_text "Error: you must specify EteosClientURL " +
-                  "in your class definition " +
-                  "before calling authenticate."
-
-    # if eteosUsername is defined, do nothing
-    unless @session["eteosUsername"]
-      unless @params["eteosTicket"]
-        # TODO: URI.escape doesn't sufficiently escape URLs
-        redirect_to EteosLoginURL + URI.escape(EteosClientURL + @request.request_uri)
-      else
-        # we have a ticket, we must check it
-        Net::HTTP.start(EteosServer, 80) do |http|
-          response = http.get("#{EteosTicketURI + @params['eteosTicket']}")
-          status,msg = response.body.split(":")
-          if status == "OK"
-            @session["eteosUsername"] = msg
-            return true
-          else
-            render_text "Invalid Ticket. Please try again!"
-            return false
-          end
-        end
-      end
-    else
-      return true
-    end
-  end
-end
+# eteos-client.rb
+#  eteos client for rails
+#  v0.3.0
+#
+# David Adams
+# March 22, 2005
+#
+
+require 'uri'
+require 'net/http'
+
+# extend ActionController::Base to provide
+# an authentication framework
+class ActionController::Base
+
+ private
+  # this class variable holds the error handler for the controller
+  @@eteos_error_handler = nil
+
+  # this class variable holds the name of the user Model
+  @@eteos_user_model = :User
+
+  # this class variable holds the name of the field in the
+  # user Model where the eteos username is stored
+  @@eteos_username_field = "eteos_username"
+
+  # this class variable holds the name of the field in the
+  # user Model where the last visit timestampe is stored
+  @@eteos_last_visit_field = "last_visit"
+
+ protected
+  def self.eteos_error_handler(m)
+    @@eteos_error_handler = m
+  end
+
+  def self.eteos_user_model(m)
+    @@eteos_user_model = m
+  end
+
+  def self.eteos_username_field(f)
+    @@eteos_username_field = f
+  end
+
+  def self.eteos_last_visit_field(f)
+    @@eteos_last_visit_field = f
+  end
+
+ private
+  EteosLoginURL = "http://www.eteos.com/login?url="
+  EteosServer = "www.eteos.com"
+  EteosTicketURI = "/ticket/"
+
+ protected
+
+  # eteos_authenticate takes session hash and updates it
+  def eteos_authenticate
+    # build request URL
+    request_url = @request.ssl? ? "https://" : "http://" + @request.host_with_port
+
+    # if eteos_username is defined, do nothing
+    unless @session["eteos_username"]
+      unless @params["eteosTicket"]
+        redirect_to EteosLoginURL + URI.escape(request_url + @request.request_uri, '?&+=/[]\% :$')
+      else
+        # we have a ticket, we must check it
+        Net::HTTP.start(EteosServer, 80) do |http|
+          response = http.get("#{EteosTicketURI + @params['eteosTicket']}")
+          status,msg = response.body.split(":")
+          if status == "OK"
+            eteos_update_user_info(msg)
+            return true
+          else
+            eteos_error("Invalid ticket.")
+            return false
+          end
+        end
+      end
+    else
+      eteos_update_user_info(@session['eteos_username'])
+      return true
+    end
+  end
+
+ private
+
+  # handle an error
+  def eteos_error(err)
+    if @@eteos_error_handler.nil?
+      eteos_default_error_handler(err)
+    else
+      result = case @@eteos_error_handler
+        when Symbol
+          self.send(@@eteos_error_handler, err)
+        when Array
+          @session['eteos_error'] = err
+          redirect_to(:controller => @@eteos_error_handler[0],
+                      :action => @@eteos_error_handler[1])
+        else
+          # use the default handler but return a different error
+          eteos_default_error_handler("An error occured, but " +
+                                      "eteos_error_handler was not defined properly!")
+      end
+    end
+  end
+
+  # default error handler
+  def eteos_default_error_handler(err)
+    render_text "ETEOS ERROR: <b>#{err}</b>"
+  end
+
+  # check to see if user model and field exist
+  def eteos_valid_model?
+    # check to see if model exists
+    model = @@eteos_user_model.to_s
+    begin
+      eval "#{model}.new"
+     rescue NameError
+      return false
+    end
+
+    # check to see if field exists
+    field = @@eteos_username_field.to_s
+    begin
+      field_exists = eval "#{model}.new.attributes.include?('#{field}')"
+      return field_exists ? true : false
+
+     rescue NameError
+      return false
+    end
+  end
+
+  def eteos_update_user_info(username)
+    @session["eteos_username"] = username
+
+    if eteos_valid_model?
+      model = @@eteos_user_model.to_s
+      username_field = @@eteos_username_field.to_s
+      last_visit_field = @@eteos_last_visit_field.to_s
+      has_changed = false
+
+      eval <<-END_OF_EVAL
+        user_object = #{model}.find_by_#{username_field}("#{username}")
+        if user_object.nil?
+          user_object = #{model}.new(:#{username_field} => "#{username}")
+          has_changed = true
+        end
+        if user_object.attributes.include? "#{last_visit_field}"
+          user_object.#{last_visit_field} = Time.now
+          has_changed = true
+        end
+
+        user_object.save if has_changed
+       END_OF_EVAL
+    end
+  end
+
+end

metadata

@@ -3,16 +3,16 @@ rubygems_version: 0.8.4
 specification_version: 1
 name: eteos-client
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2005-03-10
-summary: Eteos Client for Ruby on Rails
+  version: 0.3.0
+date: 2005-03-23
+summary: Eteos Client for Rails allows cross-website authentication via the Eteos authentication service (www.eteos.com) in two lines of code for Rails applications. Even integrates with ActiveRecord user models simply and easily.
 require_paths: 
   - lib
 email: daveadams@gmail.com
-homepage: http://eteos-client.rubyforge.org
+homepage: http://rubyforge.org/projects/eteos-client
 rubyforge_project: eteos-client
 description: 
-autorequire: 
+autorequire: eteos-client
 default_executable: 
 bindir: bin
 has_rdoc: false