rack-openid 0.2.3 → 1.0.0

data/README.rdoc

@@ -9,6 +9,8 @@ You trigger an OpenID request similar to HTTP authentication. From your app, ret
 On competition, the OpenID response is automatically verified and assigned to
 <tt>env["rack.openid.response"]</tt>.
 
+=== Rack Example
+
   MyApp = lambda { |env|
     if resp = env["rack.openid.response"]
       case resp.status
@@ -23,3 +25,46 @@ On competition, the OpenID response is automatically verified and assigned to
 
   use Rack::OpenID
   run MyApp
+
+=== Sinatra Example
+
+  # Session needs to be before Rack::OpenID
+  use Rack::Session::Cookie
+
+  require 'rack/openid'
+  use Rack::OpenID
+
+  get '/login' do
+    erb :login
+  end
+
+  post '/login' do
+    if resp = request.env["rack.openid.response"]
+      if resp.status == :success
+        "Welcome: #{resp.display_identifier}"
+      else
+        "Error: #{resp.status}"
+      end
+    else
+      headers 'WWW-Authenticate' => Rack::OpenID.build_header(
+        :identifier => params["openid_identifier"]
+      )
+      throw :halt, [401, 'got openid?']
+    end
+  end
+
+  use_in_file_templates!
+
+  __END__
+
+  @@ login
+  <form action="/login" method="post">
+    <p>
+      <label for="openid_identifier">OpenID:</label>
+      <input id="openid_identifier" name="openid_identifier" type="text" />
+    </p>
+
+    <p>
+      <input name="commit" type="submit" value="Sign in" />
+    </p>
+  </form>

data/lib/rack/openid.rb

@@ -6,8 +6,21 @@ require 'openid/consumer'
 require 'openid/extensions/sreg'
 require 'openid/extensions/ax'
 
-module Rack
+module Rack #:nodoc:
+  # A Rack middleware that provides a more HTTPish API around the
+  # ruby-openid library.
+  #
+  # You trigger an OpenID request similar to HTTP authentication.
+  # From your app, return a "401 Unauthorized" and a "WWW-Authenticate"
+  # header with the identifier you would like to validate.
+  #
+  # On competition, the OpenID response is automatically verified and
+  # assigned to <tt>env["rack.openid.response"]</tt>.
   class OpenID
+    # Helper method for building the "WWW-Authenticate" header value.
+    #
+    #   Rack::OpenID.build_header(:identifier => "http://josh.openid.com/")
+    #     #=> OpenID identifier="http://josh.openid.com/"
     def self.build_header(params = {})
       'OpenID ' + params.map { |key, value|
         if value.is_a?(Array)
@@ -18,6 +31,11 @@ module Rack
       }.join(', ')
     end
 
+    # Helper method for parsing "WWW-Authenticate" header values into
+    # a hash.
+    #
+    #   Rack::OpenID.parse_header("OpenID identifier='http://josh.openid.com/'")
+    #     #=> {:identifier => "http://josh.openid.com/"}
     def self.parse_header(str)
       params = {}
       if str =~ AUTHENTICATE_REGEXP
@@ -33,29 +51,44 @@ module Rack
       params
     end
 
-    class TimeoutResponse
+    class TimeoutResponse #:nodoc:
       include ::OpenID::Consumer::Response
       STATUS = :failure
     end
 
-    class MissingResponse
+    class MissingResponse #:nodoc:
       include ::OpenID::Consumer::Response
       STATUS = :missing
     end
 
+    # :stopdoc:
+
     HTTP_METHODS = %w(GET HEAD PUT POST DELETE OPTIONS)
 
     RESPONSE = "rack.openid.response".freeze
     AUTHENTICATE_HEADER = "WWW-Authenticate".freeze
     AUTHENTICATE_REGEXP = /^OpenID/.freeze
 
+    URL_FIELD_SELECTOR = lambda { |field| field.to_s =~ %r{^https?://} }
+
+    # :startdoc:
 
+    # Initialize middleware with application and optional OpenID::Store.
+    # If no store is given, OpenID::Store::Memory is used.
+    #
+    #   use Rack::OpenID
+    #
+    # or
+    #
+    #   use Rack::OpenID, OpenID::Store::Memcache.new
     def initialize(app, store = nil)
       @app = app
       @store = store || default_store
       freeze
     end
 
+    # Standard Rack +call+ dispatch that accepts an +env+ and
+    # returns a <tt>[status, header, body]</tt> response.
     def call(env)
       req = Rack::Request.new(env)
       if env["REQUEST_METHOD"] == "GET" && req.GET["openid.mode"]
@@ -181,8 +214,6 @@ module Rack
         oidreq.redirect_url(trust_root || realm_url(req), return_to || request_url)
       end
 
-      URL_FIELD_SELECTOR = lambda { |field| field.to_s =~ %r{^https?://} }
-
       def add_simple_registration_fields(oidreq, fields)
         sregreq = ::OpenID::SReg::Request.new
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rack-openid
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors: 
 - Joshua Peek
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-06 00:00:00 -06:00
+date: 2010-02-18 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency