omniauth-multiprovider 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96e73d3f9fb27f6b97a817cd686171e911d5060e
-  data.tar.gz: ed5755e6cb69e323a80f6052e62824f14951c669
+  metadata.gz: c1f3a5a4a52bb8284020af1e7399416e1b1b34d6
+  data.tar.gz: 15ec2a53af0a3a883291ad7c0c8dcb3772c19bef
 SHA512:
-  metadata.gz: d7397943a451ddd556ef854f442aad422ccc11e8be4ee0b31483c7921a7e2a8d936eb2f8350b98a34436eb6c5fa8ac628dfccf877599fee5e64b10c6c993b7c5
-  data.tar.gz: fe84283f3ae92745c71912739c8bf10d02a48ec726f45e460854e37ad072f63ef265c286e1f853002bb0c335074284935dbbebbf9fccb3cca64062a7d7bf779b
+  metadata.gz: cda70641cc3aea4b3998bb02e13b22cf9bb0e77dd7bf459d4bb9496841392489be746885a0a402f1a2d1d5da5b5fdf3a86b186b3cc0d792ddca611c90d65789a
+  data.tar.gz: 4ba92b422f566f0b1f7e2e3c88578c05a3e51b939ed2469c6616f28e01f10ee56e2ec1db0d02738c3f8e2c2d95a90dd95ef1fb1a9becf8789322db1ce65b40f5

data/.gitignore

