domp 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+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,84 @@
+# DOMP: Devise & Omniauth Multiple Providers
+
+Generator for using Devise & Omniauth with Multiple Providers. I wrote this because I got tired of repeating the same code in every app that required multiple providers.
+
+Basically, to have multiple providers working in a brand new application, all you need to do is run the following:
+```
+gem "devise"
+```
+```
+rails generate devise:install
+rails generate devise User
+rails generate domp User facebook twitter
+```
+
+Note: this is not an engine but rather a generator which will generate models, controllers and setup configs for you. You are free to change everything. You are the king.
+
+## Installation
+
+    $ gem install domp
+
+## Usage
+
+First, you need to have `devise` already installed and your model generated:
+
+```
+rails generate devise:install
+rails generate devise User
+```
+
+Run the `domp` generator:
+
+```
+rails generate domp User facebook twitter
+```
+
+During the generation you will be promted for the provider's application id and secret key.
+
+## What is generated for you:
+
+### AuthenticationProvider
+Model & migration. Will be populated with the providers you specify.
+
+### UserAuthentication
+Model & migration.
+
+### User model additions
+Here's what the `User` model will look like:
+
+```ruby
+class User < ActiveRecord::Base
+  has_many :authentications, class_name: 'UserAuthentication'
+  devise :omniauthable,  :database_authenticatable, :registerable,
+         :recoverable, :rememberable, :trackable, :validatable
+```
+
+### User::OmniauthCallbacksController
+Here goes all the logic of creating multiple authentications. You are free to change everything, it's just a boilerplate that will make sense it most of the apps.
+
+### Route additions
+```ruby
+devise_for :users, controllers: { omniauth_callbacks: 'users/omniauth_callbacks' }
+```
+### Devise config additions
+
+The following will be added to `config/initializers/devise.rb`:
+
+```ruby
+config.omniauth :facebook, 'x', 'x'
+config.omniauth :twitter, 'x', 'x'
+  ```
+
+### Gemfile additions
+```
+gem "omniauth"
+gem "omniauth-facebook"
+gem "omniauth-twitter"
+```
+## 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/domp.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'domp/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "domp"
+  gem.version       = Domp::VERSION
+  gem.authors       = ["Alexander Zaytsev"]
+  gem.email         = ["alexander@say26.com"]
+  gem.description   = %q{Devise Omniauth Multiple Providers}
+  gem.summary       = %q{Generator to bootstrap usage of multiple providers with Devise and Omniauth}
+  gem.homepage      = "https://github.com/AlexanderZaytsev/domp"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/domp.rb

@@ -0,0 +1,5 @@
+require "domp/version"
+
+module Domp
+
+end

data/lib/domp/version.rb

@@ -0,0 +1,3 @@
+module Domp
+  VERSION = "0.0.1"
+end

data/lib/generators/domp/USAGE

@@ -0,0 +1,12 @@
+Description:
+    Generator to bootstrap usage of multiple providers with Devise and Omniauth
+
+Example:
+    rails generate domp User facebook twitter
+
+    This will create:
+      create  app/models/authentication_provider.rb
+      create  app/models/user_authentication.rb
+      create  db/migrate/20130118200452_create_authentication_providers.rb
+      create  db/migrate/20130118200453_create_user_authentications.rb
+      create  app/controllers/users/omniauth_callbacks_controller.rb

data/lib/generators/domp/domp_generator.rb

