danwrong-merb_openid 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Dan Webb
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,68 @@
+merb_openid
+===========
+
+A plugin for Merb that wraps the ruby-openid gem (2.x) and provides an easy interface for consuming OpenIDs
+in a very similar way to the open_id_authentication plugin for Rails.
+
+Installation
+============
+
+Easy:
+
+   gem install danwrong-merb_openid --source http://gems.github.com
+   
+Then in your application's init.rb:
+
+   dependency 'merb_openid'
+   
+The plugin uses the pretty limited memory store by default but you can add a new store using Merb::Config:
+
+   Merb::Config[:merb_openid][:store] = OpenID::Store::Memory.new
+   
+You'll probably want to use a database store on production apps.  I'll start adding adapters based on the
+various ORMs soon.
+
+Usage
+=====
+
+In your routes you need to make sure that the url you consume OpenIDs from can accept get requests, so:
+
+   r.match('openid').(:controller => 'session', :action => 'openid')
+   
+Then in your controller:
+
+  class Session < Merb::Controller
+  
+    def openid
+      if openid_request? # has the user provided a url (openid_url)
+        openid_authenticate do |result, identity_url|
+          if result == :success
+            user = User.find_by_openid_url(identity_url)
+          end
+        end
+      end
+    end
+    
+  end
+  
+SReg
+====
+
+Getting SReg data is easy too:
+
+  class Session < Merb::Controller
+  
+    def openid
+      if openid_request? # has the user provided a url (openid_url)
+        openid_authenticate(:fields => [:fullname, :email]) do |result, identity_url, sreg|
+          if result == :success
+            user = User.find_by_openid_url(identity_url)
+            user.name = sreg[:fullname]
+          end
+        end
+      end
+    end
+    
+  end
+  
+More to come!

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+spec = eval(File.read(File.join(File.dirname(__FILE__), 'merb_openid.gemspec')))
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{spec.name}-#{spec.version} --no-update-sources}
+end
+
+namespace :jruby do
+
+  desc "Run :package and install the resulting .gem with jruby"
+  task :install => :package do
+    sh %{#{SUDO} jruby -S gem install pkg/#{spec.name}-#{Merb::VERSION}.gem --no-rdoc --no-ri}
+  end
+  
+end

data/lib/merb_openid/controller_extensions.rb

@@ -0,0 +1,110 @@
+require 'openid'
+require 'openid/extensions/sreg'
+require 'openid/store/memory'
+
+module MerbOpenID
+  
+  def self.store
+    @@store
+  end
+  
+  def self.store=(val)
+    @@store = val
+  end 
+  
+  module ControllerExtensions
+    
+    def openid_request?(open_id_param=params[:openid_url])
+      !!((open_id_param && !open_id_param.blank?) || params[:openid_complete])
+    end
+    
+    def openid_authenticate(options={}, &block)
+      open_id_param = options.delete(:open_id_param) || params[:openid_url]
+      
+      unless params[:openid_complete]
+        begin_openid_authentication(open_id_param, options, &block)
+      else
+        complete_openid_authentication(&block)
+      end
+    end
+    
+    def openid_consumer
+      @@openid_consumer ||= OpenID::Consumer.new session, MerbOpenID.store
+    end
+    
+    private
+    
+    def begin_openid_authentication(openid_url, options={})
+      fields = options[:sreg] || {}
+      immediate = (options[:immediate] === true)
+      
+      request = openid_consumer.begin(openid_url)
+      
+      add_sreg_fields(request, fields)
+      
+      redirect openid_provider_url(request, immediate)
+      
+    rescue OpenID::OpenIDError, Timeout::Error
+      yield :missing
+    end
+    
+    def complete_openid_authentication
+      query_string_params = Merb::Request.query_parse(request.query_string)
+      
+      begin
+        response = openid_consumer.complete(query_string_params, openid_return_to)
+        identity_url = response.endpoint.claimed_id
+        
+        case response.status
+          when OpenID::Consumer::SUCCESS
+            yield :successful, identity_url, OpenID::SReg::Response.from_success_response(response)
+          when OpenID::Consumer::CANCEL
+            yield :cancelled, identity_url, nil
+          when OpenID::Consumer::FAILURE
+            yield :failed, identity_url, nil
+          when OpenID::Consumer::SETUP_NEEDED
+            yield :setup_needed, identity_url, response.setup_url
+        end
+      rescue Timeout::Error
+        yield :failed
+      end
+    end
+    
+    def add_sreg_fields(request, fields)
+      if fields.is_a?(Array)
+        required, optional = fields, []
+      else
+        required = fields[:required] || []
+        optional = fields[:optional] || []
+      end
+      
+      sreg = OpenID::SReg::Request.new
+      
+      sreg.request_fields(required.collect { |f| f.to_s }, true) unless required.empty?
+      sreg.request_fields(optional.collect { |f| f.to_s }, false) unless optional.empty?
+      
+      request.add_extension(sreg)
+    end
+    
+    def openid_provider_url(request, immediate)
+      request.return_to_args['openid_complete'] = '1'
+      request.redirect_url(openid_trust_root, openid_return_to, immediate)
+    end
+    
+    def openid_trust_root
+      @openid_trust_root ||= [request.protocol, request.host, "/"].join
+    end
+    
+    def openid_return_to
+      @openid_return_to ||= [request.protocol, request.host, request.uri].join
+    end
+    
+  end
+  
+end
+
+Merb::Controller.class_eval do
+  include MerbOpenID::ControllerExtensions
+end
+
+MerbOpenID.store = (Merb::Config[:merb_openid] && Merb::Config[:merb_openid][:store]) || OpenID::Store::Memory.new

data/lib/merb_openid.rb

@@ -0,0 +1,12 @@
+if defined?(Merb::Plugins)
+  
+  Merb::BootLoader.before_app_loads do
+    dependency 'openid', '>= 2.0.0'
+    Merb::Config[:merb_openid] ||= {}
+  end
+  
+  Merb::BootLoader.after_app_loads do
+    require 'merb_openid/controller_extensions'
+  end
+  
+end

data/spec/merb_openid_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "merb_openid" do
+  it "should do nothing" do
+    true.should == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: danwrong-merb_openid
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Dan Webb
+autorequire: merb_openid
+bindir: bin
+cert_chain: []
+
+date: 2008-06-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-openid
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+description: A Merb plugin for consuming OpenID
+email: dan@danwebb.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- LICENSE
+- README
+- Rakefile
+- lib/merb_openid.rb
+- lib/merb_openid/controller_extensions.rb
+- spec/merb_openid_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A Merb plugin for consuming OpenID
+test_files: []
+