@@ -1,19 +1,14 @@
-*.rbc
-*.sassc
-.sass-cache
-capybara-*.html
-.rspec
-.rvmrc
-/.bundle
-/vendor/bundle
-/log/*
-/tmp/*
-/db/*.sqlite3
-/public/system/*
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
 /coverage/
-/spec/tmp/*
-**.orig
-rerun.txt
-pickle-email-*.html
-.project
-config/initializers/secret_token.rb
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-gemset

@@ -0,0 +1 @@
+omniauth-multiprovider

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-multiprovider.gemspec
+gemspec

data/README.md

@@ -1,17 +1,33 @@
-omniauth-multiprovider
-======================
+# Omniauth::Multiprovider
+
 
 An easy way to authenticate users through many oauth providers (i.e. facebook, twitter, github and custom providers)
 
 No more OmniauthCallbacksController, no more complex method to relate users with tokens
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-multiprovider'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-multiprovider
+
 ## Disclaimer
 
 This is a work in progress. Expect serious refactors, breaking changes.
 
-I am almose sure that this gem will not work outside an Rails project. Sorry Sinatra lovers... I will try to remove any DHH opinion ;)
+I am almost sure that this gem will not work outside an Rails project. Sorry Sinatra lovers... I will try to remove any DHH opinion ;)
 
-## How to use
+## Usage
 
 In your devise resource model (aka mapping), usually `User` add:
 
@@ -32,26 +48,55 @@ Create a migration to add the `Authentication` model with:
 The change method should contain something like:
 
     create_table :authentications do |t|
-      t.references :{devise_mapping_name}
+      t.references :{devise_mapping_name}, polymorphic: true
       t.string :uid,              null: false
       t.string :provider,         null: false
       t.string :access_token
       t.string :permissions
       t.timestamps
     end
-    
+
     add_index :authentications, [:provider, :uid], unique: true
 
 **devise_mapping_name** is probably `user`
 
+### Errors and handling
+
+There are 3 error scenarios:
+
+* The oauth authentication already exists and belongs to the current logged-in user (it's trying to reconnect)
+* The oauth authentication already exists and belongs to a different user (potential identity theft attemp)
+* The oauth-provided email is already in use
+
+The first error will be ignored by default.
+
+For the other two errors `OmniAuth::MultiProvider::CallbacksController` will set the `flash[:alert]` to the localized I18N keys:
+
+* common prefix: `devise.callbacks.user`
+  * `bound_to_other`
+  * `email_taken`
+
+
 ## Testing
 
-I am porting this gem from an existing project, the testing is currently embebed in the project. I will extract those test and cover this project.
+Run `rspec`.
+
+More tests are appreciated.
 
 ##Contributors
 
 [German DZ](https://twitter.com/GermanDZ)
+[Abel Muiño](https://twitter.com/amuino)
 
 ## License
 
 MIT License.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/omniauth-multiprovider/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/omniauth-multiprovider.rb

@@ -1,4 +1,5 @@
 require 'omniauth/multiprovider'
+require 'omniauth/multiprovider/models/active_record'
 
 autoload :Authentication,             'omniauth/multiprovider/models/authentication'
 module OmniAuth
@@ -7,11 +8,12 @@ module OmniAuth
     autoload :OmniAuthenticable,          'omniauth/multiprovider/models/concerns/omni_authenticable'
     autoload :EmailMockups,               'omniauth/multiprovider/models/email_mockups'
     autoload :Error,                      'omniauth/multiprovider/error'
+    autoload :AlreadyBoundError,          'omniauth/multiprovider/error'
   end
   module Provider
     autoload :Abstract,                   'omniauth/provider/abstract'
     autoload :Generic,                    'omniauth/provider/generic'
     autoload :Facebook,                   'omniauth/provider/facebook'
-    autoload :Guests,                     'omniauth/provider/guests'
   end
 end
+

data/lib/omniauth/multiprovider.rb

@@ -1,2 +1 @@
-require 'omniauth/multiprovider/helpers'
 require 'omniauth/multiprovider/version'

data/lib/omniauth/multiprovider/config.rb

@@ -0,0 +1,25 @@
+module OmniAuth
+  module MultiProvider
+    class Config
+      def authentication_klass
+        Authentication
+      end
+
+      def resource_klass
+        User
+      end
+
+      def resource_mapping
+        :user
+      end
+
+      def current_resource
+        "current_#{resource_mapping}".to_sym
+      end
+
+      def authentication_relationship_name
+        :authentications
+      end
+    end
+  end
+end

data/lib/omniauth/multiprovider/controllers/callbacks_controller.rb

@@ -1,9 +1,49 @@
 module OmniAuth
   module MultiProvider
     class CallbacksController < Devise::OmniauthCallbacksController
-      def self.add_callback(provider, &block)
-        self.send :define_method, provider, &block
+
+      protected
+
+      def self.create_handler(provider_name)
+        provider_class =
+          begin
+            "OmniAuth::Provider::#{provider_name.to_s.camelize}".constantize
+          rescue NameError
+            OmniAuth::Provider::Generic
+          end
+        define_method provider_name do
+          memo_name = "@_#{provider_name}"
+          provider = instance_variable_get memo_name
+          unless provider.present?
+            provider = provider_class.new(self)
+            instance_variable_set memo_name, provider
+          end
+          handle_request provider
+        end
+      end
+
+      def handle_request(provider)
+          provider.handle_request
+      rescue OmniAuth::MultiProvider::Error => error
+        raise unless handle_provider_error(error)
+      rescue RuntimeError => error
+        raise unless handle_unexpected_error(error)
+      end
+
+      def handle_provider_error(error)
+        set_flash_message :alert, error.message
+        redirect_to after_sign_in_path_for(resource_name)
+        true
+      end
+
+      def handle_unexpected_error(error)
+        false # no explicit handling
+      end
+
+      # TODO: this looks like a good candidate for using method_missing
+      Devise.omniauth_providers.each do |provider_name|
+        create_handler provider_name
       end
     end
   end
-end
+end

data/lib/omniauth/multiprovider/error.rb

@@ -2,5 +2,28 @@ module OmniAuth
   module MultiProvider
     class Error < RuntimeError
     end
+
+    class AlreadyBoundError < Error
+      def initialize(current, bound_to)
+        @current = current
+        @bound_to = bound_to
+      end
+
+      def message
+        if @current == @bound_to
+          'bound_to_same'
+        else
+          'bound_to_other'
+        end
+      end
+
+      attr_reader :current, :bound_to
+    end
+
+    class EmailTakenError < Error
+      def message
+        'email_taken'
+      end
+    end
   end
-end
+end

data/lib/omniauth/multiprovider/models/active_record.rb

@@ -0,0 +1,14 @@
+require 'active_record'
+require 'omniauth/multiprovider/config'
+
+module OmniAuth
+  module MultiProvider
+    module ActiveRecord
+      def omniauthenticable
+        include OmniAuth::MultiProvider::OmniAuthenticable
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend OmniAuth::MultiProvider::ActiveRecord

data/lib/omniauth/multiprovider/models/authentication.rb

@@ -1,7 +1,7 @@
 require 'hashugar'
 
 class Authentication < ActiveRecord::Base
-  belongs_to OmniAuth::MultiProvider::resource_mapping
+  belongs_to :resource, polymorphic: true
   validates :provider, :uid, presence: true
 
   def self.from(omniauth_data, resource)
@@ -24,14 +24,6 @@ class Authentication < ActiveRecord::Base
     normalized
   end
 
-  def resource
-    send OmniAuth::MultiProvider::resource_mapping
-  end
-
-  def resource=(resource)
-    send("#{OmniAuth::MultiProvider::resource_mapping}=", resource)
-  end
-
   private
 
   def self.find_or_create(auth)

data/lib/omniauth/multiprovider/models/concerns/omni_authenticable.rb

@@ -1,48 +1,95 @@
+
 module OmniAuth
   module MultiProvider
 
     module OmniAuthenticable
-      extend ActiveSupport::Concern
-
-      def self.authenticate_from_params(params)
-        resource = nil
-        if params[:username].present? && params[:password].present?
-          resource = MultiProvider::resource_klass.find_for_database_authentication(email: params[:username])
-          resource = nil if resource.nil? || !resource.valid_password?(params[:password])
-        end
-        if params[:provider].present?
-          omniauth_data = {
-            provider: params[:provider],
-            uid: params[:user_id],
-            credentials: {
-              token: params[:access_token]
-            }
-          }
-          provider_class = "OmniAuth::Provider::#{params[:provider].camelize}".constantize
-          resource = provider_class.authenticate_from_oauth(params[:provider], omniauth_data)
-        end
-        resource
-      end
+      extend ::ActiveSupport::Concern
 
       included do
-        include MultiProvider::EmailMockups
+        include OmniAuth::MultiProvider::EmailMockups
+
+        class << self
+          def _oamp
+            @_omniauth_multiprovider_config ||= OmniAuth::MultiProvider::Config.new
+          end
+
+          def from_oauth(omniauth_data, signed_in_resource=nil)
+            auth = _oamp.authentication_klass.normalize(omniauth_data)
+            provider_name = auth.provider
+            access_token = auth.credentials.token
+            authentication = _oamp.authentication_klass.find_by(provider: provider_name, uid: auth.uid)
+
+            resource = authentication.try :resource
 
-        has_many MultiProvider::authentication_relationship_name, dependent: :destroy, inverse_of: MultiProvider::resource_mapping, autosave: true, class_name: MultiProvider::authentication_klass.name do
-          def [](provider)
-            find_by(provider: provider)
+            if resource and signed_in_resource
+              signed_in_resource.oauth_already_bound resource, auth
+              return signed_in_resource
+            end
+            unless resource
+              attributes = oauth_to_attributes auth
+              if signed_in_resource
+                signed_in_resource.update_from_oauth attributes, auth
+                resource = signed_in_resource
+              else
+                resource = create_from_oauth attributes, auth
+              end
+              _oamp.authentication_klass.from(auth, resource)
+            end
+            resource
+          end
+
+          # Can be customized in each model
+          def oauth_to_attributes(oauth_data)
+            attrs = {
+              email: oauth_data.info[:email] || mock_email(oauth_data.provider, oauth_data.uid),
+              password: Devise.friendly_token[0,20]
+            }
+            attrs[:password_confirmation] = attrs[:password]
+            return attrs
+          end
+
+          # Can be customized in each model
+          def create_from_oauth(attributes, signed_in_resource = nil, oauth_data)
+            raise OmniAuth::MultiProvider::EmailTakenError if exists?(email: attributes[:email])
+            create!(attributes)
           end
         end
 
-        omniauth_providers.each do |provider_name|
-          begin
-            klass = "OmniAuth::Provider::#{provider_name.to_s.camelize}".constantize
-          rescue NameError
-            klass = OmniAuth::Provider::Generic
+        has_many _oamp.authentication_relationship_name,
+          dependent: :destroy,
+          inverse_of: :resource,
+          as: :resource,
+          autosave: true,
+          class_name: _oamp.authentication_klass.name do
+            def [](provider)
+              find_by(provider: provider)
+            end
           end
-          klass.init(provider_name)
+      end
+
+      # Handler for the case when there is already an Authentication
+      # Can be customized in each model
+      def oauth_already_bound(other, oauth_data)
+        if self == other
+          # update
+          self.update_from_oauth self.class.oauth_to_attributes(oauth_data), oauth_data
+        else
+          # raise error if the oauth data is bound to another resource
+          raise MultiProvider::AlreadyBoundError.new self, other
         end
+      end
 
+      # Handler for the case when a signed_in_resource exists and is being authenticated
+      # Can be customized in each model
+      def update_from_oauth(new_attrs, oauth)
+        unless self.email.blank? || new_attrs[:email] == self.email
+          # refusing to change existing email
+          new_attrs.delete(:email)
+          # but check if someone else is using it anyway
+          raise OmniAuth::MultiProvider::EmailTakenError if User.exists?(email: new_attrs[:email])
+        end
+        self.update!(new_attrs)
       end
     end
   end
-end
+end