@@ -0,0 +1,75 @@
+require 'bundler'
+class DompGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  argument :providers, type: :array, banner: "provider"
+
+  def check_if_devise_is_installed
+    unless File.exists?("config/initializers/devise.rb")
+      puts "Devise not found. Install it first."
+      exit
+    end
+  end
+
+  def check_if_devise_has_generated_model
+    unless File.exists?("app/models/#{file_name}.rb")
+      puts "Could not find `app/models/#{file_name}.rb`. You need to generate it with Devise first."
+      exit
+    end
+  end
+
+  def update_devise_config
+    omniauth_config = []
+
+    providers.each do |provider|
+      id = ask("#{provider.capitalize} application ID:")
+      secret = ask("#{provider.capitalize} application secret:")
+      omniauth_config << "\n  config.omniauth :#{provider}, '#{id}', '#{secret}'\n"
+    end
+
+    inject_into_file 'config/initializers/devise.rb', after: "# config.omniauth :github, 'APP_ID', 'APP_SECRET', :scope => 'user,public_repo'" do
+      omniauth_config.join('')
+    end
+  end
+
+  def update_model_class
+    inject_into_class "app/models/#{file_name}.rb", class_name do
+      "  has_many :authentications, class_name: '#{class_name}Authentication'\n"
+    end
+
+    inject_into_file "app/models/#{file_name}.rb", after: "  devise" do
+      " :omniauthable, "
+    end
+  end
+
+  def update_gemfile
+    gem 'omniauth'
+    providers.each do |provider|
+      gem "omniauth-#{provider}"
+    end
+  end
+
+  def update_routes
+    inject_into_file 'config/routes.rb', after: "devise_for :#{table_name}" do
+      ", controllers: { omniauth_callbacks: '#{table_name}/omniauth_callbacks' }"
+    end
+  end
+
+  def copy_templates
+    template 'authentication_provider.rb', 'app/models/authentication_provider.rb'
+    template "model_authentication.rb", "app/models/#{file_name}_authentication.rb"
+    template "authentication_providers_migration.rb", "db/migrate/#{Time.now.strftime('%Y%m%d%H%M%S')}_create_authentication_providers.rb"
+    template "model_authentications_migration.rb", "db/migrate/#{(Time.now + 1).strftime('%Y%m%d%H%M%S')}_create_#{class_name.downcase}_authentications.rb"
+    template "omniauth_callbacks_controller.rb", "app/controllers/#{table_name}/omniauth_callbacks_controller.rb"
+  end
+
+  def bundle
+    Bundler.with_clean_env do
+      run 'bundle install'
+    end
+  end
+
+  def migrate
+    rake 'db:migrate'
+  end
+
+end

data/lib/generators/domp/templates/authentication_provider.rb

@@ -0,0 +1,8 @@
+<% module_namespacing do -%>
+class AuthenticationProvider < ActiveRecord::Base
+  has_many :<%= table_name %>
+<% if Rails::VERSION::MAJOR < 4 -%>
+  attr_accessible :name
+<% end -%>
+end
+<% end -%>

data/lib/generators/domp/templates/authentication_providers_migration.rb

@@ -0,0 +1,16 @@
+<% module_namespacing do -%>
+class CreateAuthenticationProviders < ActiveRecord::Migration
+  def change
+    create_table "authentication_providers", :force => true do |t|
+      t.string   "name"
+      t.datetime "created_at",                 :null => false
+      t.datetime "updated_at",                 :null => false
+    end
+    add_index "authentication_providers", ["name"], :name => "index_name_on_authentication_providers"
+<% providers.each do |provider| -%>
+    AuthenticationProvider.create(name: '<%= provider %>')
+<% end -%>
+  end
+end
+<% end -%>
+

data/lib/generators/domp/templates/model_authentication.rb

@@ -0,0 +1,23 @@
+<% module_namespacing do -%>
+class <%= class_name %>Authentication < ActiveRecord::Base
+  belongs_to :<%= class_name.downcase %>
+  belongs_to :authentication_provider
+
+  serialize :params
+
+<% if Rails::VERSION::MAJOR < 4 -%>
+  attr_accessible :user_id, :authentication_provider_id, :uid, :token, :token_expires_at, :params
+
+<% end -%>
+  def self.create_from_omniauth(params, <%= class_name.downcase %>, provider)
+    create(
+      <%= class_name.downcase %>: <%= class_name.downcase %>,
+      authentication_provider: provider,
+      uid: params['uid'],
+      token: params['credentials']['token'],
+      token_expires_at: params['credentials']['expires_at'],
+      params: params,
+    )
+  end
+end
+<% end -%>

