devise_openid_authenticatable 1.0.0.alpha1

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/README.md

@@ -0,0 +1,102 @@
+devise_openid_authenticatable
+==========================
+
+Written by Nat Budin
+
+devise_openid_authenticatable is [OpenID](http://openid.net) authentication support for
+[Devise](http://github.com/plataformatec/devise) applications.  It is very thin and uses
+[Rack::OpenID](http://github.com/josh/rack-openid) for most of the actual work.
+
+Requirements
+------------
+
+- Devise 1.0.6 or later (including 1.1 versions)
+- rack-openid
+
+Installation
+------------
+
+    gem install --pre devise_openid_authenticatable
+    
+and add devise_openid_authenticatable to your Gemfile or config/environment.rb as a gem
+dependency.
+
+Example
+-------
+
+I've modified the devise_example application to work with this gem.  You can find the results
+[here](http://github.com/nbudin/devise_openid_example).
+    
+Setup
+-----
+
+Once devise\_openid\_authenticatable is installed, add the following to your user model:
+
+    devise :openid_authenticatable
+    
+You can also add other modules such as token_authenticatable, trackable, etc.  Database_authenticatable
+should work fine alongside openid_authenticatable.
+
+You'll also need to set up the database schema for this:
+
+    create_table :users do |t|
+      t.openid_authenticatable
+    end
+
+and, optionally, indexes:
+
+    add_index :users, :identity_url, :unique => true
+    
+In addition, you'll need to modify sessions/new.html.erb (or the appropriate scoped view if you're
+using those).  You need to add a field for identity_url, and remove username and password if you
+aren't using database_authenticatable:
+
+    <% form_for resource_name, resource, :url => session_path(resource_name) do |f| -%>
+      <p><%= f.label :identity_url %></p>
+      <p><%= f.text_field :identity_url %></p>
+
+      <% if devise_mapping.rememberable? -%>
+        <p><%= f.check_box :remember_me %> <%= f.label :remember_me %></p>
+      <% end -%>
+
+      <p><%= f.submit "Sign in" %></p>
+    <% end -%>
+
+Finally, you'll need to add the following in your Rails configuration:
+
+    config.middleware.use Rack::OpenID
+    
+which is the Rack middleware that actually does most of the heavy lifting here.
+
+Automatically creating users
+----------------------------
+
+If you want to have users automatically created when a new OpenID identity URL is
+successfully used to sign in, you can implement a method called "create_from_identity_url"
+to your user model class:
+
+    class User < ActiveRecord::Base
+      devise :openid_authenticatable
+      
+      def self.create_from_identity_url(identity_url)
+        User.create(:identity_url => identity_url)
+      end
+    end
+    
+Ideally I'd like to add support for using sreg attributes here as well, to populate other
+fields in the user table.
+
+See also
+--------
+
+* [OpenID](http://openid.net)
+* [Rack::OpenID](http://github.com/josh/rack-openid)
+* [Devise](http://github.com/plataformatec/devise)
+* [Warden](http://github.com/hassox/warden)
+
+TODO
+----
+
+* Add sreg attributes support
+* Write test suite
+* Test on non-ActiveRecord ORMs

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the devise_openid_authenticatable plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the devise_openid_authenticatable plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'devise_openid_authenticatable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "devise_openid_authenticatable"
+    gemspec.summary = "OpenID authentication module for Devise"
+    gemspec.description = "OpenID authentication module for Devise using Rack::OpenID"
+    gemspec.email = "natbudin@gmail.com"
+    gemspec.homepage = "http://github.com/nbudin/devise_cas_authenticatable"
+    gemspec.authors = ["Nat Budin"]
+    gemspec.add_runtime_dependency "devise", ">= 1.0.6"
+    gemspec.add_runtime_dependency "rack-openid", "~> 1.0.3"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0.alpha1

data/devise_openid_authenticatable.gemspec

@@ -0,0 +1,53 @@
+# 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{devise_openid_authenticatable}
+  s.version = "1.0.0.alpha1"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nat Budin"]
+  s.date = %q{2010-05-21}
+  s.description = %q{OpenID authentication module for Devise using Rack::OpenID}
+  s.email = %q{natbudin@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "devise_openid_authenticatable.gemspec",
+     "lib/devise_openid_authenticatable.rb",
+     "lib/devise_openid_authenticatable/model.rb",
+     "lib/devise_openid_authenticatable/routes.rb",
+     "lib/devise_openid_authenticatable/schema.rb",
+     "lib/devise_openid_authenticatable/strategy.rb",
+     "rails/init.rb"
+  ]
+  s.homepage = %q{http://github.com/nbudin/devise_cas_authenticatable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{OpenID authentication module for Devise}
+
+  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_runtime_dependency(%q<devise>, [">= 1.0.6"])
+      s.add_runtime_dependency(%q<rack-openid>, ["~> 1.0.3"])
+    else
+      s.add_dependency(%q<devise>, [">= 1.0.6"])
+      s.add_dependency(%q<rack-openid>, ["~> 1.0.3"])
+    end
+  else
+    s.add_dependency(%q<devise>, [">= 1.0.6"])
+    s.add_dependency(%q<rack-openid>, ["~> 1.0.3"])
+  end
+end
+

data/lib/devise_openid_authenticatable/model.rb

@@ -0,0 +1,9 @@
+module Devise
+  module Models
+    module OpenidAuthenticatable
+      def find_by_identity_url(identity_url)
+        find(:first, :conditions => {:identity_url => identity_url})
+      end
+    end
+  end
+end

data/lib/devise_openid_authenticatable/routes.rb

@@ -0,0 +1,16 @@
+if ActionController::Routing.name =~ /ActionDispatch/
+  # We're on Rails 3
+  ActionDispatch::Routing::Mapper.class_eval do
+    protected
+  
+    alias_method :devise_openid, :devise_session
+  end
+else
+  # We're on Rails 2
+
+  ActionController::Routing::RouteSet::Mapper.class_eval do
+    protected
+
+    alias_method :openid_authenticatable, :database_authenticatable
+  end
+end

data/lib/devise_openid_authenticatable/schema.rb

@@ -0,0 +1,5 @@
+Devise::Schema.class_eval do
+  def openid_authenticatable
+    apply_schema :identity_url, String
+  end
+end

data/lib/devise_openid_authenticatable/strategy.rb

@@ -0,0 +1,43 @@
+require 'devise/strategies/base'
+require 'rack/openid'
+
+module Devise
+  module Strategies
+    class OpenidAuthenticatable < Base
+      def valid?
+        env[Rack::OpenID::RESPONSE] || (mapping.to.respond_to?(:find_by_identity_url) && 
+          params[scope] && !params[scope]["identity_url"].blank?)
+      end
+
+      def authenticate!
+        RAILS_DEFAULT_LOGGER.info("Authenticating with OpenID for mapping #{mapping.to}")
+        if resp = env[Rack::OpenID::RESPONSE]
+          RAILS_DEFAULT_LOGGER.info "Attempting OpenID auth: #{env["rack.openid.response"].inspect}"
+          case resp.status
+          when :success
+            u = mapping.to.find_by_identity_url(resp.identity_url)
+            if u
+              success!(u)
+            elsif mapping.to.respond_to?(:create_from_identity_url)
+              success!(mapping.to.create_from_identity_url(resp.identity_url))
+            else
+              fail!("This OpenID URL is not associated with any registered user")
+            end
+          when :cancel
+            fail!("OpenID auth cancelled")
+          when :failure
+            fail!("OpenID auth failed")
+          end
+        else
+          header_data = Rack::OpenID.build_header(:identifier => params[scope]["identity_url"])
+          RAILS_DEFAULT_LOGGER.info header_data
+          custom!([401, {
+                Rack::OpenID::AUTHENTICATE_HEADER => header_data
+              }, "Sign in with OpenID"])
+        end
+      end
+    end
+  end
+end
+
+Warden::Strategies.add(:openid_authenticatable, Devise::Strategies::OpenidAuthenticatable)

data/lib/devise_openid_authenticatable.rb

@@ -0,0 +1,11 @@
+require 'devise'
+
+require 'devise_openid_authenticatable/schema'
+require 'devise_openid_authenticatable/strategy'
+require 'devise_openid_authenticatable/routes'
+
+Devise.add_module(:openid_authenticatable, 
+  :strategy => true,
+  :model => 'devise_openid_authenticatable/model',
+  :controller => :sessions,
+  :route => :openid)

data/rails/init.rb

@@ -0,0 +1 @@
+require "devise_openid_authenticatable"

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: devise_openid_authenticatable
+version: !ruby/object:Gem::Version 
+  hash: -1710980573
+  prerelease: true
+  segments: 
+  - 1
+  - 0
+  - 0
+  - alpha1
+  version: 1.0.0.alpha1
+platform: ruby
+authors: 
+- Nat Budin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-21 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: devise
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 0
+        - 6
+        version: 1.0.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack-openid
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :runtime
+  version_requirements: *id002
+description: OpenID authentication module for Devise using Rack::OpenID
+email: natbudin@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- README.md
+- Rakefile
+- VERSION
+- devise_openid_authenticatable.gemspec
+- lib/devise_openid_authenticatable.rb
+- lib/devise_openid_authenticatable/model.rb
+- lib/devise_openid_authenticatable/routes.rb
+- lib/devise_openid_authenticatable/schema.rb
+- lib/devise_openid_authenticatable/strategy.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/nbudin/devise_cas_authenticatable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: OpenID authentication module for Devise
+test_files: []
+