devise-omniauth 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,58 @@
+devise-omniauth
+===============
+
+# This gem is very much in development and I do not at all recommend using it in a project yet. Feel free to contribute though :)
+
+Reusable Omniauth integration for Devise supporting multiple providers. Gives you a User model
+
+Run the installer
+
+    rails generate devise_omniauth:install
+
+Follow the instructions output from the installer
+
+Install the database migrations
+
+    rake devise_omniauth:install:migrations
+
+Run migrations
+
+    rake db:migrate
+
+
+
+
+
+# Below are old notes, ignore
+Mount the engine's routes in your routes.rb. Note: if you change the :as option you will need to customize the paths in the devise views (see below)
+
+    mount DeviseOmniauth::Engine => "/", :as => "devise_omniauth"
+
+Now you can access the routes url helpers from this engine in your application using the prefix you cleared in the :as above, for instance:
+
+    devise_omniauth.user_omniauth_authorize_path(:facebook)
+
+Install the devise initializer
+
+    rails generate initializer devise
+
+Open the newly created config/initializers/devise.rb and customize the following lines with your oauth settings:
+
+    config.omniauth :facebook, "[SET APP_ID HERE]", "[SET APP_SECRET HERE]"
+
+To customize the devise views (optional):
+
+    rails generate devise:views
+
+
+
+
+
+For each provider you want to use, add them to your config/initializers/devise.rb, for instance:
+
+    require "omniauth-facebook"
+    config.omniauth :facebook, "APP_ID", "APP_SECRET"
+
+Make sure your model is omniauthable (app/models/user.rb
+
+    devise :omniauthable

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DeviseOmniauth'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/devise-omniauth/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/devise-omniauth/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/devise_omniauth/application_controller.rb

@@ -0,0 +1,4 @@
+module DeviseOmniauth
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/devise_omniauth/confirmations_controller.rb

@@ -0,0 +1,4 @@
+module DeviseOmniauth
+  class ConfirmationsController < Devise::ConfirmationsController
+  end
+end

data/app/controllers/devise_omniauth/passwords_controller.rb

@@ -0,0 +1,4 @@
+module DeviseOmniauth
+  class PasswordsController < Devise::PasswordsController
+  end
+end

data/app/controllers/devise_omniauth/registrations_controller.rb

@@ -0,0 +1,4 @@
+module DeviseOmniauth
+  class RegistrationsController < Devise::RegistrationsController
+  end
+end

data/app/controllers/devise_omniauth/sessions_controller.rb

@@ -0,0 +1,4 @@
+module DeviseOmniauth
+  class SessionsController < Devise::SessionsController
+  end
+end

data/app/controllers/devise_omniauth/unlocks_controller.rb

@@ -0,0 +1,4 @@
+module DeviseOmniauth
+  class UnlocksController < Devise::UnlocksController
+  end
+end

data/app/controllers/devise_omniauth/users/omniauth_callbacks_controller.rb

@@ -0,0 +1,17 @@
+module DeviseOmniauth
+  class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+    def facebook
+
+      auth = DeviseOmniauth::Authentication.find_or_create_for_facebook_oauth(request.env["omniauth.auth"], current_user)
+      @user = auth.user
+
+      if @user.persisted?
+        flash[:notice] = I18n.t "devise.omniauth_callbacks.success", :kind => "Facebook"
+        sign_in_and_redirect @user, :event => :authentication
+      else
+        session["devise.facebook_data"] = request.env["omniauth.auth"]
+        redirect_to new_user_registration_url
+      end
+    end
+  end
+end

data/app/helpers/devise-omniauth/application_helper.rb

@@ -0,0 +1,4 @@
+module DeviseOmniauth
+  module ApplicationHelper
+  end
+end

data/app/models/devise_omniauth/authentication.rb

@@ -0,0 +1,34 @@
+module DeviseOmniauth
+  class Authentication < ActiveRecord::Base
+    belongs_to :user
+    attr_accessible :provider, :provider_id, :user
+
+    def self.find_or_create_for_facebook_oauth(auth_info, signed_in_resource=nil)
+      # Try to find an existing authentication
+      auth = self.where(provider: auth_info.provider, provider_id: auth_info.uid).first
+      # No existing authentication was found
+      unless auth
+        # Try to find a user with the email address contained in auth_info
+        # TODO should we have the user confirm they want to link these?
+        user = User.find_by_email(auth_info.info.email)
+        # If there isn't a user, create one with the auth_info
+        # TODO should the user confirm this and/or have the opportunity to link to a different email?
+        unless user
+          user = User.create(
+            name: auth_info.extra.raw_info.name,
+            email: auth_info.info.email,
+            password: Devise.friendly_token[0, 20]
+          )
+        end
+        # Create the Authentication for the user we found or created
+        auth = self.create(
+          user: user,
+          provider: auth_info.provider,
+          provider_id: auth_info.uid
+        )
+      end
+      # Return the Authentication
+      auth
+    end
+  end
+end

data/app/models/user.rb

@@ -0,0 +1,19 @@
+class User < ActiveRecord::Base
+  # Include default devise modules. Others available are:
+  # TODO only have omniauthable and required here and give instructions for adding the rest in your app
+  devise :database_authenticatable, :registerable, :token_authenticatable, :lockable, :timeoutable,
+         :recoverable, :rememberable, :trackable, :validatable, :confirmable, :omniauthable
+
+  # Setup accessible (or protected) attributes for your model
+  attr_accessible :email, :password, :password_confirmation, :remember_me, :name
+
+  has_many :omniauth_authentications, :class_name => DeviseOmniauth::Authentication
+
+  def self.new_with_session(params, session)
+    super.tap do |user|
+      if data = session["devise.facebook_data"] && session["devise.facebook_data"]["extra"]["raw_info"]
+        user.email = data["email"] if user.email.blank?
+      end
+    end
+  end
+end

data/app/views/layouts/devise-omniauth/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>DeviseOmniauth</title>
+  <%= stylesheet_link_tag    "devise-omniauth/application", :media => "all" %>
+  <%= javascript_include_tag "devise-omniauth/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/devise.rb

@@ -0,0 +1,5 @@
+# This is an empty shell file just so that you can run the generators in your application without error.
+# For this gem to work you must run "rails generate devise_omniauth:install" in your application. See the README for more info
+Devise.setup do |config|
+  require 'devise/orm/active_record'
+end

data/config/routes.rb

@@ -0,0 +1,7 @@
+DeviseOmniauth::Engine.routes.draw do
+
+  devise_for :users, {
+    controllers: {:omniauth_callbacks => "devise_omniauth/users/omniauth_callbacks"}
+  }
+
+end

data/db/migrate/20120626001219_devise_create_users.rb

@@ -0,0 +1,49 @@
+class DeviseCreateUsers < ActiveRecord::Migration
+  def change
+    create_table(:users) do |t|
+
+      ## Store the user's name
+      t.string :name
+
+      ## Database authenticatable
+      t.string :email,              :null => false, :default => ""
+      t.string :encrypted_password, :null => false, :default => ""
+
+      ## Recoverable
+      t.string   :reset_password_token
+      t.datetime :reset_password_sent_at
+
+      ## Rememberable
+      t.datetime :remember_created_at
+
+      ## Trackable
+      t.integer  :sign_in_count, :default => 0
+      t.datetime :current_sign_in_at
+      t.datetime :last_sign_in_at
+      t.string   :current_sign_in_ip
+      t.string   :last_sign_in_ip
+
+      ## Confirmable
+      t.string   :confirmation_token
+      t.datetime :confirmed_at
+      t.datetime :confirmation_sent_at
+      t.string   :unconfirmed_email # Only if using reconfirmable
+
+      ## Lockable
+      t.integer  :failed_attempts, :default => 0 # Only if lock strategy is :failed_attempts
+      t.string   :unlock_token # Only if unlock strategy is :email or :both
+      t.datetime :locked_at
+
+      ## Token authenticatable
+      t.string :authentication_token
+
+      t.timestamps
+    end
+
+    add_index :users, :email,                :unique => true
+    add_index :users, :reset_password_token, :unique => true
+    add_index :users, :confirmation_token,   :unique => true
+    add_index :users, :unlock_token,         :unique => true
+    add_index :users, :authentication_token, :unique => true
+  end
+end

data/db/migrate/20120701141457_create_devise_omniauth_authentications.rb

@@ -0,0 +1,13 @@
+class CreateDeviseOmniauthAuthentications < ActiveRecord::Migration
+  def change
+    create_table :devise_omniauth_authentications do |t|
+      t.integer :user_id
+      t.string :provider
+      t.string :provider_id
+      t.timestamps
+    end
+
+    add_index :devise_omniauth_authentications, :user_id, :name => 'devise_omniauth_authentications_on_user_id'
+    add_index :devise_omniauth_authentications, [:provider, :provider_id], :name => 'devise_omniauth_authentications_on_provider_and_provider_id'
+  end
+end

data/lib/devise-omniauth.rb

@@ -0,0 +1,5 @@
+require 'devise'
+require "devise-omniauth/engine"
+
+module DeviseOmniauth
+end

data/lib/devise-omniauth/engine.rb

@@ -0,0 +1,5 @@
+module DeviseOmniauth
+  class Engine < ::Rails::Engine
+    isolate_namespace DeviseOmniauth
+  end
+end

data/lib/devise-omniauth/version.rb

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

data/lib/generators/devise_omniauth/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Install devise-omniauth by copying a devise initializer, the devise views, devise locale translations
+
+Example:
+    rails generate devise_omniauth:install
+
+    This will create:
+        app/views/devise/*
+        config/initializers/devise.rb
+        config/locales/devise.en.yml
+
+    Add will add this to your routes.rb:
+        mount DeviseOmniauth::Engine => '/', :as => 'devise_omniauth'

data/lib/generators/devise_omniauth/install_generator.rb

@@ -0,0 +1,35 @@
+module DeviseOmniauth
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates a Devise initializer and copy locale files to your application."
+      class_option :orm
+
+      # TODO is there a way for these to come from devise even with the changes?
+      def copy_views
+        directory 'views/devise/', 'app/views/devise'
+      end
+
+      # TODO the source should come from devise and not duplicated in this gem
+      def copy_initializer
+        template "config/initializers/devise.rb", "config/initializers/devise.rb"
+      end
+
+      # TODO the source should come from devise and not duplicated in this gem
+      def copy_locale
+        copy_file "config/locales/en.yml", "config/locales/devise.en.yml"
+      end
+
+      # TODO should be able to customize the :as option (also will have to change in views)
+      def add_devise_routes
+        devise_route = "mount DeviseOmniauth::Engine => '/', :as => 'devise_omniauth'"
+        route devise_route
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/devise_omniauth/templates/README

@@ -0,0 +1,10 @@
+===============================================================================
+
+Open the newly created config/initializers/devise.rb and customize the following lines with your oauth settings:
+
+    config.omniauth :facebook, "[SET APP_ID HERE]", "[SET APP_SECRET HERE]"
+
+You must also also define root :to in your routes.rb for devise to work properly. You can set it to anything you want.
+See the devise wiki for more information
+
+===============================================================================