RubyGems - jerryvos-authlogic_facebook_connect - Versions diffs - 1.0.0 - Mend

jerryvos-authlogic_facebook_connect 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

data/README.rdoc +79 -0
data/Rakefile +18 -0
data/VERSION +1 -0
data/init.rb +1 -0
data/lib/authlogic_facebook_connect.rb +10 -0
data/lib/authlogic_facebook_connect/acts_as_authentic.rb +20 -0
data/lib/authlogic_facebook_connect/helper.rb +29 -0
data/lib/authlogic_facebook_connect/session.rb +136 -0
data/lib/authlogic_facebook_connect/version.rb +0 -0
metadata +63 -0

data/README.rdoc ADDED Viewed

@@ -0,0 +1,79 @@
+== Install and use
+=== 1. Install the facebooker gem and make Rails use it
+  $ sudo gem install facebooker
+Make sure that you have setup you config/facebooker.yml to match your facebook application, make you application depended on the facebooker gem
+  config.gem "facebooker"
+and run the xd_receiver generator to create the cross domain scripting bridge to make it possible for your application to communicate with facebook
+  $ script/generate xd_receiver
+For more information on the facebooker gem checkout it's readme http://github.com/mmangino/facebooker/tree/master
+=== 2. Install the Authlogic Facebook Connect plugin
+  $ script/plugin install git://github.com/kalasjocke/authlogic_facebook_connect.git
+This plugin should soon be packed inside a gem.
+=== 3. Make some changes to your database
+  class AddFacebookConnectFieldsToUser < ActiveRecord::Migration
+    def self.up
+      add_column :users, :name, :string
+      add_column :users, :facebook_uid, :integer, :limit => 8
+    end
+    def self.down
+      remove_column :users, :facebook_uid
+      remove_column :users, :name
+    end
+  end
+=== 4. Make your layout look something like this
+The important parts are the facebook html namespace, facebook javascript include and the facebook helper calls to init the facebooker gem.
+  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+  <html xmlns="http://www.w3.org/1999/xhtml" xmlns:fb="http://www.facebook.com/2008/fbml">
+  <head>
+    <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+    <title>Your awsome facebook connected app</title>
+    <%= stylesheet_link_tag 'application' %>
+    <%= javascript_include_tag :defaults %>
+    <script src="http://static.ak.connect.facebook.com/js/api_lib/v0.4/FeatureLoader.js.php" type="text/javascript"></script>
+  </head>
+  <body>
+  <p style="color: green"><%= flash[:notice] %></p>
+  <%= fb_connect_javascript_tag %>
+  <%= init_fb_connect "XFBML" %>
+  <%= yield %>
+  </body>
+  </html>
+=== 5. Add the Facebook Connect button to your login form
+  <%= authlogic_facebook_login_button %>
+=== Notes
+If you want to save some user data when connecting to facebook you can use the before_connect hook in your user model.
+  def before_connect(facebook_session)
+    self.name = facebook_session.user.name
+  end
+For more information about what you can get form the facebook_session checkout the Facebooker gem rdoc.

