rails_openid 0.1.0 → 0.2.0

data/README.rdoc

@@ -6,34 +6,23 @@ infant library, use at your own peril.
 
 == Installation
 
-This gem is provided through Gemcutter so you need to have gem configured to
-pull gems from Gemcutter.
+This gem is provided through RubyGems.org so you need to have gem configured to
+pull gems from RubyGems.org.
 
-=== Enabling Gemcutter
+=== Enabling RubyGems.org (formerly known as GemCutter)
 
-A properly configured environment would be like this:
+You can skip this if you have RubyGems.org enabled (which is going to be the
+default in the future anyway). A properly configured environment should list
+rubygems.org or gemcutter.org in the gem sources, like:
 
   $ gem sources
   *** CURRENT SOURCES ***
-  
-  http://gemcutter.org
-  http://gems.rubyforge.org/
-  http://gems.github.com
 
-If you don't have http://gemcutter.org in your sources then you need to add. I
-know two ways to do. One is installing Gemcutter and running gem tumble:
+  http://rubygems.org/
 
-  $ sudo gem install gemcutter
-  $ gem tumble
+If you don't have it, you can probably add it this way:
 
-Be careful that gem tumble will remove Gemcutter from your repositories if it's
-already there.
-
-The other way is by hand like this:
-
-  $ gem source -a http://gemcutter.org
-
-I'm not sure if there's any difference. I think there isn't one.
+  $ gem source -a http://rubygems.org/
 
 === Installing rails_openid manually
 
@@ -43,7 +32,21 @@ It's simple a matter of running:
 
 and that's it. Let me know if something breaks.
 
-=== Installing through your Ruby on Rails project
+=== Installing through your Ruby on Rails 3 project
+
+In the +Gemfile+ file of your Ruby on Rails project you'll need to add:
+
+  gem "rails_openid"
+
+after that run
+
+  bundle install
+
+and watch the magic happen, all required gems will be installed. Configuring
+your Rails project like that is something you'll need anyway, so this is my
+recommended way.
+
+=== Installing through your Ruby on Rails 2.3 project
 
 In the +environment.rb+ file of your Ruby on Rails project you'll have some
 commented out lines like this:
@@ -65,6 +68,39 @@ and you'll get this and all the gems your Rails project need installed.
 Configuring your Rails project like that is something you'll need anyway, so
 this is my recommended way.
 
+== Getting started
+
+A good way to get started is to run the open_id_scaffold generator:
+
+    ./script/generate open_id_scaffold
+
+Be sure to have the following line in your environment.rb (or the equivalent
+in Rails 3)
+
+    config.gem "rails_openid"
+    config.gem "ruby-openid", :lib => "openid"
+
+To be able to run the provided tests, you'll need mocha, so add:
+
+    config.gem "mocha"
+
+to your config/environments/test.rb
+
+If you don't have a user model, you'll want to create one. You can do it like
+this:
+
+    ./script/generate model User name:string email:string nickname:string
+
+To link your user model to their open ids add the following line to your user
+model:
+
+    has_many :open_ids
+
+rails_openid come with tests you already have in your project. Their failures
+will show things you need to complete on your own. Also, if you go through the
+generated code, search for TODOs and you'll find the places where there's code
+you are likely to want to change.
+
 == API Documentation
 
 Up to date api documentation should be automatically generated on

data/Rakefile

@@ -1,3 +1,6 @@
+# coding: utf-8
+# Copyright 2010 J. Pablo Fernández
+
 require 'rubygems'
 require 'rake'
 
@@ -10,6 +13,7 @@ begin
     gem.email = "pupeno@pupeno.com"
     gem.homepage = "http://github.com/pupeno/rails_openid"
     gem.authors = ["J. Pablo Fernández"]
+    gem.files = %w(LICENSE README.rdoc Rakefile VERSION) + Dir.glob("{lib,generators}/**/*")
     #gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/generators/open_id_scaffold/open_id_scaffold_generator.rb

