fbdoorman 0.0.1

data/generators/fbdoorman/USAGE

@@ -0,0 +1 @@
+script/generate fbdoorman

data/generators/fbdoorman/fbdoorman_generator.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
+require File.expand_path(File.dirname(__FILE__) + "/lib/rake_commands.rb")
+
+class FbdoormanGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.directory File.join("config", "initializers")
+      m.file "clearance.rb", "config/initializers/clearance.rb"
+
+      m.insert_into "app/controllers/application_controller.rb",
+                    "include Clearance::Authentication"
+
+      user_model = "app/models/user.rb"
+      if File.exists?(user_model)
+        m.insert_into user_model, "include Clearance::User"
+      else
+        m.directory File.join("app", "models")
+        m.file "user.rb", user_model
+      end
+      
+      m.insert_into "config/routes.rb",
+                    "Clearance::Routes.draw(map)"
+
+      m.directory File.join("test", "factories")
+      m.file "factories.rb", "test/factories/clearance.rb"
+
+      m.migration_template "migrations/#{migration_source_name}.rb",
+                           'db/migrate',
+                           :migration_file_name => "clearance_#{migration_target_name}"
+
+      m.readme "README"
+    end
+  end
+
+  def schema_version_constant
+    if upgrading_clearance_again?
+      "To#{schema_version.gsub('_', '')}"
+    end
+  end
+
+  private
+
+  def migration_source_name
+    if ActiveRecord::Base.connection.table_exists?(:users)
+      'update_users'
+    else
+      'create_users'
+    end
+  end
+
+  def migration_target_name
+    if upgrading_clearance_again?
+      "update_users_to_#{schema_version}"
+    else
+      'create_users'
+    end
+  end
+
+  def schema_version
+    IO.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).strip.gsub(/[^\d]/, '_')
+  end
+
+  def upgrading_clearance_again?
+    ActiveRecord::Base.connection.table_exists?(:users)
+  end
+
+end

data/generators/fbdoorman/lib/insert_commands.rb

@@ -0,0 +1,33 @@
+# Mostly pinched from http://github.com/ryanb/nifty-generators/tree/master
+
+Rails::Generator::Commands::Base.class_eval do
+  def file_contains?(relative_destination, line)
+    File.read(destination_path(relative_destination)).include?(line)
+  end
+end
+
+Rails::Generator::Commands::Create.class_eval do
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+    unless options[:pretend] || file_contains?(file, line)
+      gsub_file file, /^(class|module|.*Routes).*$/ do |match|
+        "#{match}\n  #{line}"
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def insert_into(file, line)
+    logger.remove "#{line} from #{file}"
+    unless options[:pretend]
+      gsub_file file, "\n  #{line}", ''
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+  end
+end

data/generators/fbdoorman/lib/rake_commands.rb

@@ -0,0 +1,22 @@
+Rails::Generator::Commands::Create.class_eval do
+  def rake_db_migrate
+    logger.rake "db:migrate"
+    unless system("rake db:migrate")
+      logger.rake "db:migrate failed. Rolling back"      
+      command(:destroy).invoke!
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def rake_db_migrate
+    logger.rake "db:rollback"  
+    system "rake db:rollback"  
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def rake_db_migrate
+    logger.rake "db:migrate"    
+  end
+end

data/generators/fbdoorman/templates/README

@@ -0,0 +1,43 @@
+
+*******************************************************************************
+
+Next:
+
+1. Configure default url options for the mailer to generate URLs in emails.
+   In production.rb it must be the actual host your application is deployed to.
+   In config/environments/test.rb and config/environments/development.rb:
+
+     config.action_mailer.default_url_options = { :host => 'localhost:3000' }
+
+2. Migrate:
+
+     rake db:migrate
+
+4. Make sure you're displaying flashes somewhere. For instance, in a layout:
+
+    <div id="flash">
+      <% flash.each do |key, value| -%>
+        <div id="flash_<%= key %>"><%=h value %></div>
+      <% end -%>
+    </div>
+
+5. If you haven't, create your app in http://www.facebook.com/developers/createapp.php  
+
+6. Create config/facebook.yml and put in there you app's information. It should look something like this:
+
+	:app_id: #Get this from http://www.facebook.com/developers/createapp.php    
+	:secret: #from FB    
+	:api_key: #from FB    
+	:base_url: http://localhost:3000 #This is the url where you app's in, this is where Fb should go after login    
+	:after_login_path: /welcome/logged #Where to take your users when they login with FB    
+	:after_register_path: /welcome/new #Where to go when a new user registers
+	:url_after_create: /welcome/logged #Where to go when a session is created
+	
+7. Insert the JS for the login button and FB single sign-on redirection to work in your layouts.
+
+	(...your layout code...)
+	<%= facebook_js  %>
+	</body> (....) 
+
+
+*******************************************************************************

data/generators/fbdoorman/templates/clearance.rb

