socialmux 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4feb9f255148e3abc9a97d01afe6a156bbfa80e8
+  data.tar.gz: fb8b815274c1aaee7ead7c86a9132ca6c1c80cb1
+SHA512:
+  metadata.gz: 7768d1a811be1d8f5dd570e74692ef26e3f97d3a3c40467f5ff103a92c800b545388c83cfe0425df3bfbcdf166d28aa3b9e633ee1a006270e55c3f4fd16b7c7d
+  data.tar.gz: d064285e28aaeb95718e11a38ca81609d22433e3cfe9042b80568c73826334b4ec864420ccdd37a498ae87239d0274944d6d232581a810ff9e1fa75925d8f5d5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+
+script: "bundle exec rspec spec"
+
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stefano Verna
+
+MIT License
+
+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,220 @@
+# Socialmux
+
+[![Build Status](https://travis-ci.org/stefanoverna/socialmux.png)](https://travis-ci.org/stefanoverna/socialmux)
+[![Coverage Status](https://coveralls.io/repos/stefanoverna/socialmux/badge.png?branch=master)](https://coveralls.io/r/stefanoverna/socialmux?branch=master)
+
+Socialmux implements a strategy to add multiple social providers to the same
+user. It's meant to be used togheter with OmniAuth.
+
+* Socialmux works with any DB schema and ORM, as it delegates DB management to 
+a simple adapter class the developer needs to implement.
+
+* Socialmux works with any authentication system, as it just prepares the User
+  model, and leave the authentication part to your controllers.
+
+## The strategy
+
+* If a matching social account is already present in the database:
+  * it returns the linked user and no change is made;
+
+* If a user is already signed in:
+   * it fills up any user blank attribute with data coming from the
+     authentication;
+   * it builds a new social authentication model, and adds it to the user model;
+   * it returns the modified user without saving it;
+
+* If an user exists with the same email:
+   * it fills up any user blank attribute with data coming from the
+     authentication;
+   * it builds a new social authentication model, and adds it to the user model;
+   * it returns the modified user without saving it;
+
+* Otherwise a new User instance gets instantiated:
+   * it fills up any user blank attribute with data coming from the
+     authentication;
+   * it builds a new social authentication model, and adds it to the user model;
+   * it returns the modified user without saving it;
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'socialmux'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install socialmux
+
+## Typical Usage
+
+This is a real word example for the following schema:
+
+* `User (email, password)`
+* `Profile (user_id, first_name, last_name)`
+* `SocialAuth (user_id, provider, uid)`
+
+User requires an email, so if an external auth provider does not give us this 
+information, a form will be shown for the user to fill it in.
+
+### `config/routes.rb`
+
+```ruby
+MyApp::Application.routes.draw do
+  devise_for :users
+
+  # OmniAuth route
+  match '/auth/:provider/callback' => 'social#callback', via: [:get, :post]
+
+  # This is where the magic happens :)
+  match '/auth/complete' => 'social#complete', as: :social_complete, via: [:get, :post], as: :social_complete
+
+  # ...
+end
+```
+
+### `app/services/social_schema_adapter.rb`
+
+This is the adapter to the database. Socialmux requires these methods'
+interfaces. The implementation will differ based on the project.
+
+```ruby
+class SocialSchemaAdapter
+  def init_user
+    User.new
+  end
+
+  def find_user_with_email(email)
+    User.where(email: email).first
+  end
+
+  def find_user_with_authentication(data)
+    auth = SocialAuth.where(provider: data.provider, uid: data.uid).first
+    auth.user if auth.present?
+  end
+
+  def update_user_with_params(user, user_params)
+    user.attributes = user_params
+  end
+
+  def update_user_with_data_if_blank(user, data)
+    profile = user.profile || user.build_profile
+
+    update_attr_if_blank(user, :email, data.email)
+    update_attr_if_blank(profile, :first_name, data.first_name)
+    update_attr_if_blank(profile, :last_name, data.last_name)
+  end
+
+  def build_authentication(user, data)
+    auth_attrs = { provider: data.provider, uid: data.uid }
+    user.social_auths.build(auth_attrs)
+  end
+
+  private
+
+  def update_attr_if_blank(record, key, value)
+    current_value = record.send(key)
+    record.send("#{key}=", value) if current_value.blank?
+  end
+end
+```
+
+### `app/controllers/social_controller.rb`
+
+```ruby
+  class SocialController < ApplicationController
+    def callback
+      session[:omniauth] ||= request.env['omniauth.auth']
+      redirect_to social_complete_path
+    end
+
+    def complete
+
+      # Here we instanciate our Socialmux strategy with all the required
+      # arguments
+
+      authentication = Socialmux::Strategy.new(
+        adapter: SocialSchemaAdapter.new,
+        current_user: current_user,
+        omniauth_data: session[:omniauth],
+        user_params: user_params
+      )
+
+      # `.result` returns a Socialmux::Result, which gives us the
+      # found/generated user that we need to sign in
+      result = authentication.result
+      @user = result.user
+
+      # If you cannot save the model, it's because some required fields
+      # could not be extracted from the thirdy party authentication source.
+      # We render a form that points to this very same action.
+
+      if @user.save
+        sign_in_and_notice(@user, result.event)
+      else
+        render :complete
+      end
+    end
+
+    private
+
+    def user_params
+      if request.post?
+        params.require(:user).permit(:email, profile_attributes: [ :first_name, :last_name ])
+      else
+        {}
+      end
+    end
+
+    def sign_in_and_notice(user, event)
+      flash[:notice] = "Result: #{event}"
+      session.delete(:omniauth)
+      sign_in_and_redirect(user)
+    end
+  end
+```
+
+### `app/views/social/complete.html.slim`
+
+```slim
+h1 Sign up with Social
+
+= simple_form_for @user, url: social_complete_path do |f|
+
+  p You're close to finish the registration process... In order to be able to restore your account in the future, please insert your email!
+
+  = f.input :email
+
+  fieldset
+    legend Optional data
+
+    = f.simple_fields_for :profile do |p|
+      = p.input :first_name
+      = p.input :last_name
+
+  = f.button :submit
+```
+
+## About sessions
+
+In the above example, OmniAuth `AuthResult` is stored in session until the user
+completes the sign up process.
+
+If you use cookies, this won't work and raise a `CookieOverflow` error. Use a
+session store backed by an Active Record class:
+
+```ruby
+gem 'activerecord-session_store', github: 'rails/activerecord-session_store'
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+

data/Rakefile

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

data/lib/socialmux/auth_mapper/base.rb

@@ -0,0 +1,25 @@
+require 'hashie'
+require 'active_support/core_ext/module/delegation'
+
+module Socialmux
+  module AuthMapper
+    class Base
+      attr_reader :data
+
+      delegate :uid, to: :data
+      delegate :info, to: :data
+      delegate :provider, to: :data
+
+      delegate :first_name, to: :info
+      delegate :last_name, to: :info
+      delegate :email, to: :info
+      delegate :image, to: :info
+      delegate :description, to: :info
+
+      def initialize(data)
+        @data = Hashie::Mash.new(data)
+      end
+    end
+  end
+end
+

data/lib/socialmux/auth_mapper/facebook.rb

@@ -0,0 +1,7 @@
+module Socialmux
+  module AuthMapper
+    class Facebook < Base
+    end
+  end
+end
+

data/lib/socialmux/auth_mapper/github.rb

@@ -0,0 +1,7 @@
+module Socialmux
+  module AuthMapper
+    class Github < GuessName
+    end
+  end
+end
+

data/lib/socialmux/auth_mapper/google_oauth2.rb

@@ -0,0 +1,7 @@
+module Socialmux
+  module AuthMapper
+    class GoogleOauth2 < Base
+    end
+  end
+end
+

data/lib/socialmux/auth_mapper/guess_name.rb

@@ -0,0 +1,22 @@
+module Socialmux
+  module AuthMapper
+    class GuessName < Base
+      def first_name
+        name_chunks.first
+      end
+
+      def last_name
+        last_name = name_chunks.dup
+        last_name.shift
+        last_name.join(" ")
+      end
+
+      private
+
+      def name_chunks
+        info.name.split(/\s+/)
+      end
+    end
+  end
+end
+

data/lib/socialmux/auth_mapper/linkedin.rb

@@ -0,0 +1,7 @@
+module Socialmux
+  module AuthMapper
+    class Linkedin < Base
+    end
+  end
+end
+

data/lib/socialmux/auth_mapper/twitter.rb

@@ -0,0 +1,7 @@
+module Socialmux
+  module AuthMapper
+    class Twitter < GuessName
+    end
+  end
+end
+

data/lib/socialmux/auth_mapper.rb

@@ -0,0 +1,26 @@
+require 'hashie'
+
+require 'socialmux/auth_mapper/base'
+require 'socialmux/auth_mapper/guess_name'
+require 'socialmux/auth_mapper/facebook'
+require 'socialmux/auth_mapper/twitter'
+require 'socialmux/auth_mapper/github'
+require 'socialmux/auth_mapper/google_oauth2'
+require 'socialmux/auth_mapper/linkedin'
+
+module Socialmux
+  module AuthMapper
+    class NotFound < RuntimeError; end
+
+    def self.init_with_data(data)
+      data = Hashie::Mash.new(data)
+
+      klass_name = "Social::AuthMapper::#{data.provider.classify}"
+      klass = klass_name.constantize
+      klass.new(data)
+    rescue NameError
+      raise NotFound, "Mapper #{klass_name} for provider #{data.provider} not found!"
+    end
+  end
+end
+

data/lib/socialmux/event.rb

@@ -0,0 +1,13 @@
+module Socialmux
+  module Event
+    SIGN_IN = :sign_in
+    SIGN_UP = :sign_up
+    TOUCHED_CURRENT_USER = :updated_current_user
+    TOUCHED_EMAIL_USER = :updated_email_user
+
+    def self.all
+      [ SIGN_IN, SIGN_UP, TOUCHED_CURRENT_USER, TOUCHED_EMAIL_USER ]
+    end
+  end
+end
+

data/lib/socialmux/result.rb

@@ -0,0 +1,15 @@
+module Socialmux
+  class Result < Struct.new(:user, :event)
+
+    def method_missing(name, *args, &block)
+      Event.all.each do |event_name|
+        if name.to_s == "#{event_name}?"
+          return event == event_name
+        end
+      end
+
+      super
+    end
+  end
+end
+

data/lib/socialmux/strategy.rb

@@ -0,0 +1,69 @@
+require 'active_support/core_ext/hash/reverse_merge'
+require 'active_support/core_ext/hash/keys'
+
+module Socialmux
+  class Strategy
+    attr_reader :adapter
+    attr_reader :current_user
+    attr_reader :omniauth_data
+    attr_reader :user_params
+
+    def initialize(options)
+      options.assert_valid_keys(:adapter,
+                                :current_user,
+                                :omniauth_data,
+                                :user_params)
+
+      options.each do |key, value|
+        instance_variable_set "@#{key}", value
+      end
+    end
+
+    def result
+      returning_user ||
+      augmented_current_user ||
+      augmented_user_with_same_email ||
+      new_user
+    end
+
+    private
+
+    def returning_user
+      user = adapter.find_user_with_authentication(data)
+      Result.new(user, Event::SIGN_IN) if user
+    end
+
+    def augmented_current_user
+      return nil if !current_user
+
+      augment_user(current_user)
+      Result.new(current_user, Event::TOUCHED_CURRENT_USER)
+    end
+
+    def augmented_user_with_same_email
+      user = adapter.find_user_with_email(data.email)
+      return if !user
+
+      augment_user(user)
+      return Result.new(user, Event::TOUCHED_EMAIL_USER)
+    end
+
+    def new_user
+      user = adapter.init_user
+      augment_user(user)
+      Result.new(user, Event::SIGN_UP)
+    end
+
+    def data
+      @data ||= AuthMapper.init_with_data(omniauth_data)
+    end
+
+    def augment_user(user)
+      adapter.update_user_with_data_if_blank(user, data)
+      adapter.update_user_with_params(user, user_params)
+      adapter.build_authentication(user, data)
+      user
+    end
+  end
+end
+

data/lib/socialmux/version.rb

@@ -0,0 +1,4 @@
+module Socialmux
+  VERSION = "0.0.1"
+end
+

data/lib/socialmux.rb

@@ -0,0 +1,9 @@
+require 'socialmux/version'
+require 'socialmux/event'
+require 'socialmux/result'
+require 'socialmux/strategy'
+require 'socialmux/auth_mapper'
+
+module Socialmux
+end
+

data/socialmux.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'socialmux/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "socialmux"
+  spec.version       = Socialmux::VERSION
+  spec.authors       = ["Stefano Verna"]
+  spec.email         = ["stefano.verna@welaika.com"]
+  spec.description   = %q{Socialmux implements a strategy to add multiple social providers to the same user. It's meant to be used togheter with OmniAuth.}
+  spec.summary       = %q{Socialmux implements a strategy to add multiple social providers to the same user. It's meant to be used togheter with OmniAuth.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'bourne'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'hashie'
+end
+