facebooker 0.9.5 → 1.0.13

data/History.txt

@@ -1,3 +1,17 @@
+=== 1.0.13 / 2009-02-26
+
+* Modified fql_query to return results as Hashes as a last resort [Alan Larkin]
+* fixed typo in set app properties parser [Andrew Grim, shane]
+* Removed actor_id param from templatized feed [shane]
+* Added admin.get_allocation [shane]
+* Added data.get_cookies and data.set_cookie [shane]
+* Added admin.get_app_properties and admin.set_app_properties [shane]
+
+=== 0.9.9 / 2008-09-08
+
+* Re-package as gem after reworking for new API
+
+
 === 0.9.5 / 2008-02-13
 
 * Next release of documentation

data/Manifest.txt

@@ -6,45 +6,98 @@ README
 README.txt
 Rakefile
 TODO.txt
-facebooker.yml.tpl
+generators/publisher/publisher_generator.rb
+generators/facebook/facebook_generator.rb
+generators/facebook/templates/config/facebooker.yml
+generators/facebook/templates/public/javascripts/facebooker.js
+generators/facebook_controller/USAGE
+generators/facebook_controller/facebook_controller_generator.rb
+generators/facebook_controller/templates/controller.rb
+generators/facebook_controller/templates/functional_test.rb
+generators/facebook_controller/templates/helper.rb
+generators/facebook_controller/templates/view.fbml.erb
+generators/facebook_controller/templates/view.html.erb
+generators/facebook_publisher/facebook_publisher_generator.rb
+generators/facebook_publisher/templates/create_facebook_templates.rb
+generators/facebook_publisher/templates/publisher.rb
+generators/facebook_scaffold/USAGE
+generators/facebook_scaffold/facebook_scaffold_generator.rb
+generators/facebook_scaffold/templates/controller.rb
+generators/facebook_scaffold/templates/facebook_style.css
+generators/facebook_scaffold/templates/functional_test.rb
+generators/facebook_scaffold/templates/helper.rb
+generators/facebook_scaffold/templates/layout.fbml.erb
+generators/facebook_scaffold/templates/layout.html.erb
+generators/facebook_scaffold/templates/style.css
+generators/facebook_scaffold/templates/view_edit.fbml.erb
+generators/facebook_scaffold/templates/view_edit.html.erb
+generators/facebook_scaffold/templates/view_index.fbml.erb
+generators/facebook_scaffold/templates/view_index.html.erb
+generators/facebook_scaffold/templates/view_new.fbml.erb
+generators/facebook_scaffold/templates/view_new.html.erb
+generators/facebook_scaffold/templates/view_show.fbml.erb
+generators/facebook_scaffold/templates/view_show.html.erb
+generators/xd_receiver/xd_receiver_generator.rb
+generators/xd_receiver/templates/xd_receiver.html
 init.rb
 install.rb
 lib/facebooker.rb
-lib/facebooker/affiliation.rb
-lib/facebooker/album.rb
-lib/facebooker/cookie.rb
+lib/facebooker/adapters/adapter_base.rb
+lib/facebooker/adapters/bebo_adapter.rb
+lib/facebooker/adapters/facebook_adapter.rb
+lib/facebooker/admin.rb
+lib/facebooker/batch_request.rb
 lib/facebooker/data.rb
-lib/facebooker/education_info.rb
-lib/facebooker/event.rb
 lib/facebooker/feed.rb
-lib/facebooker/group.rb
-lib/facebooker/location.rb
+lib/facebooker/logging.rb
 lib/facebooker/model.rb
-lib/facebooker/notifications.rb
+lib/facebooker/models/affiliation.rb
+lib/facebooker/models/album.rb
+lib/facebooker/models/applicationproperties.rb
+lib/facebooker/models/cookie.rb
+lib/facebooker/models/education_info.rb
+lib/facebooker/models/event.rb
+lib/facebooker/models/friend_list.rb
+lib/facebooker/models/group.rb
+lib/facebooker/models/info_item.rb
+lib/facebooker/models/info_section.rb
+lib/facebooker/models/location.rb
+lib/facebooker/models/notifications.rb
+lib/facebooker/models/page.rb
+lib/facebooker/models/photo.rb
+lib/facebooker/models/tag.rb
+lib/facebooker/models/user.rb
+lib/facebooker/models/work_info.rb
 lib/facebooker/parser.rb
-lib/facebooker/photo.rb
 lib/facebooker/rails/controller.rb
 lib/facebooker/rails/facebook_asset_path.rb
 lib/facebooker/rails/facebook_form_builder.rb
