devise_facebook_connectable 0.1.0

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+
+NAME = "devise_facebook_connectable"
+SUMMARY = %{Devise << Facebook Connect.}
+HOMEPAGE = "http://github.com/grimen/#{NAME}"
+AUTHORS = ["Jonas Grimfelt"]
+EMAIL = "grimen@gmail.com"
+SUPPORT_FILES = %w(README)
+
+begin
+  gem 'jeweler'
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name        = NAME
+    gemspec.summary     = SUMMARY
+    gemspec.description = SUMMARY
+    gemspec.homepage    = HOMEPAGE
+    gemspec.authors     = AUTHORS
+    gemspec.email       = EMAIL
+    
+    gemspec.require_paths = %w{lib}
+    gemspec.files = SUPPORT_FILES << %w(Rakefile) <<
+      Dir.glob(File.join(*%w[{assets,lib} ** *]).to_s)
+    gemspec.extra_rdoc_files = SUPPORT_FILES
+    
+    gemspec.add_dependency 'activesupport',   '>= 2.3.0'
+    gemspec.add_dependency 'devise',          '>= 0.7.0'
+    gemspec.add_dependency 'facebooker',      '>= 1.0.55'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler - or one of its dependencies - is not available. " <<
+        "Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+
+desc %Q{Generate documentation for "#{NAME}".}
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = NAME
+  rdoc.options << '--line-numbers' << '--inline-source' << '--charset=UTF-8'
+  rdoc.rdoc_files.include(SUPPORT_FILES)
+  rdoc.rdoc_files.include(File.join(*%w[lib ** *.rb]))
+end

data/lib/devise_facebook_connectable/controller_filters.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require 'facebooker'
+
+module Devise
+  module FacebookConnectable
+    module Controllers
+      module Filters
+
+        def self.included(klass)
+          klass.class_eval do
+            before_filter :set_facebook_session
+            helper_method :facebook_session # session[:facebook_session]
+            rescue_from ::Facebooker::Session::SessionExpired, :with => :facebook_session_expired
+            
+            # Handle expired Facebook sessions automatically.
+            #
+            def facebook_session_expired
+              clear_fb_cookies!
+              clear_facebook_session_information
+              redirect_to root_url # TODO: Maybe a bad assumption? Maybe just re-load current page?
+            end
+          end
+        end
+
+      end
+    end
+  end
+end
+
+ActionController::Base.send :include, Devise::FacebookConnectable::Controllers::Filters

data/lib/devise_facebook_connectable/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  devise:
+    sessions:
+      facebook_invalid: "Could not login. Invalid account."
+      facebook_session_expired: "Could not login. Facebook Connect session expired."
+      facebook_login: "Connect"
+      facebook_logout: "Logout"

data/lib/devise_facebook_connectable/model.rb

