warden-openid 0.0.1 → 0.1.0

data/README.rdoc

@@ -1,9 +1,76 @@
-= warden-openid
+= Warden OpenID Strategy
 
-Description goes here.
+== Install
+
+ $ gem install warden-openid
+
+== Usage
+
+=== 1. Configure Warden uses OpenID strategy
+
+ require 'warden-openid'
+
+ use Rack::Session::Cookie
+ use Rack::OpenID
+ use Warden::Manager do |manager|
+   manager.default_strategies :openid
+   manager.failure_app = FailureApp
+ end
+
+=== 2. Setup user finder
+
+ Warden::OpenID.configure do |config|
+   config.user_finder do |response|
+     User.find_by_identity_url(response.identity_url)
+   end
+ end
+
+_response_ is an instance of <tt>OpenID::Consumer::Response</tt>.
+
+=== 3. Create route and view
+
+Example by Sinatra and Haml:
+
+ post '/signin' do
+   authenticate!
+ end
+
+ %form(action='/signin' method='post')
+   %input(type='text' name='openid_identifier')
+   %input(type='submit' value='Sign in')
+
+This strategy starts with _openid_identifier_ parameter.
+
+You may need to customize <tt>/unauthenticated</tt> route. Please refer to examples directory for details.
+
+== Fetch additional fields from server
+
+ Warden::OpenID.configure do |config|
+   config.required_fields = 'email'
+   config.optional_fields = %w(nickname fullname)
+
+   config.user_finder do |response|
+     fields = OpenID::SReg::Response.from_success_response(response)
+     p fields['email']
+     p fields['nickname']
+   end
+ end
+
+== Caveats
+
+If you use this with Rails, please don't use <tt>OpenID::Store::Memory</tt>. A problem occurs by class reloading in the development mode.
+
+For example, <tt>OpenID::Store::Filesystem</tt> is used instead:
+
+ require 'openid/store/filesystem'
+ Rails.configuration.middleware.use Rack::OpenID, OpenID::Store::Filesystem.new(Rails.root + 'tmp/openid')
+
+== Contributors
+
+* Philip H. MacIver
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/examples/sinatra/.gitignore