@@ -0,0 +1,48 @@
+# coding: utf-8
+# Copyright 2010 J. Pablo Fernández
+
+class OpenIdScaffoldGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      # Migration.
+      m.directory "db/migrate"
+      m.migration_template "create_open_ids.rb", "db/migrate", :migration_file_name => "create_open_ids"
+
+      # Model
+      m.directory "app/models"
+      m.directory "test/fixtures"
+      m.directory "test/unit"
+      m.file "open_id.rb", "app/models/open_id.rb"
+      m.file "open_ids.yml", "test/fixtures/open_ids.yml"
+      m.file "open_id_test.rb", "test/unit/open_id_test.rb"
+
+      # Controller
+      m.directory "app/controllers"
+      m.directory "app/views/sessions"
+      m.directory "test/functional"
+      m.file "sessions_controller.rb", "app/controllers/sessions_controller.rb"
+      m.file "new.html.erb", "app/views/sessions/new.html.erb"
+      m.file "sessions_controller_test.rb", "test/functional/sessions_controller_test.rb"
+
+      m.route_resource ":session, :only => [:new, :create, :destroy], :member => { :finish_creating => :get }"
+      
+      # Read me
+      m.readme 'INSTALL'
+    end
+  end
+end
+
+class Rails::Generator::Commands::Create
+  # Generate singleton resources. Copied, pasted and modified from
+  # http://api.rubyonrails.org/classes/Rails/Generator/Commands/Create.html
+  def route_resource(resource)
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+
+    logger.route "map.resource #{resource}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.resource #{resource}\n"
+      end
+    end
+  end
+end

data/generators/open_id_scaffold/templates/INSTALL

@@ -0,0 +1,6 @@
+
+Thank you for trying or using rails_openid, I hope you find it useful.
+
+You can find the latest version, documentation, issues tracker, etc. at
+http://github.com/pupeno/rails_openid Go there for the documentation on how to
+get started.

data/generators/open_id_scaffold/templates/create_open_ids.rb

@@ -0,0 +1,16 @@
+class CreateOpenIds < ActiveRecord::Migration
+  def self.up
+    create_table :open_ids do |t|
+      # TODO: Change if your users table is not users.
+      t.integer :user_id
+      t.string :identifier
+      t.string :display_identifier
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :open_ids
+  end
+end

data/generators/open_id_scaffold/templates/new.html.erb

@@ -0,0 +1,19 @@
+<h1>Log in or Register</h1>
+
+<%=h flash[:notice] %>
+<%=h flash[:message] %>
+
+<p>You don't need to register on this web site. That happens automatically the
+  first time you log in. To log in, just pick one of the services you'd like to
+  use for your identity and you'll be in.</p>
+<p>For example, if you have a Gmail account, you could use Google, if you have a
+  Yahoo! Mail account, then use Yahoo. If you don't have any, you can create an
+  account in any of those or in myOpenID. If you know what you are doing, you
+  can use any OpenID server.</p>
+
+
+<% form_tag session_url, :method => :post, :class => :openid do -%>
+  <%= label :openid_identifier, "OpenID" %>
+  <%= text_field_tag :openid_identifier %>
+  <%= submit_tag "Log in" %>
+<% end -%>

data/generators/open_id_scaffold/templates/open_id.rb

@@ -0,0 +1,22 @@
+class OpenId < ActiveRecord::Base
+  # TODO: If your user model is not user, change it here.
+  # TODO: Add has_many :open_ids to your user model.
+  belongs_to :user
+
+  # TODO: If your user model is not user, change it here.
+  validates_presence_of :user
+  validates_presence_of :identifier
+  attr_accessible :identifier, :display_identifier
+end
+
+# == Schema Information
+#
+# Table name: open_ids
+#
+#  id                 :integer         not null, primary key
+#  user_id            :integer
+#  identifier         :string(255)
+#  display_identifier :string(255)
+#  created_at         :datetime
+#  updated_at         :datetime
+#

data/generators/open_id_scaffold/templates/open_id_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class OpenIdTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end
+
+# == Schema Information
+#
+# Table name: open_ids
+#
+#  id                 :integer(4)      not null, primary key
+#  user_id            :integer(4)      not null
+#  identifier         :string(255)     not null
+#  display_identifier :string(255)
+#  created_at         :datetime
+#  updated_at         :datetime
+#
+

data/generators/open_id_scaffold/templates/open_ids.yml

@@ -0,0 +1,34 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+# TODO: change the user: part if your user model is called firently or rewrite
+# this file to fit your fixtures.
+
+one:
+  # TODO: change to point to an actual user.
+  user: one
+  identifier: http://example.com/one
+  display_identifier: http://example.com/one
+
+the_one:
+  # TODO: change to point to the same user as before.
+  user: one
+  identifier: http://one.example.org
+  display_identifier: http://one.example.org
+
+two:
+  # TODO: change to point to an actual user.
+  user: two
+  identifier: http://example.com/two
+  display_identifier: http://example.com/two
+
+# == Schema Information
+#
+# Table name: open_ids
+#
+#  id                 :integer         not null, primary key
+#  user_id            :integer
+#  identifier         :string(255)
+#  display_identifier :string(255)
+#  created_at         :datetime
+#  updated_at         :datetime
+#