data/Rakefile ADDED Viewed

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jerryvos-authlogic_facebook_connect"
+    gem.summary = %Q{Extension of the Authlogic library to add Facebook Connect support built upon the excellent facebooker gem}
+    # gem.description = %Q{}
+    # gem.email = ""
+    gem.homepage = "http://github.com/kalasjocke/authlogic_facebook_connect"
+    gem.authors = ["kalasjocke"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 1.0.0

data/init.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ require 'authlogic_facebook_connect'

data/lib/authlogic_facebook_connect.rb ADDED Viewed

@@ -0,0 +1,10 @@
+# require "authlogic_facebook_connect/version"
+require "authlogic_facebook_connect/acts_as_authentic"
+require "authlogic_facebook_connect/session"
+require "authlogic_facebook_connect/helper"
+if ActiveRecord::Base.respond_to?(:add_acts_as_authentic_module)
+  ActiveRecord::Base.send(:include, AuthlogicFacebookConnect::ActsAsAuthentic)
+  Authlogic::Session::Base.send(:include, AuthlogicFacebookConnect::Session)
+  ActionController::Base.helper AuthlogicFacebookConnect::Helper
+end

data/lib/authlogic_facebook_connect/acts_as_authentic.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module AuthlogicFacebookConnect
+  module ActsAsAuthentic
+    def self.included(klass)
+      klass.class_eval do
+        extend Config
+        add_acts_as_authentic_module(Methods, :prepend)
+      end
+    end
+    module Config
+    end
+    module Methods
+      def self.included(klass)
+        klass.class_eval do
+        end
+      end
+    end
+  end
+end

data/lib/authlogic_facebook_connect/helper.rb ADDED Viewed

@@ -0,0 +1,29 @@
+module AuthlogicFacebookConnect
+  module Helper
+    def authlogic_facebook_login_button(options = {})
+      # TODO: Make this with correct helpers istead of this uggly hack.
+      options[:controller] ||= "user_session"
+      options[:js] ||= :prototype
+      case options[:js]
+      when :prototype
+        js_selector = "$('connect_to_facebook_form')"
+      when :jquery
+        js_selector = "jQuery('#connect_to_facebook_form')"
+      end
+      output = "<form id='connect_to_facebook_form' method='post' action='/#{options[:controller]}'>\n"
+      output << "<input type='hidden' name='authenticity_token' value='#{form_authenticity_token}'/>\n"
+      output << "</form>\n"
+      output << "<script type='text/javascript' charset='utf-8'>\n"
+      output << " function connect_to_facebook() {\n"
+      output << "   #{js_selector}.submit();\n"
+      output << " }\n"
+      output << "</script>\n"
+      options.delete(:controller)
+      output << fb_login_button("connect_to_facebook()", options)
+      output
+    end
+  end
+end

data/lib/authlogic_facebook_connect/session.rb ADDED Viewed

@@ -0,0 +1,136 @@
+module AuthlogicFacebookConnect
+  module Session
+    def self.included(klass)
+      klass.class_eval do
+        extend Config
+        include Methods
+      end
+    end
+    module Config
+      # Should the user be saved with our without validations?
+      #
+      # The default behavior is to save the user without validations and then
+      # in an application specific interface ask for the additional user
+      # details to make the user valid as facebook just provides a facebook id.
+      #
+      # This is useful if you do want to turn on user validations, maybe if you
+      # just have facebook connect as an additional authentication solution and
+      # you already have valid users.
+      #
+      # * <tt>Default:</tt> true
+      # * <tt>Accepts:</tt> Boolean
+      def facebook_valid_user(value = nil)
+        rw_config(:facebook_valid_user, value, false)
+      end
+      alias_method :facebook_valid_user=, :facebook_valid_user
+      # What user field should be used for the facebook UID?
+      #
+      # This is useful if you want to use a single field for multiple types of
+      # alternate user IDs, e.g. one that handles both OpenID identifiers and
+      # facebook ids.
+      #
+      # * <tt>Default:</tt> :facebook_uid
+      # * <tt>Accepts:</tt> Symbol
+      def facebook_uid_field(value = nil)
+        rw_config(:facebook_uid_field, value, :facebook_uid)
+      end
+      alias_method :facebook_uid_field=, :facebook_uid_field
+      # Class representing facebook users we want to authenticate against
+      #
+      # * <tt>Default:</tt> klass
+      # * <tt>Accepts:</tt> Class
+      def facebook_user_class(value = nil)
+        rw_config(:facebook_user_class, value, klass)
+      end
+      alias_method :facebook_user_class=, :facebook_user_class
+      # Should a new user creation be skipped if there is no user with given facebook uid?
+      #
+      # The default behavior is not to skip (hence create new user). You may want to turn it on
+      # if you want to try with different model.
+      #
+      # * <tt>Default:</tt> false
+      # * <tt>Accepts:</tt> Boolean
+      def facebook_skip_new_user_creation(value = nil)
+        rw_config(:facebook_skip_new_user_creation, value, false)
+      end
+      alias_method :facebook_skip_new_user_creation=, :facebook_skip_new_user_creation
+    end
+    module Methods
+      def self.included(klass)
+        klass.class_eval do
+          validate :validate_by_facebook_connect, :if => :authenticating_with_facebook_connect?
+        end
+        def credentials=(value)
+          # TODO: Is there a nicer way to tell Authlogic that we don't have any credentials than this?
+          values = [:facebook_connect]
+          super
+        end
+      end
+      def validate_by_facebook_connect
+        facebook_session = controller.facebook_session
+        self.attempted_record = facebook_user_class.find(:first, :conditions => { facebook_uid_field => facebook_session.user.uid }).try(:"#{klass}".to_s.underscore)
+        unless self.attempted_record || facebook_skip_new_user_creation
+          begin
+            # Get the user from facebook and create a local user.
+            #
+            # We assign it after the call to new in case the attribute is protected.
+            new_user = klass.new
+            if klass == facebook_user_class
+              new_user.send(:"#{facebook_uid_field}=", facebook_session.user.uid)
+            else
+              new_user.send(:"build_#{facebook_user_class.to_s.underscore}", :"#{facebook_uid_field}" => facebook_session.user.uid)
+            end
+            new_user.before_connect(facebook_session) if new_user.respond_to?(:before_connect)
+            self.attempted_record = new_user
+            if facebook_valid_user
+              errors.add_to_base(
+                I18n.t('error_messages.facebook_user_creation_failed',
+                       :default => 'There was a problem creating a new user ' +
+                                   'for your Facebook account')) unless self.attempted_record.valid?
+              self.attempted_record = nil
+            else
+              self.attempted_record.save_with_validation(false)
+            end
+          rescue Facebooker::Session::SessionExpired
+            errors.add_to_base(I18n.t('error_messages.facebooker_session_expired',
+              :default => "Your Facebook Connect session has expired, please reconnect."))
+          end
+        end
+      end
+      def authenticating_with_facebook_connect?
+        controller.set_facebook_session
+        attempted_record.nil? && errors.empty? && controller.facebook_session
+      end
+      private
+        def facebook_valid_user
+          self.class.facebook_valid_user
+        end
+        def facebook_uid_field
+          self.class.facebook_uid_field
+        end
+       def facebook_user_class
+         self.class.facebook_user_class
+       end
+       def facebook_skip_new_user_creation
+         self.class.facebook_skip_new_user_creation
+       end
+    end
+  end
+end

data/lib/authlogic_facebook_connect/version.rb ADDED Viewed

File without changes

metadata ADDED Viewed

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: jerryvos-authlogic_facebook_connect
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- kalasjocke
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-11-22 00:00:00 -06:00
+default_executable:
+dependencies: []
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/authlogic_facebook_connect.rb
+- lib/authlogic_facebook_connect/acts_as_authentic.rb
+- lib/authlogic_facebook_connect/helper.rb
+- lib/authlogic_facebook_connect/session.rb
+- lib/authlogic_facebook_connect/version.rb
+has_rdoc: true
+homepage: http://github.com/kalasjocke/authlogic_facebook_connect
+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: Extension of the Authlogic library to add Facebook Connect support built upon the excellent facebooker gem
+test_files: []