+lib/facebooker/rails/facebook_pretty_errors.rb
 lib/facebooker/rails/facebook_request_fix.rb
 lib/facebooker/rails/facebook_session_handling.rb
+lib/facebooker/rails/facebook_url_helper.rb
 lib/facebooker/rails/facebook_url_rewriting.rb
 lib/facebooker/rails/helpers.rb
+lib/facebooker/rails/helpers/fb_connect.rb
+lib/facebooker/rails/profile_publisher_extensions.rb
+lib/facebooker/rails/publisher.rb
 lib/facebooker/rails/routing.rb
 lib/facebooker/rails/test_helpers.rb
 lib/facebooker/rails/utilities.rb
 lib/facebooker/server_cache.rb
 lib/facebooker/service.rb
 lib/facebooker/session.rb
-lib/facebooker/tag.rb
-lib/facebooker/user.rb
 lib/facebooker/version.rb
-lib/facebooker/work_info.rb
 lib/net/http_multipart_post.rb
 lib/tasks/facebooker.rake
 lib/tasks/tunnel.rake
+rails/init.rb
 setup.rb
+templates/layout.erb
+test/adapters_test.rb
+test/batch_request_test.rb
 test/event_test.rb
+test/facebook_admin_test.rb
 test/facebook_cache_test.rb
 test/facebook_data_test.rb
 test/facebooker_test.rb
@@ -52,9 +105,10 @@ test/fixtures/multipart_post_body_with_only_parameters.txt
 test/fixtures/multipart_post_body_with_single_file.txt
 test/fixtures/multipart_post_body_with_single_file_that_has_nil_key.txt
 test/http_multipart_post_test.rb
+test/logging_test.rb
 test/model_test.rb
+test/publisher_test.rb
 test/rails_integration_test.rb
 test/session_test.rb
 test/test_helper.rb
 test/user_test.rb
-

data/README

