facebooker 0.9.5

data/COPYING

@@ -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/History.txt

@@ -0,0 +1,3 @@
+=== 0.9.5 / 2008-02-13
+
+* Next release of documentation

data/Manifest.txt

@@ -0,0 +1,60 @@
+CHANGELOG.txt
+COPYING
+History.txt
+Manifest.txt
+README
+README.txt
+Rakefile
+TODO.txt
+facebooker.yml.tpl
+init.rb
+install.rb
+lib/facebooker.rb
+lib/facebooker/affiliation.rb
+lib/facebooker/album.rb
+lib/facebooker/cookie.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/model.rb
+lib/facebooker/notifications.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_request_fix.rb
+lib/facebooker/rails/facebook_session_handling.rb
+lib/facebooker/rails/facebook_url_rewriting.rb
+lib/facebooker/rails/helpers.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
+setup.rb
+test/event_test.rb
+test/facebook_cache_test.rb
+test/facebook_data_test.rb
+test/facebooker_test.rb
+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/model_test.rb
+test/rails_integration_test.rb
+test/session_test.rb
+test/test_helper.rb
+test/user_test.rb
+

data/README

@@ -0,0 +1,44 @@
+Copyright (c) 2007 Chad Fowler, Patrick Ewing
+
+= Facebooker
+
+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
+* Concrete classes and methods modeling the Facebook data, so it's easy for a Rubyist to understand what's available
+* Well tested
+
+= Installing (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
+
+= Installing (Rails)
+
+Facebooker can be installed as a Rails plugin by:
+
+  script/plugin install http://facebooker.rubyforge.org/svn/trunk/facebooker/
+
+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.
+
+
+== Work in Progress
+
+I'm not saying it meets its goals fully yet.  Please help.  I'm especially interested in feedback and criticism re: Ruby style and design and testing.  RCov has the library (at the time of this writing) at 100% coverage.  I take that with a grain of salt, but it's a good start.
+
+== Contribute
+
+Please visit the {RubyForge project page}[http://rubyforge.org/projects/facebooker] to get the latest source via svn, write some tests, add/fix features, and submit a patch via the tracker.  If you submit a good patch, it's likely that I'll add you to the project for commit access if you want to be added.
+

data/README.txt

@@ -0,0 +1,79 @@
+= facebooker
+
+* http://facebooker.rubyforge.org
+
+== DESCRIPTION:
+
+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
+* 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:
+
+  Facebooker tutorial coming soon
+
+== 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 http://facebooker.rubyforge.org/svn/trunk/facebooker/
+
+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.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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,38 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+$: << File.dirname(__FILE__) + '/lib'
+require './lib/facebooker.rb'
+
+Hoe.new('facebooker', Facebooker::VERSION) do |p|
+  p.rubyforge_name = 'facebooker'
+  p.author = ['Chad Fowler', 'Patrick Ewing','Mike Mangino','Shane Vitarana']
+  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
+end
+
+# vim: syntax=Ruby
+# 
+# 
+# require File.dirname(__FILE__) + '/vendor/gardener/lib/gardener'
+# 
+# require 'facebooker'
+# 
+# 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.txt

@@ -0,0 +1,10 @@
+[ ] 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.)
+
+[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/facebooker.yml.tpl

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

data/init.rb

@@ -0,0 +1,52 @@
+require 'net/http_multipart_post'
+require 'facebooker/rails/controller'
+require 'facebooker/rails/facebook_url_rewriting'
+require 'facebooker/rails/facebook_session_handling'
+require 'facebooker/rails/facebook_asset_path'
+require 'facebooker/rails/facebook_request_fix'
+require 'facebooker/rails/routing'
+
+module ::ActionController
+  class Base
+    def self.inherited_with_facebooker(subclass)
+      inherited_without_facebooker(subclass)
+      if subclass.to_s == "ApplicationController"
+        subclass.send(:include,Facebooker::Rails::Controller) 
+        subclass.helper Facebooker::Rails::Helpers
+      end
+    end
+    class << self
+      alias_method_chain :inherited, :facebooker
+    end
+  end
+end
+
+
+class ActionController::Routing::Route
+  def recognition_conditions_with_facebooker
+    defaults = recognition_conditions_without_facebooker 
+    defaults << " env[:canvas] == conditions[:canvas] " if conditions[:canvas]
+    defaults
+  end
+  alias_method_chain :recognition_conditions, :facebooker
+end
+# We turn off route optimization to make named routes use our code for figuring out if they should go to the session
+# If this fails, it means we're on rails 1.2, we can ignore it
+begin
+  ActionController::Base::optimise_named_routes = false 
+rescue NoMethodError=>e
+  nil
+end
+# pull :canvas=> into env in routing to allow for conditions
+ActionController::Routing::RouteSet.send :include,  Facebooker::Rails::Routing::RouteSetExtensions
+ActionController::Routing::RouteSet::Mapper.send :include, Facebooker::Rails::Routing::MapperExtensions
+
+facebook_config = "#{RAILS_ROOT}/config/facebooker.yml"
+
+if File.exist?(facebook_config)
+  FACEBOOKER = YAML.load_file(facebook_config)[RAILS_ENV] 
+  ENV['FACEBOOK_API_KEY'] = FACEBOOKER['api_key']
+  ENV['FACEBOOK_SECRET_KEY'] = FACEBOOKER['secret_key']
+  ENV['FACEBOOKER_RELATIVE_URL_ROOT'] = FACEBOOKER['canvas_page_name']
+  ActionController::Base.asset_host = FACEBOOKER['callback_url']
+end

data/install.rb

@@ -0,0 +1,5 @@
+require 'fileutils'
+
+facebook_config = File.dirname(__FILE__) + '/../../../config/facebooker.yml'
+FileUtils.cp File.dirname(__FILE__) + '/facebooker.yml.tpl', facebook_config unless File.exist?(facebook_config)
+puts IO.read(File.join(File.dirname(__FILE__), 'README'))

data/lib/facebooker.rb

@@ -0,0 +1,63 @@
+
+require 'facebooker/affiliation'
+require 'facebooker/album'
+require 'facebooker/education_info'
+require 'facebooker/feed'
+require 'facebooker/location'
+require 'facebooker/model'
+require 'facebooker/notifications'
+require 'facebooker/parser'
+require 'facebooker/photo'
+require 'facebooker/cookie'
+require 'facebooker/service'
+require 'facebooker/server_cache'
+require 'facebooker/data'
+require 'facebooker/session'
+require 'facebooker/tag'
+require 'facebooker/user'
+require 'facebooker/version'
+require 'facebooker/work_info'
+require 'facebooker/event'
+require 'facebooker/group'
+module Facebooker
+  VERSION="0.9.5"
+  class << self
+    def path_prefix
+      @path_prefix
+    end
+  
+    def facebook_path_prefix=(path)
+      @facebook_path_prefix = path
+    end
+  
+    def facebook_path_prefix
+      "/" + (@facebook_path_prefix || ENV["FACEBOOK_CANVAS_PATH"] || ENV["FACEBOOKER_RELATIVE_URL_ROOT"])
+    end
+  
+    # Set the asset path to the canvas path for just this one request
+    # by definition, we will make this a canvas request
+    def with_asset_path_for_canvas
+      original_asset_host = ActionController::Base.asset_host
+      begin
+        ActionController::Base.asset_host = "http://apps.facebook.com"
+        request_for_canvas(true) do
+          yield
+        end
+      ensure
+        ActionController::Base.asset_host = original_asset_host
+      end
+    end
+  
+    # If this request is_canvas_request
+    # then use the application name as the url root
+    def request_for_canvas(is_canvas_request)
+      original_path_prefix = @path_prefix 
+      begin
+        @path_prefix = facebook_path_prefix if is_canvas_request
+        yield
+      ensure
+        @path_prefix = original_path_prefix
+      end
+    end
+  end
+end

data/lib/facebooker/affiliation.rb

@@ -0,0 +1,10 @@
+require 'facebooker/model'
+module Facebooker
+  ##
+  # Represents a user's affiliation, for example, which educational institutions
+  # the user is associated with.
+  class Affiliation
+    include Model
+    attr_accessor :name, :status, :type, :year, :nid
+  end
+end

data/lib/facebooker/album.rb

@@ -0,0 +1,11 @@
+require 'facebooker/model'
+module Facebooker
+  ##
+  # A simple representation of a photo album.
+  class Album
+    include Model
+    attr_accessor :aid, :cover_pid, :owner, :name, :created,
+                  :modified, :description, :location, :link, :size
+
+  end
+end