@@ -0,0 +1,3 @@
+Clearance.configure do |config|
+  config.mailer_sender = 'donotreply@example.com'
+end

data/generators/fbdoorman/templates/facebook.yml

@@ -0,0 +1,7 @@
+:app_id: 
+:secret: 
+:api_key: 
+:callback_url: http://localhost:3000/fbconnect/
+:after_login_path:
+:after_register_path:
+:base_url: http://localhost:3000

data/generators/fbdoorman/templates/factories.rb

@@ -0,0 +1,13 @@
+Factory.sequence :email do |n|
+  "user#{n}@example.com"
+end
+
+Factory.define :user do |user|
+  user.email                 { Factory.next :email }
+  user.password              { "password" }
+  user.password_confirmation { "password" }
+end
+
+Factory.define :email_confirmed_user, :parent => :user do |user|
+  user.email_confirmed { true }
+end

data/generators/fbdoorman/templates/migrations/create_users.rb

@@ -0,0 +1,24 @@
+class ClearanceCreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table(:users) do |t|
+      t.string   :email
+      t.string   :encrypted_password, :limit => 128
+      t.string   :salt,               :limit => 128
+      t.string   :confirmation_token, :limit => 128
+      t.string   :remember_token,     :limit => 128
+      t.string   :name,               :limit => 128
+      t.integer  :fbid        
+      t.boolean  :email_confirmed, :default => false, :null => false
+      t.timestamps
+    end
+
+    add_index :users, [:id, :confirmation_token]
+    add_index :users, :email
+    add_index :users, :fbid
+    add_index :users, :remember_token
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/generators/fbdoorman/templates/migrations/update_users.rb

@@ -0,0 +1,44 @@
+class ClearanceUpdateUsers<%= schema_version_constant %> < ActiveRecord::Migration
+  def self.up
+<%
+      existing_columns = ActiveRecord::Base.connection.columns(:users).collect { |each| each.name }
+      columns = [
+        [:email,              't.string :email'],
+        [:encrypted_password, 't.string :encrypted_password, :limit => 128'],
+        [:salt,               't.string :salt, :limit => 128'],
+        [:confirmation_token, 't.string :confirmation_token, :limit => 128'],
+        [:remember_token,     't.string :remember_token, :limit => 128'],
+        [:name,     't.string :name, :limit => 128'],
+        [:fbid,     't.integer :fbid'],
+        [:email_confirmed,    't.boolean :email_confirmed, :default => false, :null => false']
+      ].delete_if {|c| existing_columns.include?(c.first.to_s)}
+-%>
+    change_table(:users) do |t|
+<% columns.each do |c| -%>
+      <%= c.last %>
+<% end -%>
+    end
+
+<%
+    existing_indexes = ActiveRecord::Base.connection.indexes(:users)
+    index_names = existing_indexes.collect { |each| each.name }
+    new_indexes = [
+      [:index_users_on_id_and_confirmation_token, 'add_index :users, [:id, :confirmation_token]'],
+      [:index_users_on_email,                     'add_index :users, :email'],
+      [:index_users_on_fbid,                     'add_index :users, :fbid'],
+      [:index_users_on_remember_token,            'add_index :users, :remember_token']
+    ].delete_if { |each| index_names.include?(each.first.to_s) }
+-%>
+<% new_indexes.each do |each| -%>
+    <%= each.last %>
+<% end -%>
+  end
+
+  def self.down
+    change_table(:users) do |t|
+<% unless columns.empty? -%>
+      t.remove <%= columns.collect { |each| ":#{each.first}" }.join(',') %>
+<% end -%>
+    end
+  end
+end

data/generators/fbdoorman/templates/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  include Clearance::User
+end

data/lib/clearance/authentication.rb