@@ -5,7 +5,7 @@ Copyright (c) 2007 Chad Fowler, Patrick Ewing
 Facebooker is a Ruby wrapper over the Facebook[http://facebook.com] {REST API}[http://developer.facebook.com].  Its goals are:
 
 * Idiomatic Ruby
-* No dependencies outside of the Ruby standard library
+* No dependencies outside of the Ruby standard library (This is true with Rails 2.1. Previous Rails versions require the JSON gem)
 * Concrete classes and methods modeling the Facebook data, so it's easy for a Rubyist to understand what's available
 * Well tested
 
@@ -23,7 +23,9 @@ If, for some reason, you can't/won't use RubyGems, you can do:
 
 Facebooker can be installed as a Rails plugin by:
 
-  script/plugin install http://facebooker.rubyforge.org/svn/trunk/facebooker/
+  script/plugin install git://github.com/mmangino/facebooker.git
+
+If you don't have git, the plugin can be downloaded from http://github.com/mmangino/facebooker/tarball/master
 
 Once the plugin is installed, you will need to configure your Facebook app in config/facebooker.yml. 
 

data/README.txt

@@ -4,10 +4,10 @@
 
 == DESCRIPTION:
 
-Facebooker is a Ruby wrapper over the Facebook[http://facebook.com] {REST API}[http://developer.facebook.com].  Its goals are:
+Facebooker is a Ruby wrapper over the Facebook[http://facebook.com] {REST API}[http://wiki.developers.facebook.com/index.php/API].  Its goals are:
 
 * Idiomatic Ruby
-* No dependencies outside of the Ruby standard library
+* No dependencies outside of the Ruby standard library (This is true with Rails 2.1. Previous Rails versions require the JSON gem)
 * Concrete classes and methods modeling the Facebook data, so it's easy for a Rubyist to understand what's available
 * Well tested
 
@@ -21,7 +21,7 @@ Facebooker is a Ruby wrapper over the Facebook[http://facebook.com] {REST API}[h
 
 == SYNOPSIS:
 
-  Facebooker tutorial coming soon
+View David Clements' {excellent tutorial}[http://apps.facebook.com/facebooker_tutorial] at {http://apps.facebook.com/facebooker_tutorial/}[http://apps.facebook.com/facebooker_tutorial] or check out {Developing Facebook Platform Applications with Rails}[http://www.pragprog.com/titles/mmfacer].
 
 == REQUIREMENTS:
 
@@ -43,7 +43,9 @@ If, for some reason, you can't/won't use RubyGems, you can do:
 
 Facebooker can be installed as a Rails plugin by:
 
-  script/plugin install http://facebooker.rubyforge.org/svn/trunk/facebooker/
+  script/plugin install git://github.com/mmangino/facebooker.git
+
+If you don't have git, the plugin can be downloaded from http://github.com/mmangino/facebooker/tarball/master
 
 Once the plugin is installed, you will need to configure your Facebook app in config/facebooker.yml. 
 
@@ -53,6 +55,22 @@ Your application users will need to have added the application in facebook to ac
 
 to your application controller.
 
+== using MemCache session
+
+Facebook uses some non alphanum characters in the session identifier which interfere with memcache stored sessions. If you want to use MemCache for storing sessions, you can override the valid session id method on memcache by placing the following code in an initializer:
+
+# add - as an okay key
+class CGI
+  class Session
+    class MemCacheStore
+      def check_id(id) #:nodoc:#
+        /[^0-9a-zA-Z\-\._]+/ =~ id.to_s ? false : true
+      end
+    end
+  end
+end
+
+
 == LICENSE:
 
 (The MIT License)

data/Rakefile

@@ -1,19 +1,51 @@
 # -*- ruby -*-
-
+# 
 require 'rubygems'
+ENV['RUBY_FLAGS']="-I#{%w(lib ext bin test).join(File::PATH_SEPARATOR)}"
 require 'hoe'
-$: << File.dirname(__FILE__) + '/lib'
+ $: << File.dirname(__FILE__) + '/lib'
 require './lib/facebooker.rb'
 
-Hoe.new('facebooker', Facebooker::VERSION) do |p|
+Hoe.new('facebooker', Facebooker::VERSION::STRING) do |p|
   p.rubyforge_name = 'facebooker'
-  p.author = ['Chad Fowler', 'Patrick Ewing','Mike Mangino','Shane Vitarana']
+  p.author = ['Chad Fowler', 'Patrick Ewing', 'Mike Mangino', 'Shane Vitarana', 'Corey Innis']
   p.email = 'mmangino@elevatedrails.com'
   p.summary = 'Pure, idiomatic Ruby wrapper for the Facebook REST API.'
   p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
   p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
   p.remote_rdoc_dir = '' # Release to root
+  p.test_globs = 'test/*.rb'
+  p.extra_deps << ['json', '>= 1.0.0'] 
+end
+
+require 'rcov/rcovtask'
+
+namespace :test do 
+  namespace :coverage do
+    desc "Delete aggregate coverage data."
+    task(:clean) { rm_f "coverage.data" }
+  end
+  desc 'Aggregate code coverage for unit, functional and integration tests'
+  Rcov::RcovTask.new(:coverage) do |t|
+    t.libs << "test"
+    t.test_files = FileList["test/*.rb"]
+    t.output_dir = "coverage/"
+    t.verbose = true
+  end
+end
+
+gem_spec_file = 'facebooker.gemspec'
+
+gem_spec = eval(File.read(gem_spec_file)) rescue nil
+
+desc "Generate the gemspec file."
+task :gemspec do
+  require 'erb'
+
+  File.open(gem_spec_file, 'w') do |f|
+    f.write ERB.new(File.read("#{gem_spec_file}.erb")).result(binding)
+  end
 end
 
 # vim: syntax=Ruby
@@ -23,6 +55,12 @@ end
 # 
 # require 'facebooker'
 # 
+# namespace :doc do
+#   task :readme do
+#     puts "Readme"
+#   end
+# end
+# 
 # Gardener.configure do
 #   gem_spec do |spec|
 #     spec.name              = 'facebooker'

data/TODO.txt

@@ -1,10 +1,4 @@
-[ ] Remove facebook prefix from resource routes, making them worth with facebook and regular Rails controllers
-[ ] Use fb_sig_request_method to make facebook routes more Rails-like
-[ ] Refactor facebook form builder so erbout won't be deeply nested, causing erubis to break
-[ ] Support missing parameters on methods---most notably authentication-related parameters such as next and canvas
-[ ] Finish FQL Querying
-[ ] Refactor FQL Querying
-[ ] Transform incoming data into appropriate classes (Integers, Dates, etc.)
+[ ] Document session handling. Come up with different cases and paths for the flow and create tests for each
+[ ] Verify that sessions are used only where required. Raise exceptions on User methods that require a session when none is available
+[ ] Refactor setup / Adapter loading code
 
-[x] Specify fields wanted when getting user info (defaults to all now) [shane]
-[x] Create facebooker.yml config file and merge with tunnel.yml [shane]

data/generators/facebook/facebook_generator.rb

@@ -0,0 +1,14 @@
+class FacebookGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.file 'config/facebooker.yml',            'config/facebooker.yml'
+      m.file 'public/javascripts/facebooker.js', 'public/javascripts/facebooker.js'
+    end
+  end
+
+  protected
+
+  def banner
+    "Usage: #{$0} facebooker"
+  end
+end

data/{facebooker.yml.tpl → generators/facebook/templates/config/facebooker.yml}

@@ -1,12 +1,20 @@
 # The api key, secret key, and canvas page name are required to get started
 # Tunnel configuration is only needed if you are going to use the facebooker:tunnel Rake tasks
 # Your callback url in Facebook should be set to http://public_host:public_port
+# If you're building a Facebook connect site, 
+#    change the value of set_asset_host_to_callback_url to false
+# To develop for the new profile design, add the following key..
+# api: new
+# remove the key or set it to anything else to use the old facebook design.
+# This should only be necessary until the final version of the new profile is released.
 
 development:
   api_key: 
   secret_key: 
   canvas_page_name:
   callback_url:
+  pretty_errors: true
+  set_asset_host_to_callback_url: true
   tunnel:
     public_host_username: 
     public_host: 
@@ -18,6 +26,7 @@ test:
   secret_key: 
   canvas_page_name: 
   callback_url:
+  set_asset_host_to_callback_url: true
   tunnel:
     public_host_username: 
     public_host: 
@@ -28,9 +37,10 @@ production:
   api_key: 
   secret_key: 
   canvas_page_name: 
-  callback_url:  
+  callback_url: 
+  set_asset_host_to_callback_url: true   
   tunnel:
     public_host_username: 
     public_host: 
     public_port: 4007
-    local_port: 3000
+    local_port: 3000

data/generators/facebook/templates/public/javascripts/facebooker.js

@@ -0,0 +1,106 @@
+
+function $(element) {
+  if (typeof element == "string") {
+    element=document.getElementById(element);
+  }
+  if (element)
+    extend_instance(element,Element);
+  return element;
+}
+
+function extend_instance(instance,hash) {
+  for (var name in hash) {
+    instance[name] = hash[name];
+  }
+}
+
+var Element = {
+  "hide": function () {
+    this.setStyle("display","none")
+  },
+  "show": function () {
+    this.setStyle("display","block")
+  },
+  "visible": function () {
+    return (this.getStyle("display") != "none");
+  },
+  "toggle": function () {
+    if (this.visible) {
+      this.hide();
+    } else {
+      this.show();
+    }
+  }
+};
+
+function encodeURIComponent(str) {
+  if (typeof(str) == "string") {
+    return str.replace(/=/g,'%3D').replace(/&/g,'%26');
+  }
+  //checkboxes and radio buttons return objects instead of a string
+  else if(typeof(str) == "object"){
+    for (prop in str)
+    {
+      return str[prop].replace(/=/g,'%3D').replace(/&/g,'%26');
+    }
+  }
+};
+
+var Form = {};
+Form.serialize = function(form_element) {
+  elements=$(form_element).serialize();
+  param_string="";
+  for (var name in elements) {
+    if (param_string) 
+      param_string += "&";
+    param_string += encodeURIComponent(name)+"="+encodeURIComponent(elements[name]);
+  }
+  return param_string;
+};
+
+Ajax.Updater = function (container,url,options) {
+  this.container = container;
+  this.url=url;
+  this.ajax = new Ajax();
+  this.ajax.requireLogin = 1;
+  if (options["onSuccess"]) {
+    this.ajax.responseType = Ajax.JSON;
+    this.ajax.ondone = options["onSuccess"];
+  } else {
+    this.ajax.responseType = Ajax.FBML;
+    this.ajax.ondone = function(data) {
+      $(container).setInnerFBML(data);
+    }
+  }
+  if (options["onFailure"]) {
+    this.ajax.onerror = options["onFailure"];
+  }
+
+  // Yes, this is an excercise in undoing what we just did
+  // FB doesn't provide encodeURI, but they will encode things passed as a hash
+  // so we turn it into a string, esaping & and =
+  // then we split it all back out here
+  // this could be killed if encodeURIComponent was available
+  parameters={};
+  if (options['parameters']) {
+    pairs=options['parameters'].split('&'); 
+    for (var i=0; i<pairs.length; i++) {
+      kv=pairs[i].split('=');
+      key=kv[0].replace(/%3D/g,'=').replace(/%26/g,'&');
+      val=kv[1].replace(/%3D/g,'=').replace(/%26/g,'&');
+      parameters[key]=val;
+    }
+  }
+  this.ajax.post(url,parameters); 
+  if (options["onLoading"]) {
+     options["onLoading"].call() 
+  }
+};
+Ajax.Request = function(url,options) {
+  Ajax.Updater('unused',url,options);
+};
+
+PeriodicalExecuter = function (callback, frequency) {
+        setTimeout(callback, frequency *1000);
+        setTimeout(function() { new PeriodicalExecuter(callback,frequency); }, frequency*1000);
+};