devise_rpx_connectable 0.1.3 → 0.2.0

data/README.textile

@@ -8,63 +8,31 @@ A great authentication gem for Rails applications.
 
 "http://github.com/plataformatec/devise":http://github.com/plataformatec/devise
 
-h2. What is RPX?
+h2. What is RPX (now Janrain Engage)?
 
-RPX is a Software as a Service (SaaS) that helps you manage multiple authentication methods (FacebookConnect, Google, Twitter, OpenID, MySpace...) using a single API.
+RPX (now called Janrain Engage) is a Software as a Service (SaaS) that helps you manage multiple authentication methods (FacebookConnect, Google, Twitter, OpenID, MySpace...) using a single API.
 It also provides a multilingual connection widget.
 Instead of managing multiple authentication providers and APIs, you just need to handle one.
 
-RPX provides free and paid accounts.
+Janrain Engage provides free and paid accounts.
 
-See *"RPX official homepage":https://rpxnow.com/*. If you want to see what it looks like, you may signup on the RPX website as it uses RPX for signup :).
+See *"Janrain Engage official homepage":https://rpxnow.com/*. If you want to see what it looks like, you may signup on the Janrain Engage website as it uses Engage for signup :).
 
 h2. What is Devise RPX Connectable?
 
-Devise RPX Connectable is a gem to integrate RPX authentication in a Rails application using Devise.
+Devise RPX Connectable is a gem to integrate Janrain Engage authentication in a Rails application using Devise.
 
-Please note that this is an unofficial library. It is neither affiliated with, nor endorsed by RPX/JanRain Inc.
+Please note that this is an unofficial library. It is neither affiliated with, nor endorsed by Janrain Inc.
 
 h2. Dependencies
 
-Devise RPX Connectable was tested using latest stable Rails and Devise gems.
+Devise RPX Connectable should be compatible with the latest Rails and Devise versions (currently Rails 3.0 and Devise 1.2).
 
-Currently :
-
-*Rails* : version 2.3.5
-*Devise* : version 1.0.6
-
-I also want it to be compatible with latest prerelease gems of Devise, Rails and Mongoid.
-Therefore I also tested it with :
-
-*Rails* : version 3.0.0beta3
-*Mongoid* : version 2.0.0beta4
-*Devise* : master branch.
+IMPORTANT : This gem is now ONLY COMPATIBLE with Rails 3, if you want to use it with Rails 2, please use version 0.1.3.
 
 h2. Installation
 
-*Gem (Rails >= 2.3.5)*
-
-<pre>
-  $ sudo gem install devise_rpx_connectable
-</pre>
-
-...and in @config/environment.rb@:
-
-<pre>
-  config.gem 'devise'
-  config.gem 'rpx_now'
-  config.gem 'devise_rpx_connectable'
-</pre>
-
-*Gem (Rails >= 3.0.0beta3)*
-
-@Gemfile@
-
-<pre>
-  gem 'devise', :git => 'git://github.com/plataformatec/devise.git'
-  gem 'rpx_now'
-  gem 'devise_rpx_connectable'
-</pre>
+As usual... Add @gem "devise_rpx_connectable"@ in your Gemfile.lock...
 
 h2. Setup
 
@@ -93,19 +61,18 @@ In the Devise initializer (may be @config/initializers/devise.rb@) :
 
 *RPXNow:API Key*
 
-In @config/environment.rb@ :
+In @config/application.rb@ or @config/environments/YOUR_ENV.rb@ (to set a different key for each environment...) :
 
 <pre>
   ...
-  config.after_initialize do # so rake gems:install works
     RPXNow.api_key = "aaaabbbbbccccdddddeeeeefffff"
-  end
   ...
 </pre>
 
 *Migrations*
 
 Your model needs one attribute/column to store the RPX identifier. By default, this identifier is @rpx_identifier@.
+So don't forget to add that field to your model (using a migration or whatever...).
 
 *Views*
 
@@ -152,21 +119,22 @@ There is some advanced features that you may use...
 
 *Devise:Model*
 