@@ -0,0 +1,208 @@
+# encoding: utf-8
+require 'devise_facebook_connectable/strategy'
+require 'devise_facebook_connectable/serializer'
+
+module Devise
+  module FacebookConnectable
+    module Model
+      # Facebook Connectable Module, responsible for validating authenticity of a 
+      # user and storing credentials while signing in using their Facebook account.
+      #
+      # Configuration:
+      #
+      # You can overwrite configuration values by setting in globally in Devise (+Devise.setup+),
+      # using devise method, or overwriting the respective instance method.
+      #
+      #   facebook_uid_field: Defines the name of the Facebook user UID database attribute/column.
+      #
+      #   facebook_session_key_field: Defines the name of the Facebook session key database attribute/column.
+      #
+      #   facebook_skip_create: Speifies if account should automatically be created upon connect
+      #                         if not already exists.
+      #
+      # Examples:
+      #
+      #    User.facebook_connect(:uid => '123456789')     # returns authenticated user or nil
+      #    User.find(1).facebook_connected?               # returns true/false
+      #
+      module FacebookConnectable
+
+        DEFAULT_FACEBOOK_UID_FIELD = :facebook_uid
+        DEFAULT_FACEBOOK_SESSION_KEY_FIELD = :facebook_session_key
+
+        def self.included(base)
+          base.class_eval do
+            extend ClassMethods
+            extend ::Devise::Models::SessionSerializer
+
+            cattr_accessor :facebook_uid_field, :facebook_session_key_field, :facebook_skip_create
+          end
+        end
+
+        # Store Facebook Connect account/session credentials.
+        #
+        def store_facebook_credentials!(attributes = {})
+          # FIXME: Don't work...nil for some reason.
+          # self.send(:"#{self.class.facebook_uid_field}=", attributes[:uid])
+          # self.send(:"#{self.class.facebook_session_key_field}=", attributes[:session_key])
+
+          self.send(:"#{DEFAULT_FACEBOOK_UID_FIELD}=", attributes[:uid])
+          self.send(:"#{DEFAULT_FACEBOOK_SESSION_KEY_FIELD}=", attributes[:session_key])
+
+          # Only populate +email+ field if it's available (say, if +authenticable+ module is used).
+          self.email = attributes[:email] || '' if self.respond_to?(:email)
+
+          # Lazy hack: These database fields are required if +authenticable+/+confirmable+
+          # module(s) is used.
+          self.password_salt = '' if self.respond_to?(:password_salt)
+          self.encrypted_password = '' if self.respond_to?(:encrypted_password)
+          self.confirmed_at = ::Time.now if self.respond_to?(:confirmed_at)
+        end
+
+        # Checks if Facebook Connect:ed.
+        #
+        def facebook_connected?
+          self.send(:"#{self.class.facebook_uid_field}").present?
+        end
+        alias :is_facebook_connected? :facebook_connected?
+
+        # Hook that gets called before connect (each time). Useful for
+        # fetching additional user info (etc.) from Facebook.
+        #
+        # Default: Do nothing.
+        #
+        # Examples:
+        #
+        #   # Overridden in Facebook Connect:able model, e.g. "User".
+        #   #
+        #   def before_facebook_connect(fb_session)
+        #     
+        #     # Just fetch what we really need from Facebook...
+        #     fb_session.user.populate(:locale, :current_location, :username, :name,
+        #                               :first_name, :last_name, :birthday_date, :sex,
+        #                               :city, :state, :country)
+        #     
+        #     self.locale             = my_fancy_locale_parser(fb_session.user.locale)
+        #     "Stockholm" => "(GMT+01:00) Stockholm", "Never-Never-land" => "(GMT+00:00) UTC"
+        #     self.time_zone          = fb_session.user.current_location.try(:city)
+        #     self.country            = fb_session.user.current_location.try(:country)
+        #     
+        #     self.username           = fb_session.user.username
+        #     
+        #     self.profile.real_name  = fb_session.user.name
+        #     self.profile.first_name = fb_session.user.first_name
+        #     self.profile.last_name  = fb_session.user.last_name
+        #     self.profile.birthdate  = fb_session.user.birthday_date.try(:to_date)
+        #     self.profile.gender     = my_fancy_gender_parser(fb_session.user.sex)
+        #     
+        #     self.profile.city       = fb_session.user.hometown_location.try(:city)
+        #     self.profile.zip_code   = fb_session.user.hometown_location.try(:state)
+        #     self.profile.country    = fb_session.user.hometown_location.try(:country)
+        #     
+        #     # etc...
+        #     
+        #   end
+        #
+        # For more info:
+        #   http://facebooker.pjkh.com/user/populate
+        #
+        def before_facebook_connect(facebook_session)
+          # Default: Do nothing.
+        end
+        alias :before_connect :before_facebook_connect
+
+        def store_session(using_session_key)
+          if self.session_key != using_session_key
+            self.update_attribute(:facebook_session_key, using_session_key)
+          end
+        end
+
+        # Optional: Recreate Facebook session for this account/user.
+        #
+        def new_facebook_session
+          returning(::Facebooker::Session.create) do |new_session|
+            new_session.secure_with!(self.facebook_session_key, self.facebook_uid, 1.hour.from_now)
+            ::Facebooker::Session.current = new_session
+          end
+        end
+
+        # Optional: See +new_facebook_session+.
+        #
+        def facebook_session(force = false)
+          @facebook_session = self.new_facebook_session if force || @facebook_session.nil?
+          @facebook_session
+        end
+
+        module ClassMethods
+
+          # Alias don't work for some reason, so...a more Ruby-ish alias
+          # for +facebook_skip_create+.
+          #
+          def facebook_skip_create?
+            self.facebook_skip_create
+          end
+
+          # Specifies the name of the database column name used for storing
+          # the user Facebook UID.
+          #
+          def facebook_uid_field
+            @@facebook_uid_field ||= DEFAULT_FACEBOOK_UID_FIELD
+          end
+
+          # Specifies the name of the database column name used for storing
+          # the user Facebook session key.
+          #
+          def facebook_session_key_field
+            @@facebook_session_key_field ||= DEFAULT_FACEBOOK_SESSION_KEY_FIELD
+          end
+
+          # Authenticate using a Facebook UID.
+          #
+          def facebook_connect(attributes = {})
+            if attributes[:uid].present?
+              self.find_for_facebook_connect(attributes[:uid])
+            end
+          end
+
+          protected
+
+            # Find first record based on conditions given (Facebook UID).
+            # Overwrite to add customized conditions, create a join, or maybe use a
+            # namedscope to filter records while authenticating.
+            #
+            # Example:
+            #
+            #   def self.find_for_facebook_connect(conditions = {})
+            #     conditions[:active] = true
+            #     self.find(:first, :conditions => conditions)
+            #   end
+            #
+            def find_for_facebook_connect(uid)
+              self.find_by_facebook_uid(uid)
+            end
+
+            # Contains the logic used in authentication. Overwritten by other devise modules.
+            # In the Facebook Connect case; nothing fancy required.
+            #
+            def valid_for_facebook_connect(resource, attributes)
+              true
+            end
+
+          # Configuration params accessible within +Devise.setup+ procedure (in initalizer).
+          #
+          ::Devise::Models.config(self,
+              :facebook_uid_field,
+              :facebook_session_key_field,
+              :facebook_skip_create
+            )
+
+        end
+
+      end
+    end
+  end
+end
+
+Devise::Models.module_eval do
+  include ::Devise::FacebookConnectable::Model
+end