@@ -0,0 +1 @@
+.bundle/*

data/examples/sinatra/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'sinatra'
+gem 'warden-openid'
+gem 'haml'
+gem 'rack-flash'

data/examples/sinatra/Gemfile.lock

@@ -0,0 +1,39 @@
+--- 
+dependencies: 
+  haml: 
+    group: 
+    - :default
+    version: ">= 0"
+  rack-flash: 
+    group: 
+    - :default
+    version: ">= 0"
+  warden-openid: 
+    group: 
+    - :default
+    version: ">= 0"
+  sinatra: 
+    group: 
+    - :default
+    version: ">= 0"
+specs: 
+- haml: 
+    version: 3.0.10
+- rack: 
+    version: 1.1.0
+- rack-flash: 
+    version: 0.1.1
+- ruby-openid: 
+    version: 2.1.7
+- rack-openid: 
+    version: 1.0.3
+- sinatra: 
+    version: "1.0"
+- warden: 
+    version: 0.10.7
+- warden-openid: 
+    version: 0.0.1
+hash: a1205587e00609d6a930be402bdd2afbd252e0c0
+sources: 
+- Rubygems: 
+    uri: http://gemcutter.org

data/examples/sinatra/README

@@ -0,0 +1,5 @@
+$ gem install bundler
+$ bundle install
+$ rackup
+
+visit http://localhost:9292

data/examples/sinatra/app.rb

@@ -0,0 +1,84 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler.require :default
+
+users = {}
+
+Warden::OpenID.configure do |config|
+  config.user_finder do |response|
+    users[response.identity_url]
+  end
+end
+
+helpers do
+  def warden
+    env['warden']
+  end
+end
+
+get '/' do
+  haml <<-'HAML'
+%p#notice= flash[:notice]
+%p#error= flash[:error]
+
+- if warden.authenticated?
+  %p
+    Welcome #{warden.user}!
+    %a(href='/signout') Sign out
+- else
+  %form(action='/signin' method='post')
+    %p
+      %label
+        OpenID:
+        %input(type='text' name='openid_identifier')
+      %input(type='submit' value='Sign in')
+  HAML
+end
+
+post '/signin' do
+  warden.authenticate!
+  flash[:notice] = 'You signed in'
+  redirect '/'
+end
+
+get '/signout' do
+  warden.logout(:default)
+  flash[:notice] = 'You signed out'
+  redirect '/'
+end
+
+post '/unauthenticated' do
+  if openid = env['warden.options'][:openid]
+    # OpenID authenticate success, but user is missing
+    # (Warden::OpenID.user_finder returns nil)
+    session[:identity_url] = openid[:response].identity_url
+    redirect '/register'
+  else
+    # OpenID authenticate failure
+    flash[:error] = warden.message
+    redirect '/'
+  end
+end
+
+get '/register' do
+  haml <<-'HAML'
+%form(action='/signup' method='post')
+  %p
+    %label
+      Name:
+      %input(type='text' name='name')
+    %input(type='submit' value='Sign up')
+  HAML
+end
+
+post '/signup' do
+  if (name = params[:name]).empty?
+    redirect '/register'
+  else
+    users[session.delete(:identity_url)] = name
+    warden.set_user name
+    flash[:notice] = 'You signed up'
+    redirect '/'
+  end
+end

data/examples/sinatra/config.ru

@@ -0,0 +1,12 @@
+require 'app'
+
+use Rack::Session::Cookie
+use Rack::OpenID
+
+use Warden::Manager do |manager|
+  manager.default_strategies :openid
+  manager.failure_app = Sinatra::Application
+end
+
+use Rack::Flash
+run Sinatra::Application

data/lib/warden/openid.rb

@@ -3,8 +3,51 @@ require 'rack/openid'
 
 module Warden
   module OpenID
-    def self.user_finder(&block)
-      block ? @@_user_finder = block : @@_user_finder
+    CONFIG_EXAMPLE = <<-CODE
+Warden::OpenID.configure do |config|
+  config.user_finder do |response|
+    # do something
+  end
+end
+    CODE
+
+    class Config
+      attr_accessor :required_fields, :optional_fields, :policy_url
+
+      def user_finder(&block)
+        @user_finder = block
+      end
+
+      def find_user(response)
+        raise "Warden::OpenID::Config#user_finder has not been set yet.\n\n#{Warden::OpenID::CONFIG_EXAMPLE}" unless @user_finder
+        @user_finder.call(response)
+      end
+
+      def to_params
+        {
+          :required   => required_fields,
+          :optional   => optional_fields,
+          :policy_url => policy_url
+        }
+      end
+    end
+
+    class << self
+      def config
+        @@config ||= Config.new
+      end
+
+      def configure(&block)
+        block.call(config)
+      end
+
+      def user_finder(&block)
+        $stderr.puts "DEPRECATION WARNING: Warden::OpenID.user_finder is deprecated. Use Warden::OpenID::Config#user_finder instead.\n\n#{CONFIG_EXAMPLE}"
+
+        configure do |config|
+          config.user_finder(&block)
+        end
+      end
     end
 
     class Strategy < Warden::Strategies::Base
@@ -12,7 +55,7 @@ module Warden
         if response = env[Rack::OpenID::RESPONSE]
           case response.status
           when :success
-            if user = Warden::OpenID.user_finder.call(response)
+            if user = Warden::OpenID.config.find_user(response)
               success!(user)
             else
               fail!('User not found')
@@ -22,10 +65,10 @@ module Warden
             fail!(response.respond_to?(:message) ? response.message : "OpenID authentication failed: #{response.status}")
           end
         elsif identifier = params['openid_identifier']
-          if identifier.empty?
+          if identifier.nil? || identifier.empty?
             fail!('OpenID identifier is required')
           else
-            custom!([401, {'WWW-Authenticate' => Rack::OpenID.build_header(:identifier => identifier)}, ''])
+             custom!([401, {'WWW-Authenticate' => Rack::OpenID.build_header(Warden::OpenID.config.to_params.merge(:identifier => identifier))}, ''])
           end
         end
       end

data/warden-openid.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{warden-openid}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Keita Urashima"]
+  s.date = %q{2010-06-10}
+  s.description = %q{A warden strategy for authenticate with OpenID}
+  s.email = %q{ursm@ursm.jp}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/sinatra/.gitignore",
+     "examples/sinatra/Gemfile",
+     "examples/sinatra/Gemfile.lock",
+     "examples/sinatra/README",
+     "examples/sinatra/app.rb",
+     "examples/sinatra/config.ru",
+     "lib/warden-openid.rb",
+     "lib/warden/openid.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/warden-openid_spec.rb",
+     "warden-openid.gemspec"
+  ]
+  s.homepage = %q{http://github.com/ursm/warden-openid}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A warden strategy for authenticate with OpenID}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/warden-openid_spec.rb",
+     "examples/sinatra/app.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<warden>, [">= 0"])
+      s.add_runtime_dependency(%q<rack-openid>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<warden>, [">= 0"])
+      s.add_dependency(%q<rack-openid>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<warden>, [">= 0"])
+    s.add_dependency(%q<rack-openid>, [">= 0"])
+  end
+end
+

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: warden-openid
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Keita Urashima
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-19 00:00:00 +09:00
+date: 2010-06-10 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -35,9 +38,11 @@ dependencies:
   name: warden
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -47,9 +52,11 @@ dependencies:
   name: rack-openid
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -71,11 +78,18 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- examples/sinatra/.gitignore
+- examples/sinatra/Gemfile
+- examples/sinatra/Gemfile.lock
+- examples/sinatra/README
+- examples/sinatra/app.rb
+- examples/sinatra/config.ru
 - lib/warden-openid.rb
 - lib/warden/openid.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/warden-openid_spec.rb
+- warden-openid.gemspec
 has_rdoc: true
 homepage: http://github.com/ursm/warden-openid
 licenses: []
@@ -86,26 +100,31 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A warden strategy for authenticate with OpenID
 test_files: 
 - spec/spec_helper.rb
 - spec/warden-openid_spec.rb
+- examples/sinatra/app.rb