data/generators/open_id_scaffold/templates/sessions_controller.rb

@@ -0,0 +1,43 @@
+class SessionsController < ApplicationController
+  include RailsOpenId
+
+  def new
+    # render an openid form
+  end
+
+  def destroy
+    # TODO: whatever you need to remove the user from the session.
+    session["user_id"] = nil
+    flash[:notice] = "You are now logged out."
+    redirect_to root_url
+  end
+
+  def create
+    # TODO: pick what you want to ask for, email, nickname, fullname, etc.
+    send_open_id_request(params, new_session_url, finish_creating_session_url, ['email', 'nickname', 'fullname'])
+  end
+
+  def finish_creating
+    oid_data = process_open_id_response(params, finish_creating_session_url, new_session_url)
+
+    if oid_data
+      oid = OpenId.find(:first, :conditions => ['identifier = ?', oid_data[:identity_url]], :include => :user)
+
+      if not oid
+        # TODO: whatever you need to do to create a new user.
+        user = User.create!(
+          :name => oid_data['name'],
+          :nickname => oid_data['nickname'],
+          :email => oid_data['email'])
+        oid = user.open_ids.create(
+          :identifier => oid_data[:identity_url],
+          :display_identifier => oid_data[:display_identifier])
+      end
+
+      # TODO: do whatever you need to do to mark the user as logged in, merge it (if you are using ubiquitous_user), etc.
+      session["user_id"] = oid.user.id
+      flash[:notice] = "Welcome #{oid.user.name}, you are now logged in."
+      redirect_to root_url
+    end
+  end
+end

data/generators/open_id_scaffold/templates/sessions_controller_test.rb