data/lib/devise_facebook_connectable/routes.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+ActionController::Routing::RouteSet::Mapper.class_eval do
+
+  protected
+    # Re-use "authenticatable"-stuff.
+    alias :facebook_connectable :authenticatable
+
+end

data/lib/devise_facebook_connectable/schema.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require 'devise_facebook_connectable/model'
+
+module Devise
+  module FacebookConnectable
+    module Schema
+
+      # Creates facebook_uid and facebook_session_key (for Facebook Connect authentication/management).
+      def facebook_connectable
+        # apply_schema ::Devise::Models::FacebookConnectable.facebook_uid_field, Integer, :limit => 8   # BIGINT unsigned / 64-bit int
+        apply_schema ::Devise::Models::FacebookConnectable.facebook_uid_field, String
+        apply_schema ::Devise::Models::FacebookConnectable.facebook_session_key_field, String
+      end
+
+    end
+  end
+end
+
+Devise::Schema.module_eval do
+  include ::Devise::FacebookConnectable::Schema
+end

data/lib/devise_facebook_connectable/serializer.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+Warden::Serializers.add(:facebook_connectable, Devise::Serializers::Authenticatable)

data/lib/devise_facebook_connectable/strategy.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+module Devise
+  module Strategies
+
+    # Default strategy for signing in a user using Facebook Connect (a Facebook account).
+    # Redirects to sign_in page if it's not authenticated
+    #
+    class FacebookConnectable < ::Warden::Strategies::Base
+
+      include ::Devise::Strategies::Base
+
+      # Without a Facebook session authentication cannot proceed.
+      #
+      def valid?
+        session[:facebook_session].present?
+      end
+
+      # Authenticate user with Facebook Connect.
+      #
+      def authenticate!
+        klass = mapping.to
+        begin
+          facebook_session = session[:facebook_session]
+          user = klass.facebook_connect(:uid => facebook_session.user.uid)
+
+          if user.present?
+            success!(user)
+          else
+            if klass.facebook_skip_create?
+              fail!(:facebook_invalid)
+            else
+              user = returning(klass.new) do |u|
+                u.store_facebook_credentials!(
+                    :session_key => facebook_session.session_key,
+                    :uid => facebook_session.user.uid,
+                    :email => facebook_session.user.proxied_email
+                  )
+                u.before_connect(facebook_session)
+              end
+
+              begin
+                user.save_with_validation(false)
+                success!(user)
+              rescue
+                fail!(:facebook_invalid)
+              end
+            end
+          end
+        # Now handled in the controller.
+        # rescue ::Facebooker::Session::SessionExpired
+          # fail!(:facebook_session_expired)
+        end
+      end
+
+    end
+  end
+end
+
+Warden::Strategies.add(:facebook_connectable, Devise::Strategies::FacebookConnectable)