-Some hooks are available to get the RPXNow user data objects before or after the connection. Read the RPXNow gem documentation for more information.
+There are two hooks that you may define in your model : @before_rpx_success@ (called before each successful connection) and @before_rpx_auto_create@ (called only once before the auto saving of the user instance, when rpx_auto_create_account is enabled).
+You get in parameter the RPX User object from the RPXNow gem which is basically a Hash containing more or less information depending on your RPX configuration and account.
+Read the RPXNow gem documentation for more information about this...
 
 <pre>
-  def before_rpx_connect(rpx_user)
+  def before_rpx_success(rpx_user)
     # Do something with rpx_user...
   end
   
-  def after_rpx_connect(rpx_user)
+  def before_rpx_auto_create(rpx_user)
     # Do something with rpx_user
   end
 </pre>
 
 h2. TODO
 
-* With Rails 3 (only) I get an invalid auth token in sessions#create action. I have to skip the validation of the auth token. See why?
 * Handle RPX multiple accounts mapping?
 
 h2. Contributors
@@ -175,6 +143,8 @@ h2. Contributors
 * "DohMoose":http://github.com/DohMoose
 * "Chris de Bruin":http://github.com/chrisdebruin
 * "Michael Bumann":http://github.com/bumi
+* "Arek Flinik":http://github.com/blax
+* "Nader Akhnoukh":http://github.com/iamnader
 
 h2. Thanks
 

data/Rakefile

@@ -20,7 +20,7 @@ begin
 
     spec.files = FileList['[A-Z]*', File.join(*%w[{lib,rails} ** *]).to_s]
 
-    spec.add_dependency 'devise',           '>= 1.0.6'
+    spec.add_dependency 'devise',           '>= 1.2.0'
     spec.add_dependency 'rpx_now',          '>= 0.6.19'
   end
   Jeweler::GemcutterTasks.new

data/lib/devise_rpx_connectable/model.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-require 'devise/models'
 
 module Devise #:nodoc:
   # module RpxConnectable #:nodoc:
@@ -56,16 +55,16 @@ module Devise #:nodoc:
       end
       alias :is_rpx_connected? :rpx_connected?
 
-      # Hook that gets called *before* connect (each time). Useful for
-      # fetching additional user info (etc.) from RPX.
+      # Hook that gets called before a successful connection (each time).
+      # Useful for fetching additional user info (etc.) from RPX.
       #
       # Default: Do nothing.
       #
-      # == Examples:
+      # == Example:
       #
       #   # Overridden in RPX connectable model, e.g. "User".
       #   #
-      #   def before_rpx_connect(rpx_user)
+      #   def before_rpx_success(rpx_user)
       #
       #      # Get email (if the provider supports it)
       #      email = rpx_user["email"]
@@ -77,14 +76,13 @@ module Devise #:nodoc:
       #
       #   * http://github.com/grosser/rpx_now
       #
-      def on_before_rpx_connect(rpx_user)
-        if self.respond_to?(:before_rpx_connect)
-          self.send(:before_rpx_connect, rpx_user) rescue nil
-        end
+      def on_before_rpx_success(rpx_user)
+        self.send(:before_rpx_success, rpx_user) if self.respond_to?(:before_rpx_success)
       end
-
-      # Hook that gets called *after* connect (each time). Useful for
-      # fetching additional user info (etc.) from RPX.
+      
+      # Hook that gets called before the auto creation of the user.
+      # Therefore, this hook is only called when rpx_auto_create_account config option is enabled.
+      # Useful for fetching additional user info (etc.) from RPX.
       #
       # Default: Do nothing.
       #
@@ -92,14 +90,20 @@ module Devise #:nodoc:
       #
       #   # Overridden in RPX connectable model, e.g. "User".
       #   #
-      #   def after_rpx_connect(rpx_user)
-      #     # See "on_before_rpx_connect" example.
+      #   def before_rpx_auto_create(rpx_user)
+      #
+      #      # Get email (if the provider supports it)
+      #      email = rpx_user["email"]
+      #     # etc...
+      #
       #   end
       #
-      def on_after_rpx_connect(rpx_user)
-        if self.respond_to?(:after_rpx_connect)
-          self.send(:after_rpx_connect, rpx_user) rescue nil
-        end
+      # == For more info:
+      #
+      #   * http://github.com/grosser/rpx_now
+      #
+      def on_before_rpx_auto_create(rpx_user)
+        self.send(:before_rpx_auto_create, rpx_user) if self.respond_to?(:before_rpx_auto_create)
       end
 
       module ClassMethods
