socialite 0.0.1.beta4 → 0.1.0.pre

data/README.md

@@ -1,17 +1,29 @@
 # Socialite
 
-A Rails 3.1 engine that provides a User model with support for linking
-multiple authorization accounts per user (linking). Current support for
-Twitter, Facebook, Github and LinkedIn.
+This is an opinionated Rails 3.1 mountable engine provides your application with
+support for managing multiple OAuth providers per User.
 
-Additional authorizations can be added if they are supported by
-the [OmniAuth](http://github.com/intridea/omniauth) project.
+## Why make this?
 
-## Development
+Every site I have built in the past couple years has required implementing
+authentication support for Users. Now this was simple enough when it was only
+**one** provider (in my case, "Login with Facebook"), but more often then not
+it evolved into "Login with `<insert_oauth_provider>`".
 
-We are currently working on an initial release of Socialite. Once we
-have a solid suite of tests in place, we will release an official 0.1.0
-version to the public.
+Now OmniAuth has some [good write-ups](https://github.com/intridea/omniauth/wiki/Managing-Multiple-Providers)
+on handling multiple providers, but it lacked any support for restricting a user
+to one identity per provider. Socialite aims to solve this and while enforcing
+every user to have a Basic Authentication identity as a fall-back in case of
+password recovery.
+
+## What makes this unique?
+
+1. Every User can only have one identity per supported provider
+  * Example: User can have only 1 linked Facebook Identity at any given time
+2. Every User must have an basic-auth identity
+  * Example: User signs up through Facebook, but unlinks it.
+    Enforcing a local basic auth mechanism aids account recovery.
+3. Supports any provider strategy in the OmniAuth project.
 
 ## Resources
 
@@ -26,38 +38,25 @@ version to the public.
 
 To use Socialite in a Rails 3.1 application:
 
-* Require it in the Gemfile: `gem 'socialite'`
-* Install it by running `bundle`.
-* Import migrations into the parent project with `rake
-  socialite:install:migrations`
-* Use the provided CSS by adding `//= require socialite` from your
-  application's CSS manifest file
+* Require it in the Gemfile:
+  `gem 'socialite', git: 'git://github.com/jsmestad/socialite`
+* Install the gem it by running `bundle install`.
+* Run the socialite generator using `rails g socialite:install` for typical
+  installs and `rails g active_record:socialite` for specifying custom options.
 
 ## History
 
 This project began as a fork of [Tim Riley](http://openmonkey.com)'s
 great Omnisocial plugin. The motivation for this fork is that I required
 multiple authorizations for each account (linking support) and wanted a
-proper Rails 3.1 Engine.
-
-## Socialite Contributers
-
-* [Justin Smestad](http://github.com/jsmestad)
-* [Bobby Wilson](http://github.com/bobbyw)
-
-### Omnisocial Contributers
-
-* [Klaus Hartl](http://github.com/carhartl)
-* [Stephen Aument](http://github.com/stephenaument)
-* [Lucas Allan](http://github.com/lucasallan)
-* [James Dumay](http://github.com/i386)
-* [Pablo Dejuan](http://github.com/pdjota)
-* [Chris Oliver](http://github.com/excid3)
+proper mountable Rails 3.1 Engine.
 
 ## Copyright & License
 
-Socialite is Copyright (c) 2011 Justin Smestad. All Rights are Reserved. Code is 
-distributed under the Apache 2.0 License. See LICENSE file for more information.
+Socialite is Copyright (c) 2011- 2013 Justin Smestad. All Rights are Reserved.
+Code is distributed under the Apache 2.0 License. See LICENSE file for more
+information.
 
-The original OmniSocial code is Copyright (c) 2010-2011 [Tim Riley](http://openmonkey.com/)
-and [Icelab](http://icelab.com.au/), and is released under MIT License.
+The original OmniSocial code is Copyright (c) 2010-2011
+[Tim Riley](http://openmonkey.com/) and [Icelab](http://icelab.com.au/), and is
+released under MIT License.

data/Rakefile

@@ -5,30 +5,17 @@ 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
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
 
 task :default => :spec
-
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Socialite'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
-Bundler::GemHelper.install_tasks

data/app/controllers/socialite/application_controller.rb

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

data/app/controllers/socialite/identities_controller.rb

@@ -5,20 +5,8 @@ module Socialite
     before_filter :ensure_user, :only => [:destroy]
     respond_to :html, :json
 
-    def create
-      auth_hash = request.env['omniauth.auth']
-      identity = Identity.find_or_initialize_by_oauth(auth_hash)
-      identity.build_user if identity.user.blank?
-
-      if identity.save
-        self.current_user ||= identity.user
-        flash_message :notice, 'You have logged in successfully.'
-      else
-        flash_message :error, 'An error occurred. Please try again.'
-      end
-      respond_with(identity) do |format|
-        format.html { redirect_back_or_default }
-      end
+    def new
+      @identity = env['omniauth.identity'] ||= User.new
     end
 
     def failure

data/app/controllers/socialite/session_controller.rb

@@ -7,6 +7,26 @@ module Socialite
 
     respond_to :html, :json
 
+    def new; end
 
+    def create
+      @identity = Identity.find_or_initialize_by_oauth(env['omniauth.auth'])
+      @identity.build_user if @identity.user.blank?
+
+      if @identity.save
+        self.current_user = @identity.user
+        flash_message :notice, 'You have logged in successfully.'
+      else
+        flash_message :error, 'An error occurred. Please try again.'
+      end
+      respond_with(identity) do |format|
+        format.html { redirect_back_or_default }
+      end
+    end
+
+    def destroy
+      logout!
+      redirect_to main_app.root_path, notice: 'Signed out!'
+    end
   end
 end

data/app/controllers/socialite/users_controller.rb

@@ -34,6 +34,5 @@ module Socialite
     def user
       @user = current_user
     end
-
   end
 end

data/app/views/layouts/socialite/application.html.haml

@@ -0,0 +1,11 @@
+!!!
+%html
+%head
+  %title Socialite
+  = stylesheet_link_tag    "socialite/application", :media => "all"
+  = javascript_include_tag "socialite/application"
+  = csrf_meta_tags
+%body
+  = yield
+
+

data/app/views/socialite/identities/new.html.haml

@@ -0,0 +1,27 @@
+%h1 New Account
+
+= form_tag "/auth/identity/register" do
+  - if @identity && @identity.errors.any?
+    .error_messages
+      %h2 #{pluralize(@identity.errors.count, "error")} prohibited this account from being saved:
+      %ul
+      - @identity.errors.full_messages.each do |msg|
+        %li= msg
+  .field
+    = label_tag :name
+    %br
+    = text_field_tag :name, @identity.try(:name)
+  .field
+    = label_tag :email
+    %br
+    = text_field_tag :email, @identity.try(:email)
+  .field
+    = label_tag :password
+    %br
+    = password_field_tag :password
+  .field
+    = label_tag :password_confirmation
+    %br
+    = password_field_tag :password_confirmation
+  .actions
+    = submit_tag "Register"

data/app/views/socialite/session/new.html.haml

@@ -1,14 +1,31 @@
-#socialite_login
-  .information
-    %h1 Sign in (or up)
-    %p.large
-      You can use either your Twitter or Facebook account to sign in or sign up.
-    %p
-      Select your preferred method and you'll be sent off to authorise us to use your account.
-    %p
-      It’ll only take a second and your information will be perfectly safe. We don't get access to your password and
-      %em we won't post or tweet anything from your account
-      without your explicit permission.
-
-  = twitter_login_button
-  = facebook_login_button
+%h1 Sign In
+
+%p
+  %strong Sign in through one of these services:
+
+.auth_providers
+  %a.auth_provider{href: "/auth/twitter"}
+    #{image_tag "twitter_64.png", size: "64x64", alt: "Twitter"}
+    Twitter
+  %a.auth_provider{href: "/auth/facebook"}
+    #{image_tag "facebook_64.png", size: "64x64", alt: "Facebook"}
+    Facebook
+  %a.auth_provider{href: "/auth/google_apps"}
+    #{image_tag "google_apps_64.png", size: "64x64", alt: "Google"}
+    Google
+
+%p
+  %strong Don't use these services?
+  #{link_to "Create an account", new_identity_path} or login below.
+
+= form_tag "/auth/identity/callback" do
+  .field
+    = label_tag :auth_key, "Email"
+    %br
+    = text_field_tag :auth_key
+  .field
+    = label_tag :password
+    %br
+    = password_field_tag :password
+  .actions
+    = submit_tag "Login"

data/app/views/socialite/user/edit.html.haml

@@ -1 +1 @@
-= render 'users/form', :locals => {:user => @user }
+= render 'users/form', :locals => {:user => @user}

data/config/routes.rb

@@ -1,10 +1,10 @@
 Socialite::Engine.routes.draw do
-  match '/login'                  => 'session#new',      :as => :login
-  match '/auth/:service/callback' => 'identities#create', :as => :callback
-  match '/auth/failure'           => 'identities#failure'
-  match '/logout'                 => 'session#destroy',  :as => :logout
+  # match '/login'                  => 'session#new',      :as => :login
+  # match '/auth/:service/callback' => 'identities#create', :as => :callback
+  # match '/auth/failure'           => 'identities#failure'
+  # match '/logout'                 => 'session#destroy',  :as => :logout
 
-  resource :user, :except => [:new, :create] do
-    resources :identities
-  end
+  # resource :user, :except => [:new, :create] do
+    # resources :identities
+  # end
 end

data/lib/generators/socialite/install_generator.rb

@@ -1,21 +1,19 @@
 require 'rails/generators'
-require 'rails/generators/migration'
 
 module Socialite
   module Generators
-    class InstallGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-
-      desc 'Generates the socialite initializer'
-
-      def self.source_root
-        File.join(File.dirname(__FILE__), 'templates')
-      end
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
 
+      desc 'Creates a socialite initializer'
       def copy_initializer
         template 'socialite.rb', 'config/initializers/socialite.rb'
       end
 
+      # def add_opro_routes
+        # socialite_routes = "mount_socialite_oauth"
+        # route socialite_routes
+      # end
     end
   end
 end

data/lib/generators/socialite/migrations_generator.rb

@@ -0,0 +1,34 @@
+require 'rails/generators/migration'
+
+module Socialite
+  module Generators
+    class MigrationsGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+
+      class_option :users_table,
+        :default => 'socialite_users',
+        :type => :string
+      class_option :identity_table,
+        :default => 'socialite_identities',
+        :type => :string
+
+      desc "add the migrations needed for socialite"
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template "users.rb.erb", "db/migrate/create_socialite_users.rb"
+        migration_template "identity.rb.erb", "db/migrate/create_socialite_identities.rb"
+      end
+    end
+  end
+end
+

data/lib/generators/socialite/templates/identity.rb.erb

@@ -0,0 +1,25 @@
+class CreateSocialiteIdentities < ActiveRecord::Migration
+  def up
+    create_table :<%= options[:identity_table] %> do |t|
+      t.string :uid, :provider
+      t.text :auth_hash
+      t.integer :<%= "#{options[:users_table].singularize}_id" %>
+      t.timestamps
+    end
+
+    add_index :<%= options[:identity_table] %>,
+      :<%= "#{options[:users_table].singularize}_id" %>
+
+    # Restrict each user to one identity per provider, to disable comment out.
+    add_index :<%= options[:identity_table] %>,
+      [:<%= "#{options[:users_table].singularize}_id" %>, :provider], :unique => true
+
+    # Database constraint to ensure uniqueness of UIDs (scoped to provider)
+    add_index :<%= options[:identity_table] %>,
+      [:provider, :uid], :unique => true
+  end
+
+  def down
+    drop_table :<%= options[:identity_table] %>
+  end
+end

data/lib/generators/socialite/templates/socialite.rb

@@ -1,14 +1,27 @@
-require 'socialite'
-
 Socialite.setup do |config|
-  # ==> Twitter
-  # config.twitter 'APP_KEY', 'APP_SECRET'
+  ## Configure Classes
+  # If you are not using the default names set below. Please change them to
+  # reflect the correct classes.
+  #
+  # **NOTE** These _should_ be set to string values to prevent any possible
+  # errors caused by load order.
+  config.user_class = 'User'
+  config.identity_class = 'Identity'
 
-  # ==> Facebook
-  # config.facebook 'APP_KEY', 'APP_SECRET', :scope => 'publish_stream'
+  ## Add any supported OmniAuth providers
+  # You can pass any providers that are supported by OmniAuth simply by
+  # including it in your Gemfile.
+  #
+  # Examples:
+  # config.provider :facebook, ENV['FACEBOOK_APP_KEY'], ENV['FACEBOOK_SECRET'],
+  #   :scope => 'email,friends'
+  # config.provider :identity, :on_failed_registration => lambda { |env|
+  #   UsersController.action(:new).call(env)
+  # }
+  # config.provider :twitter, ENV['TWITTER_APP_KEY'], ENV['TWITTER_SECRET']
 
   if Rails.env.production?
-    # Configs for production mode go here
+    # Any production specific information
   elsif Rails.env.development?
     # Configs for development mode go here
   end

data/lib/generators/socialite/templates/users.rb.erb

@@ -0,0 +1,12 @@
+class CreateSocialiteUsers < ActiveRecord::Migration
+  def up
+    create_table :<%= options[:users_table] %> do |t|
+      t.string :name
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :<%= options[:users_table] %>
+  end
+end

data/lib/socialite.rb

@@ -1,15 +1,10 @@
+require 'socialite/engine'
+
 require 'haml'
-require 'omniauth/core'
-require 'omniauth/oauth'
+require 'omniauth'
 
 module Socialite
   autoload :ControllerSupport, 'socialite/controller_support'
-  autoload :ServiceConfig, 'socialite/service_config'
-
-  module ApiWrappers
-    autoload :Facebook, 'socialite/api_wrappers/facebook'
-    autoload :Twitter, 'socialite/api_wrappers/twitter'
-  end
 
   module Controllers
     autoload :Helpers, 'socialite/controllers/helpers'
@@ -20,35 +15,38 @@ module Socialite
   end
 
   module Models
-    autoload :Identity, 'socialite/models/identity'
-    autoload :User, 'socialite/models/user'
-    autoload :FacebookIdentity, 'socialite/models/facebook_identity.rb'
+    autoload :IdentityConcern, 'socialite/models/identity_concern'
+    autoload :UserConcern, 'socialite/models/user_concern'
+  end
+
+  def self.setup
+    yield self if block_given?
   end
 
-  mattr_accessor :service_configs, :root_path, :mount_prefix, :mounted_engine
-  @@service_configs = {}
+  mattr_accessor :user_class, :identity_class, :providers
 
-  def self.generate_token
-    SecureRandom.base64(15).tr('+/=lIO0', 'pqrsxyz')
+  def self.providers
+    @@providers ||= []
   end
 
-  def self.setup(entity = nil, &block)
-    block.call self if block_given?
+  def self.provider(klass, *args)
+    @@providers ||= []
+    @@providers << [klass, args]
   end
 
-  def self.mounted_engine?
-    !!mounted_engine
+  def self.identity_class
+    identity_class_name.constantize
   end
 
-  # config.twitter APP_KEY, APP_SECRET, :scope => ['foo', 'bar']
-  def self.twitter(app_key, app_secret, options = {})
-    @@service_configs[:twitter] = ServiceConfig.new(app_key, app_secret, options)
+  def self.identity_class_name
+    @@identity_class.camelize
   end
 
-  # config.facebook APP_KEY, APP_SECRET, :scope => ['foo', 'bar']
-  def self.facebook(app_key, app_secret, options = {})
-    @@service_configs[:facebook] = ServiceConfig.new(app_key, app_secret, options)
+  def self.user_class
+    user_class_name.constantize
   end
-end
 
-require 'socialite/engine'
+  def self.user_class_name
+    @@user_class.camelize
+  end
+end