refacebook 0.4.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.4.0 / 2009-04-13
+
+* Cleaned up abstraction between memcache store and the refacebook class.
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/blah
+lib/blah.rb
+test/test_blah.rb

data/README.txt

@@ -0,0 +1,60 @@
+= refacebook
+
+* http://github.com/abhiyerra/refacebook/
+
+== DESCRIPTION:
+
+ReFacebook is a facebook library and Sinatra extension.
+
+== TODO:
+
+* Need to document the code.
+* Need helpers to make life easier.
+* Abstract the session store so it's not reliant on the set and get. Also,
+  remove the :store option eventually since that seems like a copout method
+  and doesn't add simplicity. 
+* Make the api spit out an exception if call returns error.
+* Have a better example application with fbml, api, and all that good stuff.
+* Write unit tests
+* Test with ruby 1.9, remove json dep if 1.9 since json is included.
+
+
+== SYNOPSIS:
+
+To see how to use the library please look at examples/example.rb
+
+== REQUIREMENTS:
+
+RubyGems
+* json
+* memcache-client
+
+== INSTALL:
+
+sudo gem sources -a http://gems.github.com
+sudo gem install abhiyerra-refacebook
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Abhi Yerra <abhi@traytwo.com>
+
+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/Rakefile

@@ -0,0 +1,55 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require './lib/refacebook.rb'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "refacebook"
+    gemspec.summary = "ReFacebook is a facebook library and Sinatra extension."
+    gemspec.email = "abhi@traytwo.com"
+    gemspec.homepage = "http://github.com/abhiyerra/refacebook"
+    gemspec.description = "ReFacebook is a facebook library and Sinatra extension."
+    gemspec.authors = ["Abhi Yerra"]
+    gemspec.rubyforge_project = "refacebook"
+
+    if defined?(JRUBY_VERSION)
+      gemspec.add_dependency("json-jruby", [">= 1.1.3"])
+    else
+      gemspec.add_dependency("json", [">= 1.1.4"])
+    end
+
+    gemspec.add_dependency("memcache-client", [">= 1.7.1"])
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/the-perfect-gem/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end
+
+# vim: syntax=Ruby

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 4
+:major: 0
+:patch: 1

data/bin/refacebook

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+abort "you need to write me"

data/examples/example.rb

@@ -0,0 +1,33 @@
+$:.push('../lib/')
+
+require 'rubygems'
+require 'sinatra'
+require 'refacebook'
+require 'refacebook/sinatra'
+require 'memcache'
+
+set :port, 3000
+
+store = MemCache.new 'localhost:11211'
+
+require_facebook(:api_key =>'2a7a86cd4ea39bb7ea4eaabb938acb86',
+                 :secret_key => '662361041ddcb4b3f7df0f4b092249ee',
+                 :canvas_url => 'http://apps.facebook.com/traytwo',
+                 :require_login => true,
+                 :store => store)
+
+get '/' do
+  body params.collect {|k,v| "#{k} = #{v}<br/>" }
+end
+
+get '/link_from_canvas' do
+  body link_from_canvas("in_canvas")
+end
+
+get '/in_canvas' do
+  if in_canvas?
+    body "yes"
+  else
+    body "no"
+  end
+end

data/lib/refacebook/sinatra.rb

@@ -0,0 +1,58 @@
+require 'sinatra/base'
+require 'refacebook'
+
+module Sinatra
+  module ReFacebookHelper
+    def in_canvas?
+      params["fb_sig_in_canvas"].eql? "1"
+    end
+
+    # Return a url prefixed with the canvas url with a path given as an argument.
+    def link_from_canvas(path="")
+      path = (path.empty? || path.eql?("/")) ? "" : "/#{path}"
+      "#{options.canvas_url}#{path}"
+    end
+
+    def fbml_redirect(url)
+      halt "<fb:redirect url=\"#{url}\" />"
+    end
+  end
+
+  module ReFacebookRegister
+    def require_facebook *args
+      settings = args[0]
+
+      configure do
+        set :canvas_url, settings[:canvas_url]
+      end
+
+      before do 
+        # Passes the request to the correct request method since canvas requests
+        # come in as POSTs.
+        if params["fb_sig_in_canvas"].eql? "1" and params["fb_sig_request_method"].eql? "GET"
+          request.env['REQUEST_METHOD'] = 'GET' 
+        end
+
+        if params['fb_sig_session_key']
+          @fbsession = settings[:store].get(params['fb_sig_session_key'])
+          @fbsession = ReFacebook::Session.new(settings[:api_key], settings[:secret_key]) unless @fbsession
+          @fbsession.update_session_params(params)
+
+          expiry = @fbsession.expires.to_i - @fbsession.time.to_i
+          settings[:store].set(params['fb_sig_session_key'], @fbsession, expiry)
+        else
+          # Just return a session, even if it's not a lasting session.
+          @fbsession = ReFacebook::Session.new(settings[:api_key], settings[:secret_key])
+        end
+
+        if settings[:require_login] and !params['fb_sig_session_key']
+          fbml_redirect(@fbsession.get_login_url(:next => link_from_canvas(request.fullpath),
+                                                 :canvas => true))
+        end
+      end
+    end
+  end
+
+  helpers ReFacebookHelper
+  register ReFacebookRegister
+end

