oa-openid 0.1.4 → 0.1.5

data/lib/omniauth/openid.rb

@@ -1,6 +1,57 @@
 require 'omniauth/core'
 
 module OmniAuth
+  # OmniAuth::OpenID provides strategies for authenticating to providers
+  # using the OpenID standard. 
+  # 
+  # # Installation
+  # 
+  # To get just OpenID functionality:
+  # 
+  #     gem install oa-openid
+  # 
+  # For the full auth suite:
+  # 
+  #     gem install omniauth
+  # 
+  # # Stand-Alone Example
+  # 
+  # Use the strategy as a middleware in your application:
+  # 
+  #     require 'omniauth/openid'
+  #     require 'openid/store/filesystem'
+  # 
+  #     use Rack::Session::Cookie
+  #     use OmniAuth::Strategies::OpenID, OpenID::Store::Filesystem.new('/tmp')
+  # 
+  # Then simply direct users to '/auth/open_id' to prompt them for their OpenID identifier. You may also pre-set the identifier by passing an <tt>identifier</tt> parameter to the URL (Example: <tt>/auth/open_id?openid_url=yahoo.com</tt>).
+  # 
+  # A list of all OpenID stores is available at http://github.com/openid/ruby-openid/tree/master/lib/openid/store/
+  # 
+  # # OmniAuth Builder
+  # 
+  # If OpenID is one of several authentication strategies, use the OmniAuth Builder:
+  # 
+  #     require 'omniauth/openid'
+  #     require 'omniauth/basic'  # for Campfire
+  #     require 'openid/store/filesystem'
+  # 
+  #     use OmniAuth::Builder do
+  #       provider :open_id, OpenID::Store::Filesystem.new('/tmp')
+  #       provider :campfire
+  #     end
+  # 
+  # # Configured Identifiers
+  # 
+  # You may pre-configure an OpenID identifier.  For example, to use Google's main OpenID endpoint:
+  # 
+  #     use OmniAuth::Builder do
+  #       provider :open_id, nil, :name => 'google', :identifier => 'https://www.google.com/accounts/o8/id'
+  #     end
+  # 
+  # Note the use of nil, which will trigger ruby-openid's default Memory Store.
+  module OpenID; end
+  
   module Strategies
     autoload :OpenID, 'omniauth/strategies/open_id'
     autoload :GoogleApps, 'omniauth/strategies/google_apps'

data/lib/omniauth/strategies/open_id.rb

@@ -4,6 +4,8 @@ require 'omniauth/openid'
 
 module OmniAuth
   module Strategies
+    # OmniAuth strategy for connecting via OpenID. This allows for connection
+    # to a wide variety of sites, some of which are listed [on the OpenID website](http://openid.net/get-an-openid/).
     class OpenID
       include OmniAuth::Strategy
       
@@ -23,14 +25,24 @@ module OmniAuth
         :image => 'http://axschema.org/media/image/aspect11'
       }
       
+      # @param app [Rack Application] Standard Rack middleware application argument.
+      # @param store [OpenID Store] The [OpenID Store](http://github.com/openid/ruby-openid/tree/master/lib/openid/store/)
+      #   you wish to use. Defaults to OpenID::MemoryStore.
+      # @option options [Array] :required The identity fields that are required for the OpenID 
+      #   request. May be an ActiveExchange schema URL or an sreg identifier.
+      # @option options [Array] :optional The optional attributes for the OpenID request. May
+      #   be ActiveExchange or sreg.
+      # @option options [Symbol, :open_id] :name The URL segment name for this provider.
       def initialize(app, store = nil, options = {})
-        super(app, options.delete(:name) || :open_id)
+        super(app, options[:name] || :open_id)
         @options = options
         @options[:required] ||= [AX[:email], AX[:first_name], AX[:last_name], 'email', 'fullname']
         @options[:optional] ||= [AX[:nickname], AX[:city], AX[:state], AX[:website], AX[:image], 'postcode', 'nickname']
         @store = store
       end
       
+      protected
+      
       def dummy_app
         lambda{|env| [401, {"WWW-Authenticate" => Rack::OpenID.build_header(
           :identifier => identifier,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: oa-openid
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-12 00:00:00 -05:00
+date: 2010-10-19 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,12 +24,12 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 17
         segments: 
         - 0
         - 1
-        - 4
-        version: 0.1.4
+        - 5
+        version: 0.1.5
   requirement: *id001
   name: oa-core
   prerelease: false
@@ -171,7 +171,6 @@ files:
 - lib/omniauth/openid.rb
 - lib/omniauth/strategies/google_apps.rb
 - lib/omniauth/strategies/open_id.rb
-- README.rdoc
 - LICENSE.rdoc
 - CHANGELOG.rdoc
 has_rdoc: true

data/README.rdoc

@@ -1,37 +0,0 @@
-= OmniAuth::OpenID
-
-OpenID strategies for the OmniAuth gem.
-
-== Installation
-
-To get just OpenID functionality:
-
-    gem install oa-openid
-    
-For the full auth suite:
-
-    gem install omniauth
-    
-== Stand-Alone Example
-
-Use the strategy as a middleware in your application:
-
-    require 'omniauth/openid'
-    require 'openid/store/filesystem'
-    
-    use OmniAuth::Strategies::OpenID, OpenID::Store::Filesystem.new('/tmp')
-    
-Then simply direct users to '/auth/open_id' to prompt them for their OpenID identifier. You may also pre-set the identifier by passing an <tt>identifier</tt> parameter to the URL (Example: <tt>/auth/open_id?openid_url=google.com</tt>).
-
-== OmniAuth Builder
-
-If OpenID is one of several authentication strategies, use the OmniAuth Builder:
-
-    require 'omniauth/openid'
-    require 'omniauth/basic'  # for Campfire
-    require 'openid/store/filesystem'
-    
-    use OmniAuth::Builder do
-      provider :open_id, OpenID::Store::Filesystem.new('/tmp')
-      provider :campfire
-    end