@@ -115,10 +119,10 @@ module Devise #:nodoc:
         #   end
         #
         ::Devise::Models.config(self,
-        :rpx_identifier_field,
-        :rpx_auto_create_account,
-        :rpx_extended_user_data,
-        :rpx_additional_user_data
+          :rpx_identifier_field,
+          :rpx_auto_create_account,
+          :rpx_extended_user_data,
+          :rpx_additional_user_data
         )
 
         # Alias don't work for some reason, so...a more Ruby-ish alias

data/lib/devise_rpx_connectable/schema.rb

@@ -9,7 +9,7 @@ module Devise #:nodoc:
       # Database migration schema for RPX.
       #
       def rpx_connectable
-        apply_schema ::Devise.rpx_identifier_field, String, :limit => 255
+        apply_devise_schema ::Devise.rpx_identifier_field, String, :limit => 255
       end
 
     end

data/lib/devise_rpx_connectable/strategy.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-require 'devise/strategies/base'
 
 module Devise #:nodoc:
   module RpxConnectable #:nodoc:
@@ -24,26 +23,23 @@ module Devise #:nodoc:
             fail!(:rpx_invalid) and return unless rpx_user
             
             if user = klass.authenticate_with_rpx(:identifier => rpx_user["identifier"])
+              user.on_before_rpx_success(rpx_user)
               success!(user)
-            else
-              if klass.rpx_auto_create_account?
-                user = returning(klass.new) do |u|
-                  u.store_rpx_credentials!(rpx_user)
-                  u.on_before_rpx_connect(rpx_user)
-                end
-                begin
-                  user.save(false)
-                  user.on_after_rpx_connect(rpx_user)
-                  success!(user)
-                rescue
-                  fail!(:rpx_invalid)
-                end
-              else
-                fail!(:rpx_invalid)
-              end
+              return
             end
-          rescue => e
-            fail!(e.message)
+            
+            fail!(:rpx_invalid) and return unless klass.rpx_auto_create_account?
+            
+            user = klass.new
+            user.store_rpx_credentials!(rpx_user)
+            user.on_before_rpx_auto_create(rpx_user)
+            
+            user.save(:validate => false)
+            user.on_before_rpx_success(rpx_user)
+            success!(user)
+            
+          rescue
+            fail!(:rpx_invalid)
           end
         end
         
@@ -61,4 +57,3 @@ module Devise #:nodoc:
   end
 end
 
-Warden::Strategies.add(:rpx_connectable, Devise::RpxConnectable::Strategies::RpxConnectable)

data/lib/devise_rpx_connectable/version.rb

@@ -1,5 +1,6 @@
 module Devise
   module RpxConnectable
-    VERSION = "0.1.3".freeze
+    VERSION = "0.2.0"
   end
 end
+

data/lib/devise_rpx_connectable/view_helpers.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-require 'devise/mapping'
 
 module Devise #:nodoc:
   module RpxConnectable #:nodoc:
@@ -60,7 +59,8 @@ module Devise #:nodoc:
         end
         
         def build_token_url(return_url)
-          "#{return_url}?authenticity_token=#{Rack::Utils.escape(form_authenticity_token)}"
+          token = return_url.include?("?") ? "&" : "?"
+          "#{return_url}#{token}authenticity_token=#{Rack::Utils.escape(form_authenticity_token)}"
         end
       
     end

data/lib/devise_rpx_connectable.rb

@@ -4,6 +4,8 @@ require 'rpx_now'
 
 require 'devise_rpx_connectable/model'
 require 'devise_rpx_connectable/strategy'
+Warden::Strategies.add(:rpx_connectable, Devise::RpxConnectable::Strategies::RpxConnectable)
+
 require 'devise_rpx_connectable/schema'
 require 'devise_rpx_connectable/view_helpers'
 

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_rpx_connectable
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Nicolas Blanco
@@ -9,29 +15,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-02 00:00:00 +02:00
+date: 2010-09-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: devise
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.6
-    version: 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rpx_now
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 33
+        segments: 
+        - 0
+        - 6
+        - 19
         version: 0.6.19
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: Devise << RPX
 email: slainer68@gmail.com
 executables: []
@@ -62,21 +80,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Devise << RPX