data/lib/refacebook.rb

@@ -0,0 +1,96 @@
+require 'net/http'
+require 'uri'
+require 'md5'
+require 'json'
+
+# ReFacebook the main store for a facebook session.
+module ReFacebook
+  APIRestServer = "http://api.facebook.com/restserver.php"
+  LoginUrl = "http://www.facebook.com/login.php"
+
+  class Session
+    attr_reader :api_key, :secret, :api
+
+    attr_accessor :user, :friends, :session_key, 
+                  :expires, :time, :profile_update_time
+
+    def initialize api_key, secret
+      @api_key = api_key
+      @secret = secret
+      @api = API.new(api_key, secret)
+
+      %w{user friends session_key expires time profile_update_time}.each do |var|
+        instance_variable_set "@#{var}", nil
+      end
+    end
+
+    def update_session_params params
+      @user = params['fb_sig_user']
+      @friends = params['fb_sig_friends'].split(',')
+
+      @session_key = params['fb_sig_session_key']
+
+      @expires = params['fb_sig_expires']
+      @time = params['fb_sig_time']
+
+      @profile_update_time = params['fb_sig_profile_update_time']
+    end
+
+    def get_login_url *args
+      params = {}
+      params['v'] = '1.0'
+      params['api_key'] = @api_key
+      params['next'] = args[0][:next]
+
+      if args[0][:canvas]
+        params['canvas'] = '1'
+      end
+
+      LoginUrl + '?' + params.collect {|k,v| "#{k}=#{v}"}.join('&')
+    end
+
+    def session_key=(session_key)
+      @session_key = @api.session_key = session_key
+    end
+  end
+
+  class API
+    attr_accessor :session_key
+
+    def initialize api_key, secret
+      @api_key = api_key
+      @secret = secret
+      @session_key = nil
+    end
+
+    def method_missing method, *args
+      request = {}
+
+      args[0].each {|k,v| request[k.to_s] = v } if args[0]
+
+      request['api_key'] = @api_key
+      request['format'] = 'json' unless request['json']
+      request['method'] = method.to_s.gsub(/_/, '.')
+      request['session_key'] = @session_key if @session
+      request['v'] = '1.0' unless request['v']
+
+      request['sig'] = generate_sig(request.sort)
+
+      # FIXME: Implement.
+      return if request['method'].eql? 'batch.run'
+  
+      req = Net::HTTP.post_form(URI.parse(APIRestServer), request)
+      JSON.parse("[#{req.body}]")
+    end
+
+    private
+      # args = array of args to the request, not counting sig, formatted in non-urlencoded arg=val pairs
+      # sorted_array = alphabetically_sort_array_by_keys(args);
+      # request_str = concatenate_in_order(sorted_array);
+      # signature = md5(concatenate(request_str, secret))
+      def generate_sig args
+        request_str = args.collect { |k,v| "#{k}=#{v}" }.join ''
+        MD5.hexdigest(request_str.concat(@secret));
+      end
+  end
+end

data/test/test_refacebook.rb

@@ -0,0 +1,8 @@
+require "test/unit"
+require "refacebook"
+
+class TestRefacebook < Test::Unit::TestCase
+  def test_sanity
+    flunk "write tests or I will kneecap you"
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - '>='
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+email: abhi@traytwo.com
+cert_chain: []
+
+summary: ReFacebook is a facebook library and Sinatra extension.
+post_install_message: 
+extra_rdoc_files: 
+- README.txt
+homepage: http://github.com/abhiyerra/refacebook
+signing_key: 
+name: refacebook
+rdoc_options: 
+- --charset=UTF-8
+autorequire: 
+rubyforge_project: refacebook
+executables: 
+- refacebook
+description: ReFacebook is a facebook library and Sinatra extension.
+specification_version: 2
+default_executable: refacebook
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- VERSION.yml
+- bin/refacebook
+- examples/example.rb
+- lib/refacebook.rb
+- lib/refacebook/sinatra.rb
+- test/test_refacebook.rb
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - '>='
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+extensions: []
+
+rubygems_version: 1.3.1
+requirements: []
+
+authors: 
+- Abhi Yerra
+date: 2009-04-13 00:00:00 Z
+platform: ruby
+test_files: 
+- test/test_refacebook.rb
+- examples/example.rb
+version: !ruby/object:Gem::Version 
+  version: 0.4.1
+require_paths: 
+- lib
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - '>='
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+  type: :runtime
+  version_requirement: 
+  name: json-jruby
+- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - '>='
+      - !ruby/object:Gem::Version 
+        version: 1.7.1
+    version: 
+  type: :runtime
+  version_requirement: 
+  name: memcache-client
+bindir: bin
+has_rdoc: true