corey-facebooker 1.0.28.1

data/CHANGELOG.rdoc

@@ -0,0 +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/COPYING.rdoc

@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2007 Chad Fowler <chad@infoether.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/README.rdoc

@@ -0,0 +1,104 @@
+= Facebooker
+
+* http://facebooker.rubyforge.org
+
+== DESCRIPTION:
+
+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 (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
+
+
+== FEATURES/PROBLEMS:
+
+* Idiomatic Ruby
+* No dependencies outside of the Ruby standard library
+* Concrete classes and methods modeling the Facebook data, so it's easy for a Rubyist to understand what's available
+* Well tested
+
+== SYNOPSIS:
+
+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].
+{Join the Mailing List}:[groups.google.com/group/facebooker]
+
+== REQUIREMENTS:
+
+None
+
+== INSTALL:
+
+=== Non Rails
+
+The best way is:
+
+  gem install facebooker
+
+If, for some reason, you can't/won't use RubyGems, you can do:
+
+  (sudo) ruby setup.rb
+
+=== Rails
+
+Facebooker can be installed as a Rails plugin by:
+
+  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. 
+
+Your application users will need to have added the application in facebook to access all of facebooker's features. You enforce this by adding
+
+  ensure_application_is_installed_by_facebook_user  
+
+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)
+
+Copyright (c) 2008-2009:
+
+* Chad Fowler
+* Patrick Ewing
+* Mike Mangino
+* Shane Vitarana
+* Corey Innis
+
+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,86 @@
+# -*- ruby -*-
+# 
+require 'rubygems'
+ENV['RUBY_FLAGS']="-I#{%w(lib ext bin test).join(File::PATH_SEPARATOR)}"
+require 'hoe'
+begin
+  require 'load_multi_rails_rake_tasks'
+rescue LoadError
+  $stderr.puts "Install the multi_rails gem to run tests against multiple versions of Rails"
+end
+
+$: << File.dirname(__FILE__) + '/lib'
+require './lib/facebooker.rb'
+
+HOE = Hoe.new('facebooker', Facebooker::VERSION::STRING) do |p|
+  p.rubyforge_name = 'facebooker'
+  p.author = ['Chad Fowler', 'Patrick Ewing', 'Mike Mangino', 'Shane Vitarana', 'Corey Innis']
+  p.email = 'mmangino@elevatedrails.com'
+  p.readme_file   = 'README.rdoc'
+  p.history_file  = 'CHANGELOG.rdoc'
+  p.remote_rdoc_dir = '' # Release to root
+  p.test_globs = 'test/**/*_test.rb'
+  p.extra_deps << ['json', '>= 1.0.0'] 
+  p.extra_rdoc_files  = FileList['*.rdoc']
+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/**/*_test.rb"]
+    t.output_dir = "coverage/"
+    t.verbose = true
+    t.rcov_opts = ['--exclude', 'test,/usr/lib/ruby,/Library/Ruby,/System/Library', '--sort', 'coverage']
+  end
+end
+
+namespace :gem do
+  task :spec do
+    File.open("#{HOE.name}.gemspec", 'w') do |f|
+      f.write(HOE.spec.to_ruby)
+    end
+  end
+
+  namespace :spec do
+    task :dev do
+      File.open("#{HOE.name}.gemspec", 'w') do |f|
+        HOE.spec.version = "#{HOE.version}.#{Time.now.strftime("%Y%m%d%H%M%S")}"
+        f.write(HOE.spec.to_ruby)
+      end
+    end
+  end
+end
+
+# vim: syntax=Ruby
+# 
+# 
+# require File.dirname(__FILE__) + '/vendor/gardener/lib/gardener'
+# 
+# require 'facebooker'
+# 
+# namespace :doc do
+#   task :readme do
+#     puts "Readme"
+#   end
+# end
+# 
+# Gardener.configure do
+#   gem_spec do |spec|
+#     spec.name              = 'facebooker'
+#     spec.version           = Gem::Version.new(Facebooker::VERSION::STRING)
+#     spec.summary           = "Pure, idiomatic Ruby wrapper for the Facebook REST API."
+#     spec.email             = 'chad@infoether.com'
+#     spec.author            = ['Chad Fowler', 'Patrick Ewing','Mike Mangino','Shane Vitarana']
+#     spec.extra_rdoc_files  = %w(COPYING)
+#     spec.rdoc_options      = ['--title', "Gardener",
+#                               '--main',  'README',
+#                               '--line-numbers', '--inline-source']
+#   end
+# end

