devise_rpx_connectable 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Nicolas Blanco
+
+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.textile

@@ -0,0 +1,166 @@
+h1. Devise RPX Connectable
+
+_Devise << RPX_
+
+h2. What is Devise?
+
+A great authentication gem for Rails applications.
+
+"http://github.com/plataformatec/devise":http://github.com/plataformatec/devise
+
+h2. What is RPX?
+
+RPX 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.
+
+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 :).
+
+h2. What is Devise RPX Connectable?
+
+Devise RPX Connectable is a gem to integrate RPX authentication in a Rails application using Devise.
+
+h2. Dependencies
+
+Devise RPX Connectable was tested using latest stable Rails and Devise gems.
+
+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.
+
+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>
+
+h2. Setup
+
+*Devise: Setup*
+
+See "Devise":http://github.com/plataformatec/devise documentation for instructions on how to setup Devise.
+
+*Devise: Model*
+
+Add @:rpx_connectable@ in your Devise model (ie. User.rb)
+
+<pre>
+  devise ..., :rpx_connectable
+</pre>
+
+*Devise:Setup*
+
+In the Devise initializer (may be @config/initializers/devise.rb@) :
+
+<pre>
+  Devise.setup do |config|
+    ...
+    config.rpx_application_name = "mytestingapp" # The name of your RPX application (this is the name, NOT the API key!)
+  end
+</pre>
+
+*RPXNow:API Key*
+
+In @config/environment.rb@ :
+
+<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@.
+
+*Views*
+
+I added an easy to use helper to add a link to the RPX connection popup.
+
+<pre>
+  <%= link_to_rpx "Signin using RPX!", user_session_url %>
+</pre>
+
+If you use the link alone, users will be redirected to a new page.
+If you want the more sexy popup in overlay, you need to add the JS code before the @</body>@ of your layout.
+An helper is also included for this task :
+
+<pre>
+      ...
+      <%= javascript_include_rpx(user_session_url) %>
+    </body>
+  </html>
+</pre>
+
+h2. Advanced
+
+There is some advanced features that you may use...
+
+*Devise:Setup*
+
+<pre>
+  Devise.setup do |config|
+    ...
+    config.rpx_auto_create_account = true # false if you don't want to create users automaticaly. True by default.
+  end
+</pre>
+
+*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.
+
+<pre>
+  def before_rpx_connect(rpx_user)
+    # Do something with rpx_user...
+  end
+  
+  def after_rpx_connect(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. Thanks
+
+The base of this gem was heavily inspired from the "Devise Facebook Connectable gem":http://github.com/grimen/devise_facebook_connectable by "Jonas Grimfelt":http://github.com/grimen and other Devise gems.
+
+h2. License
+
+Released under the MIT license.<br />
+Copyright (c) 2010 "Nicolas Blanco":http://github.com/slainer68

data/Rakefile

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+require File.join(File.dirname(__FILE__), 'lib', 'devise_rpx_connectable', 'version')
+
+NAME = "devise_rpx_connectable"
+
+begin
+  gem 'jeweler'
+  require 'jeweler'
+  Jeweler::Tasks.new do |spec|
+    spec.name         = NAME
+    spec.version      = ::Devise::RpxConnectable::VERSION
+    spec.summary      = %{Devise << RPX}
+    spec.description  = spec.summary
+    spec.homepage     = "http://github.com/slainer68/#{spec.name}"
+    spec.authors      = ["Nicolas Blanco"]
+    spec.email        = "slainer68@gmail.com"
+
+    spec.files = FileList['[A-Z]*', File.join(*%w[{lib,rails} ** *]).to_s]
+
+    spec.add_dependency 'devise',           '>= 1.0.6'
+    spec.add_dependency 'rpx_now',          '>= 0.6.19'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler - or one of its dependencies - is not available. " <<
+        "Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end

data/lib/devise_rpx_connectable/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  devise:
+    sessions:
+      rpx_invalid: "Could not login. Invalid account."

data/lib/devise_rpx_connectable/model.rb

@@ -0,0 +1,157 @@
+# encoding: utf-8
+require 'devise/models'
+
+module Devise #:nodoc:
+  # module RpxConnectable #:nodoc:
+  module Models #:nodoc:
+
+    # RPX Connectable Module, responsible for validating authenticity of a
+    # user and storing credentials while signing in.
+    #
+    # == Configuration:
+    #
+    # You can overwrite configuration values by setting in globally in Devise (+Devise.setup+),
+    # using devise method, or overwriting the respective instance method.
+    #
+    # +rpx_identifier_field+ - Defines the name of the RPX identifier database attribute/column.
+    #
+    # +rpx_auto_create_account+ - Speifies if account should automatically be created upon connect
+    #                                 if not already exists.
+    #
+    # == Examples:
+    #
+    #    User.authenticate_with_rpx(:identifier => 'john@doe.com')     # returns authenticated user or nil
+    #    User.find(1).rpx_connected?                                  # returns true/false
+    #
+    module RpxConnectable
+
+      def self.included(base) #:nodoc:
+        base.class_eval do
+          extend ClassMethods
+        end
+      end
+
+      # Store RPX account/session credentials.
+      #
+      def store_rpx_credentials!(attributes = {})
+        self.send(:"#{self.class.rpx_identifier_field}=", attributes[:identifier])
+
+        # Confirm without e-mail - if confirmable module is loaded.
+        self.skip_confirmation! if self.respond_to?(:skip_confirmation!)
+
+        # Only populate +email+ field if it's available (e.g. if +authenticable+ module is used).
+        self.email = attributes[:email] || '' if self.respond_to?(:email)
+
+        # Lazy hack: These database fields are required if +authenticable+/+confirmable+
+        # module(s) is used. Could be avoided with :null => true for authenticatable
+        # migration, but keeping this to avoid unnecessary problems.
+        self.password_salt = '' if self.respond_to?(:password_salt)
+        self.encrypted_password = '' if self.respond_to?(:encrypted_password)
+      end
+
+      # Checks if RPX connected.
+      #
+      def rpx_connected?
+        self.send(:"#{self.class.rpx_identifier_field}").present?
+      end
+      alias :is_rpx_connected? :rpx_connected?
+
+      # Hook that gets called *before* connect (each time). Useful for
+      # fetching additional user info (etc.) from RPX.
+      #
+      # Default: Do nothing.
+      #
+      # == Examples:
+      #
+      #   # Overridden in RPX connectable model, e.g. "User".
+      #   #
+      #   def before_rpx_connect(rpx_user)
+      #
+      #      # Get email (if the provider supports it)
+      #      email = rpx_user["email"]
+      #     # etc...
+      #
+      #   end
+      #
+      # == For more info:
+      #
+      #   * 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
+      end
+
+      # Hook that gets called *after* connect (each time). Useful for
+      # fetching additional user info (etc.) from RPX.
+      #
+      # Default: Do nothing.
+      #
+      # == Example:
+      #
+      #   # Overridden in RPX connectable model, e.g. "User".
+      #   #
+      #   def after_rpx_connect(rpx_user)
+      #     # See "on_before_rpx_connect" example.
+      #   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
+      end
+
+      module ClassMethods
+
+        # Configuration params accessible within +Devise.setup+ procedure (in initalizer).
+        #
+        # == Example:
+        #
+        #   Devise.setup do |config|
+        #     config.rpx_identifier_field = :rpx_identifier
+        #     config.rpx_auto_create_account = true
+        #   end
+        #
+        ::Devise::Models.config(self,
+        :rpx_identifier_field,
+        :rpx_auto_create_account
+        )
+
+        # Alias don't work for some reason, so...a more Ruby-ish alias
+        # for +rpx_auto_create_account+.
+        #
+        def rpx_auto_create_account?
+          self.rpx_auto_create_account
+        end
+
+        # Authenticate a user based on RPX Identifier.
+        #
+        def authenticate_with_rpx(attributes = {})
+          if attributes[:identifier].present?
+            self.find_for_rpx(attributes[:identifier])
+          end
+        end
+
+        protected
+
+        # Find first record based on conditions given (RPX identifier).
+        # Overwrite to add customized conditions, create a join, or maybe use a
+        # namedscope to filter records while authenticating.
+        #
+        def find_for_rpx(identifier)
+          self.first(:conditions =>  { rpx_identifier_field => identifier })
+        end
+
+        # Contains the logic used in authentication. Overwritten by other devise modules.
+        # In the RPX connect case; nothing fancy required.
+        #
+        def valid_for_rpx(resource, attributes)
+          true
+        end
+
+      end
+
+    end
+  end
+end

data/lib/devise_rpx_connectable/schema.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require 'devise/schema'
+
+module Devise #:nodoc:
+  module RpxConnectable #:nodoc:
+
+    module Schema
+
+      # Database migration schema for RPX.
+      #
+      def rpx_connectable
+        apply_schema ::Devise.rpx_identifier_field, String, :limit => 255
+      end
+
+    end
+  end
+end
+
+Devise::Schema.module_eval do
+  include ::Devise::RpxConnectable::Schema
+end

data/lib/devise_rpx_connectable/strategy.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+require 'devise/strategies/base'
+
+module Devise #:nodoc:
+  module RpxConnectable #:nodoc:
+    module Strategies #:nodoc:
+
+      # Default strategy for signing in a user using RPX.
+      # Redirects to sign_in page if it's not authenticated
+      #
+      class RpxConnectable < ::Devise::Strategies::Base
+
+        def valid?
+          valid_controller? && valid_params? && mapping.to.respond_to?('authenticate_with_rpx')
+        end
+
+        # Authenticate user with RPX.
+        #
+        def authenticate!
+          klass = mapping.to
+          begin
+            
+            rpx_user = (RPXNow.user_data(params[:token]) rescue nil)
+            
+            if rpx_user && user = klass.authenticate_with_rpx(:identifier => rpx_user["identifier"])
+              success!(user)
+            else
+              if klass.rpx_auto_create_account?
+                user = returning(klass.new) do |u|
+                  u.store_rpx_credentials!(rpx_user)
+                end
+                begin
+                  user.save(false)
+                  success!(user)
+                rescue
+                  fail!(:rpx_invalid)
+                end
+              else
+                fail!(:rpx_invalid)
+              end
+            end
+          rescue => e
+            fail!(e.message)
+          end
+        end
+        
+        protected
+          def valid_controller?
+            params[:controller] == 'sessions'
+          end
+
+          def valid_params?
+            params[:token].present?
+          end
+
+      end
+    end
+  end
+end
+
+Warden::Strategies.add(:rpx_connectable, Devise::RpxConnectable::Strategies::RpxConnectable)

data/lib/devise_rpx_connectable/version.rb

@@ -0,0 +1,5 @@
+module Devise
+  module RpxConnectable
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/devise_rpx_connectable/view_helpers.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+require 'devise/mapping'
+
+module Devise #:nodoc:
+  module RpxConnectable #:nodoc:
+
+    # RPX view helpers to easily add the link to the RPX connection popup and also the necessary JS code.
+    #
+    module Helpers
+      
+      # Creates the link to the RPX connection popup.
+      # If you create a link without putting the JS code, the popup will load in a new page.
+      # By default the RPX link will be linked to the RPX application name you defined in the configuration.
+      # It may be overriden using :application_name if the options.
+      # The second parameter is the return URL, it must be absolute (***_url).
+      #
+      # For example :
+      # <%= link_to_rpx "Signin using RPX!", user_session_url %>
+      #
+      def link_to_rpx(link_text, link_url, options={})
+        options = { :unobtrusive => true }.merge(options)
+    		token_url = build_token_url(link_url)
+    		out = RPXNow.popup_code(link_text, rpx_application_name_from_options(options), token_url, options)
+    		out.respond_to?(:html_safe) ? out.html_safe : out
+      end
+
+      # Returns the necessary JS code for the RPX popup.
+      # It is recommended to put this code just before the </body> tag of your layout.
+      # 
+      # For example :
+      # ...
+      # <%= javascript_include_rpx(user_session_url) %>
+      # </body>
+      # </html>
+      #
+      def javascript_include_rpx(link_url, options={})
+    		token_url = build_token_url(link_url)
+        out = RPXNow.popup_source(rpx_application_name_from_options(options), token_url, options)
+        out.respond_to?(:html_safe) ? out.html_safe : out
+      end
+
+      protected
+        def rpx_application_name_from_options(options)
+          options[:application_name] ? options.delete(:application_name) : ::Devise.rpx_application_name
+        end
+        
+        def build_token_url(return_url)
+          "#{return_url}?authenticity_token=#{form_authenticity_token}"
+        end
+      
+    end
+  end
+end
+
+::ActionView::Base.send :include, Devise::RpxConnectable::Helpers

data/lib/devise_rpx_connectable.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require 'devise'
+require 'rpx_now'
+
+require 'devise_rpx_connectable/model'
+require 'devise_rpx_connectable/strategy'
+require 'devise_rpx_connectable/schema'
+require 'devise_rpx_connectable/view_helpers'
+
+module Devise
+  mattr_accessor :rpx_identifier_field
+  @@rpx_identifier_field = :rpx_identifier
+  
+  mattr_accessor :rpx_auto_create_account
+  @@rpx_auto_create_account = true
+  
+  mattr_accessor :rpx_application_name
+  @@rpx_application_name = nil
+end
+
+I18n.load_path.unshift File.join(File.dirname(__FILE__), *%w[devise_rpx_connectable locales en.yml])
+
+Devise.add_module(:rpx_connectable,
+  :strategy => true,
+  :controller => :sessions,
+  :model => 'devise_rpx_connectable/model')

data/rails/init.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'devise_rpx_connectable'

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: devise_rpx_connectable
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nicolas Blanco
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-25 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: devise
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rpx_now
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.19
+    version: 
+description: Devise << RPX
+email: slainer68@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- lib/devise_rpx_connectable.rb
+- lib/devise_rpx_connectable/locales/en.yml
+- lib/devise_rpx_connectable/model.rb
+- lib/devise_rpx_connectable/schema.rb
+- lib/devise_rpx_connectable/strategy.rb
+- lib/devise_rpx_connectable/version.rb
+- lib/devise_rpx_connectable/view_helpers.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/slainer68/devise_rpx_connectable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Devise << RPX
+test_files: []
+