simple_facebook_connect 0.0.5

data/.gitignore

@@ -0,0 +1 @@
+*.sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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,115 @@
+## Simple Facebook Connect
+
+This plugin adds the ability to sign in/sign up using facebook connect to your Rails application.
+
+## Disclaimer
+
+Most of the code here is a direct rip-off of the facebooker gem. We wanted something much simpler than facebooker so we took the code we needed, refactored and changed bits and pieces and here we are.
+
+## Basic process
+
+With this plugin you will add the well know facebook connect button to your site. When a visitor clicks on it:
+
+* she will be redirected to facebook
+* after signing in at facebook be directed back to your signup page
+* there she will sign up as usual but without being asked to enter a password
+* after signing up she will be able to sign into your site by clicking the facebook connect button
+
+When an existing user of your site clicks the button he will also be able to log in via facebook, given the email address he signed up with at your site is also known to facebook.
+
+## Set up a facebook application
+
+For basic application setup see the [facebook developer documentation](http://developers.facebook.com/get_started.php).
+
+Set the "Canvas Callback URL" to "http://your.server.com/fb/connect" and the "Connect URL" to "http://your.server.com". Write down the API and secret key for later.
+
+
+## Installation
+
+This plugin assumes you have a `User` model with an `email` attribute. It will add some extensions to your `User` model and controllers in order to provide the necessary hooks and calls for facebook to authenticate your users.
+
+Install the gem:
+
+    sudo gem install upstream-simple_facebook_connect
+    
+Add it as a dependency to your Rails application:
+
+    # environment.rb
+    gem 'upstream-simple_facebook_connect', :source => 'http://gems.github.com'
+    
+Run the migration generator and migrate:
+
+    script/generate simple_facebook_connect_migration
+    rake db:migrate
+    rake db:test:clone
+    
+In the meantime we have created a _RAILS_ROOT/config/simple_facebook_connect.yml_ file in which you should enter your facebook API and secret keys.
+    
+After that add the facebook connect button to your sign up and/or sign in pages. We have prepared a partial for you:
+
+    <%= render :partial => 'shared/facebook_connect_button' %>
+    
+Add this to your signup action (`users/create` in most cases):
+
+    class UsersController < ApplicationController
+      def create
+        @user = # initialize user
+        ....
+        @user.fb_uid = facebook_user.uid if facebook_user
+        @user.save
+      end
+    end
+    
+Change your signup form to not show any password fields when signing up via facebook:
+
+    <%- unless facebook_user -%>
+      <%= f.password_field :password -%>
+      ...
+    <%- end -%>
+    
+Provide a `log_in(user)` method, either in your `ApplicationController` or by subclassing `SimpleFacebookConnect::ConnectController`:
+
+    class AppicationController < ActionController::Base
+    
+      ...
+      
+      private
+      
+      def log_in(user)
+        session[:user_id] = user.id # or whatever your app does
+        redirect_to account_path
+      end
+    end
+    
+Optional step (well, you really should do this): Generate Cucumber Features:
+
+    script/generate simple_facebook_connect_features
+    
+This will generate a feature, step definitions and fixtures to test the facebook connect integration. You will probably have to adjust those files to fit your app, for example we are using _Machinist_ to generate `User` instances.
+
+Finally: run the features and by now everything should be green. Congrats.
+
+## What else
+
+You can grab some of the facebook profile data (e.g. name, location, picture) when signing up your new users. For a complete list of attributes see `SimpleFacebookConnect::User::FIELDS`. In order to do that you could add a line of code to your signup action:
+
+    class UsersController < ApplicationController
+      def create
+        @user = # initialize user
+        ....
+        if facebook_user
+          @user.name = facebook_user.name
+          @user.about_me = facebook_user.about_me
+        end
+        @user.save
+      end
+    end
+
+## Links
+
+* facebooker: http://facebooker.rubyforge.org/
+* contact: http://upstream-berlin.com
+* email: alex [at] upstream-berlin dot com
+
+
+Copyright (c) 2009 Alexander Lang, Frank Prößdorf, released under the MIT license

data/Rakefile

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "simple_facebook_connect"
+    gem.summary = %Q{This plugin adds the ability to sign in/sign up using facebook connect to your Rails application.}
+    gem.email = "alex@upstream-berlin.com"
+    gem.homepage = "http://github.com/upstream/simple_facebook_connect"
+    gem.authors = ["Alexander Lang", 'Frank Prößdorf']
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.5

data/app/controllers/simple_facebook_connect/connect_controller.rb

@@ -0,0 +1,59 @@
+module SimpleFacebookConnect
+  class ConnectController < ApplicationController
+  
+    def authenticate
+      redirect_to new_facebook_session.login_url
+    end
+  
+    def connect
+      begin
+        new_facebook_session(params['auth_token'])
+        if facebook_user
+          unless log_in_via_fb_id(facebook_user) || log_in_via_email_hash(facebook_user)
+            redirect_to(signup_path)
+          end
+        else
+          render(:nothing => true)
+        end
+      rescue FacebookApiError => e
+        Rails.logger.warn e.message
+        redirect_to fb_authenticate_path
+      end
+    end
+  
+    private
+    
+    def signup_path
+      new_user_path(:fb_user => 1)
+    end
+  
+    def new_facebook_session(token = nil)
+      facebook_session = Session.new(SimpleFacebookConnect.api_key, SimpleFacebookConnect.secret_key)
+      if token
+        facebook_session.auth_token = token
+        facebook_session.secure!
+        session[:facebook_session] = facebook_session
+      end
+      facebook_session
+    end
+  
+    def log_in_via_fb_id(facebook_user)
+      if user = ::User.find_by_fb_uid(facebook_user.uid)
+        log_in(user)
+        true
+      end
+    end
+  
+    def log_in_via_email_hash(facebook_user)
+      facebook_user.email_hashes.each do |hash|
+        if user = ::User.find_by_email_hash(hash)
+          user.update_attribute(:fb_uid, facebook_user.uid)
+          log_in(user)
+          return true
+        end
+      end
+      false
+    end
+
+  end
+end

data/app/views/shared/_facebook_connect_button.html.erb

@@ -0,0 +1,15 @@
+<fb:login-button onclick="redirect_to_authenticate()"></fb:login-button>
+<%= javascript_include_tag 'http://static.ak.connect.facebook.com/js/api_lib/v0.4/FeatureLoader.js.php' %>
+<script type="text/javascript" charset="utf-8">
+ function redirect_to_authenticate() {
+   FB.Facebook.get_sessionState().waitUntilReady(function() {
+     window.location = window.facebook_authenticate_location;
+   });
+ };
+
+ window.api_key = "<%= SimpleFacebookConnect.api_key %>";
+ window.facebook_authenticate_location = '<%= fb_authenticate_path %>';
+ window.xd_receiver = '/xd_receiver.html';
+
+ FB.init(window.api_key, window.xd_receiver);
+</script>

data/config/simple_facebook_connect_routes.rb

@@ -0,0 +1,4 @@
+ActionController::Routing::Routes.draw do |map|
+  map.fb_connect '/fb/connect', :controller => 'simple_facebook_connect/connect', :action => 'connect'
+  map.fb_authenticate '/fb/authenticate', :controller => 'simple_facebook_connect/connect', :action => 'authenticate'
+end

data/generators/simple_facebook_connect_features/simple_facebook_connect_features_generator.rb

@@ -0,0 +1,14 @@
+class SimpleFacebookConnectFeaturesGenerator < Rails::Generator::Base
+  def manifest
+    record do |r|
+      r.file 'facebook_connect.feature', "features/facebook_connect.feature"
+      r.file 'facebook_connect_steps.rb', "features/step_definitions/facebook_connect_steps.rb"
+      r.file 'facebook_connect_stubs.rb', "features/support/facebook_connect_stubs.rb"
+      
+      r.directory 'features/fixtures/facebook.auth.getSession'
+      r.file 'facebook_auth_getsession.xml', "features/fixtures/facebook.auth.getSession/default.xml"
+      r.directory 'features/fixtures/facebook.users.getInfo'
+      r.file 'facebook_users_getinfo.xml', "features/fixtures/facebook.users.getInfo/default.xml"
+    end
+  end
+end

data/generators/simple_facebook_connect_features/templates/facebook_auth_getsession.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<auth_getSession_response
+  xmlns="http://api.facebook.com/1.0/"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd">
+    <session_key>5f34e11bfb97c762e439e6a5-8055</session_key>
+    <uid>8055</uid>
+    <expires>1173309298</expires>
+</auth_getSession_response>

data/generators/simple_facebook_connect_features/templates/facebook_connect.feature

@@ -0,0 +1,27 @@
+Feature: facebook connect
+  In order to get more users
+  As a site owner
+  I want users to easily sign in and sign up via facebook
+  
+  Scenario: sign in via facebook when being connected
+    Given a user who is connected via facebook
+    When I go to the start page
+    And I sign in via facebook
+    Then I should see "Welcome"
+    
+  Scenario: sign in via facebook when not being connected
+    Given a user with the email "email@person.com"
+    When I go to the start page
+    And I sign in via facebook
+    Then I should see "Welcome"
+  
+  Scenario: sign up via facebook
+    When I go to the start page
+    And I sign up via facebook
+    Then I should not see "Password"
+    When I fill in "Email" with "email@person.com"
+    And I press "Sign Up"
+    
+    Then I should see "instructions for confirming"
+    And a confirmation message should be sent to "email@person.com"
+    And my facebook id should be set

data/generators/simple_facebook_connect_features/templates/facebook_connect_steps.rb

@@ -0,0 +1,19 @@
+When /I sign up via facebook/ do
+  get fb_authenticate_path
+  response.redirected_to.should include('facebook.com')
+  # go to facebook and come back with auth token
+  post fb_connect_path, auth_token: '3e4a22bb2f5ed75114b0fc9995ea85f1'
+  visit response.redirected_to
+end
+
+When /I sign in via facebook/ do
+  When 'I sign up via facebook'
+end
+
+Then 'my facebook id should be set' do
+  User.last.fb_uid.should == 8055 # taken from xml fixture
+end
+
+Given /a user who is connected via facebook/ do
+  User.make fb_uid: 8055 # make from machinist
+end

data/generators/simple_facebook_connect_features/templates/facebook_connect_stubs.rb

@@ -0,0 +1,43 @@
+module SimpleFacebookConnect
+  module ServiceStub
+    def read_fixture(method)
+      if File.exists?(fixture_path(method, 'default'))
+        File.read fixture_path(method, 'default')
+      else
+        raise "Missing fixture #{fixture_path(method, 'default')}\nFacebook API Reference: http://wiki.developers.facebook.com/index.php/#{method.sub(/^facebook\./, '')}#Example_Return_XML"
+      end
+    end
+
+    def post(params)
+      method = params.delete(:method)
+      params.delete_if {|k,_| [:v, :api_key, :call_id, :sig].include?(k) }
+      Parser.parse(method, read_fixture(method))
+    end
+
+    private
+
+    def fixture_path(method, filename)
+      File.join(Rails.root + 'features/fixtures', method, "#{filename}.xml")
+    end
+  end
+
+  module SessionStub
+    def service
+      unless @service
+        service = Service.new(Session::API_SERVER_BASE_URL, Session::API_PATH_REST, @api_key)
+        service.extend(ServiceStub)
+        @service = service
+      else
+        @service
+      end
+    end
+  end
+end
+
+SimpleFacebookConnect::Session.class_eval do
+  def self.new(*args)
+    session = super
+    session.extend SimpleFacebookConnect::SessionStub
+    session
+  end
+end

data/generators/simple_facebook_connect_features/templates/facebook_users_getinfo.xml

@@ -0,0 +1,119 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<users_getInfo_response xmlns="http://api.facebook.com/1.0/"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd" list="true">
+    <user>
+      <uid>8055</uid>
+      <about_me>This field perpetuates the glorification of the ego.  Also, it has a character limit.</about_me>
+      <activities>Here: facebook, etc. There: Glee Club, a capella, teaching.</activities>
+      <affiliations list="true">
+        <affiliation>
+          <nid>50453093</nid>
+          <name>Facebook Developers</name>
+          <type>work</type>
+          <status/>
+          <year/>
+        </affiliation>
+      </affiliations> 
+      <birthday>November 3</birthday>
+      <books>The Brothers K, GEB, Ken Wilber, Zen and the Art, Fitzgerald, The Emporer's New Mind, The Wonderful Story of Henry Sugar</books>
+      <current_location>
+        <city>Palo Alto</city>
+        <state>California</state>
+        <country>United States</country>
+        <zip>94303</zip>
+      </current_location>
+      <education_history list="true">
+        <education_info>
+          <name>Harvard</name>
+          <year>2003</year>
+          <concentrations list="true">
+            <concentration>Applied Mathematics</concentration>
+            <concentration>Computer Science</concentration>
+          </concentrations>
+        </education_info>
+      </education_history>
+      <email_hashes list="true">
+        <email_hash_elt>2781152470_9f9c29692798573d8c76eaaf053a1911</email_hash_elt>
+      </email_hashes>
+      <family list="true">
+        <family_elt list="true">
+          <family_elt_elt>mother</family_elt_elt>
+          <family_elt_elt>1394244902</family_elt_elt>
+        </family_elt>
+        <family_elt list="true">
+          <family_elt_elt>sister</family_elt_elt>
+          <family_elt_elt>48703107</family_elt_elt>
+        </family_elt>
+        <family_elt list="true">
+          <family_elt_elt>brother</family_elt_elt>
+          <family_elt_elt>1078767258</family_elt_elt>
+        </family_elt>
+        <family_elt list="true">
+          <family_elt_elt>brother</family_elt_elt>
+          <family_elt_elt>John Doe</family_elt_elt>
+          <family_elt_elt/>
+        </family_elt>
+      </family>
+      <first_name>Dave</first_name>
+       <hometown_location>
+         <city>York</city>
+         <state>Pennsylvania</state>
+         <country>United States</country>
+       </hometown_location>
+       <hs_info>
+         <hs1_name>Central York High School</hs1_name>
+         <hs2_name/>
+         <grad_year>1999</grad_year>
+         <hs1_id>21846</hs1_id>
+         <hs2_id>0</hs2_id>
+       </hs_info>
+       <is_app_user>1</is_app_user>
+       <has_added_app>1</has_added_app>
+       <interests>coffee, computers, the funny, architecture, code breaking,snowboarding, philosophy, soccer, talking to strangers</interests>
+       <last_name>Fetterman</last_name>
+       <locale>en_US</locale>
+       <meeting_for list="true">
+         <seeking>Friendship</seeking>
+       </meeting_for>
+       <meeting_sex list="true">
+         <sex>female</sex>
+       </meeting_sex>
+       <movies>Tommy Boy, Billy Madison, Fight Club, Dirty Work, Meet the Parents, My Blue Heaven, Office Space </movies>
+       <music>New Found Glory, Daft Punk, Weezer, The Crystal Method, Rage, the KLF, Green Day, Live, Coldplay, Panic at the Disco, Family Force 5</music>
+       <name>Dave Fetterman</name>
+       <notes_count>0</notes_count>
+       <pic>http://photos-055.facebook.com/ip007/profile3/1271/65/s8055_39735.jpg</pic>
+       <pic_big>http://photos-055.facebook.com/ip007/profile3/1271/65/n8055_39735.jpg</pic_big>
+       <pic_small>http://photos-055.facebook.com/ip007/profile3/1271/65/t8055_39735.jpg</pic_small>
+       <pic_square>http://photos-055.facebook.com/ip007/profile3/1271/65/q8055_39735.jpg</pic_square>
+       <political>Moderate</political>
+       <profile_update_time>1170414620</profile_update_time>
+       <quotes/>
+       <relationship_status>In a Relationship</relationship_status>
+       <religion/>
+       <sex>male</sex>
+       <significant_other_id xsi:nil="true"/>
+       <status>
+         <message>Fast Company, November issue, page 84</message>
+         <time>1193075616</time>
+       </status>
+       <timezone>-8</timezone>
+       <tv>cf. Bob Trahan</tv>
+       <wall_count>121</wall_count>
+       <work_history list="true">
+         <work_info>
+           <location>
+             <city>Palo Alto</city>
+             <state>CA</state>
+             <country>United States</country>
+           </location>
+           <company_name>Facebook</company_name>
+           <position>Software Engineer</position>
+           <description>Tech Lead, Facebook Platform</description>
+           <start_date>2006-01</start_date>
+           <end_date/>
+          </work_info>
+       </work_history>
+    </user>
+ </users_getInfo_response>

data/generators/simple_facebook_connect_migration/simple_facebook_connect_migration_generator.rb

@@ -0,0 +1,13 @@
+class SimpleFacebookConnectMigrationGenerator < Rails::Generator::Base 
+  
+  def manifest
+    record do |r|
+      r.migration_template 'migration.rb', "db/migrate"
+    end
+  end
+  
+  def file_name
+    "add_facebook_connect" 
+  end
+  
+end

data/generators/simple_facebook_connect_migration/templates/migration.rb

@@ -0,0 +1,17 @@
+class AddFacebookConnect < ActiveRecord::Migration
+  def self.up
+    add_column :users, :fb_uid, :integer
+    add_column :users, :email_hash, :string
+    
+    add_index :users, :fb_uid
+    add_index :users, :email_hash
+  end
+
+  def self.down
+    remove_index :users, :fb_uid
+    remove_index :users, :email_hash
+
+    remove_column :users, :email_hash
+    remove_column :users, :fb_uid
+  end
+end

data/init.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/lib/simple_facebook_connect'
+
+config_file = Rails.root + 'config/simple_facebook_connect.yml'
+
+unless File.exist?(config_file)
+  File.open(config_file, 'w') do |f|
+    f << <<-CONF
+test:
+  api_key:
+  secret_key: 
+
+development:
+  api_key:
+  secret_key: 
+
+production:
+  api_key:
+  secret_key: 
+  
+CONF
+  end
+  
+  puts "Created the facebook simple connect configuration in #{config_file}. Please enter your facebook API and secret keys there."
+  exit(1)
+end
+
+config = YAML::load(File.read(config_file))[Rails.env]
+
+SimpleFacebookConnect.api_key = config['api_key']
+SimpleFacebookConnect.secret_key = config['secret_key']
+
+ApplicationController.send(:include, SimpleFacebookConnect::ControllerExtension)
+User.send(:include, SimpleFacebookConnect::UserExtension)
+
+require 'simple_facebook_connect/extensions/routes'

data/lib/simple_facebook_connect/controller_extension.rb

@@ -0,0 +1,11 @@
+module SimpleFacebookConnect
+  module ControllerExtension
+    def facebook_session
+      session[:facebook_session]
+    end
+
+    def facebook_user
+      (session[:facebook_session] && session[:facebook_session].session_key) ? session[:facebook_session].user : nil
+    end
+  end
+end

data/lib/simple_facebook_connect/extensions/routes.rb

@@ -0,0 +1,13 @@
+# without this hack people can't override our routes when subclassing controllers in the app. trick stolen from clearance.
+class ActionController::Routing::RouteSet
+  def load_routes_with_simple_facebook_connect!
+    lib_path = File.dirname(__FILE__)
+    routes = File.join(lib_path, *%w[.. .. .. config simple_facebook_connect_routes.rb])
+    unless configuration_files.include?(routes)
+      add_configuration_file(routes)
+    end
+    load_routes_without_simple_facebook_connect!
+  end
+
+  alias_method_chain :load_routes!, :simple_facebook_connect
+end