data/TODO.rdoc

@@ -0,0 +1,4 @@
+[ ] 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
+

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/generators/facebook/templates/config/facebooker.yml

@@ -0,0 +1,49 @@
+# 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: 
+    public_port: 4007
+    local_port: 3000
+    server_alive_interval: 0
+
+test:
+  api_key: 
+  secret_key: 
+  canvas_page_name: 
+  callback_url:
+  set_asset_host_to_callback_url: true
+  tunnel:
+    public_host_username: 
+    public_host: 
+    public_port: 4007
+    local_port: 3000
+    server_alive_interval: 0
+
+production:
+  api_key: 
+  secret_key: 
+  canvas_page_name: 
+  callback_url: 
+  set_asset_host_to_callback_url: true   
+  tunnel:
+    public_host_username: 
+    public_host: 
+    public_port: 4007
+    local_port: 3000
+    server_alive_interval: 0

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

@@ -0,0 +1,99 @@
+
+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) {
+  return $(form_element).serialize();
+};
+
+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);
+};

data/generators/facebook_controller/USAGE

@@ -0,0 +1,33 @@
+Description:
+    Stubs out a new controller and its views. Pass the controller name, either
+    CamelCased or under_scored, and a list of views as arguments.
+
+    To create a controller within a module, specify the controller name as a
+    path like 'parent_module/controller_name'.
+
+    This generates a controller class in app/controllers, view templates in
+    app/views/controller_name, a helper class in app/helpers, and a functional
+    test suite in test/functional.
+
+    Also, it generates fbml view templates.
+
+Example:
+    `./script/generate controller CreditCard open debit credit close`
+
+    Credit card controller with URLs like /credit_card/debit.
+        Controller: app/controllers/credit_card_controller.rb
+        Views:      app/views/credit_card/debit.html.erb [...],
+                    app/views/credit_card/debit.fbml.erb [...]		
+        Helper:     app/helpers/credit_card_helper.rb
+        Test:       test/functional/credit_card_controller_test.rb
+
+Modules Example:
+    `./script/generate controller 'admin/credit_card' suspend late_fee`
+
+    Credit card admin controller with URLs /admin/credit_card/suspend.
+        Controller: app/controllers/admin/credit_card_controller.rb
+        Views:      app/views/admin/credit_card/debit.html.erb [...],
+                    app/views/admin/credit_card/debit.fbml.erb [...]
+        Helper:     app/helpers/admin/credit_card_helper.rb
+        Test:       test/functional/admin/credit_card_controller_test.rb
+

data/generators/facebook_controller/facebook_controller_generator.rb

@@ -0,0 +1,40 @@
+class FacebookControllerGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, "#{class_name}Controller", "#{class_name}ControllerTest", "#{class_name}Helper"
+
+      # Controller, helper, views, and test directories.
+      m.directory File.join('app/controllers', class_path)
+      m.directory File.join('app/helpers', class_path)
+      m.directory File.join('app/views', class_path, file_name)
+      m.directory File.join('test/functional', class_path)
+
+      # Controller class, functional test, and helper class.
+      m.template 'controller.rb',
+                  File.join('app/controllers',
+                            class_path,
+                            "#{file_name}_controller.rb")
+
+      m.template 'functional_test.rb',
+                  File.join('test/functional',
+                            class_path,
+                            "#{file_name}_controller_test.rb")
+
+      m.template 'helper.rb',
+                  File.join('app/helpers',
+                            class_path,
+                            "#{file_name}_helper.rb")
+
+      # View template for each action.
+      actions.each do |action|
+        html_path = File.join('app/views', class_path, file_name, "#{action}.html.erb")
+        m.template 'view.html.erb', html_path,
+          :assigns => { :action => action, :path => html_path }
+        fbml_path = File.join('app/views', class_path, file_name, "#{action}.fbml.erb")
+        m.template 'view.fbml.erb', fbml_path,
+          :assigns => { :action => action, :path => fbml_path }
+      end
+    end
+  end
+end