RubyGems - sinbook - Versions diffs - 0.1.5 - Mend

sinbook 0.1.5

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 (6) hide show

data/README ADDED

@@ -0,0 +1,107 @@
+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'
+=== 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.
+=== Other Options
+  facebook do
+    symbolize_keys true
+  end
+  >> fb.groups.get :uid => 1234
+  => [{:name => 'Sinatra Users'}]
+=== 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

data/examples/connect.rb ADDED

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'sinbook'
+require 'sinatra'
+facebook do
+  api_key  '858593842e5a3cefe59b72ddc7ffdd56'
+  secret   '56ce1b26bf48ac8bac927c7d280b18f8'
+  app_id   185945096655
+  url      'http://tmm1.net:4568/'
+  callback 'http://tmm1.net:4568/'
+end
+set :port, 4568
+get '/' do
+  haml :main
+end
+get '/receiver' do
+  %[<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+  <html xmlns="http://www.w3.org/1999/xhtml" >
+  <body>
+      <script src="http://static.ak.connect.facebook.com/js/api_lib/v0.4/XdCommReceiver.js" type="text/javascript"></script>
+  </body>
+  </html>]
+end
+__END__
+@@ layout
+%html{:xmlns=>"http://www.w3.org/1999/xhtml", :'xmlns:fb'=>"http://www.facebook.com/2008/fbml"}
+  %head
+    %title Welcome to my Facebook Connect website!
+    %script{:type => 'text/javascript', :src => 'http://static.ak.connect.facebook.com/js/api_lib/v0.4/FeatureLoader.js.php/en_US'}
+  %body
+    = yield
+    :javascript
+      FB.init("#{fb.api_key}", "/receiver")
+@@ main
+- if fb.valid? and fb[:user]
+  Hi,
+  %fb:profile-pic{:uid => fb[:user]}
+  %fb:name{:uid => fb[:user], :useyou => 'false', :firstnameonly => 'true'}
+  !
+  %br/
+  Do you want to <a href="javascript:FB.Connect.logoutAndRedirect('/')">logout</a>?
+- else
+  Please login:
+  %fb:login-button{:onlogin => 'document.location.reload(true)'}

data/examples/simple.rb ADDED

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'sinbook'
+require 'sinatra'
+facebook do
+  api_key  '45796747415d12227f52146b4444cbb0'
+  secret   '5106c7409f18d7618dd03433a2f72342'
+  app_id   81747826609
+  url      'http://apps.facebook.com/sinatrafacebook'
+  callback 'http://tmm1.net:4567'
+end
+get '/' do
+  if not facebook.valid?
+    # not accessed via facebook, redirect to the facebook app url
+    redirect fb.url
+  elsif fb[:logged_out_facebook]
+    # user is not logged into facebook
+    "Hey there! This is an awesome facebook app, but you must login to facebook to see it."
+  elsif not fb[:added]
+    # user is logged into facebook, but not our app
+    if not fb[:canvas_user]
+      # user navigated to the app directly, we know nothing about them
+      "
+      Hey there, you should add this <b>awesome</b> app! <br>
+      Go <a href='#{fb.addurl}'>here</a> or just click <a href='#' requirelogin=true>here</a>! <br>
+      Or, if you don't want to add the app, click <a href='#{fb.url('/')}'>here</a> so I know who you are.
+      "
+    else
+      # user came via a feed/notification or clicked on a link in the app, so we know who they are
+      "
+      Hey <fb:name uid=#{fb[:canvas_user]} useyou=false />. <br>
+      All I know about you is that you have #{fb[:friends].size} friends. <br>
+      Maybe you'll <a href='#{fb.addurl}'>add this app</a> so I can tell you more?
+      "
+    end
+  elsif fb[:user]
+    # logged into facebook and our app, we can get all their info
+    "
+    Hey <fb:name uid=#{fb[:user]} useyou=false />! <br>
+    Check out the special <a href='#{fb.url('/members')}'>members-only area</a>. <br>
+    And don't forget to tell your #{fb[:friends].size} friends to add this app too!
+    "
+  end
+end
+get '/members' do
+  fb.require_login!
+  groups = fb.groups.get :uid => fb[:user]
+  "
+  Hey there, now that you're a member I can tell what groups you're in on Facebook: <br>
+  #{groups.map{|g| g['name'] }.join('<br>')}
+  "
+end

