sco-fakebook 0.1.0

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2008 Scott Raymond <sco@scottraymond.net>
+
+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/Manifest

@@ -0,0 +1,20 @@
+bin/fakebook
+lib/fakebook-assets/base.js
+lib/fakebook-assets/canvas.css
+lib/fakebook-assets/common.css
+lib/fakebook-assets/extended.js
+lib/fakebook-assets/fakebook.js
+lib/fakebook-assets/fbml.js
+lib/fakebook-assets/navigator_bg.gif
+lib/fakebook-assets/shadow_gray.gif
+lib/fakebook-assets/string.js
+lib/fakebook-assets/white.gif
+lib/fakebook.rb
+lib/node.rb
+lib/templates/minimal.html.erb
+lib/templates/standard.html.erb
+lib/tokenizer.rb
+LICENSE
+Manifest
+README
+TODO

data/README

@@ -0,0 +1,74 @@
+= Fakebook
+
+Fakebook simulates the Facebook platform, to aid in developing Facebook canvas apps offline. 
+It takes a request and passes it to the app as a POST with the fb_sig_* params added, etc. 
+The response is returned with FBML parsed (sort of) and some chrome added.
+
+In other words: you can work on Facebook canvas apps when you're on a plane.
+
+To use, run 'fakebook' from the command line to start up a Fakebook proxy. For example, if you 
+have an app running on port 3000, and the callback path is "/", and the canvas path 
+is "myapp", you would run:
+
+  $ fakebook --callback="http://localhost:3000/" --canvas="myapp"
+
+See "fakebook --help" for more options. By default, Fakebook will look for a config file at 
+./config/fakebook.yml. The file should look like this:
+
+  callback: http://localhost:3000/
+  canvas:   myapp
+  secret:   secret
+  user:     1
+  session:  session_key
+  friends:  2, 3, 4
+  host:     0.0.0.0
+  port:     5000
+
+You can also use the library directly with the Fakebook class, which eases testing:
+
+  require 'fakebook'
+  app = Fakebook.new :callback  => "http://localhost:3000/",
+                     :canvas    => "myapp",
+                     :secret    => "secret",
+                     :fb_params => { :user => 1, :session_key => 'session_key', :friends => [2, 3, 4] }
+  app.request("/")
+
+Because Fakebook implements #call according to the Rack 
+specification[http://rack.rubyforge.org/doc/files/SPEC.html], you can create an HTTP server 
+that proxies to your application using your choice of server library (Mongrel, WEBrick, Thin, 
+etc.) For example:
+
+  require 'fakebook'
+  app = Fakebook.new # etc...
+  Rack::Handler::Mongrel.run app, :Port => 5000
+
+
+== Getting started
+
+To install via RubyGems:
+
+  $ sudo gem install sco-fakebook --source http://gems.github.com/
+
+Run the executable to see the available options:
+
+  $ fakebook --help
+
+To install the development version from the repository:
+
+  $ wget http://github.com/sco/fakebook/tarball/master
+  $ tar -xvf sco-fakebook-master.tar.gz
+  $ cd sco-fakebook-master
+  $ sudo rake install_gem
+
+
+== Dependencies
+
+Ruby
+Rack >= 0.3.0
+
+
+== Author
+
+Scott Raymond <sco@scottraymond.net>
+
+Thanks to PackRat[http://apps.facebook.com/packrat/], from which this code was extracted.

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require './lib/fakebook'
+
+#begin
+#  require 'rubygems'
+#  gem 'echoe', '>=2.7'
+#  ENV['RUBY_FLAGS'] = ""
+#  require 'echoe'
+#
+#  Echoe.new('fakebook') do |p|
+#    p.project        = 'fakebook'
+#    p.rubyforge_name = 'fakebook'
+#    p.version        = Fakebook::Version
+#    p.summary        = "Simple Facebook platform simulator, to aid in developing Facebook canvas apps offline."
+#    p.description    = "Simple Facebook platform simulator, to aid in developing Facebook canvas apps offline."
+#    p.url            = "http://github.com/sco/fakebook/"
+#    p.author         = 'Scott Raymond'
+#    p.email          = "sco@scottraymond.net"
+#    p.dependencies   << 'rack >=0.3.0'
+#    p.clean_pattern.delete('lib/*-*') # so that 'rake clean' won't clobber fakebook-assets
+#  end
+#rescue LoadError => boom
+#  puts "You are missing a dependency required for meta-operations on this gem."
+#  puts "#{boom.to_s.capitalize}."
+#end
+#
+#desc 'Install as a gem'
+#task :install_gem do
+#  puts `rake manifest package && gem install pkg/fakebook-#{Fakebook::Version}.gem`
+#end
+#
+
+task :install_gem do
+  puts `gem build fakebook.gemspec && gem install fakebook-#{Fakebook::Version}.gem && rm fakebook-#{Fakebook::Version}.gem`
+end

data/TODO

@@ -0,0 +1,16 @@
+- document how to use different templates; provide config/commandline option for specifying template
+- parse_fbml needs to become a full-blown parser
+   - if-is-user
+   - is-logged-out
+   - iframe
+   - profile-pic
+   - comments
+   - possessive names
+   - share_button
+   - fb:header, create button, action link, help link, etc.
+   - fb:tabs
+   - fb:request_form
+- better handling of API requests
+- allow for per-user or per-environment configs?
+- implement ajax, including the local proxy
+- figure out what the license and attribution is for the HTML parsing stuff

data/bin/fakebook

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/fakebook'
+require 'optparse'
+require 'rack'
+
+begin
+  server = Rack::Handler::Mongrel
+rescue LoadError => e
+  server = Rack::Handler::WEBrick
+end
+rack_options = { :Port => 5000, :Host => "0.0.0.0" }
+fakebook_options = { :callback => "http://0.0.0.0:3000/", :canvas => "myapp", :secret => "secret", :fb_params => { :user => 1, :session_key => 'session_key', :friends => [2, 3, 4] } }
+config_file = "config/fakebook.yml"
+
+OptionParser.new do |opts|
+  opts.banner = "Fakebook #{Fakebook::Version}. Usage: fakebook [options]"
+
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on("-f", "--config [PATH]", "path to a YAML config file (default: #{config_file})") { |v|
+    config_file = v
+  }
+
+  opts.on("-c", "--callback [URL]", "the callback URL of your application (default: #{fakebook_options[:callback]})") { |v|
+    fakebook_options[:callback] = v
+  }
+
+  opts.on("-a", "--canvas [PATH]", "the canvas path of your application (default: #{fakebook_options[:canvas]})") { |v|
+    fakebook_options[:canvas] = v
+  }
+
+  opts.on("-s", "--secret [SECRET]", "the application secret (default: #{fakebook_options[:secret]})") { |v|
+    fakebook_options[:secret] = v
+  }
+
+  opts.on("-u", "--user [USER_ID]", "the fb id of the user (default: #{fakebook_options[:fb_params][:user]})") { |v|
+    fakebook_options[:fb_params][:user] = v
+  }
+
+  opts.on("-k", "--session [SESSION_KEY]", "the user's session key (default: #{fakebook_options[:fb_params][:session_key]})") { |v|
+    fakebook_options[:fb_params][:session_key] = v
+  }
+
+  opts.on("--friends [FRIENDS]", "the user's friends (default: #{fakebook_options[:fb_params][:friends]})") { |v|
+    fakebook_options[:fb_params][:friends] = v
+  }
+
+  opts.on("-h", "--host [HOST]", "host to listen on (default: #{rack_options[:Host]})") { |host|
+    rack_options[:Host] = host
+  }
+
+  opts.on("-p", "--port [PORT]", "port to use (default: #{rack_options[:Port]})") { |port|
+    rack_options[:Port] = port
+  }
+
+  opts.on("--server [SERVER]", "web server to (e.g., webrick, mongrel. default: mongrel)") { |s|
+    case s
+    when "mongrel"
+      server = Rack::Handler::Mongrel
+    when "webrick"
+      server = Rack::Handler::WEBrick
+    end
+  }
+
+  opts.on_tail("--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+end.parse!
+
+if File.exists?(config_file)
+  config = YAML.load_file(config_file) || {}
+  fakebook_options[:callback] = config['callback'] if config['callback']
+  fakebook_options[:canvas]   = config['canvas']   if config['canvas']
+  fakebook_options[:secret]   = config['secret']   if config['secret']
+  fakebook_options[:fb_params][:user]        = config['user']    if config['user']
+  fakebook_options[:fb_params][:session_key] = config['session'] if config['session']
+  fakebook_options[:fb_params][:friends]     = config['friends'] if config['friends']
+  rack_options[:Host] = config['host'] if config['host']
+  rack_options[:Port] = config['port'] if config['port']
+end
+
+fakebook = Fakebook.new(fakebook_options)
+app = Rack::Builder.new {
+  use Rack::CommonLogger, STDERR
+  use Rack::ShowExceptions
+  use Rack::Lint
+  run fakebook
+}
+
+STDERR.puts "Starting Fakebook proxy from http://#{rack_options[:Host]}:#{rack_options[:Port]}/#{fakebook.canvas}/ to #{fakebook.callback}"
+STDERR.puts "  Using fb_params: #{fakebook.fb_params.inspect}"
+
+server.run app, rack_options

data/fakebook.gemspec

@@ -0,0 +1,39 @@
+Gem::Specification.new do |s|
+  s.name             = "fakebook"
+  s.version          = "0.1.0" # also see fakebook.rb
+  s.date             = "2008-04-26"
+  s.summary          = "Simple Facebook platform simulator, to aid in developing Facebook canvas apps offline."
+  s.homepage         = "http://github.com/sco/fakebook"
+  s.author           = "Scott Raymond"
+  s.email            = "sco@scottraymond.net"
+  s.add_dependency   "rack", ">=0.3.0"
+  s.has_rdoc         = true
+  s.rdoc_options     = ["--main", "README"]
+  s.extra_rdoc_files = ["Manifest", "TODO", "README", "LICENSE"]
+  s.executables      = ['fakebook']
+  s.files            = ["bin/fakebook",
+                        "fakebook.gemspec",
+                        "lib/fakebook-assets/base.js",
+                        "lib/fakebook-assets/canvas.css",
+                        "lib/fakebook-assets/common.css",
+                        "lib/fakebook-assets/extended.js",
+                        "lib/fakebook-assets/fakebook.js",
+                        "lib/fakebook-assets/fbml.js",
+                        "lib/fakebook-assets/navigator_bg.gif",
+                        "lib/fakebook-assets/shadow_gray.gif",
+                        "lib/fakebook-assets/string.js",
+                        "lib/fakebook-assets/white.gif",
+                        "lib/fakebook.rb",
+                        "lib/node.rb",
+                        "lib/templates/minimal.html.erb",
+                        "lib/templates/standard.html.erb",
+                        "lib/tokenizer.rb",
+                        "LICENSE",
+                        "Manifest",
+                        "Rakefile",
+                        "README",
+                        "TODO",
+                       ]
+end
+
+#