@@ -0,0 +1,220 @@
+require 'test_helper'
+require 'mocha'
+
+class SessionsControllerTest < ActionController::TestCase
+  test 'get log in form' do
+    assert_no_difference('User.count') do
+      get :new
+    end
+    assert_response :success
+  end
+
+  test 'start openid authentication' do
+    # Mock out OpenID Request
+    oidreq = mock('OpenID Request')
+    oidreq.expects(:add_extension)
+    oidreq.expects(:return_to_args).returns({})
+    oidreq.expects(:send_redirect?).returns(true)
+    oidreq.expects(:redirect_url).returns('http://cyberspace.com/login')
+    OpenID::Consumer.any_instance.stubs(:begin).returns(oidreq)
+
+    assert_no_difference('User.count') do
+      post :create, :openid_identifier => 'william.cyberspace.com'
+    end
+
+    assert_redirected_to 'http://cyberspace.com/login'
+  end
+
+  test 'start openid authentication with no redirect' do
+    # Mock out OpenID Request
+    oidreq = mock('OpenID Request')
+    oidreq.expects(:add_extension)
+    oidreq.expects(:return_to_args).returns({})
+    oidreq.expects(:send_redirect?).returns(false)
+    body = "blah blah blah"
+    oidreq.expects(:html_markup).returns(body)
+    OpenID::Consumer.any_instance.stubs(:begin).returns(oidreq)
+
+    assert_no_difference('User.count') do
+      post :create, :openid_identifier => 'william.cyberspace.com'
+    end
+
+    assert_response :success
+    assert_equal body, @response.body
+  end
+
+  test 'fail to start openid authentication due to invalid identifier' do
+    OpenID::Consumer.any_instance.stubs(:begin).raises(OpenID::OpenIDError, "Mock OpenID error")
+
+    assert_no_difference('User.count') do
+      post :create, :openid_identifier => 'william.cyberspace.com'
+    end
+
+    assert_redirected_to new_session_url
+  end
+
+  test 'fail to start openid authentication due to empty identifier' do
+    assert_no_difference('User.count') do
+      post :create, :openid_identifier => ''
+    end
+
+    assert_match /enter an OpenID/, flash[:error]
+  end
+
+  test 'fail to start openid authentication due to nil identifier' do
+    assert_no_difference('User.count') do
+      post :create, :openid_identifier => nil
+    end
+
+    assert_match /enter an OpenID/, flash[:error]
+  end
+
+  test 'fail to start openid authentication due to missing identifier' do
+    assert_no_difference('User.count') do
+      post :create
+    end
+
+    assert_match /enter an OpenID/, flash[:error]
+  end
+
+  test 'log in with existing user' do
+    mock_openid_response(:open_id => open_ids(:one))
+
+    assert_no_difference('User.count') do
+      get :finish_creating, :did_sreg => 'y'
+    end
+
+    assert_response :redirect
+    assert_logged_in(open_ids(:one).identifier)
+  end
+
+  test 'log in creating user' do
+    name = 'Ray Bradbury'
+    email = 'ray@mars.com'
+    identifier = 'http://ray.mars.com'
+    mock_openid_response(:name => name, :email => email, :identifier => identifier)
+
+    assert_difference('User.count', +1) do
+      get :finish_creating, :did_sreg => 'y'
+    end
+
+    assert_response :redirect
+    assert_logged_in(identifier)
+    # Verify the user is properly create.
+    oid = OpenId.find(:first, :conditions => ['identifier = ?', identifier])
+    assert oid
+    assert_equal name, oid.user.name
+    assert_equal email, oid.user.email
+  end
+
+  test 'log in creating a user without metadata' do
+    identifier = 'http://ray.mars.com'
+    mock_openid_response(:identifier => identifier)
+
+    assert_difference('User.count', +1) do
+      get :finish_creating, :did_sreg => 'y'
+    end
+
+    assert_response :redirect
+    assert_logged_in(identifier)
+    # Verify the user is properly create.
+    oid = OpenId.find(:first, :conditions => ['identifier = ?', identifier])
+    assert oid
+    assert_equal identifier, oid.identifier
+    assert oid.user.name.blank?
+    assert oid.user.nickname.blank?
+    assert oid.user.email.blank?
+  end
+
+  test 'log in creating a user without metadata and an ugly identifier' do
+    identifier = 'http://ray.mars.com/very/long/and/ugly/identifier/than/nobody/wants/to/ever/see'
+    mock_openid_response(:identifier => identifier)
+
+    assert_difference('User.count', +1) do
+      get :finish_creating, :did_sreg => 'y'
+    end
+
+    assert_response :redirect
+    assert_logged_in(identifier)
+    # Verify the user is properly create.
+    oid = OpenId.find(:first, :conditions => ['identifier = ?', identifier])
+    assert oid
+    #assert_equal User::ANON_NAME, oid.user.name_or_else
+    assert oid.user.name.blank?
+    assert oid.user.email.blank?
+  end
+
+  test 'log in and log out' do
+    mock_openid_response(:open_id => open_ids(:one))
+
+    assert_no_difference('User.count') do
+      get :finish_creating, :did_sreg => 'y'
+    end
+
+    assert_logged_in(open_ids(:one).identifier)
+
+    assert_no_difference('User.count') do
+      get :destroy
+    end
+    assert_nil session[:user_id]
+    assert_nil session[:user_name]
+    assert_match /You are now logged out/, flash[:notice]
+  end
+
+  test 'fail to log in due to cancelled OpenID request' do
+    mock_openid_response(:outcome => :cancel, :identifier => 'example.com')
+
+    assert_no_difference('User.count') do
+      get :finish_creating
+    end
+
+    assert_match /We couldn\'t verify your OpenID/, flash[:error]
+  end
+
+  test 'fail to log in due to cancelled OpenID request with no display identifier' do
+    mock_openid_response(:outcome => :cancel, :identifier => 'example.com', :display_identifier => '')
+
+    assert_no_difference('User.count') do
+      get :finish_creating
+    end
+
+    assert_match /We couldn\'t verify your OpenID/, flash[:error]
+  end
+
+  private
+
+  def assert_logged_in(identifier)
+    oid = OpenId.find(:first, :conditions => ['identifier = ?', identifier])
+    assert oid
+    assert_equal oid.user.id, session[:user_id]
+    #assert_equal oid.user.name_or_else, session[:user_name]
+    #assert_match /#{oid.user.name}.*you are now logged in/, flash[:notice]
+    assert_match /you are now logged in/, flash[:notice]
+  end
+  
+  def mock_openid_response(options = {})
+    identifier = options[:identifier] || options[:open_id].identifier
+    display_identifier = options[:display_identifier] || (options[:open_id] && options[:open_id].display_identifier) || identifier
+    outcome = options[:outcome] || :success
+
+    oidresp = mock("OpenID Response: #{outcome}")
+    oidresp.expects(:status).returns(outcome == :success ? OpenID::Consumer::SUCCESS : OpenID::Consumer::CANCEL).at_least(0)
+    oidresp.expects(:identity_url).returns(identifier).at_least(0)
+    oidresp.expects(:display_identifier).returns(display_identifier).at_least(0)
+    OpenID::Consumer.any_instance.stubs(:complete).returns(oidresp)
+
+    if outcome == :success
+      email = options[:email] or (options[:open_id] and options[:open_id].user and options[:open_id].user.email)
+      name = options[:name] or (options[:open_id] and options[:open_id].user and options[:open_id].user.name)
+      nickname = options[:nickname] or (name and name.split[0])   # users never have a nickname
+
+      sreg_resp = mock('OpenID SReg Response')
+      sreg_resp.expects(:data).at_least(0).returns({
+        'email' => email,
+        'name' => name,
+        'nickname' => nickname
+        })
+      OpenID::SReg::Response.stubs(:from_success_response).returns(sreg_resp)
+    end
+  end
+end

