koala 0.5.0 → 0.6.0

data/CHANGELOG

@@ -1,3 +1,11 @@
+v0.6.0
+-- Added support for the old REST API thanks to cbaclig's great work
+-- Updated tests to conform to RSpec standards
+-- Updated changelog, readme, etc.
+
+v0.5.1
+-- Documentation is now on the wiki, updated readme accordingly.
+
 v0.5.0
 -- Added several new OAuth methods for making and parsing access token requests
 -- Added test suite for the OAuth class

data/Manifest

@@ -2,11 +2,15 @@ CHANGELOG
 Manifest
 Rakefile
 init.rb
+lib/graph_api.rb
 lib/http_services.rb
 lib/koala.rb
+lib/rest_api.rb
 readme.md
-test/facebook_data.yml
-test/koala/facebook_no_access_token_tests.rb
-test/koala/facebook_oauth_tests.rb
-test/koala/facebook_with_access_token_tests.rb
-test/koala_tests.rb
+spec/facebook_data.yml
+spec/koala/facebook_no_access_token_tests.rb
+spec/koala/facebook_oauth_tests.rb
+spec/koala/facebook_rest_api_no_access_token_test.rb
+spec/koala/facebook_rest_api_with_access_token_test.rb
+spec/koala/facebook_with_access_token_tests.rb
+spec/koala_spec.rb

data/Rakefile

@@ -4,11 +4,11 @@ require 'rake'
 require 'echoe'
 
 # gem management
-Echoe.new('koala', '0.5.0') do |p|
+Echoe.new('koala', '0.6.0') do |p|
   p.summary    = "A lightweight, flexible library for Facebook's new Graph API"
-  p.description = "Koala is a lightweight, flexible Ruby SDK for Facebook's new Graph API.  It allows read/write access to the Facebook Graph and provides OAuth URLs and cookie validation for Facebook Connect sites.  Koala supports Net::HTTP and Typhoeus connections out of the box and can accept custom modules for other services."
+  p.description = "Koala is a lightweight, flexible Ruby SDK for Facebook's new Graph API.  It allows read/write access to the Facebook Graph and provides OAuth URLs and cookie validation for Facebook Connect sites; it also supports access-token based interaction with the old REST API.  Koala supports Net::HTTP and Typhoeus connections out of the box and can accept custom modules for other services."
   p.url            = "http://github.com/arsduo/koala"
-  p.author         = ["Alex Koppel", "Rafi Jacoby", "Context Optional"]
+  p.author         = ["Alex Koppel", "Chris Baclig", "Rafi Jacoby", "Context Optional"]
   p.email          = "alex@alexkoppel.com"
   p.ignore_pattern = ["tmp/*", "script/*", "pkg/*"]
   p.development_dependencies = []