data/lib/generators/domp/templates/model_authentications_migration.rb

@@ -0,0 +1,19 @@
+<% module_namespacing do -%>
+class Create<%= class_name %>Authentications < ActiveRecord::Migration
+  def change
+    create_table "<%= class_name.downcase %>_authentications", :force => true do |t|
+      t.integer  "<%= class_name.downcase %>_id"
+      t.integer  "authentication_provider_id"
+      t.string   "uid"
+      t.string   "token"
+      t.datetime "token_expires_at"
+      t.text     "params"
+      t.datetime "created_at",                 :null => false
+      t.datetime "updated_at",                 :null => false
+    end
+    add_index "<%= class_name.downcase %>_authentications", ["authentication_provider_id"], :name => "index_<%= class_name.downcase %>_authentications_on_authentication_provider_id"
+    add_index "<%= class_name.downcase %>_authentications", ["<%= class_name.downcase %>_id"], :name => "index_<%= class_name.downcase %>_authentications_on_user_id"
+  end
+end
+<% end -%>
+

data/lib/generators/domp/templates/omniauth_callbacks_controller.rb

@@ -0,0 +1,46 @@
+<% module_namespacing do -%>
+class <%= class_name %>::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+
+<% providers.each do |provider| -%>
+  def <%= provider %>
+    create
+  end
+
+<% end -%>
+  private
+
+    def create
+      auth_params = request.env["omniauth.auth"]
+      provider = AuthenticationProvider.where(name: auth_params.provider).first
+
+      authentication = provider.<%= class_name.downcase %>_authentications.where(uid: auth_params.uid).first
+      if authentication
+        sign_in_with_existing_authentication(authentication)
+      elsif <%= class_name.downcase %>_signed_in?
+        create_authentication_and_sign_in(auth_params, current_<%= class_name.downcase %>, provider)
+      else
+        create_<%= class_name.downcase %>_and_authentication_and_sign_in(auth_params, provider)
+      end
+    end
+
+    def sign_in_with_existing_authentication(authentication)
+      sign_in_and_redirect(:<%= class_name.downcase %>, authentication.<%= class_name.downcase %>)
+    end
+
+    def create_authentication_and_sign_in(auth_params, <%= class_name.downcase %>, provider)
+      <%= class_name %>Authentication.create_from_omniauth(auth_params, <%= class_name.downcase %>, provider)
+
+      sign_in_and_redirect(:<%= class_name.downcase %>, <%= class_name.downcase %>)
+    end
+
+    def create_<%= class_name.downcase %>_and_authentication_and_sign_in(auth_params, provider)
+      <%= class_name.downcase %> = <%= class_name %>.create_from_omniauth(auth_params)
+      if <%= class_name.downcase %>.valid?
+        create_authentication_and_sign_in(auth_params, <%= class_name.downcase %>, provider)
+      else
+        flash[:error] = <%= class_name.downcase %>.errors.full_messages.first
+        redirect_to new_<%= class_name.downcase %>_registration_url
+      end
+    end
+end
+<% end -%>

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: domp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexander Zaytsev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-18 00:00:00.000000000 Z
+dependencies: []
+description: Devise Omniauth Multiple Providers
+email:
+- alexander@say26.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- domp.gemspec
+- lib/domp.rb
+- lib/domp/version.rb
+- lib/generators/domp/USAGE
+- lib/generators/domp/domp_generator.rb
+- lib/generators/domp/templates/authentication_provider.rb
+- lib/generators/domp/templates/authentication_providers_migration.rb
+- lib/generators/domp/templates/model_authentication.rb
+- lib/generators/domp/templates/model_authentications_migration.rb
+- lib/generators/domp/templates/omniauth_callbacks_controller.rb
+homepage: https://github.com/AlexanderZaytsev/domp
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Generator to bootstrap usage of multiple providers with Devise and Omniauth
+test_files: []