data/lib/rails_openid.rb

@@ -1,3 +1,6 @@
+# coding: utf-8
+# Copyright 2010 J. Pablo Fernández
+
 require 'openid/extensions/sreg'
 require 'openid/store/filesystem'
 
@@ -6,13 +9,14 @@ module RailsOpenId
     # Create the OpenID request, and in the process, verify the URI is valid.
     identifier = params[:openid_identifier]
     if identifier.blank?
+      # TODO: throw an exception, don't redirect.
       flash[:error] = "Please, enter an OpenID identifier (that is, your OpenID address)."
       redirect_to fallback
       return
     end
-  
+    
     oidreq = consumer.begin(identifier)
-  
+    
     if not meta.empty?
       # Request email, nickname and fullname.
       sregreq = OpenID::SReg::Request.new
@@ -20,7 +24,7 @@ module RailsOpenId
       oidreq.add_extension(sregreq)
       oidreq.return_to_args['did_sreg'] = 'y'
     end
-  
+    
     if oidreq.send_redirect?(root_url, return_to)
       redirect_to oidreq.redirect_url(root_url, return_to)
     else
@@ -29,23 +33,27 @@ module RailsOpenId
       render :text => oidreq.html_markup(root_url, root_url, :form_tag_attrs => {'id' => 'openid_form'})
     end
   rescue OpenID::OpenIDError => e
+    # TODO: throw an exception, don't redirect.
     flash[:error] = "#{identifier} doesn't seem to be a valid, working OpenID. Maybe it has a typo?"
     redirect_to fallback
     return
   end
-
+  
   def process_open_id_response(params, current_url, fallback)
     parameters = params.reject {|k,v| request.path_parameters[k] }
     oidresp = consumer.complete(parameters, current_url)
-  
+    
     if oidresp.status == OpenID::Consumer::SUCCESS
-      data = nil
+      data = {}
       if params[:did_sreg]
         sreg_resp = OpenID::SReg::Response.from_success_response(oidresp)
-        data = sreg_resp.data
+        data.merge! sreg_resp.data
       end
-      return oidresp, data
+      data[:identity_url] = oidresp.identity_url
+      data[:display_identifier] = oidresp.display_identifier
+      return data
     else
+      # TODO: throw an exception, don't redirect.
       # Possible non-succes statuses: OpenID::Consumer::FAILURE, OpenID::Consumer::SETUP_NEEDED, OpenID::Consumer::CANCEL
       if not oidresp.display_identifier.blank?
         flash[:error] = "We couldn't verify your OpenID #{oidresp.display_identifier}."
@@ -56,9 +64,9 @@ module RailsOpenId
       return nil
     end
   end
-
+  
   private
-
+  
   def consumer
     if @consumer.nil?
       dir = Pathname.new(RAILS_ROOT).join('db').join('cstore')

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rails_openid
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "J. Pablo Fern\xC3\xA1ndez"
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-29 00:00:00 +01:00
+date: 2010-03-13 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -23,15 +28,21 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
-- .document
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
+- generators/open_id_scaffold/USAGE
+- generators/open_id_scaffold/open_id_scaffold_generator.rb
+- generators/open_id_scaffold/templates/INSTALL
+- generators/open_id_scaffold/templates/create_open_ids.rb
+- generators/open_id_scaffold/templates/new.html.erb
+- generators/open_id_scaffold/templates/open_id.rb
+- generators/open_id_scaffold/templates/open_id_test.rb
+- generators/open_id_scaffold/templates/open_ids.yml
+- generators/open_id_scaffold/templates/sessions_controller.rb
+- generators/open_id_scaffold/templates/sessions_controller_test.rb
 - lib/rails_openid.rb
-- test/helper.rb
-- test/test_rails-openid.rb
 has_rdoc: true
 homepage: http://github.com/pupeno/rails_openid
 licenses: []
@@ -45,18 +56,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: ruby-openid wrappers to make it simpler for a rails app

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,22 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-*.gemspec
-
-## PROJECT::SPECIFIC