public
Description: simple sinatra facebook extension in 300 lines of ruby
Homepage:
Clone URL: git://github.com/tmm1/sinbook.git
name age message
file README Wed Nov 25 21:59:09 -0800 2009 Minor cleanups [Aman Gupta]
directory examples/ Wed Nov 25 21:59:09 -0800 2009 Minor cleanups [Aman Gupta]
directory lib/ Thu Nov 26 10:46:57 -0800 2009 Fix for 1.9 and Rubinius [Aman Gupta]
file sinbook.gemspec Thu Nov 26 10:47:27 -0800 2009 Version bump [Aman Gupta]
README
sinbook: simple sinatra facebook extension in 300 lines of ruby
  (c) 2009 Aman Gupta (tmm1)

=== Usage

  require 'sinbook'
  require 'sinatra'

  facebook do
    api_key  '4579...cbb0'
    secret   '5106...2342'
    app_id   81747826609
    url      'http://apps.facebook.com/myappname'
    callback 'http://myappserver.com'
  end

  get '/' do
    fb.require_login!
    "Hi <fb:name uid=#{fb[:user]} useyou=false />!"
  end


=== Features

  sinbook provides a simple `facebook` helper (also aliased to `fb`).

    >> fb.valid?
    => true                              # valid (authenticated) request from facebook's servers

    >> pp fb.params
    {
      :logged_out_facebook => false,     # request came from a user logged into facebook
      :added => true,                    # user is logged into our app
      :user => 1234,                     # user's facebook uid
      :friends => [1,2,3],               # list of user's friends
      ...
    }

    >> fb[:user]                         # [] is aliased to params[]
    => 1234

    >> fb.callback
    => 'http://apps.facebook.com/myappname'

    >> fb.callback('/homepage')
    => 'http://apps.facebook.com/myappname/homepage'

    >> fb.url('/images/static.gif')
    => 'http://myappserver.com/images/static.gif'

    >> fb.appurl
    => 'http://apps.facebook.com/add.php?api_key=4579...cbb0'

    >> fb.addurl
    => 'http://www.facebook.com/apps/application.php?id=81747826609'

    >> fb.redirect('/welcome')           # redirect using an fb:redirect tag

    >> fb.require_login!                 # redirect to addurl page unless logged in


  The helper can also be used to make API calls

    >> fb.users.getInfo :uid => 1234, :fields => [:name]
    => [{'uid' => 1234, 'name' => 'Frank Sinatra'}]

    >> fb.groups.get :uid => 1234
    => [{'name' => 'Sinatra Users'}]

    >> fb.profile.setFBML :profile => 'hello world'
    => true

    >> fb.profile.getFBML
    => 'hello world'


=== Other Options

  facebook do
    symbolize_keys true
  end

  >> fb.groups.get :uid => 1234
  => [{:name => 'Sinatra Users'}]


=== Local Development

  To develop locally, use ssh to setup a reverse tunnel to your external server.
  For example, set your callback url to http://myserver.com:4567/, and run:

    ssh -gNR 4567:localhost:4567 me@myserver.com

  Then, simply launch sinatra on your local machine. Facebook will make requests to
  http://myserver.com:4567/ which will be forwarded to port 4567 on your local machine.


=== TODO

  * Split out facebook api client so it can be used outside sinatra
  * Add a batch mode for api calls:

      groups, pics = fb.batch do |b|
        b.groups.get :uid => 123
        b.users.getInfo :uids => 123, :fields => [:pic_square]
      end