data/koala.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{koala}
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Alex Koppel, Rafi Jacoby, Context Optional"]
-  s.date = %q{2010-05-08}
-  s.description = %q{Koala is a lightweight, flexible Ruby SDK for Facebook's new Graph API.  It allows read/write access to the Facebook Graph and provides OAuth URLs and cookie validation for Facebook Connect sites.  Koala supports Net::HTTP and Typhoeus connections out of the box and can accept custom modules for other services.}
+  s.authors = ["Alex Koppel, Chris Baclig, Rafi Jacoby, Context Optional"]
+  s.date = %q{2010-05-17}
+  s.description = %q{Koala is a lightweight, flexible Ruby SDK for Facebook's new Graph API.  It allows read/write access to the Facebook Graph and provides OAuth URLs and cookie validation for Facebook Connect sites; it also supports access-token based interaction with the old REST API.  Koala supports Net::HTTP and Typhoeus connections out of the box and can accept custom modules for other services.}
   s.email = %q{alex@alexkoppel.com}
-  s.extra_rdoc_files = ["CHANGELOG", "lib/http_services.rb", "lib/koala.rb"]
-  s.files = ["CHANGELOG", "Manifest", "Rakefile", "init.rb", "lib/http_services.rb", "lib/koala.rb", "readme.md", "test/facebook_data.yml", "test/koala/facebook_no_access_token_tests.rb", "test/koala/facebook_oauth_tests.rb", "test/koala/facebook_with_access_token_tests.rb", "test/koala_tests.rb", "koala.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG", "lib/graph_api.rb", "lib/http_services.rb", "lib/koala.rb", "lib/rest_api.rb"]
+  s.files = ["CHANGELOG", "Manifest", "Rakefile", "init.rb", "lib/graph_api.rb", "lib/http_services.rb", "lib/koala.rb", "lib/rest_api.rb", "readme.md", "spec/facebook_data.yml", "spec/koala/facebook_no_access_token_tests.rb", "spec/koala/facebook_oauth_tests.rb", "spec/koala/facebook_rest_api_no_access_token_test.rb", "spec/koala/facebook_rest_api_with_access_token_test.rb", "spec/koala/facebook_with_access_token_tests.rb", "spec/koala_spec.rb", "koala.gemspec"]
   s.homepage = %q{http://github.com/arsduo/koala}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Koala", "--main", "readme.md"]
   s.require_paths = ["lib"]

data/lib/graph_api.rb

@@ -0,0 +1,126 @@
+module Koala
+  module Facebook
+    GRAPH_SERVER = "graph.facebook.com"
+
+    module GraphAPIMethods
+      # A client for the Facebook Graph API.
+      # 
+      # See http://developers.facebook.com/docs/api for complete documentation
+      # for the API.
+      # 
+      # The Graph API is made up of the objects in Facebook (e.g., people, pages,
+      # events, photos) and the connections between them (e.g., friends,
+      # photo tags, and event RSVPs). This client provides access to those
+      # primitive types in a generic way. For example, given an OAuth access
+      # token, this will fetch the profile of the active user and the list
+      # of the user's friends:
+      # 
+      #    graph = Koala::Facebook::GraphAPI.new(access_token)
+      #    user = graph.get_object("me")
+      #    friends = graph.get_connections(user["id"], "friends")
+      # 
+      # You can see a list of all of the objects and connections supported
+      # by the API at http://developers.facebook.com/docs/reference/api/.
+      # 
+      # You can obtain an access token via OAuth or by using the Facebook
+      # JavaScript SDK. See http://developers.facebook.com/docs/authentication/
+      # for details.
+      # 
+      # If you are using the JavaScript SDK, you can use the
+      # Koala::Facebook::OAuth.get_user_from_cookie() method below to get the OAuth access token
+      # for the active user from the cookie saved by the SDK.
+            
+      def get_object(id, args = {})
+        # Fetchs the given object from the graph.
+        api(id, args)
+      end
+    
+      def get_objects(ids, args = {})
+        # Fetchs all of the given object from the graph.
+        # We return a map from ID to object. If any of the IDs are invalid,
+        # we raise an exception.
+        api("", args.merge("ids" => ids.join(",")))
+      end
+    
+      def get_connections(id, connection_name, args = {})
+        # Fetchs the connections for given object.
+        api("#{id}/#{connection_name}", args)
+      end
+    
+      def put_object(parent_object, connection_name, args = {})
+        # Writes the given object to the graph, connected to the given parent.
+        # 
+        # For example,
+        # 
+        #     graph.put_object("me", "feed", :message => "Hello, world")
+        # 
+        # writes "Hello, world" to the active user's wall. Likewise, this
+        # will comment on a the first post of the active user's feed:
+        # 
+        #     feed = graph.get_connections("me", "feed")
+        #     post = feed["data"][0]
+        #     graph.put_object(post["id"], "comments", :message => "First!")
+        # 
+        # See http://developers.facebook.com/docs/api#publishing for all of
+        # the supported writeable objects.
+        # 
+        # Most write operations require extended permissions. For example,
+        # publishing wall posts requires the "publish_stream" permission. See
+        # http://developers.facebook.com/docs/authentication/ for details about
+        # extended permissions.
+
+        raise APIError.new({"type" => "KoalaMissingAccessToken", "message" => "Write operations require an access token"}) unless @access_token
+        api("#{parent_object}/#{connection_name}", args, "post")
+      end
+    
+      def put_wall_post(message, attachment = {}, profile_id = "me")
+        # Writes a wall post to the given profile's wall.
+        # 
+        # We default to writing to the authenticated user's wall if no
+        # profile_id is specified.
+        # 
+        # attachment adds a structured attachment to the status message being
+        # posted to the Wall. It should be a dictionary of the form:
+        # 
+        #     {"name": "Link name"
+        #      "link": "http://www.example.com/",
+        #      "caption": "{*actor*} posted a new review",
+        #      "description": "This is a longer description of the attachment",
+        #      "picture": "http://www.example.com/thumbnail.jpg"}
+
+        self.put_object(profile_id, "feed", attachment.merge({:message => message}))
+      end
+    
+      def put_comment(object_id, message)
+        # Writes the given comment on the given post.
+        self.put_object(object_id, "comments", {:message => message})
+      end
+    
+      def put_like(object_id)
+        # Likes the given post.
+        self.put_object(object_id, "likes")
+      end
+    
+      def delete_object(id)
+        # Deletes the object with the given ID from the graph.
+        api(id, {}, "delete")
+      end
+    
+      def search(search_terms, args = {})
+        # Searches for a given term
+        api("search", args.merge({:q => search_terms}))
+      end
+    
+      def api(*args)
+        response = super
+        
+        # check for errors
+        if response.is_a?(Hash) && error_details = response["error"]
+          raise APIError.new(error_details)
+        end
+      
+        response
+      end
+    end
+  end
+end

data/lib/http_services.rb

@@ -6,14 +6,15 @@ module Koala
         require 'net/http' unless defined?(Net::HTTP)
         require 'net/https'
 
-        def self.make_request(path, args, verb)
+        def self.make_request(path, args, verb, options = {})
           # We translate args to a valid query string. If post is specified,
           # we send a POST request to the given path with the given arguments.
 
           # if the verb isn't get or post, send it as a post argument
           args.merge!({:method => verb}) && verb = "post" if verb != "get" && verb != "post"
 
-          http = Net::HTTP.new(Facebook::GRAPH_SERVER, 443)
+          server = options[:rest_api] ? Facebook::REST_SERVER : Facebook::GRAPH_SERVER
+          http = Net::HTTP.new(server, 443)
           http.use_ssl = true
           # we turn off certificate validation to avoid the 
           # "warning: peer certificate won't be verified in this SSL session" warning
@@ -46,13 +47,14 @@ module Koala
       base.class_eval do
         require 'typhoeus' unless defined?(Typhoeus)
         include Typhoeus
-        
-        def self.make_request(path, args, verb)
+
+        def self.make_request(path, args, verb, options = {})
           # if the verb isn't get or post, send it as a post argument
           args.merge!({:method => verb}) && verb = "post" if verb != "get" && verb != "post"
-          self.send(verb, "https://#{Facebook::GRAPH_SERVER}/#{path}", :params => args).body
+          server = options[:rest_api] ? Facebook::REST_SERVER : Facebook::GRAPH_SERVER
+          self.send(verb, "https://#{server}/#{path}", :params => args).body
         end
-      end      
+      end # class_eval
     end
   end
 end

data/lib/koala.rb

@@ -8,6 +8,12 @@ require 'json'
 # include default http services
 require 'http_services'
 
+# add Graph API methods
+require 'graph_api'
+
+# add REST API methods
+require 'rest_api'
+
 module Koala
     
   module Facebook
@@ -32,151 +38,50 @@ module Koala
     # http://developers.facebook.com/docs/api. You can download the Facebook
     # JavaScript SDK at http://github.com/facebook/connect-js/.
 
-    GRAPH_SERVER = "graph.facebook.com"
-
-    class GraphAPI
-      # A client for the Facebook Graph API.
-      # 
-      # See http://developers.facebook.com/docs/api for complete documentation
-      # for the API.
-      # 
-      # The Graph API is made up of the objects in Facebook (e.g., people, pages,
-      # events, photos) and the connections between them (e.g., friends,
-      # photo tags, and event RSVPs). This client provides access to those
-      # primitive types in a generic way. For example, given an OAuth access
-      # token, this will fetch the profile of the active user and the list
-      # of the user's friends:
-      # 
-      #    graph = Koala::Facebook::GraphAPI.new(access_token)
-      #    user = graph.get_object("me")
-      #    friends = graph.get_connections(user["id"], "friends")
-      # 
-      # You can see a list of all of the objects and connections supported
-      # by the API at http://developers.facebook.com/docs/reference/api/.
-      # 
-      # You can obtain an access token via OAuth or by using the Facebook
-      # JavaScript SDK. See http://developers.facebook.com/docs/authentication/
-      # for details.
-      # 
-      # If you are using the JavaScript SDK, you can use the
-      # Koala::Facebook::OAuth.get_user_from_cookie() method below to get the OAuth access token
-      # for the active user from the cookie saved by the SDK.
-            
+    class API
       # initialize with an access token 
       def initialize(access_token = nil)
         @access_token = access_token
       end
-    
-      def get_object(id, args = {})
-        # Fetchs the given object from the graph.
-        api(id, args)
-      end
-    
-      def get_objects(ids, args = {})
-        # Fetchs all of the given object from the graph.
-        # We return a map from ID to object. If any of the IDs are invalid,
-        # we raise an exception.
-        api("", args.merge("ids" => ids.join(",")))
-      end
-    
-      def get_connections(id, connection_name, args = {})
-        # Fetchs the connections for given object.
-        api("#{id}/#{connection_name}", args)
-      end
-    
-      def put_object(parent_object, connection_name, args = {})
-        # Writes the given object to the graph, connected to the given parent.
-        # 
-        # For example,
-        # 
-        #     graph.put_object("me", "feed", :message => "Hello, world")
-        # 
-        # writes "Hello, world" to the active user's wall. Likewise, this
-        # will comment on a the first post of the active user's feed:
-        # 
-        #     feed = graph.get_connections("me", "feed")
-        #     post = feed["data"][0]
-        #     graph.put_object(post["id"], "comments", :message => "First!")
-        # 
-        # See http://developers.facebook.com/docs/api#publishing for all of
-        # the supported writeable objects.
-        # 
-        # Most write operations require extended permissions. For example,
-        # publishing wall posts requires the "publish_stream" permission. See
-        # http://developers.facebook.com/docs/authentication/ for details about
-        # extended permissions.
-
-        raise GraphAPIError.new({"type" => "KoalaMissingAccessToken", "message" => "Write operations require an access token"}) unless @access_token
-        api("#{parent_object}/#{connection_name}", args, "post")
-      end
-    
-      def put_wall_post(message, attachment = {}, profile_id = "me")
-        # Writes a wall post to the given profile's wall.
-        # 
-        # We default to writing to the authenticated user's wall if no
-        # profile_id is specified.
-        # 
-        # attachment adds a structured attachment to the status message being
-        # posted to the Wall. It should be a dictionary of the form:
-        # 
-        #     {"name": "Link name"
-        #      "link": "http://www.example.com/",
-        #      "caption": "{*actor*} posted a new review",
-        #      "description": "This is a longer description of the attachment",
-        #      "picture": "http://www.example.com/thumbnail.jpg"}
-
-        self.put_object(profile_id, "feed", attachment.merge({:message => message}))
-      end
-    
-      def put_comment(object_id, message)
-        # Writes the given comment on the given post.
-        self.put_object(object_id, "comments", {:message => message})
-      end
-    
-      def put_like(object_id)
-        # Likes the given post.
-        self.put_object(object_id, "likes")
-      end
-    
-      def delete_object(id)
-        # Deletes the object with the given ID from the graph.
-        api(id, {}, "delete")
-      end
-    
-      def search(search_terms, args = {})
-        # Searches for a given term
-        api("search", args.merge({:q => search_terms}))
-      end
-    
-      def api(path, args = {}, verb = "get")
+      
+      def api(path, args = {}, verb = "get", options = {})
         # Fetches the given path in the Graph API.
         args["access_token"] = @access_token if @access_token
         
         # make the request via the provided service
-        result = Koala.make_request(path, args, verb)
+        result = Koala.make_request(path, args, verb, options)
       
         # Facebook sometimes sends results like "true" and "false", which aren't strictly object
         # and cause JSON.parse to fail
         # so we account for that
         response = JSON.parse("[#{result}]")[0]
 
-        # check for errors
-        if response.is_a?(Hash) && error_details = response["error"]
-          raise GraphAPIError.new(error_details)
-        end
-      
         response
       end
     end
-  
-    class GraphAPIError < Exception
+    
+    class GraphAPI < API
+      include GraphAPIMethods
+    end
+    
+    class RestAPI < API
+      include RestAPIMethods
+    end
+    
+    class GraphAndRestAPI < API
+      include GraphAPIMethods
+      include RestAPIMethods
+    end
+    
+    class APIError < Exception
       attr_accessor :fb_error_type
       def initialize(details = {})
         self.fb_error_type = details["type"]  
         super("#{fb_error_type}: #{details["message"]}")
       end
     end
-  
+    
+    
     class OAuth
       attr_accessor :app_id, :app_secret, :oauth_callback_url
       def initialize(app_id, app_secret, oauth_callback_url = nil)
@@ -260,7 +165,7 @@ module Koala
         result = fetch_token_string(code)
         
         # if we have an error, parse the error JSON and raise an error
-        raise GraphAPIError.new((JSON.parse(result)["error"] rescue nil) || {}) if result =~ /error/
+        raise APIError.new((JSON.parse(result)["error"] rescue nil) || {}) if result =~ /error/
         # otherwise, parse the access token
         parse_access_token(result)
       end
@@ -280,4 +185,4 @@ module Koala
   rescue LoadError
     Koala.http_service = NetHTTPService
   end
-end
+end

data/lib/rest_api.rb

@@ -0,0 +1,28 @@
+module Koala
+  module Facebook
+    REST_SERVER = "api.facebook.com"
+    
+    module RestAPIMethods
+      def fql_query(fql)
+        args = {
+          "query" => fql,
+          "format" => "json",
+        }
+
+        api('method/fql.query', args, 'get', :rest_api => true)
+      end
+      
+      def api(*args)
+        response = super
+        
+        # check for REST API-specific errors
+        if response.is_a?(Hash) && response["error_code"]
+          raise APIError.new("type" => response["error_code"], "message" => response["error_msg"])
+        end
+        
+        response
+      end
+    end
+    
+  end # module Facebook
+end # module Koala

data/readme.md

@@ -18,9 +18,19 @@ If you're using Koala within a web application with the Facebook
 [JavaScript SDK](http://github.com/facebook/connect-js), you can use the Koala::Facebook::OAuth class 
 to parse the cookies set by the JavaScript SDK for logged in users.
 
+FQL and the old-school REST API
+-----
+Where the Graph API and the old REST API overlap, you should choose the Graph API.  Unfortunately, that overlap is far from complete, and there are many important API calls -- including fql.query -- that can't yet be done via the Graph.  
+
+Koala now supports the old-school REST API using OAuth access tokens; to use this, instantiate your class using the GraphAndRestAPI class:
+
+	api = Koala::Facebook::GraphAndRestAPI.new(oauth_access_token)
+
+The GraphAndRestAPI class provides access to all the Graph API methods, as well as an fql method that you can use to make FQL calls.  (You can pass the :rest\_api => true option to the api method to make REST API calls; check out lib/rest\_api.rb to see how it's done.)  We reserve the right to expand the built-in REST API coverage to additional methods in the future, depending on how fast Facebook moves to fill in the gaps.  
+
 Examples and More Details 
 -----
-There's a very detailed description and walkthrough of Koala at <a href="http://blog.twoalex.com/2010/05/03/introducing-koala-a-new-gem-for-facebooks-new-graph-api/">http://blog.twoalex.com/2010/05/03/introducing-koala-a-new-gem-for-facebooks-new-graph-api/</a>.
+Complete Koala documentation can now be found <a href="http://wiki.github.com/arsduo/koala/">on the wiki</a>!
 
 You can easily generate OAuth access tokens and any other data needed to play with the Graph API or OAuth at the Koala-powered <a href="http://oauth.twoalex.com" target="_blank">OAuth Playground</a>.
 
@@ -28,17 +38,15 @@ You can easily generate OAuth access tokens and any other data needed to play wi
 Testing
 -----
 
-Unit tests are provided for Graph API methods.  However, because the Graph API uses access tokens, which expire, you have to provide your own token with stream publishing permissions for the tests.  Insert the token value into the file test/facebook_data.yml, then run the test as follows:
+Unit tests are provided for all of Koala's methods; however, because the OAuth access tokens and cookies expire, you have to provide some of your own data: a valid OAuth access token with publish_stream and read_stream permissions and an OAuth code that can be used to generate an access token.  (The file also provides valid values for other tests, which you're welcome to sub out for data specific to your own application.)
+
+Insert the required values into the file test/facebook_data.yml, then run the test as follows:
     spec koala_tests.rb
     
-Unit tests for cookie validation and other methods in the OAuth class will be provided shortly.  (You'll also need to add that information into the yml.)
-
 
 Coming Soon
 -----
-1. OAuth class methods to parse the results of the access token call
-2. OAuth class method to directly fetch the access token when given a code value
-
+* Support for real-time updates
 
 Known Issues
 -----

data/{test → spec}/facebook_data.yml

@@ -1,19 +1,17 @@
-# Check out http://oauth.twoalex.com to easily generate tokens, cookies, etc.
+# Check out http://oauth.twoalex.com/ to easily generate tokens, cookies, etc.
 # Those values will work with the default settings in this yaml.
 # Of course, you can change this to work with your own app.
 # Just remember to update all fields!
-
-# for testing the GraphAPI class
-# OAuth token should have publish_stream and read_stream permissions 
-oauth_token: 119908831367602|2.8VK0rWWLe3y4L8JfrpBupA__.3600.1273370400-2905623|u-QAARJz9UeZrF6ef2qu-Fk4UH0.
+ 
+# You must supply this value yourself to test the GraphAPI class.
+# Your OAuth token should have publish_stream and read_stream permissions.
+oauth_token: 
 
 # for testing the OAuth class    
 # baseline app
-oauth_test_data:
-  # You must supply these values yourself, since they will expire.
-  valid_cookies: # note: the tests stub the time class so these default cookies are always valid
-    fbs_119908831367602: '"access_token=119908831367602|2.LKE7ksSPOx0V_8mHPr2NHQ__.3600.1273363200-2905623|CMpi0AYbn03Oukzv94AUha2qbO4.&expires=1273363200&secret=lT_9zm5r5IbJ6Aa5O54nFw__&session_key=2.LKE7ksSPOx0V_8mHPr2NHQ__.3600.1273363200-2905623&sig=9515e93113921f9476a4efbdd4a3c746&uid=2905623"'
-  code: 2.6GneoQbnEqtSiPppZzDU4Q__.3600.1273366800-2905623|vdiZmnxKxh4WVSnxBxoEvcBfamU.
+oauth_test_data: 
+  # You must supply this value yourself, since they will expire.
+  code: 
     
   # These values will work out of the box
   app_id: 119908831367602
@@ -21,6 +19,10 @@ oauth_test_data:
   callback_url: http://oauth.twoalex.com/
   raw_token_string: "access_token=119908831367602|2.6GneoQbnEqtSiPppZzDU4Q__.3600.1273366800-2905623|3OLa3w0x1K4C1S5cOgbs07TytAk.&expires=6621"
   raw_offline_access_token_string: access_token=119908831367602|2.6GneoQbnEqtSiPppZzDU4Q__.3600.1273366800-2905623|3OLa3w0x1K4C1S5cOgbs07TytAk.
+  valid_cookies: 
+    # note: the tests stub the time class so these default cookies are always valid (if you're using the default app)
+    # if not you may want to remove the stubbing to test expiration
+    fbs_119908831367602: '"access_token=119908831367602|2.LKE7ksSPOx0V_8mHPr2NHQ__.3600.1273363200-2905623|CMpi0AYbn03Oukzv94AUha2qbO4.&expires=1273363200&secret=lT_9zm5r5IbJ6Aa5O54nFw__&session_key=2.LKE7ksSPOx0V_8mHPr2NHQ__.3600.1273363200-2905623&sig=9515e93113921f9476a4efbdd4a3c746&uid=2905623"'
   expired_cookies:
     fbs_119908831367602: '"access_token=119908831367602|2.xv9mi6QSOpr474s4n2X_pw__.3600.1273287600-2905623|yVt5WH_S6J5p3gFa5_5lBzckhws.&expires=1273287600&secret=V_E79ovQnXqxGctFuC_n5A__&session_key=2.xv9mi6QSOpr474s4n2X_pw__.3600.1273287600-2905623&sig=eeef60838c0c800258d89b7e6ddddddb&uid=2905623"'
   offline_access_cookies: 

data/{test → spec}/koala/facebook_no_access_token_tests.rb

@@ -25,12 +25,7 @@ class FacebookNoAccessTokenTests < Test::Unit::TestCase
     end
   
     it "should not be able to get data about 'me'" do
-      begin
-        @graph.get_object("me")
-      rescue Koala::Facebook::GraphAPIError => @right_err
-      rescue Exception => wrong_err
-      end
-      @right_err.should_not be_nil
+      lambda { @graph.get_object("me") }.should raise_error(Koala::Facebook::APIError)
     end
   
     it "should be able to get multiple objects" do
@@ -39,12 +34,7 @@ class FacebookNoAccessTokenTests < Test::Unit::TestCase
     end
   
     it "shouldn't be able to access connections from users" do
-      begin
-        @graph.get_connections("lukeshepard", "likes")
-      rescue Koala::Facebook::GraphAPIError => @right_err
-      rescue Exception => wrong_err
-      end
-      @right_err.should_not be_nil
+      lambda { @graph.get_connections("lukeshepard", "likes") }.should raise_error(Koala::Facebook::APIError)
     end
 
     it "should be able to access connections from public Pages" do
@@ -53,53 +43,34 @@ class FacebookNoAccessTokenTests < Test::Unit::TestCase
     end
   
     it "should not be able to put an object" do
-      begin
-        @result = @graph.put_object("lukeshepard", "feed", :message => "Hello, world")
-      rescue Koala::Facebook::GraphAPIError => @right_err
-      rescue Exception => wrong_err
-      end
-      @right_err.should_not be_nil
+      lambda { @result = @graph.put_object("lukeshepard", "feed", :message => "Hello, world") }.should raise_error(Koala::Facebook::APIError)
+      puts "Error!  Object #{@result.inspect} somehow put onto Luke Shepard's wall!" if @result
     end
 
     # these are not strictly necessary as the other put methods resolve to put_object, but are here for completeness
     it "should not be able to post to a feed" do
-      begin
-        @result = @graph.put_wall_post("Hello, world", {:name => "Context Optional", :link => "http://www.contextoptional.com/"}, "contextoptional")
-      rescue Koala::Facebook::GraphAPIError => @right_err
-      rescue Exception => wrong_err
-      end
-      @right_err.should_not be_nil
+      (lambda do
+        attachment = {:name => "Context Optional", :link => "http://www.contextoptional.com/"}
+        @result = @graph.put_wall_post("Hello, world", attachment, "contextoptional") 
+      end).should raise_error(Koala::Facebook::APIError)
+      puts "Error!  Object #{@result.inspect} somehow put onto Context Optional's wall!" if @result
     end
 
     it "should not be able to comment on an object" do
-      begin
-        # random public post on the ContextOptional wall
-        @result = @graph.put_comment("7204941866_119776748033392", "The hackathon was great!")
-      rescue Koala::Facebook::GraphAPIError => @right_err
-      rescue Exception => wrong_err
-      end
-      @right_err.should_not be_nil
+      # random public post on the ContextOptional wall
+      lambda { @result = @graph.put_comment("7204941866_119776748033392", "The hackathon was great!") }.should raise_error(Koala::Facebook::APIError)
+      puts "Error!  Object #{@result.inspect} somehow commented on post 7204941866_119776748033392!" if @result    
     end
 
     it "should not be able to like an object" do
-      begin
-        @result = @graph.put_like("7204941866_119776748033392")
-      rescue Koala::Facebook::GraphAPIError => @right_err
-      rescue Exception => wrong_err
-      end
-      @right_err.should_not be_nil
+      lambda { @graph.put_like("7204941866_119776748033392") }.should raise_error(Koala::Facebook::APIError)
     end
 
 
     # DELETE
     it "should not be able to delete posts" do 
-      begin
-        # test post on the Ruby SDK Test application
-        @result = @graph.delete_object("115349521819193_113815981982767")
-      rescue Koala::Facebook::GraphAPIError => @right_err
-      rescue Exception => wrong_err
-      end
-      @right_err.should_not be_nil
+      # test post on the Ruby SDK Test application
+      lambda { @result = @graph.delete_object("115349521819193_113815981982767") }.should raise_error(Koala::Facebook::APIError)
     end
 
     # SEARCH

data/{test → spec}/koala/facebook_oauth_tests.rb

@@ -123,13 +123,7 @@ class FacebookOAuthTests < Test::Unit::TestCase
 
     it "should raise an exception if no callback is given in initialization or the call" do 
       oauth2 = Koala::Facebook::OAuth.new(@app_id, @secret)
-      begin
-        url = oauth2.url_for_oauth_code
-      rescue ArgumentError => @right_err
-      rescue
-      end
-      
-      @right_err.should
+      lambda { oauth2.url_for_oauth_code }.should raise_error(ArgumentError)
     end
 
     # url_for_access_token
@@ -190,12 +184,7 @@ class FacebookOAuthTests < Test::Unit::TestCase
     end
 
     it "should raise an error when get_access_token is called with a bad code" do
-      begin
-        result = @oauth.get_access_token("foo")
-      rescue Koala::Facebook::GraphAPIError => @right_err
-      rescue
-      end
-      @right_err.should
+      lambda { @oauth.get_access_token("foo") }.should raise_error(Koala::Facebook::APIError) 
     end
   end # describe
 

data/spec/koala/facebook_rest_api_no_access_token_test.rb

@@ -0,0 +1,20 @@
+class FacebookRestAPINoAccessTokenTest < Test::Unit::TestCase
+  
+  describe "Koala RestAPI without an access token" do
+    before :each do
+      @graph = Koala::Facebook::RestAPI.new
+    end
+  
+    # FQL
+    it "should be able to access public information via FQL" do
+      @result = @graph.fql_query('select first_name from user where uid = 216743')
+      @result.size.should == 1
+      @result.first['first_name'].should == 'Chris'
+    end
+    
+    it "should not be able to access protected information via FQL" do
+      lambda { @graph.fql_query("select read_stream from permissions where uid = 216743") }.should raise_error(Koala::Facebook::APIError)
+    end
+  end
+  
+end

data/spec/koala/facebook_rest_api_with_access_token_test.rb

@@ -0,0 +1,33 @@
+class FacebookRestAPIWithAccessTokenTests < Test::Unit::TestCase
+  describe "Koala RestAPI with an access token" do
+    before :each do
+      @token = $testing_data["oauth_token"]
+      raise Exception, "Must supply access token to run FacebookRestAPIWithAccessTokenTests!" unless @token
+      @rest = Koala::Facebook::RestAPI.new(@token)
+    end
+
+    # FQL
+    it "should be able to access public information via FQL" do
+      result = @rest.fql_query('select first_name from user where uid = 216743')
+      result.size.should == 1
+      result.first['first_name'].should == 'Chris'
+    end
+
+    it "should be able to access protected information via FQL" do
+      # Tests agains the permissions fql table
+      
+      # get the current user's ID
+      # we're sneakily using the Graph API, which should be okay since it has its own tests
+      g = Koala::Facebook::GraphAPI.new(@token)
+      id = g.get_object("me", :fields => "id")["id"]
+
+      # now send a query about your permissions
+      result = @rest.fql_query("select read_stream from permissions where uid = #{id}")
+  
+      result.size.should == 1
+      # we assume that you have read_stream permissions, so we can test against that
+      # (should we keep this?)
+      result.first["read_stream"].should == 1
+    end
+  end
+end

data/{test/koala_tests.rb → spec/koala_spec.rb}

@@ -9,6 +9,8 @@ require 'koala'
 require 'koala/facebook_no_access_token_tests'
 require 'koala/facebook_with_access_token_tests'
 require 'koala/facebook_oauth_tests'
+require 'koala/facebook_rest_api_with_access_token_test'
+require 'koala/facebook_rest_api_no_access_token_test'
 
 class FacebookTestSuite
   def self.suite
@@ -16,6 +18,8 @@ class FacebookTestSuite
     suite << FacebookNoAccessTokenTests.suite
     suite << FacebookWithAccessTokenTests.suite
     suite << FacebookOAuthTests.suite
+    suite << FacebookRestAPIWithAccessTokenTests.suite
+    suite << FacebookRestAPINoAccessTokenTest.suite
     suite
   end
 end
@@ -29,7 +33,6 @@ unless $testing_data["oauth_token"]
   puts "Access token tests will fail until you store a valid token in facebook_data.yml"
 end
 
-# TODO finish tests for OAuth class
-# unless $testing_data["cookie_hash"] && $testing_data["app_id"] && $testing_data["secret"]
-#   puts "Cookie tests will fail until you store valid data for the cookie hash, app_id, and app secret in facebook_data.yml"
-# end
+unless $testing_data["oauth_test_data"] && $testing_data["oauth_test_data"]["code"] && $testing_data["oauth_test_data"]["secret"]
+  puts "Cookie tests will fail until you store valid data for the cookie hash, app_id, and app secret in facebook_data.yml"
+end

metadata

@@ -4,21 +4,21 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
-- Alex Koppel, Rafi Jacoby, Context Optional
+- Alex Koppel, Chris Baclig, Rafi Jacoby, Context Optional
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-05-08 00:00:00 -07:00
+date: 2010-05-17 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: Koala is a lightweight, flexible Ruby SDK for Facebook's new Graph API.  It allows read/write access to the Facebook Graph and provides OAuth URLs and cookie validation for Facebook Connect sites.  Koala supports Net::HTTP and Typhoeus connections out of the box and can accept custom modules for other services.
+description: Koala is a lightweight, flexible Ruby SDK for Facebook's new Graph API.  It allows read/write access to the Facebook Graph and provides OAuth URLs and cookie validation for Facebook Connect sites; it also supports access-token based interaction with the old REST API.  Koala supports Net::HTTP and Typhoeus connections out of the box and can accept custom modules for other services.
 email: alex@alexkoppel.com
 executables: []
 
@@ -26,21 +26,27 @@ extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG
+- lib/graph_api.rb
 - lib/http_services.rb
 - lib/koala.rb
+- lib/rest_api.rb
 files: 
 - CHANGELOG
 - Manifest
 - Rakefile
 - init.rb
+- lib/graph_api.rb
 - lib/http_services.rb
 - lib/koala.rb
+- lib/rest_api.rb
 - readme.md
-- test/facebook_data.yml
-- test/koala/facebook_no_access_token_tests.rb
-- test/koala/facebook_oauth_tests.rb
-- test/koala/facebook_with_access_token_tests.rb
-- test/koala_tests.rb
+- spec/facebook_data.yml
+- spec/koala/facebook_no_access_token_tests.rb
+- spec/koala/facebook_oauth_tests.rb
+- spec/koala/facebook_rest_api_no_access_token_test.rb
+- spec/koala/facebook_rest_api_with_access_token_test.rb
+- spec/koala/facebook_with_access_token_tests.rb
+- spec/koala_spec.rb
 - koala.gemspec
 has_rdoc: true
 homepage: http://github.com/arsduo/koala