data/lib/devise_facebook_connectable/view_helpers.rb

@@ -0,0 +1,125 @@
+# encoding: utf-8
+
+module Devise
+  module FacebookConnectable
+    module Helpers
+
+      # References:
+      #
+      #   * http://facebooker.rubyforge.org/
+      #   * http://wiki.developers.facebook.com/index.php/Connect/Authorization_Websites
+      #   * http://developers.facebook.com/docs/?u=facebook.jslib.FB.Connect
+      #
+
+      # Known issues:
+      #
+      #   * autologoutlink -  There's no onlogout callback - only onlogin, so it's not straightforward
+      #                       to trigger submit on the logout form to destroy the Warden session.
+      #                       Best solution now is either to hook the even manually on click,
+      #                       or use regular link like propsed here:
+      #                         
+      #                         http://forum.developers.facebook.com/viewtopic.php?pid=121283
+      #
+
+      # Make the Facebook Connect strings localized with current locale
+      # by default. Just for convenience.
+      #
+      def localized_fb_connect_javascript_tag(options = {})
+        fb_connect_javascript_tag(options.reverse_merge(:lang => ::I18n.locale))
+      end
+
+      # Convenient connect/login/logout method. See below.
+      #
+      def facebook_link(options = {})
+        unless signed_in?(options[:for])
+          facebook_login_or_connect_link(options)
+        else
+          facebook_logout_link(options)
+        end
+      end
+
+      # Agnostic Facebook Connect login/connect button/link.
+      #
+      # Case 1: If Facebook account already connected to the app/site, this is same as
+      # a traditional "account login" but with the Facebook dialog unless already
+      # logged in to Facebook.
+      # 
+      # Case 2: If account is not connected to the app/site already;
+      # then this is the same as a traditional "create account".
+      #
+      def facebook_login_or_connect_link(options = {})
+        resource = options.delete(:for)
+        options.reverse_merge!(
+            :label => ::I18n.t(:facebook_login, :scope => [:devise, :sessions]),
+            :size => :large,
+            :length => :long,
+            :background => :white,
+            :button => true,
+            :autologoutlink => false
+          )
+
+        # It seems Devise using :get method for session destroy. Not really RESTful?
+        # options.merge!(:method => :delete) if options[:autologoutlink] && signed_in?(options[:for])
+
+        content_tag(:div, :class => 'fb_connect_login_link') do
+          facebook_connect_form(resource, options.slice(:method)) <<
+          if options[:button]
+            fb_login_button('devise.facebook_connectable.login();', options)
+          else
+            fb_logout_link(options[:label], 'devise.facebook_connectable.custom_login();')
+          end
+        end
+      end
+      alias :facebook_login_link :facebook_login_or_connect_link
+      alias :facebook_connect_link :facebook_login_or_connect_link
+
+      # Agnostic Facebook Connect logout button/link. Logs out the current
+      # user from both the app/site and Facebook main site (for security reasons).
+      #
+      def facebook_logout_link(options = {})
+        options.reverse_merge!(
+            :label => ::I18n.t(:facebook_logout, :scope => [:devise, :sessions]),
+            :size => :large,
+            :length => :long,
+            :background => :white,
+            :button => false
+          )
+
+        content_tag(:div, :class => 'fb_connect_logout_link') do
+          facebook_connect_form(options.delete(:for), :logout => true, :method => :get) <<
+          if options[:button]
+            fb_login_button('devise.facebook_connectable.logout();', options.merge(:autologoutlink => true))
+          else
+            fb_logout_link(options[:label], destroy_session_path(:user))
+          end
+        end
+      end
+
+      # TODO: Agnostic Facebook Connect disconnect button/link.
+      # Disconnects, i.e. deletes, user account. Identical as "Delete my account",
+      # but for Facebook Connect (which "un-installs" the app/site for the current user).
+      #
+      def facebook_disconnect_link(options = {})
+        raise "facebook_disconnect_link: Not implemented yet."
+      end
+
+      protected
+
+        # Generate agnostic hidden login/logout form for Facebook Connect.
+        #
+        def facebook_connect_form(for_resource, options = {})
+          logout_form = options.delete(:logout) || (options[:method] == :delete)
+          options.reverse_merge!(
+              :id => (logout_form ? 'fb_connect_logout_form' : 'fb_connect_login_form'),
+              :style => 'display:none;'
+            )
+          resource = ::Devise::Mapping.find_by_path(request.path).to rescue for_resource
+          url = logout_form ? destroy_session_path(resource) : session_path(resource)
+          form_for(resource, :url => url, :html => options) { |f| }
+        end
+
+    end
+  end
+end
+
+::ActionView::Base.send :include, ::Devise::FacebookConnectable::Helpers

