Changeset 6324

Timestamp:

03/04/07 22:02:36 (2 years ago)

Author:

david

Message:

Added OpenIdAuthentication::Result to make it easier to deal with default situations where you don't care to do something particular for each error state [DHH] Started on Mocha-based testing

Files:

• plugins/open_id_authentication/CHANGELOG (modified) (1 diff)
• plugins/open_id_authentication/lib/open_id_authentication.rb (modified) (4 diffs)
• plugins/open_id_authentication/README (modified) (2 diffs)
• plugins/open_id_authentication/test/open_id_authentication_test.rb (modified) (1 diff)
• plugins/open_id_authentication/test/status_test.rb (added)

plugins/open_id_authentication/CHANGELOG

@@ +1 @@
+* Added OpenIdAuthentication::Result to make it easier to deal with default situations where you don't care to do something particular for each error state [DHH]
+
-* Stop relying on root_url being defined, we can just grab the current url instead [DHH]

plugins/open_id_authentication/lib/open_id_authentication.rb

@@ -1 +1 @@
-module OpenIdAuthentication
-  OPEN_ID_AUTHENTICATION_DIR = RAILS_ROOT + "/tmp/openids"
+
+  class Result
+    MESSAGES = {
+      :missing    => "Sorry, the OpenID server couldn't be found",
+      :canceled   => "OpenID verification was canceled",
+      :failed     => "Sorry, the OpenID verification failed",
+      :successful => "OpenID authentication successful"
+    }
+    
+    ERROR_STATES = [ :missing, :canceled, :failed ]
+    
+    def self.[](code)
+      new(code)
+    end
+    
+    def initialize(code)
+      @code = code
+    end
+    
+    def ===(code)
+      if code == :unsuccessful && unsuccessful?
+        true
+      else
+        @code == code
+      end
+    end
+    
+    MESSAGES.keys.each { |state| define_method("#{state}?") { @code == state } }
+
+    def unsuccessful?
+      ERROR_STATES.include?(@code)
+    end
+    
+    def message
+      MESSAGES[@code]
+    end
+  end
+
-
-  protected
@@ -18 +56 @@
-  private
-    def begin_open_id_authentication(identity_url, fields = {})
-open_id_consumer.begin(identity_url)
+timeout_protection_from_identity_server { open_id_consumer.begin(identity_url) }
-
-      case open_id_response.status
-      when OpenID::FAILURE
-:missing
+Result[:missing]
-      when OpenID::SUCCESS
-        add_simple_registration_fields(open_id_response, fields)
@@ -30 +68 @@
-  
-    def complete_open_id_authentication
-open_id_consumer.complete(params)
+timeout_protection_from_identity_server { open_id_consumer.complete(params) }
-
-      case open_id_response.status
-      when OpenID::CANCEL
-:canceled
+Result[:canceled]
-      when OpenID::FAILURE
-        logger.info "OpenID authentication failed: #{open_id_response.msg}"
-:failed
+Result[:failed]
-      when OpenID::SUCCESS
-:successful
+Result[:successful]
-      end      
-    end
@@ -59 +97 @@
-      )     
-    end
+
+
+    def timeout_protection_from_identity_server
+      yield
+    rescue Timeout::Error
+      Class.new do
+        def status
+          OpenID::FAILURE
+        end
+        
+        def msg
+          "Identity server timed out"
+        end
+      end.new
+    end
-end

plugins/open_id_authentication/README

@@ -57 +57 @@
-
-      def open_id_authentication(identity_url)
-status
-status
+result
+result
-          when :missing
-            failed_login "Sorry, the OpenID server couldn't be found"
@@ -87 +87 @@
-      end
-  end
+
+
+
+If you're fine with the result messages above and don't need individual logic on a per-failure basis,
+you can collapse the case into a mere boolean:
+
+    def open_id_authentication(identity_url)
+      authenticate_with_open_id(identity_url) do |result, identity_url|
+        if result.successful?
+          if @current_user = @account.users.find_by_identity_url(identity_url)
+            successful_login
+          else
+            failed_login "Sorry, no user by that identity URL exists"
+          end
+        else
+          failed_login(result.message)
+        end
+      end
+    end
-
-

plugins/open_id_authentication/test/open_id_authentication_test.rb

@@ -1 +1 @@
-require 'test/unit'
-
+require 'rubygems'
+gem 'mocha'
+require 'mocha'
+
+gem 'ruby-openid'
+require 'openid'
+
+RAILS_ROOT = File.dirname(__FILE__)
+require File.dirname(__FILE__) + "/../lib/open_id_authentication"
+
-class OpenIdAuthenticationTest < Test::Unit::TestCase
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  end
-end