data/lib/sinbook.rb ADDED

@@ -0,0 +1,355 @@
+begin
+  require 'sinatra/base'
+rescue LoadError
+  retry if require 'rubygems'
+  raise
+end
+module Sinatra
+  require 'digest/md5'
+  require 'yajl'
+  class FacebookObject
+    def initialize app
+      @app = app
+      @api_key = app.options.facebook_api_key
+      @secret = app.options.facebook_secret
+      @app_id = app.options.facebook_app_id
+      @url = app.options.facebook_url
+      @callback = app.options.facebook_callback
+      @symbolize_keys = app.options.facebook_symbolize_keys || false
+    end
+    attr_reader :app
+    attr_accessor :api_key, :secret
+    attr_writer :url, :callback, :app_id
+    def app_id
+      @app_id || self[:app_id]
+    end
+    def url postfix=nil
+      postfix ? "#{@url}#{postfix}" : @url
+    end
+    def callback postfix=nil
+      postfix ? "#{@callback}#{postfix}" : @callback
+    end
+    def addurl
+      "http://apps.facebook.com/add.php?api_key=#{self.api_key}"
+    end
+    def appurl
+      "http://www.facebook.com/apps/application.php?id=#{self.app_id}"
+    end
+    def require_login!
+      if valid?
+        redirect addurl unless params[:user]
+      else
+        app.redirect url
+      end
+    end
+    def redirect url
+      url = self.url + url unless url =~ /^http/
+      app.body "<fb:redirect url='#{url}'/>"
+      throw :halt
+    end
+    def params
+      return {} unless valid?
+      app.env['facebook.params'] ||= \
+        app.env['facebook.vars'].inject({}) do |h,(k,v)|
+          s = k.to_sym
+          case k
+          when 'friends'
+            h[s] = v.split(',').map{|e|e.to_i}
+          when /time$/
+            h[s] = Time.at(v.to_f)
+          when 'expires'
+            v = v.to_i
+            h[s] = v>0 ? Time.at(v) : v
+          when 'user', 'app_id', 'canvas_user'
+            h[s] = v.to_i
+          when /^(logged_out|position_|in_|is_|added)/
+            h[s] = v=='1'
+          else
+            h[s] = v
+          end
+          h
+        end
+    end
+    def [] key
+      params[key]
+    end
+    def valid?
+      if app.params['fb_sig'] # canvas/iframe mode
+        prefix = 'fb_sig'
+        vars = app.params
+      elsif app.request.cookies[api_key] # fbconnect mode
+        prefix = api_key
+        vars = app.request.cookies
+      else
+        return false
+      end
+      if app.env['facebook.valid?'].nil?
+        fbvars = {}
+        sig = Digest::MD5.hexdigest(vars.map{|k,v|
+          if k =~ /^#{prefix}_(.+)$/
+            fbvars[$1] = v
+            "#{$1}=#{v}"
+          end
+        }.compact.sort.join+self.secret)
+        if app.env['facebook.valid?'] = (vars[prefix] == sig)
+          app.env['facebook.vars'] = fbvars
+        end
+      end
+      app.env['facebook.valid?']
+    end
+    class APIProxy
+      Types = %w[
+        admin
+        application
+        auth
+        batch
+        comments
+        connect
+        data
+        events
+        fbml
+        feed
+        fql
+        friends
+        groups
+        links
+        liveMessage
+        notes
+        notifications
+        pages
+        photos
+        profile
+        sms
+        status
+        stream
+        users
+        video
+      ]
+      alias :__class__ :class
+      alias :__inspect__ :inspect
+      instance_methods.each { |m| undef_method m unless m =~ /^__/ }
+      alias :inspect :__inspect__
+      def initialize name, obj
+        @name, @obj = name, obj
+      end
+      def method_missing method, opts = {}
+        @obj.request "#{@name}.#{method}", opts
+      end
+    end
+    APIProxy::Types.each do |n|
+      class_eval %[
+        def #{n}
+          (@proxies||={})[:#{n}] ||= APIProxy.new(:#{n}, self)
+        end
+      ]
+    end
+    def request method, opts = {}
+      if method == 'photos.upload'
+        image = opts.delete :image
+      end
+      opts = { :api_key => self.api_key,
+               :call_id => Time.now.to_f,
+               :format => 'JSON',
+               :v => '1.0',
+               :session_key => %w[ photos.upload ].include?(method) ? nil : params[:session_key],
+               :method => method }.merge(opts)
+      args = opts.map{ |k,v|
+                       next nil unless v
+                       "#{k}=" + case v
+                                 when Hash
+                                   Yajl::Encoder.encode(v)
+                                 when Array
+                                   if k == :tags
+                                     Yajl::Encoder.encode(v)
+                                   else
+                                     v.join(',')
+                                   end
+                                 else
+                                   v.to_s
+                                 end
+                     }.compact.sort
+      sig = Digest::MD5.hexdigest(args.join+self.secret)
+      if method == 'photos.upload'
+        data = MimeBoundary
+        data += opts.merge(:sig => sig).inject('') do |buf, (key, val)|
+          if val
+            buf << (MimePart % [key, val])
+          else
+            buf
+          end
+        end
+        data += MimeImage % ['upload.jpg', 'jpg', image.respond_to?(:read) ? image.read : image]
+      else
+        data = Array["sig=#{sig}", *args.map{|a| a.gsub('&','%26') }].join('&')
+      end
+      ret = self.class.request(data, method == 'photos.upload')
+      ret = if ['true', '1'].include? ret
+              true
+            elsif ['false', '0'].include? ret
+              false
+            elsif (n = Integer(ret) rescue nil)
+              n
+            else
+              Yajl::Parser.parse(ret, :symbolize_keys => @symbolize_keys)
+            end
+      raise Facebook::Error, ret['error_msg'] if ret.is_a? Hash and ret['error_code']
+      ret
+    end
+    MimeBoundary = "--SoMeTeXtWeWiLlNeVeRsEe\r\n"
+    MimePart = %[Content-Disposition: form-data; name="%s"\r\n\r\n%s\r\n] + MimeBoundary
+    MimeImage = %[Content-Disposition: form-data; filename="%s"\r\nContent-Type: image/%s\r\n\r\n%s\r\n] + MimeBoundary
+    require 'resolv'
+    API_SERVER = Resolv.getaddress('api.facebook.com')
+    @keepalive = false
+    def self.connect
+      sock = TCPSocket.new(API_SERVER, 80)
+      begin
+        timeout = [3,0].pack('l_2') # 3 seconds
+        sock.setsockopt Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, timeout
+        sock.setsockopt Socket::SOL_SOCKET, Socket::SO_SNDTIMEO, timeout
+      rescue Exception => ex
+        # causes issues on solaris?
+        puts ex.inspect
+      end
+      sock
+    end
+    def self.request data, mime=false
+      if @keepalive
+        @socket ||= connect
+      else
+        @socket = connect
+      end
+      @socket.print "POST /restserver.php HTTP/1.1\r\n"
+      @socket.print "Host: api.facebook.com\r\n"
+      @socket.print "Connection: keep-alive\r\n" if @keepalive
+      if mime
+        @socket.print "Content-Type: multipart/form-data; boundary=#{MimeBoundary[2..-3]}\r\n"
+        @socket.print "MIME-version: 1.0\r\n"
+      else
+        @socket.print "Content-Type: application/x-www-form-urlencoded\r\n"
+      end
+      @socket.print "Content-Length: #{data.length}\r\n"
+      @socket.print "\r\n#{data}\r\n"
+      @socket.print "\r\n\r\n"
+      buf = ''
+      headers = ''
+      headers_done = false
+      chunked = true
+      while true
+        line = @socket.gets
+        headers << line unless headers_done
+        raise Errno::ECONNRESET unless line
+        if line == "\r\n" # end of headers/chunk
+          unless headers_done
+            headers_done = true
+            if headers =~ /Encoding: chunked/i
+              chunked = true
+            else
+              len = headers[/Content-Length: (\d+)/i,1].to_i
+              buf = @socket.read(len)
+              break # done!
+            end
+          end
+          line = @socket.gets # get size of next chunk
+          if line.strip! == '0' # 0 sized chunk
+            @socket.gets # read last crlf
+            break # done!
+          end
+          buf << @socket.read(line.to_i(16)) # read in chunk
+        end
+      end
+      buf
+    rescue Errno::EPIPE, Errno::ECONNRESET
+      @socket = nil
+      retry
+    ensure
+      @socket.close if @socket and !@keepalive
+    end
+  end
+  module FacebookHelper
+    def facebook
+      env['facebook.helper'] ||= FacebookObject.new(self)
+    end
+    alias fb facebook
+  end
+  class FacebookSettings
+    def initialize app, &blk
+      @app = app
+      @app.set :facebook_symbolize_keys, false
+      instance_eval &blk
+    end
+    %w[ api_key secret app_id url callback symbolize_keys ].each do |param|
+      class_eval %[
+        def #{param} val, &blk
+          @app.set :facebook_#{param}, val
+        end
+      ]
+    end
+  end
+  module Facebook
+    class Error < StandardError; end
+    def facebook &blk
+      FacebookSettings.new(self, &blk)
+    end
+    def self.registered app
+      app.helpers FacebookHelper
+      app.before(&method(:fix_request_method))
+      app.disable :sessions
+    end
+    def self.fix_request_method app
+      if method = app.request.params['fb_sig_request_method']
+        app.request.env['REQUEST_METHOD'] = method
+      end
+    end
+  end
+  Application.register Facebook
+end

data/sinbook.gemspec ADDED

@@ -0,0 +1,24 @@
+spec = Gem::Specification.new do |s|
+  s.name = 'sinbook'
+  s.version = '0.1.5'
+  s.date = '2009-11-25'
+  s.summary = 'simple sinatra facebook extension in 300 lines of ruby'
+  s.description = 'A full-featured facebook extension for the sinatra webapp framework'
+  s.homepage = "http://github.com/tmm1/sinbook"
+  s.authors = ["Aman Gupta"]
+  s.email = "aman@tmm1.net"
+  s.add_dependency('yajl-ruby')
+  s.has_rdoc = false
+  # ruby -rpp -e' pp `git ls-files | grep -v examples`.split("\n") '
+  s.files = [
+    "README",
+    "sinbook.gemspec",
+    "lib/sinbook.rb",
+    "examples/simple.rb",
+    "examples/connect.rb"
+  ]
+end

metadata ADDED

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: sinbook
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Aman Gupta
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-11-25 00:00:00 -05:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+description: A full-featured facebook extension for the sinatra webapp framework
+email: aman@tmm1.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README
+- sinbook.gemspec
+- lib/sinbook.rb
+- examples/simple.rb
+- examples/connect.rb
+has_rdoc: true
+homepage: http://github.com/tmm1/sinbook
+licenses: []
+post_install_message:
+rdoc_options: []
+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.4
+signing_key:
+specification_version: 3
+summary: simple sinatra facebook extension in 300 lines of ruby
+test_files: []