@@ -0,0 +1,143 @@
+module Clearance
+  module Authentication
+
+    def self.included(controller) # :nodoc:
+      controller.send(:include, InstanceMethods)
+      controller.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def self.extended(controller)
+        controller.helper_method :current_user, :signed_in?, :signed_out?
+        controller.hide_action   :current_user, :current_user=,
+                                 :signed_in?,   :signed_out?,
+                                 :sign_in,      :sign_out,
+                                 :authenticate, :deny_access
+
+      end
+    end
+
+    module InstanceMethods
+      # User in the current cookie
+      #
+      # @return [User, nil]
+      def current_user
+        @_current_user ||= user_from_cookie
+      end
+
+      # Set the current user
+      #
+      # @param [User]
+      def current_user=(user)
+        @_current_user = user
+      end
+
+      # Is the current user signed in?
+      #
+      # @return [true, false]
+      def signed_in?
+        ! current_user.nil?
+      end
+
+      # Is the current user signed out?
+      #
+      # @return [true, false]
+      def signed_out?
+        current_user.nil?
+      end
+
+      # Deny the user access if they are signed out.
+      #
+      # @example
+      #   before_filter :authenticate
+      def authenticate
+        if user_from_fb? then #Manage different authentication if its a FB user
+          fb_deny_access unless authenticated_fbu? #Created a special deny access when a FB user loggout
+        else
+          deny_access unless signed_in?
+        end
+      end
+
+      # Sign user in to cookie.
+      #
+      # @param [User]
+      #
+      # @example
+      #   sign_in(@user)
+      def sign_in(user)
+        if user
+          cookies[:remember_token] = {
+            :value   => user.remember_token,
+            :expires => 1.year.from_now.utc
+          }
+          self.current_user = user
+        end
+      end
+
+      # Sign user out of cookie.
+      #
+      # @example
+      #   sign_out
+      def sign_out
+        current_user.reset_remember_token! if current_user
+        cookies.delete(:remember_token)
+        #Remove FB cookie
+        delete_fb_cookie
+        self.current_user = nil
+      end
+
+      # Store the current location and redirect to sign in.
+      # Display a failure flash message if included.
+      #
+      # @param [String] optional flash message to display to denied user
+      def deny_access(flash_message = nil)
+        store_location
+        flash[:failure] = flash_message if flash_message
+        redirect_to(sign_in_url)
+      end
+      
+      def fb_deny_access(flash_message = nil)
+        store_location
+        flash[:failure] = flash_message if flash_message
+        redirect_to FB_CLOSED_URL
+      end
+
+      protected
+
+      def user_from_cookie
+        if token = cookies[:remember_token]
+          ::User.find_by_remember_token(token)
+        end
+      end
+
+      def sign_user_in(user)
+        warn "[DEPRECATION] sign_user_in: unnecessary. use sign_in(user) instead."
+        sign_in(user)
+      end
+
+      def store_location
+        if request.get?
+          session[:return_to] = request.request_uri
+        end
+      end
+
+      def redirect_back_or(default)
+        redirect_to(return_to || default)
+        clear_return_to
+      end
+
+      def return_to
+        session[:return_to] || params[:return_to]
+      end
+
+      def clear_return_to
+        session[:return_to] = nil
+      end
+
+      def redirect_to_root
+        redirect_to('/')
+      end
+    end
+
+  end
+end

data/lib/clearance/configuration.rb

@@ -0,0 +1,25 @@
+module Clearance
+  class Configuration
+    attr_accessor :mailer_sender
+
+    def initialize
+      @mailer_sender = 'donotreply@example.com'
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Configure Clearance someplace sensible,
+  # like config/initializers/clearance.rb
+  #
+  # @example
+  #   Clearance.configure do |config|
+  #     config.mailer_sender = 'donotreply@example.com'
+  #   end
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/clearance/extensions/errors.rb

@@ -0,0 +1,6 @@
+if defined?(ActionController)
+  module ActionController
+    class Forbidden < StandardError
+    end
+  end
+end

data/lib/clearance/extensions/rescue.rb

@@ -0,0 +1,5 @@
+if defined?(ActionDispatch::ShowExceptions) # Rails 3
+  ActionDispatch::ShowExceptions.rescue_responses.update('ActionController::Forbidden' => :forbidden)
+elsif defined?(ActionController::Base)
+  ActionController::Base.rescue_responses.update('ActionController::Forbidden' => :forbidden)
+end

data/lib/clearance/routes.rb

@@ -0,0 +1,55 @@
+module Clearance
+  class Routes
+
+    # In your application's config/routes.rb, draw Clearance's routes:
+    #
+    # @example
+    #   map.resources :posts
+    #   Clearance::Routes.draw(map)
+    #
+    # If you need to override a Clearance route, invoke your app route
+    # earlier in the file so Rails' router short-circuits when it finds
+    # your route:
+    #
+    # @example
+    #   map.resources :users, :only => [:new, :create]
+    #   Clearance::Routes.draw(map)
+    def self.draw(map)
+      map.resources :passwords,
+        :controller => 'clearance/passwords',
+        :only       => [:new, :create]
+
+      map.resource  :session,
+        :controller => 'clearance/sessions',
+        :only       => [:new, :create, :destroy]
+
+      map.resources :users, :controller => 'clearance/users' do |users|
+        users.resource :password,
+          :controller => 'clearance/passwords',
+          :only       => [:create, :edit, :update]
+
+        users.resource :confirmation,
+          :controller => 'clearance/confirmations',
+          :only       => [:new, :create]
+      end
+
+      map.sign_up  'sign_up',
+        :controller => 'clearance/users',
+        :action     => 'new'
+      map.sign_in  'sign_in',
+        :controller => 'clearance/sessions',
+        :action     => 'new'
+      map.sign_out 'sign_out',
+        :controller => 'clearance/sessions',
+        :action     => 'destroy',
+        :method     => :delete
+      map.facebook  'facebook',
+          :controller => 'clearance/facebook',
+          :action     => 'index'
+      map.fbclosed  'fbclosed',
+          :controller => 'clearance/facebook',
+          :action     => 'closed'          
+    end
+
+  end
+end