omniauth-multiprovider 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f91a138b2a60e02e2c38acc950045cae88281922
+  data.tar.gz: b4743f78480676b0de284cd11e212009ead3258e
+SHA512:
+  metadata.gz: 3035045753961d2bb672c5ab90b0593a1845ea92f4572b610df5b4858fde5bb5825ae644ea083b2a2737b12999a2e3a7442275c21a5db5fe104a0895c08fece3
+  data.tar.gz: f752d7732163ab562d2020120c2c190dfb7cdfb2f6b77361b85537431fbc6924ef2a7256254c99b75586322c2a583d3a0de82f3649ee4e76e711428c8e209137

data/.gitignore

@@ -0,0 +1,19 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+.rvmrc
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+.project
+config/initializers/secret_token.rb

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 1uptalent
+
+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.md

@@ -0,0 +1,57 @@
+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
+
+## 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 ;)
+
+## How to use
+
+In your devise resource model (aka mapping), usually `User` add:
+
+    include OmniAuth::MultiProvider::OmniAuthenticable
+
+Don't forget to configure devise to use Facebook (or any other provider):
+
+    devise :omniauthable, omniauth_providers: [:facebook]
+
+In your `routes.rb`
+
+    devise_for :users, controllers: { omniauth_callbacks: 'omni_auth/multi_provider/callbacks' }
+
+Create a migration to add the `Authentication` model with:
+
+    rails g migration create_authentications
+
+The change method should contain something like:
+
+    create_table :authentications do |t|
+      t.references :{devise_mapping_name}
+      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`
+
+## 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.
+
+##Contributors
+
+[German DZ](https://twitter.com/GermanDZ)
+
+## License
+
+MIT License.

data/lib/omniauth-multiprovider.rb

@@ -0,0 +1,18 @@
+require 'omniauth/multiprovider'
+
+autoload :Authentication,             'omniauth/multiprovider/models/authentication'
+module OmniAuth
+  module MultiProvider
+    autoload :CallbacksController,        'omniauth/multiprovider/controllers/callbacks_controller'
+    autoload :OmniAuthenticable,          'omniauth/multiprovider/models/concerns/omni_authenticable'
+    autoload :EmailMockups,               'omniauth/multiprovider/models/email_mockups'
+    autoload :Error,                      '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

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

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

@@ -0,0 +1,9 @@
+module OmniAuth
+  module MultiProvider
+    class CallbacksController < Devise::OmniauthCallbacksController
+      def self.add_callback(provider, &block)
+        self.send :define_method, provider, &block
+      end
+    end
+  end
+end

data/lib/omniauth/multiprovider/error.rb

@@ -0,0 +1,6 @@
+module OmniAuth
+  module MultiProvider
+    class Error < RuntimeError
+    end
+  end
+end

data/lib/omniauth/multiprovider/helpers.rb

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

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

@@ -0,0 +1,46 @@
+require 'hashugar'
+
+class Authentication < ActiveRecord::Base
+  belongs_to OmniAuth::MultiProvider::resource_mapping
+  validates :provider, :uid, presence: true
+
+  def self.from(omniauth_data, resource)
+    auth = normalize(omniauth_data)
+    authentication = self.find_or_create(auth)
+    authentication.access_token = auth.credentials.token
+    authentication.resource = resource
+    authentication.save
+    authentication
+  end
+
+  def self.normalize(omniauth_data)
+    return omniauth_data if omniauth_data.is_a? Hashugar
+    normalized = omniauth_data.to_hashugar
+    normalized.delete(:extra)
+    normalized.credentials ||= {}
+    normalized.info ||= {}
+    normalized.info.delete(:description)
+    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)
+    self.find_by(
+      provider: auth.provider,
+      uid: auth.uid) ||
+    self.new(
+      provider: auth.provider,
+      uid: auth.uid,
+      access_token: auth.credentials.token)
+  end
+
+end

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

@@ -0,0 +1,48 @@
+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
+
+      included do
+        include MultiProvider::EmailMockups
+
+        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)
+          end
+        end
+
+        omniauth_providers.each do |provider_name|
+          begin
+            klass = "OmniAuth::Provider::#{provider_name.to_s.camelize}".constantize
+          rescue NameError
+            klass = OmniAuth::Provider::Generic
+          end
+          klass.init(provider_name)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module OmniAuth
+  module MultiProvider
+
+    module EmailMockups
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def mocked_email?
+        email.match /.*@from\-.*\.com$/
+      end
+
+      def current_email
+        mocked_email? ? '' : email
+      end
+
+      module ClassMethods
+        def mock_email(provider, nickname)
+          "#{nickname}@from-#{provider}.example.com"
+        end
+      end
+    end
+
+  end
+end

data/lib/omniauth/multiprovider/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module MultiProvider
+    VERSION = '0.0.1'
+  end
+end

data/lib/omniauth/provider/abstract.rb

@@ -0,0 +1,70 @@
+module OmniAuth
+  module Provider
+    class Abstract
+
+      def self.init
+      end
+
+      OmniAuth::MultiProvider::resource_klass.send(:include, OmniAuth::MultiProvider::EmailMockups)
+
+      def self.find_from_oauth(provider_name, omniauth_data, signed_in_resource=nil)
+        auth = MultiProvider::authentication_klass.normalize(omniauth_data)
+        access_token = auth.credentials.token
+        authentication = MultiProvider.authentication_klass.find_by(provider: provider_name, uid: auth.uid)
+
+        if authentication
+          if signed_in_resource
+            if authentication.resource == signed_in_resource
+              raise MultiProvider::Error.new 'already connected'
+            else
+              raise MultiProvider::Error.new 'already connected with other user'
+            end
+          end
+          authentication.resource
+        else
+          if auth.info[:email].blank?
+            auth.info[:email] = MultiProvider::resource_klass.mock_email(provider_name, auth.uid)
+          end
+          email = auth.info[:email]
+
+          raise MultiProvider::Error.new 'email_already_registered' if MultiProvider::resource_klass.find_by(email: email)
+
+          resource = signed_in_resource || MultiProvider::resource_klass.create(
+                                         email: email,
+                                         password: Devise.friendly_token[0,20]
+                                         )
+
+          MultiProvider.authentication_klass.from(auth, resource)
+
+          resource
+        end
+      end
+
+      def self.authenticate_from_oauth(provider_name, omniauth_data)
+        auth = MultiProvider::authentication_klass.normalize(omniauth_data)
+        access_token = auth.credentials.token
+        authentication = MultiProvider.authentication_klass.find_by(provider: provider_name, uid: auth.uid)
+
+        if authentication
+          authenticate(authentication.send(MultiProvider::resource_mapping), authentication, auth)
+        else
+          if auth.info[:email].blank?
+            auth.info[:email] = MultiProvider::resource_klass.mock_email(provider_name, auth.uid)
+          end
+          email = auth.info[:email]
+
+          raise MultiProvider::Error.new 'email_already_registered' if MultiProvider::resource_klass.find_by(email: email)
+
+          resource = MultiProvider::resource_klass.create(
+                                         email: email,
+                                         password: Devise.friendly_token[0,20]
+                                         )
+
+          MultiProvider.authentication_klass.from(auth, resource)
+
+          resource
+        end
+      end
+    end
+  end
+end

data/lib/omniauth/provider/facebook.rb

@@ -0,0 +1,14 @@
+module OmniAuth
+  module Provider
+    class Facebook < Generic
+
+      def self.authenticate(resource, authentication, omniauth_data)
+        access_token = omniauth_data.credentials.token
+        fb_user = FbGraph::User.me(access_token).fetch
+        return nil unless fb_user.identifier == omniauth_data.uid
+        authentication.update!(access_token: access_token)
+        resource
+      end
+    end
+  end
+end

data/lib/omniauth/provider/generic.rb

@@ -0,0 +1,21 @@
+module OmniAuth
+  module Provider
+    class Generic < Abstract
+
+      def self.init(provider_name)
+        klass = self
+        OmniAuth::MultiProvider::CallbacksController.add_callback(provider_name) do
+          resource = klass.find_from_oauth(provider_name, request.env['omniauth.auth'], send(OmniAuth::MultiProvider::current_resource))
+          if resource.persisted?
+            sign_in_and_redirect resource, event: :authentication #this will throw if resource is not activated
+            set_flash_message(:notice, :success, kind: provider_name.to_s.camelize) if is_navigational_format?
+          else
+            session["devise.#{provider_name}_data"] = auth
+            redirect_to send("new_#{OmniAuth::MultiProvider::resource_mapping}_registration_url")
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/omniauth/provider/guests.rb

@@ -0,0 +1,12 @@
+module OmniAuth
+  module Provider
+    class Guests < Abstract
+
+      def self.authenticate(resource, authentication, omniauth_data)
+        return nil unless authentication.access_token == omniauth_data.credentials.token
+        resource
+      end
+
+    end
+  end
+end

data/omniauth-multiprovider.gemspec

@@ -0,0 +1,19 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'omniauth/multiprovider/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'omniauth-multiprovider'
+  s.version     = OmniAuth::MultiProvider::VERSION
+  s.summary     = "Authenticate devise users with multiple OAuth providers"
+  s.description = "Provides a simple approach to support many oauth providers to devise"
+  s.authors     = ["German Del Zotto"]
+  s.email       = 'germ@ndz.com.ar'
+  s.files       = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage    = 'https://github.com/1uptalent/omniauth-multiprovider'
+  s.license     = 'MIT'
+
+  s.add_dependency('devise', '~> 3.2')
+  s.add_dependency('omniauth-oauth2', '~> 1.1')
+  s.add_dependency('hashugar', '~> 0.0.6')
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-multiprovider
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- German Del Zotto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: hashugar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+description: Provides a simple approach to support many oauth providers to devise
+email: germ@ndz.com.ar
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- lib/omniauth-multiprovider.rb
+- lib/omniauth/multiprovider.rb
+- lib/omniauth/multiprovider/controllers/callbacks_controller.rb
+- lib/omniauth/multiprovider/error.rb
+- lib/omniauth/multiprovider/helpers.rb
+- lib/omniauth/multiprovider/models/authentication.rb
+- lib/omniauth/multiprovider/models/concerns/omni_authenticable.rb
+- lib/omniauth/multiprovider/models/email_mockups.rb
+- lib/omniauth/multiprovider/version.rb
+- lib/omniauth/provider/abstract.rb
+- lib/omniauth/provider/facebook.rb
+- lib/omniauth/provider/generic.rb
+- lib/omniauth/provider/guests.rb
+- omniauth-multiprovider.gemspec
+homepage: https://github.com/1uptalent/omniauth-multiprovider
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Authenticate devise users with multiple OAuth providers
+test_files: []
+has_rdoc: