login 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 SAMER BUNA
+
+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,56 @@
+# LOGIN
+
+LOGIN is a Rails engine to quickly enable OAuth logins in a Rails website.
+
+1) Create an OAuth application, 2) Configure LOGIN to work with it, 3) run the migrations,
+and you'll be ready to login users to your site.
+
+LOGIN uses Devise and OmniAuth, and curruntly supports :github,
+:twitter, :facebook, and :google_apps providers. You can only do OAuth.
+Login with passwords is not supported, and will never be.
+The world has enough passwords.
+
+# INSTALL
+
+    gem "login"
+
+    rake login:install:migrations
+    rake db:migrate
+
+# Configuration Example
+
+Enable login via github
+
+1) Create a [github application](https://github.com/settings/applications), note the Client ID and Client Secret.
+   The callback URL has to be #{YOUR-SITE}/users/auth/github/callback
+
+2) Initialize this in your app:
+
+    Login.config = {
+      :github => ["#{client_id}", "#{client_secret}", :scope => "user"]
+    }
+
+3) Somewhere in your views, add a link to login: ``` link_to "Login in via Github", omniauth_authorize_path('user', :github) ```
+   There is also a logout route: ``` link_to "Logout", logout_path ```
+
+And that would be it. Devise/OmniAuth/LOGIN take care of the rest.
+
+You can use Devise helpers as normal, current_user, user_signed_in?, etc..
+
+# What LOGIN does
+
+LOGIN creates 2 tables:
+* users: will have a row for each unique user, it also has name and
+accounts columns, and will put information there if available (from OAuth).
+* providers: for each provider a user uses, LOGIN will store a record here.
+
+A user might have many providers, the same user (identified
+uniquiely by email when available), can login with github, and
+google_apps, for example, as long as OAuth gives that unique email,
+LOGIN logs the user's record in.
+
+LOGIN configures OAuth callbacks to work in an autamatic way, if the
+user is logging to your website for the first time, LOGIN creates a new
+users record for them, after that, it's a normal login for an existing
+record. If you need to capture more information about the user, you can
+always later force them to update the profile, for example.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/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    = 'Login'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/controllers/users/omniauth_callbacks_controller.rb

@@ -0,0 +1,31 @@
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+
+  def github
+    provider :github
+  end
+
+  def twitter
+    provider :twitter
+  end
+
+  def google_apps
+    provider :google_apps
+  end
+
+  def facebook
+    provider :facebook
+  end
+
+  private
+  def after_sign_in_path_for(resource)
+    session[:redirect] || root_path
+  end
+
+  def provider provider_id
+    @user = Login::User.provider(request.env["omniauth.auth"], provider_id).user
+    session["devise.#{provider_id}_data"] = request.env["omniauth.auth"]
+    flash[:notice] = I18n.t "devise.omniauth_callbacks.success", :kind => (provider_id == :google_apps ? :gmail : provider_id).to_s.titleize
+
+    sign_in_and_redirect @user.reload, :event => :authentication
+  end
+end

data/app/models/login/provider.rb

@@ -0,0 +1,13 @@
+module Login
+  class Provider < ActiveRecord::Base
+    attr_accessible :provider, :uid
+    belongs_to :user
+
+    module Association
+      def find_or_create auth
+        provider = where(provider:auth.provider, uid:auth.uid).first
+        provider ||= create!(provider:auth.provider, uid:auth.uid)
+      end
+    end
+  end
+end

data/app/models/login/user.rb

@@ -0,0 +1,46 @@
+module Login
+  class User < ActiveRecord::Base
+    devise :database_authenticatable, :trackable, :token_authenticatable, :omniauthable
+
+    attr_accessible :email, :twitter, :github, :screen_name, :first_name, :last_name, :password
+
+    has_many :providers, :extend => Provider::Association
+
+    validates :screen_name, :uniqueness => true, :allow_blank => true
+    validates :email, :uniqueness => true, :allow_blank => true
+    validates :twitter, :uniqueness => true, :allow_blank => true
+    validates :github, :uniqueness => true, :allow_blank => true
+
+    def self.provider auth, provider_id
+      raise "Not enough information provided" unless auth.info.nickname.present? || auth.info.email.present?
+      find_hash = { email:auth.info.email }
+      find_hash = { github:auth.info.nickname } if provider_id == :github
+      find_hash = { twitter:auth.info.nickname } if provider_id == :twitter
+      user = where(find_hash).first
+      twitter, github = "", ""
+      twitter = auth.info.nickname if provider_id == :twitter
+      github = auth.info.nickname if provider_id == :github
+      first_name = auth.info.first_name.presence || auth.info.name.split.first || ""
+      last_name = auth.info.last_name.presence || auth.info.name.split.last || ""
+      transaction do
+        if user
+          user.update_attribute :twitter, twitter unless user.twitter.present?
+          user.update_attribute :first_name, first_name unless user.first_name.present?
+          user.update_attribute :last_name, last_name unless user.last_name.present?
+        else
+          create_hash = { github: github, twitter: twitter, first_name: first_name, last_name: last_name, password: Devise.friendly_token[0,20] }
+          create_hash[:email] = auth.info.email.presence
+          user = create! create_hash
+        end
+        user.providers.find_or_create auth
+      end
+    end
+
+    def display_name
+      return screen_name if screen_name.present?
+      return "@#{github}" if github.present?
+      return "@#{twitter}" if twitter.present?
+      return email.gsub(/@(.).*$/,'@\1')
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  devise_for :users, :class_name => "Login::User", :skip => [:sessions],
+    :controllers => { :omniauth_callbacks => "users/omniauth_callbacks" }
+  devise_scope :user do
+    get "/logout", :to => "devise/sessions#destroy"
+  end
+end

data/db/migrate/20120729190657_devise_create_users.rb

@@ -0,0 +1,25 @@
+class DeviseCreateUsers < ActiveRecord::Migration
+  def change
+    create_table(:login_users) do |t|
+      t.string :first_name, :last_name, :email, :default => ""
+      t.string :encrypted_password, :default => ""
+
+      # 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
+
+      # Token authenticatable
+      t.string :authentication_token
+
+      # Non-devise fields
+      t.string :twitter, :github, :screen_name
+
+      t.timestamps
+    end
+
+    add_index :login_users, :authentication_token, :unique => true
+  end
+end

data/db/migrate/20120731003104_omni_auth_providers.rb

@@ -0,0 +1,8 @@
+class OmniAuthProviders < ActiveRecord::Migration
+  def change
+    create_table :login_providers do |t|
+      t.integer :user_id, :null => false
+      t.string :provider, :uid, :null => false
+    end
+  end
+end

data/lib/login.rb

@@ -0,0 +1,17 @@
+require "login/engine"
+
+require "devise"
+require 'omniauth-github'
+require 'omniauth-twitter'
+require 'omniauth-facebook'
+require 'omniauth-google-apps'
+
+module Login
+  mattr_accessor :config
+
+  def self.layout
+    config[:layout] || "application"
+  end
+end
+
+Login.config = {}

data/lib/login/engine.rb

@@ -0,0 +1,15 @@
+module Login
+  class Engine < ::Rails::Engine
+    isolate_namespace Login
+    initializer "devise.config" do
+      Devise.setup do |config|
+        require 'devise/orm/active_record'
+        require 'openid/store/filesystem'
+        config.sign_out_via = :get
+        [:github, :twitter, :facebook, :google_apps].each do |provider|
+          config.omniauth provider, *Login.config[provider] if Login.config[provider]
+        end
+      end
+    end
+  end
+end

data/lib/login/version.rb

@@ -0,0 +1,3 @@
+module Login
+  VERSION = "0.1.0"
+end

data/lib/tasks/login_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :login do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: login
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Samer Buna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-github
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-twitter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-facebook
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-google-apps
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Devise and Omniauth defaults
+email:
+- samer.buna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/users/omniauth_callbacks_controller.rb
+- app/models/login/provider.rb
+- app/models/login/user.rb
+- config/routes.rb
+- db/migrate/20120729190657_devise_create_users.rb
+- db/migrate/20120731003104_omni_auth_providers.rb
+- lib/login.rb
+- lib/tasks/login_tasks.rake
+- lib/login/version.rb
+- lib/login/engine.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/samerbuna/login
+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: Devise and Omniauth
+test_files: []