authlogic-connect 0.0.3.3 → 0.0.3.4

data/README.markdown

@@ -15,14 +15,11 @@ All of that is easier than creating a new account and password.
 *	<b>Authlogic:</b> [http://github.com/binarylogic/authlogic](http://github.com/binarylogic/authlogic)
 *	<b>Authlogic Connect Example Project:</b> [http://github.com/viatropos/authlogic-connect-example](http://github.com/viatropos/authlogic-connect-example)
 *	<b>Live example with Twitter and Facebook using Rails 3:</b> [http://authlogic-connect.heroku.com](http://authlogic-connect.heroku.com)
+* <b>Rails 2.3.5 Example:</b> [http://github.com/viatropos/authlogic-connect-example-rails2](http://github.com/viatropos/authlogic-connect-example-rails2)
+* **Rubygems Repository:** [http://rubygems.org/gems/authlogic-connect](http://rubygems.org/gems/authlogic-connect)
 
 ## Supported Providers
 
-Lists of all known providers here:
-
-- [Oauth Providers](http://wiki.oauth.net/ServiceProviders)
-- [OpenID Providers](http://en.wikipedia.org/wiki/List_of_OpenID_providers)
-
 ### Oauth
 
 - Twitter
@@ -33,42 +30,47 @@ Lists of all known providers here:
 
 - MyOpenID
 
-## Install and use
+Lists of all known providers here:
 
-### 1. Install Authlogic and setup your application
+- [Oauth Providers](http://wiki.oauth.net/ServiceProviders)
+- [OpenID Providers](http://en.wikipedia.org/wiki/List_of_OpenID_providers)
 
-    sudo gem install authlogic
+## Install and use
 
-### 2. Install OAuth and Authlogic Connect
+### 1. Install Authlogic Connect
 
-    sudo gem install oauth
     sudo gem install authlogic-connect
 
-Now add the gem dependencies in your config:
+### 2. Add the gem dependencies in your config:
+
+Rails 2.3.x: `config/environment.rb`
 
     config.gem "json"
     config.gem "authlogic"
     config.gem "oauth"
     config.gem "oauth2"
-    config.gem "authlogic-connect", :lib => "authlogic_connect"
+    config.gem "authlogic-connect"
 
-### 3. Add the Migrations
+Rails 3: `Gemfile`
 
-If you are starting from scratch (and you don't even have a User model yet), create the migrations using this command.
+    gem "ruby-openid"
+    gem "rack-openid", ">=0.2.1", :require => "rack/openid"
+    gem "authlogic", :git => "git://github.com/odorcicd/authlogic.git", :branch => "rails3"
+    gem "oauth"
+    gem "oauth2"
+    gem "authlogic-connect"
 
-    script/generate authlogic_connect_migration
+### 3. Add the Migrations
 
-Otherwise, add this migration
+See the [Rails 2 Example](http://github.com/viatropos/authlogic-connect-example-rails2) and [Rails 3 Example](http://github.com/viatropos/authlogic-connect-example) projects to see what you need.  Will add a generator sometime.
 
-    class AddAuthlogicConnectMigration < ActiveRecord::Migration
-      def self.up
-        # TODO
-      end
+Files needed are:
 
-      def self.down
-        # TODO
-      end
-    end
+- models: User, UserSession
+- controllers: UsersController, UserSessionsController, ApplicationController
+- migrations: create\_users, create\_sessions, create\_tokens
+- initializers: config/authlogic.example.yml, config/initializers/authlogic_connect_config.rb
+- routes
     
 ### 4. Configure your keys
 
@@ -124,15 +126,27 @@ If we don't use the block, we will get a DoubleRender error. This lets us skip t
 Here's an example of the FacebookToken for Oauth
 
     class FacebookToken < OauthToken
-    
+
+      version 2.0 # oauth 2.0
+
+      settings "https://graph.facebook.com",
+        :authorize_url => "https://graph.facebook.com/oauth/authorize",
+        :scope         => "email, offline_access"
+
     end
+    
+If there is an Oauth/OpenID service you need, let me know, or fork/add/push and I will integrate it into the project and add you to the list.
+
+Currently Implemented (some fully, some partially):
+
+- [Oauth Tokens](http://github.com/viatropos/authlogic-connect/tree/master/lib/authlogic_connect/oauth/tokens/)
   
-### 6. Add login and register buttons to your views
+### 7. Add login and register buttons to your views
 
     <%# oauth_register_button :value => "Register with Twitter" %>
     <%# oauth_login_button :value => "Login with Twitter" %>
 
-That's it! The rest is taken care of for you.
+Check out the example projects to see exactly what's required.  These aren't totally useful yet.  Their job is to just send the right parameters to authlogic-connect.
 
 ## The Flow
 
@@ -160,6 +174,14 @@ That's it! The rest is taken care of for you.
   - Save user
 - Finish block, render page
 
+### Note about the redirect process
+
+When you make a request to one of these services, it responds with a GET request.  But assuming we have made the request through a `create` method (`UsersController#create` for `/register`, `UserSessionsController#create` for `/login`), we want that GET to be a POST.
+
+This is accomplished by adding a property called `auth_callback_method` to the session when the original request is made.  It says "POST", or whatever the translation is from the controller method that was called.
+
+Then a Rack Middleware filter converts the GET return request from the authentication service into POST.  This forces it to run back through the `create` method.  Check out [`AuthlogicConnect::CallbackFilter`](http://github.com/viatropos/authlogic-connect/blob/master/lib/authlogic_connect/callback_filter.rb) for details.  Or search "Rack Middleware".
+
 ## Project Goals
 
 1. It should require the end user ONE CLICK to create an account with your site.
@@ -186,4 +208,12 @@ I have no idea how to get up and running with Autotest and Shoulda right now.  I
 ## TODO
 
 - Change `register_with_oauth` and related to `register_method` and `login_method`: oauth, openid, traditional
-- Build view helpers
+- Build view helpers
+
+## Helpful References for Rails 3
+
+- [Rails 3 Initialization Process](http://ryanbigg.com/guides/initialization.html)
+- [Rails 3 Plugins - Part 1, Big Picture](http://www.themodestrubyist.com/2010/03/01/rails-3-plugins---part-1---the-big-picture/)
+- [Rails 3 Plugins - Part 2, Writing an Engine](http://www.themodestrubyist.com/2010/03/05/rails-3-plugins---part-2---writing-an-engine/)
+- [Rails 3 Plugins - Part 3, Initializers](http://www.themodestrubyist.com/2010/03/16/rails-3-plugins---part-3---rake-tasks-generators-initializers-oh-my/)
+- [Using Gemspecs as Intended](http://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/)

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/gempackagetask'
 spec = Gem::Specification.new do |s|
   s.name              = "authlogic-connect"
   s.author            = "Lance Pollard"
-  s.version           = "0.0.3.3"
+  s.version           = "0.0.3.4"
   s.summary           = "Authlogic Connect: Let your app use all of Oauth and OpenID"
   s.homepage          = "http://github.com/viatropos/authlogic-connect"
   s.email             = "lancejpollard@gmail.com"
@@ -18,10 +18,12 @@ spec = Gem::Specification.new do |s|
   s.require_path      = "lib"
   s.add_dependency("activesupport", ">= 2.1.2")
   s.add_dependency("activerecord", ">= 2.1.2")
-  s.add_dependency("authlogic")
-  s.add_dependency("oauth")
   s.add_dependency("json")
-  s.add_dependency("oauth2") # facebook only
+  s.add_dependency("ruby-openid")
+  s.add_dependency("rack-openid", ">=0.2.1")
+  s.add_dependency("oauth")
+  s.add_dependency("oauth2")
+  s.add_dependency("authlogic")
 end
 
 desc "Create .gemspec file (useful for github)"

data/lib/authlogic-connect.rb

@@ -1,4 +1,5 @@
 require 'active_record'
+require "rubygems"
 require 'authlogic'
 require 'oauth'
 require 'oauth2'
@@ -6,18 +7,44 @@ require 'oauth2'
 this = File.dirname(__FILE__)
 library = "#{this}/authlogic_connect"
 
+class Hash
+  def recursively_symbolize_keys!
+    self.symbolize_keys!
+    self.values.each do |v|
+      if v.is_a? Hash
+        v.recursively_symbolize_keys!
+      elsif v.is_a? Array
+        v.recursively_symbolize_keys!
+      end
+    end
+    self
+  end
+end
+
+class Array
+  def recursively_symbolize_keys!
+    self.each do |item|
+      if item.is_a? Hash
+        item.recursively_symbolize_keys!
+      elsif item.is_a? Array
+        item.recursively_symbolize_keys!
+      end
+    end
+  end
+end
+
 module AuthlogicConnect
   KEY = "connect"
   
   class << self
     
     attr_accessor :config
-
+    
     def config=(value)
       value.recursively_symbolize_keys!
       @config = value
     end
-
+    
     def key(path)
       result = self.config
       path.to_s.split(".").each { |node| result = result[node.to_sym] if result }
@@ -51,15 +78,17 @@ module AuthlogicConnect
   end
 end
 
+require "#{this}/open_id_authentication"
 require "#{library}/callback_filter"
 require "#{library}/token"
 require "#{library}/openid"
 require "#{library}/oauth"
 require "#{library}/common"
+require "#{library}/engine" if defined?(Rails) && Rails::VERSION::MAJOR == 3
 
-custom_models = ["#{library}/token"]
-custom_models += Dir["#{library}/oauth/tokens"]
-custom_models +=Dir["#{library}/openid/tokens"]
+custom_models =   ["#{library}/token"]
+custom_models +=  Dir["#{library}/oauth/tokens"]
+custom_models +=  Dir["#{library}/openid/tokens"]
 
 custom_models.each do |path|
   $LOAD_PATH << path

data/lib/authlogic_connect/engine.rb

@@ -0,0 +1,15 @@
+module AuthlogicConnect
+  class Engine < Rails::Engine
+    engine_name :authlogic_connect
+    
+    initializer "authlogic_connect.authentication_hook" do |app|
+      app.middleware.use AuthlogicConnect::CallbackFilter
+      app.middleware.use OpenIdAuthentication
+    end
+    
+    initializer "authlogic_connect.finalize", :after => "authlogic_connect.authentication_hook" do |app|
+      OpenID::Util.logger = Rails.logger
+      ActionController::Base.send :include, OpenIdAuthentication
+    end
+  end
+end

data/lib/authlogic_connect/oauth/user.rb

@@ -70,7 +70,9 @@ module AuthlogicConnect::Oauth
         # Restore any attributes which were saved before redirecting to the oauth server
         self.attributes = auth_session.delete(:authlogic_oauth_attributes)
         token = AuthlogicConnect.token(oauth_provider).new(oauth_key_and_secret)
-        if Token.find_by_key(token.key)
+        puts "NEW TOKEN: #{token.inspect}"
+        if old_token = Token.find_by_key(token.key)
+          puts "OLD TOKEN? #{old_token.inspect}"
           self.errors.add("you have already created an account using your #{oauth_token.service_name} account, so it")
         else
           self.tokens << token

data/lib/open_id_authentication.rb

@@ -0,0 +1,129 @@
+# copied from open_id_authentication plugin on github
+require 'uri'
+require 'openid'
+require 'rack/openid'
+
+module OpenIdAuthentication
+  def self.new(app)
+    store = OpenIdAuthentication.store
+    if store.nil?
+      Rails.logger.warn "OpenIdAuthentication.store is nil. Using in-memory store."
+    end
+
+    ::Rack::OpenID.new(app, OpenIdAuthentication.store)
+  end
+
+  def self.store
+    @@store
+  end
+
+  def self.store=(*store_option)
+    store, *parameters = *([ store_option ].flatten)
+
+    @@store = case store
+    when :memory
+      require 'openid/store/memory'
+      OpenID::Store::Memory.new
+    when :file
+      require 'openid/store/filesystem'
+      OpenID::Store::Filesystem.new(Rails.root.join('tmp/openids'))
+    when :memcache
+      require 'memcache'
+      require 'openid/store/memcache'
+      OpenID::Store::Memcache.new(MemCache.new(parameters))
+    else
+      store
+    end
+  end
+
+  self.store = nil
+
+  class Result
+    ERROR_MESSAGES = {
+      :missing      => "Sorry, the OpenID server couldn't be found",
+      :invalid      => "Sorry, but this does not appear to be a valid OpenID",
+      :canceled     => "OpenID verification was canceled",
+      :failed       => "OpenID verification failed",
+      :setup_needed => "OpenID verification needs setup"
+    }
+
+    def self.[](code)
+      new(code)
+    end
+
+    def initialize(code)
+      @code = code
+    end
+
+    def status
+      @code
+    end
+
+    ERROR_MESSAGES.keys.each { |state| define_method("#{state}?") { @code == state } }
+
+    def successful?
+      @code == :successful
+    end
+
+    def unsuccessful?
+      ERROR_MESSAGES.keys.include?(@code)
+    end
+
+    def message
+      ERROR_MESSAGES[@code]
+    end
+  end
+
+  protected
+    # The parameter name of "openid_identifier" is used rather than
+    # the Rails convention "open_id_identifier" because that's what
+    # the specification dictates in order to get browser auto-complete
+    # working across sites
+    def using_open_id?(identifier = nil) #:doc:
+      identifier ||= open_id_identifier
+      !identifier.blank? || request.env[Rack::OpenID::RESPONSE]
+    end
+
+    def authenticate_with_open_id(identifier = nil, options = {}, &block) #:doc:
+      identifier ||= open_id_identifier
+
+      if request.env[Rack::OpenID::RESPONSE]
+        complete_open_id_authentication(&block)
+      else
+        begin_open_id_authentication(identifier, options, &block)
+      end
+    end
+
+  private
+    def open_id_identifier
+      params[:openid_identifier] || params[:openid_url]
+    end
+
+    def begin_open_id_authentication(identifier, options = {})
+      options[:identifier] = identifier
+      value = Rack::OpenID.build_header(options)
+      response.headers[Rack::OpenID::AUTHENTICATE_HEADER] = value
+      head :unauthorized
+    end
+
+    def complete_open_id_authentication
+      response   = request.env[Rack::OpenID::RESPONSE]
+      identifier = response.display_identifier
+
+      case response.status
+      when OpenID::Consumer::SUCCESS
+        yield Result[:successful], identifier,
+          OpenID::SReg::Response.from_success_response(response)
+      when :missing
+        yield Result[:missing], identifier, nil
+      when :invalid
+        yield Result[:invalid], identifier, nil
+      when OpenID::Consumer::CANCEL
+        yield Result[:canceled], identifier, nil
+      when OpenID::Consumer::FAILURE
+        yield Result[:failed], identifier, nil
+      when OpenID::Consumer::SETUP_NEEDED
+        yield Result[:setup_needed], response.setup_url, nil
+      end
+    end
+end

data/rails/init.rb

@@ -1 +1,19 @@
-require "authlogic-connect"
+require "authlogic-connect"
+
+# copied from open_id_authentication plugin on github
+
+# this is the Rails 2.x equivalent.
+# Rails 3 equivalent is in authlogic_connect/engine.rb
+if Rails.version < '3'
+  config.gem 'rack-openid', :lib => 'rack/openid', :version => '>=0.2.1'
+end
+
+require 'open_id_authentication'
+
+config.middleware.use AuthlogicConnect::CallbackFilter
+config.middleware.use OpenIdAuthentication
+
+config.after_initialize do
+  OpenID::Util.logger = Rails.logger
+  ActionController::Base.send :include, OpenIdAuthentication
+end

metadata

@@ -6,8 +6,8 @@ version: !ruby/object:Gem::Version
   - 0
   - 0
   - 3
-  - 3
-  version: 0.0.3.3
+  - 4
+  version: 0.0.3.4
 platform: ruby
 authors: 
 - Lance Pollard
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-12 00:00:00 -07:00
+date: 2010-05-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,7 +47,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: authlogic
+  name: json
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
@@ -59,7 +59,7 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: oauth
+  name: ruby-openid
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
@@ -71,7 +71,7 @@ dependencies:
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: rack-openid
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
@@ -79,11 +79,13 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        version: "0"
+        - 2
+        - 1
+        version: 0.2.1
   type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: oauth2
+  name: oauth
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
@@ -94,6 +96,30 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: oauth2
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: authlogic
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id008
 description: Let your app use all of Oauth and OpenID
 email: lancejpollard@gmail.com
 executables: []
@@ -114,6 +140,7 @@ files:
 - lib/authlogic_connect/common/user.rb
 - lib/authlogic_connect/common/variables.rb
 - lib/authlogic_connect/common.rb
+- lib/authlogic_connect/engine.rb
 - lib/authlogic_connect/oauth/helper.rb
 - lib/authlogic_connect/oauth/process.rb
 - lib/authlogic_connect/oauth/session.rb
@@ -140,6 +167,7 @@ files:
 - lib/authlogic_connect/openid/variables.rb
 - lib/authlogic_connect/openid.rb
 - lib/authlogic_connect/token.rb
+- lib/open_id_authentication.rb
 - rails/init.rb
 - test/database.yml
 - test/test_authlogic_connect.rb