data/lib/devise_facebook_connectable.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+begin
+  require 'devise'
+rescue
+  gem 'devise'
+  require 'devise'
+end
+
+begin
+  require 'facebooker'
+rescue
+  gem 'facebooker'
+  require 'facebooker'
+end
+
+require 'devise_facebook_connectable/model'
+require 'devise_facebook_connectable/serializer'
+require 'devise_facebook_connectable/strategy'
+require 'devise_facebook_connectable/schema'
+require 'devise_facebook_connectable/controller_filters'
+require 'devise_facebook_connectable/routes'
+require 'devise_facebook_connectable/view_helpers'
+
+module Devise
+  module FacebookConnectable
+    
+    extend self
+    
+    mattr_accessor  :verbose
+    
+    # Logging helper: Internal debug-logging for the plugin.
+    #
+    def log(message, level = :info)
+      return unless @@verbose
+      level = :info if level.blank?
+      @@logger ||= ::Logger.new(::STDOUT)
+      @@logger.send(level.to_sym, "[devise/facebook_connectable:]  #{level.to_s.upcase}  #{message}")
+    end
+    
+  end
+end
+
+# Ugly hack, but needed now.
+#
+Devise::STRATEGIES.unshift :facebook_connectable
+Devise::SERIALIZERS.unshift :facebook_connectable

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: devise_facebook_connectable
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jonas Grimfelt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: devise
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: facebooker
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.55
+    version: 
+description: Devise << Facebook Connect.
+email: grimen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Rakefile
+- lib/devise_facebook_connectable.rb
+- lib/devise_facebook_connectable/controller_filters.rb
+- lib/devise_facebook_connectable/locales/en.yml
+- lib/devise_facebook_connectable/model.rb
+- lib/devise_facebook_connectable/routes.rb
+- lib/devise_facebook_connectable/schema.rb
+- lib/devise_facebook_connectable/serializer.rb
+- lib/devise_facebook_connectable/strategy.rb
+- lib/devise_facebook_connectable/view_helpers.rb
+files: 
+- Rakefile
+- lib/devise_facebook_connectable.rb
+- lib/devise_facebook_connectable/controller_filters.rb
+- lib/devise_facebook_connectable/locales/en.yml
+- lib/devise_facebook_connectable/model.rb
+- lib/devise_facebook_connectable/routes.rb
+- lib/devise_facebook_connectable/schema.rb
+- lib/devise_facebook_connectable/serializer.rb
+- lib/devise_facebook_connectable/strategy.rb
+- lib/devise_facebook_connectable/view_helpers.rb
+has_rdoc: true
+homepage: http://github.com/grimen/devise_facebook_connectable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Devise << Facebook Connect.
+test_files: []
+