hobo_openid 0.4.0

data/.gitignore

@@ -0,0 +1,2 @@
+hobo_openid.gemspec
+pkg

data/CREDITS

@@ -0,0 +1,8 @@
+OpenID Authentication for Hobo
+CREDITS
+
+V1 by TheOtherShoe (Jesse Hallett), posted 10/22/2007 to hobocentral.net
+   available at http://sitr.us/openid_authentication_for_hobo.tar.gz
+
+V2 by mdj42 (Matt Jones), rewritten 6/7/2008
+   contact: al2o3cr@gmail.com for questions / comments / bugs / etc.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2007 Jesse Hallett
+
+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.markdown

@@ -0,0 +1,101 @@
+OpenID Authentication for Hobo (VERSION 3)
+==========================================
+
+This plugin provides support for OpenID login. You can add OpenID login as
+alternative login and registering method (and still allow login using
+email + password).
+
+Installing
+===========
+
+- Install Hobo gem
+- Install the ruby-openid and ruby-yadis gems.
+- Unpack the plugin in your vendor/plugins directory.
+
+
+Setting up
+==========
+
+This plugin works basically the same way authenticated user support
+works in Hobo. There are just a couple of extra things you will need
+to set up. Here is the process in its entirety:
+
+
+Modify user model
+-------------------
+
+The default hobo command now creates the User model - change User
+as appropriate if you call it something else.
+
+Open app/models/user.rb and add
+
+    openid        :string
+
+field.
+
+Modify users controller
+-------------------------
+
+Open app/controllers/users_controller.rb and add follwing line to the controller class:
+
+    openid_login({ :openid_opts => { :model => User } })
+
+
+Create OpenID login page
+------------------------
+
+Create app/views/users/openid_login.dryml with following content:
+
+    <login-page>
+      <form:>
+        <labelled-item-list>
+               <labelled-item>
+                 <item-label>OpenID</item-label>
+                 <item-value><input type="text" name="login" id="login" class="string"/></item-value>
+               </labelled-item>
+
+               <labelled-item if="&Hobo::User.default_user_model.column_names.include?('remember_token')">
+                 <item-label class="field-label">Remember me:</item-label>
+                 <item-value><input type="checkbox" name="remember_me" id="remember-me"/></item-value>
+               </labelled-item>
+             </labelled-item-list>
+             <set user="&Hobo::User.default_user_model"/>
+             <div class="actions">
+               <submit label='Log in'/>
+             </div>
+      </form:>
+    </login-page>
+
+Add links to OpenID login page on login and signup pages
+--------------------------------------------------------
+
+Create app/views/users/signup.dryml with content
+
+    <signup-page>
+      <append-body:>
+        Or <a href="&openid_login_users_path">sign up using OpenID</a>.
+      </append-body:>
+    </signup-page>
+
+and app/views/users/login.dryml with content
+
+    <login-page>
+      <append-body:>
+        Or <a href="&openid_login_users_path">log in using OpenID</a>.
+      </append-body:>
+    </login-page>
+
+
+Create routes
+-------------
+
+Add this lines to config/routes.rb:
+
+    map.openid_login_users 'users/openid_login', :controller => 'users', :action => 'openid_login', :conditions => {:method => :get}
+    map.complete_openid_users 'users/complete_openid', :controller => 'users', :action => 'complete_openid', :conditions => {:method => :get}
+
+
+Simple Registration
+===================
+
+Currently unsupported.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hobo_openid"
+    gem.summary = %Q{OpenID login for Hobo}
+    gem.description = %Q{Adds ability to login with OpenID to Hobo-based applications. See README to start using it.}
+    gem.email = "jbartosik@gmail.com"
+    gem.homepage = "http://github.com/ahenobarbi/hobo_openid"
+    gem.authors = ["Joachim Filip Ignacy Bartosik"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    #gem.add_dependency "hobo", ">=1.0.0"
+    gem.add_dependency "rails", ">=2.3.5"
+    gem.require_paths = ['lib']
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hobo_openid #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/lib/hobo_openid.rb

@@ -0,0 +1,35 @@
+require 'hobo'
+require 'openid'
+require 'openid_controller'
+
+class ActionController::Base
+
+  # Recognized options
+  #   :login_action     - default :openid_login
+  #   :complete_action  - default :complete_openid
+  #   :openid_opts      - forwarded to hobo_openid_login, hobo_openid_complete
+  #   :openid_opts recognizes
+  #     :model        - class of your user model (required)
+  #     :login        - field of params where users provide openIDs (default :login)
+  #     :return_to    - page to return after OpenID auth. -> should point to action executing hobo_openid_complete
+  #     :openid_field - field of your user model that stores openID
+  #     :mappings       - simple registration mappings (currently unsupported)
+  #     :redirect_to    - where to redirect after success
+  #     :*_notice       - failure, cancellation, setup_needed, new_user_failure
+  def self.openid_login(options = {})
+    options.reverse_merge!(:login_action => :openid_login,
+                            :complete_action => :complete_openid,
+                            :openid_opts => Hash.new)
+
+    include Hobo::OpenidController
+
+    define_method(options[:complete_action]) do
+      hobo_openid_complete(options[:openid_opts])
+    end
+
+    define_method(options[:login_action]) do
+      hobo_openid_login(request, options[:openid_opts])
+    end
+
+  end
+end

data/lib/openid_controller.rb

@@ -0,0 +1,163 @@
+require 'openid'
+require 'openid/extensions/sreg'
+require 'openid/store/memory'
+module Hobo
+  module OpenidController
+    # Login action for controller. Parameters:
+    # Recognized options are:
+    #   :model      - class of your user model (default User)
+    #   :login      - field of params where users provide openIDs (default :login)
+    #   :return_to  - page to return
+    def hobo_openid_login(request, options = {})
+      options.reverse_merge!(:success_notice => "You have logged in",
+	  	      :failure_notice => "Verification failed",
+	  	      :cancellation_notice => "Verification cancelled",
+	  	      :setup_needed_notice => "OpenID server reports setup is needed",
+	  	      :new_user_failure_notice => "Could not create a new user account",
+	  	      :redirect_to => { :controller => "front", :action => "index" },
+            :model => User,
+            :openid_field => :openid,
+            :mappings => [])
+      options.reverse_merge!(:return_to => url_for(:action => :complete_openid),
+                              :model => User, :login => :login)
+
+      return unless request.post?
+
+      openid = params[options[:login]]
+
+      begin
+        oidreq = openid_consumer.begin openid
+      rescue => e
+        flash[:error] = "Discovery failed: #{e}"
+        redirect_to homepage(request) and return
+      end
+
+      redirect_to oidreq.redirect_url(homepage(request), options[:return_to])
+    end
+
+    # Complete user login. Recognized options:
+    #   :model          - class of your user model
+    #   :openid_field   - field of your user model that stores openID
+    #   :mappings       - simple registration mappings (currently unsupported)
+	  #	  :redirect_to    - where to redirect after success
+    #	  :*_notice       - failure, cancellation, setup_needed, new_user_failure
+    def hobo_openid_complete(options={})
+      options.reverse_merge!(:success_notice => "You have logged in",
+	  	      :failure_notice => "Verification failed",
+	  	      :cancellation_notice => "Verification cancelled",
+	  	      :setup_needed_notice => "OpenID server reports setup is needed",
+	  	      :new_user_failure_notice => "Could not create a new user account",
+	  	      :redirect_to => { :controller => "front", :action => "index"},
+            :model => User,
+            :openid_field => :openid,
+            :mappings => [])
+
+      user = nil
+      current_url = url_for(:action => 'complete_openid', :only_path => false)
+
+      # un-munge params array
+      parameters  = params.reject{|k,v|request.path_parameters[k]}
+      response    = openid_consumer.complete parameters, current_url
+
+      case response.status
+      when OpenID::Consumer::SUCCESS
+	      openid = response.identity_url
+    	  user = model.first :conditions => { options[:openid_field] => openid }
+
+	      if user #user exists
+          hobo_openid_complete_user_exists(user, options)
+        else
+          hobo_openid_complete_new_user(response, openid, options)
+      	end
+
+      when OpenID::Consumer::FAILURE
+      	flash[:notice] = options[:failure_notice]
+
+      when OpenID::Consumer::CANCEL
+      	flash[:notice] = options[:cancellation_notice]
+
+      when OpenID::Consumer::SETUP_NEEDED
+      	flash[:notice] = options[:setup_needed_notice]
+
+      else
+      	flash[:notice] = "Unknown response from OpenID server."
+      end
+
+      redirect_to :action => :openid_login unless performed?
+
+    end
+
+    def openid_logout(options={})
+      options = options.reverse_merge(:notice => "You have been logged out.",
+                                      :redirect_to => base_url)
+
+      current_user.forget_me if logged_in?
+      cookies.delete :auth_token
+      reset_session
+      flash[:notice] = options[:notice]
+      redirect_back_or_default(options[:redirect_to])
+    end
+
+    private
+      # Get the OpenID::Consumer object.
+      def openid_consumer
+        @@openid_consumer ||= OpenID::Consumer.new(session, OpenID::Store::Memory.new)
+      end
+
+      # Helper function for Openid::Controller#complete.
+      # handles existing users that successfully authorized.
+      # user is user to be logged in. Recognized option :success_notice.
+      # If you provide block taking user as argument it will be used to determine
+      # if user can login.
+      def hobo_openid_complete_user_exists(user, options = {})
+	      # If supplied, a block can be used to test if this user is
+      	# allowed to log in (e.g. the account may be disabled)
+        return if block_given? && !yield(user)
+
+        # Change current_user
+        self.current_user = user
+
+  	    if params[:remember_me] == "1"
+	        current_user.remember_me
+	        create_auth_cookie
+    	  end
+
+  	    flash[:notice] ||= options[:success_notice]
+
+	      redirect_back_or_default(options[:redirect_to] || homepage(request)) unless performed?
+      end
+
+      # Helper function for Openid::Controller#complete
+      # handles new users that successfully authorized.
+      # user    - user to be logged in.
+      # respose - response of openID provider
+      # Recognized options are (if they are missing function may fail):
+      #   :model, :openid_field, :mappings
+      def hobo_openid_complete_new_user(response, openid, options = {})
+        # Generate parameters for new user record
+        user_attrs = {options[:openid_field] => openid}
+        sreg = OpenID::SReg::Response.from_success_response(response)
+
+        unless sreg.empty?
+          options[:mappings].each do |set,mappings|
+            mappings.each do |key,col|
+         		  user_attrs[col] = sreg[key.to_s]
+            end
+  	      end
+        end
+
+        user = options[:model].new(user_attrs)
+        logger.info user_attrs
+
+        flash[:notice] = options[:new_user_failure_notice] unless user.save false
+
+        self.current_user = user
+        redirect_to(:action => "edit", :id => user.id)
+      end
+
+      # If I call it home_page it'll break cucumbers
+      def homepage(request)
+        "#{request.protocol}#{request.host}:#{request.port}"
+      end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: hobo_openid
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Joachim Filip Ignacy Bartosik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-04 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id002
+description: Adds ability to login with OpenID to Hobo-based applications. See README to start using it.
+email: jbartosik@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- .gitignore
+- CREDITS
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- lib/hobo_openid.rb
+- lib/openid_controller.rb
+has_rdoc: true
+homepage: http://github.com/ahenobarbi/hobo_openid
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: OpenID login for Hobo
+test_files: []
+