koala 0.4 → 0.4.1

data/CHANGELOG

@@ -1,5 +1,12 @@
+v0.4.1
+-- Encapsulated GraphAPI and OAuth classes in the Koala::Facebook module for clarity (and to avoid claiming the global Facebook class)
+-- Moved make_request method to Koala class from GraphAPI instance (for use by future OAuth class functionality)
+-- Renamed request method to api for consistancy with Javascript library
+-- Updated tests and readme
+
 v0.4.0
 -- Adopted the Koala name
+-- Updated readme and tests
 -- Fixed cookie verification bug for non-expiring OAuth tokens
 
 v0.3.1

data/Rakefile

@@ -4,12 +4,12 @@ require 'rake'
 require 'echoe'
 
 # gem management
-Echoe.new('koala', '0.4') do |p|
+Echoe.new('koala', '0.4.1') 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.url            = "http://github.com/arsduo/ruby-sdk"
   p.author         = ["Alex Koppel", "Rafi Jacoby", "Context Optional"]
   p.email          = "alex@alexkoppel.com"
-  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.ignore_pattern = ["tmp/*", "script/*", "pkg/*"]
   p.development_dependencies = []
 end

data/koala.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{koala}
-  s.version = "0.4"
+  s.version = "0.4.1"
 
   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-01}
+  s.date = %q{2010-05-03}
   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.email = %q{alex@alexkoppel.com}
   s.extra_rdoc_files = ["CHANGELOG", "lib/http_services.rb", "lib/koala.rb"]

data/lib/http_services.rb

@@ -1,60 +1,58 @@
 module Koala
-  class GraphAPI
-    module NetHTTPService
-      # this service uses Net::HTTP to send requests to the graph
-      def self.included(base)
-        base.class_eval do
-          require 'net/http' unless defined?(Net::HTTP)
-          require 'net/https'
-        end
-      end
-    
-      def make_request(path, args, verb)
-        # 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.
+  module NetHTTPService
+    # this service uses Net::HTTP to send requests to the graph
+    def self.included(base)
+      base.class_eval do
+        require 'net/http' unless defined?(Net::HTTP)
+        require 'net/https'
 
-        # 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"
+        def self.make_request(path, args, verb)
+          # 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.
 
-        http = Net::HTTP.new(FACEBOOK_GRAPH_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
-        # not sure if this is the right way to handle it
-        # see http://redcorundum.blogspot.com/2008/03/ssl-certificates-and-nethttps.html
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          # 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"
 
-        result = http.start { |http|
-          response, body = (verb == "post" ? http.post(path, encode_params(args)) : http.get("#{path}?#{encode_params(args)}")) 
-          body
-        }
-      end
+          http = Net::HTTP.new(Facebook::GRAPH_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
+          # not sure if this is the right way to handle it
+          # see http://redcorundum.blogspot.com/2008/03/ssl-certificates-and-nethttps.html
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+          result = http.start { |http|
+            response, body = (verb == "post" ? http.post(path, encode_params(args)) : http.get("#{path}?#{encode_params(args)}")) 
+            body
+          }
+        end
 
-      protected
-      def encode_params(param_hash)
-        # TODO investigating whether a built-in method handles this
-        # if no hash (e.g. no auth token) return empty string
-        ((param_hash || {}).collect do |key_and_value| 
-          key_and_value[1] = key_and_value[1].to_json if key_and_value[1].class != String
-          "#{key_and_value[0].to_s}=#{CGI.escape key_and_value[1]}"
-        end).join("&")
+        protected
+        def self.encode_params(param_hash)
+          # TODO investigating whether a built-in method handles this
+          # if no hash (e.g. no auth token) return empty string
+          ((param_hash || {}).collect do |key_and_value| 
+            key_and_value[1] = key_and_value[1].to_json if key_and_value[1].class != String
+            "#{key_and_value[0].to_s}=#{CGI.escape key_and_value[1]}"
+          end).join("&")
+        end
       end
     end
+  end
 
-    module TyphoeusService
-      # this service uses Typhoeus to send requests to the graph
-      def self.included(base)
-        base.class_eval do
-          require 'typhoeus' unless defined?(Typhoeus)
-          include Typhoeus
-        end      
-      end
+  module TyphoeusService
+    # this service uses Typhoeus to send requests to the graph
+    def self.included(base)
+      base.class_eval do
+        require 'typhoeus' unless defined?(Typhoeus)
+        include Typhoeus
 
-      def make_request(path, args, verb)
-        # 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.class.send(verb, "https://#{FACEBOOK_GRAPH_SERVER}/#{path}", :params => args).body
-      end
+        def self.make_request(path, args, verb)
+          # 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
+        end
+      end      
     end
   end
 end

data/lib/koala.rb

@@ -9,299 +9,240 @@ require 'json'
 require 'http_services'
 
 module Koala
-  # Ruby client library for the Facebook Platform.
-  # Copyright 2010 Facebook
-  # Adapted from the Python library by Alex Koppel, Rafi Jacoby, and the team at Context Optional
-  #
-  # Licensed under the Apache License, Version 2.0 (the "License"); you may
-  # not use this file except in compliance with the License. You may obtain
-  # a copy of the License at
-  #     http://www.apache.org/licenses/LICENSE-2.0
-  #
-  # Unless required by applicable law or agreed to in writing, software
-  # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-  # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-  # License for the specific language governing permissions and limitations
-  # under the License.
-  # 
-  # This client library is designed to support the Graph API and the official
-  # Facebook JavaScript SDK, which is the canonical way to implement
-  # Facebook authentication. Read more about the Graph API at
-  # http://developers.facebook.com/docs/api. You can download the Facebook
-  # JavaScript SDK at http://github.com/facebook/connect-js/.
+    
+  module Facebook
+    # Ruby client library for the Facebook Platform.
+    # Copyright 2010 Facebook
+    # Adapted from the Python library by Alex Koppel, Rafi Jacoby, and the team at Context Optional
+    #
+    # Licensed under the Apache License, Version 2.0 (the "License"); you may
+    # not use this file except in compliance with the License. You may obtain
+    # a copy of the License at
+    #     http://www.apache.org/licenses/LICENSE-2.0
+    #
+    # Unless required by applicable law or agreed to in writing, software
+    # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+    # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+    # License for the specific language governing permissions and limitations
+    # under the License.
+    # 
+    # This client library is designed to support the Graph API and the official
+    # Facebook JavaScript SDK, which is the canonical way to implement
+    # Facebook authentication. Read more about the Graph API at
+    # http://developers.facebook.com/docs/api. You can download the Facebook
+    # JavaScript SDK at http://github.com/facebook/connect-js/.
 
-  FACEBOOK_GRAPH_SERVER = "graph.facebook.com"
+    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 = 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
-    # Facebook::get_user_from_cookie() method below to get the OAuth access token
-    # for the active user from the cookie saved by the SDK.
-            
-    # 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.
-      request(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.
-      request("", args.merge("ids" => ids.join(",")))
-    end
-    
-    def get_connections(id, connection_name, args = {})
-      # Fetchs the connections for given object.
-      request("#{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.
+    class GraphAPI
+      # A client for the Facebook Graph API.
       # 
-      # For example,
+      # See http://developers.facebook.com/docs/api for complete documentation
+      # for the API.
       # 
-      #     graph.put_object("me", "feed", :message => "Hello, world")
+      # 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:
       # 
-      # writes "Hello, world" to the active user's wall. Likewise, this
-      # will comment on a the first post of the active user's feed:
+      #    graph = Koala::Facebook::GraphAPI.new(access_token)
+      #    user = graph.get_object("me")
+      #    friends = graph.get_connections(user["id"], "friends")
       # 
-      #     feed = graph.get_connections("me", "feed")
-      #     post = feed["data"][0]
-      #     graph.put_object(post["id"], "comments", :message => "First!")
+      # You can see a list of all of the objects and connections supported
+      # by the API at http://developers.facebook.com/docs/reference/api/.
       # 
-      # See http://developers.facebook.com/docs/api#publishing for all of
-      # the supported writeable objects.
+      # You can obtain an access token via OAuth or by using the Facebook
+      # JavaScript SDK. See http://developers.facebook.com/docs/authentication/
+      # for details.
       # 
-      # 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.
+      # 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.
+            
+      # 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(nil, "Write operations require an access token") unless @access_token
-      request("#{parent_object}/#{connection_name}", args, "post")
-    end
+        raise GraphAPIError.new(nil, "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"}
+      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
+        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_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 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.
-      request(id, {}, "delete")
-    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
-      request("search", args.merge({:q => search_terms}))
-    end
+      def search(search_terms, args = {})
+        # Searches for a given term
+        api("search", args.merge({:q => search_terms}))
+      end
     
-    def request(path, args = {}, verb = "get")
-      # Fetches the given path in the Graph API.
-      args["access_token"] = @access_token if @access_token
+      def api(path, args = {}, verb = "get")
+        # Fetches the given path in the Graph API.
+        args["access_token"] = @access_token if @access_token
         
-      # make the request via the provided service
-      result = make_request(path, args, verb)
+        # make the request via the provided service
+        result = Koala.make_request(path, args, verb)
       
-      # 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]
+        # 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 = response["error"]
-        raise GraphAPIError.new(error["code"], error["message"])
-      end
+        # check for errors
+        if response.is_a?(Hash) && error = response["error"]
+          raise GraphAPIError.new(error["code"], error["message"])
+        end
       
-      response
-    end
-    
-    # set up the http service used to make requests
-    # you can use your own (for HTTParty, etc.) by calling Koala::API.http_service = YourModule
-    def self.http_service=(service)
-      self.send(:include, service)
-    end
-    
-    # by default, try requiring Typhoeus -- if that works, use it
-    begin
-      require 'typhoeus'
-      Koala::GraphAPI.http_service = TyphoeusService
-    rescue LoadError
-      Koala::GraphAPI.http_service = NetHTTPService
+        response
+      end
     end
-  end
   
-  class GraphAPIError < Exception
-    attr_accessor :code
-    def initialize(code, message)
-      super(message)
-      self.code = code  
+    class GraphAPIError < Exception
+      attr_accessor :code
+      def initialize(code, message)
+        super(message)
+        self.code = code  
+      end
     end
-  end
   
-  class OAuth    
-    def initialize(app_id, app_secret, oauth_callback_url = nil)
-      @app_id = app_id
-      @app_secret = app_secret
-      @oauth_callback_url = oauth_callback_url 
-    end
+    class OAuth    
+      def initialize(app_id, app_secret, oauth_callback_url = nil)
+        @app_id = app_id
+        @app_secret = app_secret
+        @oauth_callback_url = oauth_callback_url 
+      end
     
-    def get_user_from_cookie(cookie_hash)
-      # Parses the cookie set by the official Facebook JavaScript SDK.
-      # 
-      # cookies should be a dictionary-like object mapping cookie names to
-      # cookie values.
-      # 
-      # If the user is logged in via Facebook, we return a dictionary with the
-      # keys "uid" and "access_token". The former is the user's Facebook ID,
-      # and the latter can be used to make authenticated requests to the Graph API.
-      # If the user is not logged in, we return None.
-      # 
-      # Download the official Facebook JavaScript SDK at
-      # http://github.com/facebook/connect-js/. Read more about Facebook
-      # authentication at http://developers.facebook.com/docs/authentication/.
+      def get_user_from_cookie(cookie_hash)
+        # Parses the cookie set by the official Facebook JavaScript SDK.
+        # 
+        # cookies should be a dictionary-like object mapping cookie names to
+        # cookie values.
+        # 
+        # If the user is logged in via Facebook, we return a dictionary with the
+        # keys "uid" and "access_token". The former is the user's Facebook ID,
+        # and the latter can be used to make authenticated requests to the Graph API.
+        # If the user is not logged in, we return None.
+        # 
+        # Download the official Facebook JavaScript SDK at
+        # http://github.com/facebook/connect-js/. Read more about Facebook
+        # authentication at http://developers.facebook.com/docs/authentication/.
 
-      if fb_cookie = cookie_hash["fbs_" + @app_id.to_s]
-        # remove the opening/closing quote
-        fb_cookie = fb_cookie.gsub(/\"/, "")
+        if fb_cookie = cookie_hash["fbs_" + @app_id.to_s]
+          # remove the opening/closing quote
+          fb_cookie = fb_cookie.gsub(/\"/, "")
 
-        # since we no longer get individual cookies, we have to separate out the components ourselves
-        components = {}
-        fb_cookie.split("&").map {|param| param = param.split("="); components[param[0]] = param[1]}
+          # since we no longer get individual cookies, we have to separate out the components ourselves
+          components = {}
+          fb_cookie.split("&").map {|param| param = param.split("="); components[param[0]] = param[1]}
 
-        auth_string = components.keys.sort.collect {|a| a == "sig" ? nil : "#{a}=#{components[a]}"}.reject {|a| a.nil?}.join("")
-        sig = Digest::MD5.hexdigest(auth_string + @app_secret)
+          auth_string = components.keys.sort.collect {|a| a == "sig" ? nil : "#{a}=#{components[a]}"}.reject {|a| a.nil?}.join("")
+          sig = Digest::MD5.hexdigest(auth_string + @app_secret)
 
-        sig == components["sig"] && Time.now.to_i < components["expires"].to_i ? components : nil
+          sig == components["sig"] && (components["expires"].to_i == 0 || Time.now.to_i < components["expires"].to_i) ? components : nil
+        end
       end
-    end
     
-    def url_for_oauth_code(options = {})
-      callback = options[:callback] || @oauth_callback_url
-      permissions = options[:permissions]
-      scope = permissions ? "&scope=#{permissions.is_a?(Array) ? permissions.join(",") : permissions}" : ""
+      def url_for_oauth_code(options = {})
+        # for permissions, see http://developers.facebook.com/docs/authentication/permissions
+        permissions = options[:permissions]
+        scope = permissions ? "&scope=#{permissions.is_a?(Array) ? permissions.join(",") : permissions}" : ""
 
-      # Creates the URL for oauth authorization for a given callback and optional set of permissions
-      "https://#{FACEBOOK_GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&redirect_uri=#{callback}#{scope}"    
-    end
+        callback = options[:callback] || @oauth_callback_url
+
+        # Creates the URL for oauth authorization for a given callback and optional set of permissions
+        "https://#{GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&redirect_uri=#{callback}#{scope}"    
+      end
         
-    def url_for_access_token(code, callback = @oauth_callback_url)
-      # Creates the URL for the token corresponding to a given code generated by Facebook
-      "https://#{FACEBOOK_GRAPH_SERVER}/oauth/access_token?client_id=#{@app_id}&redirect_uri=#{callback}&client_secret=#{@app_secret}&code=#{code}"
-    end
-    
-    # for more details and up to date information, see http://developers.facebook.com/docs/authentication/permissions
-    def self.all_permissions
-      USER_PERMISSIONS.concat(FRIEND_PERMISSIONS)
+      def url_for_access_token(code, callback = @oauth_callback_url)
+        # Creates the URL for the token corresponding to a given code generated by Facebook
+        "https://#{GRAPH_SERVER}/oauth/access_token?client_id=#{@app_id}&redirect_uri=#{callback}&client_secret=#{@app_secret}&code=#{code}"
+      end
     end
-    
-    USER_PERMISSIONS = [
-      # PUBLISHING
-      "publish_stream", # Enables your application to post content, comments, and likes to a user's stream and to the streams of the user's friends, without prompting the user each time.
-      "create_event", # Enables your application to create and modify events on the user's behalf
-      "rsvp_event", # Enables your application to RSVP to events on the user's behalf
-      "sms", # Enables your application to send messages to the user and respond to messages from the user via text message
-      "offline_access", # Enables your application to perform authorized requests on behalf of the user at any time (e.g. permanent access token)
-      
-      # DATA ACCESS
-      "email", # Provides access to the user's primary email address in the email  property
-      "read_stream", # Provides access to all the posts in the user's News Feed and enables your application to perform searches against the user's News Feed
-      "user_about_me", # Provides access to the "About Me" section of the profile in the about property
-      "user_activities", # Provides access to the user's list of activities as the activities connection
-      "user_birthday", # Provides access to the full birthday with year as the birthday_date property
-      "user_education_history", # Provides access to education history as the education property
-      "user_events", # Provides access to the list of events the user is attending as the events connection
-      "user_groups", # Provides access to the list of groups the user is a member of as the groups connection
-      "user_hometown", # Provides access to the user's hometown in the hometown property
-      "user_interests", # Provides access to the user's list of interests as the interests connection
-      "user_likes", # Provides access to the list of all of the pages the user has liked as the likes connection
-      "user_location", # Provides access to the user's current location as the current_location property
-      "user_notes", # Provides access to the user's notes as the notes connection
-      "user_online_presence", # Provides access to the user's online/offline presence
-      "user_photo_video_tags", # Provides access to the photos the user has been tagged in as the photos connection
-      "user_photos", # Provides access to the photos the user has uploaded
-      "user_relationships", # Provides access to the user's family and personal relationships and relationship status
-      "user_religion_politics", # Provides access to the user's religious and political affiliations
-      "user_status", # Provides access to the user's most recent status message
-      "user_videos", # Provides access to the videos the user has uploaded
-      "user_website", # Provides access to the user's web site URL
-      "user_work_history", # Provides access to work history as the work property
-      "read_friendlists", # Provides read access to the user's friend lists
-      "read_requests" # Provides read access to the user's friend requests
-    ]
-    
-    FRIEND_PERMISSIONS = [
-      # DATA ACCESS
-      "friends_about_me", # Provides access to the "About Me" section of the profile in the about property
-      "friends_activities", # Provides access to the user's list of activities as the activities connection
-      "friends_birthday", # Provides access to the full birthday with year as the birthday_date property
-      "friends_education_history", # Provides access to education history as the education property
-      "friends_events", # Provides access to the list of events the user is attending as the events connection
-      "friends_groups", # Provides access to the list of groups the user is a member of as the groups connection
-      "friends_hometown", # Provides access to the user's hometown in the hometown property
-      "friends_interests", # Provides access to the user's list of interests as the interests connection
-      "friends_likes", # Provides access to the list of all of the pages the user has liked as the likes connection
-      "friends_location", # Provides access to the user's current location as the current_location property
-      "friends_notes", # Provides access to the user's notes as the notes connection
-      "friends_online_presence", # Provides access to the user's online/offline presence
-      "friends_photo_video_tags", # Provides access to the photos the user has been tagged in as the photos connection
-      "friends_photos", # Provides access to the photos the user has uploaded
-      "friends_relationships", # Provides access to the user's family and personal relationships and relationship status
-      "friends_religion_politics", # Provides access to the user's religious and political affiliations
-      "friends_status", # Provides access to the user's most recent status message
-      "friends_videos", # Provides access to the videos the user has uploaded
-      "friends_website", # Provides access to the user's web site URL
-      "friends_work_history" # Provides access to work history as the work property
-    ]
+  end
+  
+  # finally, set up the http service Koala methods used to make requests
+  # you can use your own (for HTTParty, etc.) by calling Koala.http_service = YourModule
+  def self.http_service=(service)
+    self.send(:include, service)
+  end
+
+  # by default, try requiring Typhoeus -- if that works, use it
+  begin
+    require 'typhoeus'
+    Koala.http_service = TyphoeusService
+  rescue LoadError
+    Koala.http_service = NetHTTPService
   end
 end

data/readme.md

@@ -1,29 +1,43 @@
-Facebook Graph
+Koala
 ====
+Koala (<a href="http://github.com/arsduo/ruby-sdk" target="_blank">http://github.com/arsduo/ruby-sdk</a>) is a new Facebook Graph library for Ruby.  We wrote Koala with four goals: 
 
-This Ruby client library is designed to support the
-[Facebook Graph API](http://developers.facebook.com/docs/api) and the official
-[Facebook JavaScript SDK](http://github.com/facebook/connect-js), which is
-the canonical way to implement Facebook authentication. You can read more
-about the Graph API at [http://developers.facebook.com/docs/api](http://developers.facebook.com/docs/api).
+* Lightweight: Koala should be as light and simple as Facebook’s own new libraries, providing API accessors and returning simple JSON.  (We clock in, with comments, just over 300 lines of code.)
+* Fast: Koala should, out of the box, be quick. In addition to supporting the vanilla Ruby networking libraries, it natively supports Typhoeus, our preferred gem for making fast HTTP requests. Of course, That brings us to our next topic:
+* Flexible: Koala should be useful to everyone, regardless of their current configuration.  (We have no dependencies beyond the JSON gem.  Koala also has a built-in mechanism for using whichever HTTP library you prefer to make requests against the graph.)
+* Tested: Koala should have complete test coverage, so you can rely on it.  (By the time you read this the final tests are being written.)
 
 Basic usage:
 
-    graph = Facebook::GraphAPI.new(oauth_access_token)
+    graph = Koala::Facebook::GraphAPI.new(oauth_access_token)
     profile = graph.get_object("me")
     friends = graph.get_connections("me", "friends")
     graph.put_object("me", "feed", :message => "I am writing on my wall!")
 
-If you are using the module within a web application with the
-[JavaScript SDK](http://github.com/facebook/connect-js), you can also use the
-module to use Facebook for login, parsing the cookie set by the JavaScript SDK
-for logged in users.
+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.
+
+Examples and More Details 
+-----
+There's a very detailed description and walkthrough of Koala at http://blog.twoalex.com/2010/05/03/introducing-koala-a-new-gem-for-facebooks-new-graph-api/.
+
 
 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:
-    spec facebook_tests.rb
+    spec koala_tests.rb
     
-Unit tests for cookie validation will be provided shortly.  (You'll also need to add that information into the yml.)
-    
+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
+
+
+Known Issues
+-----
+1. gem install koala produces "Could not find main page readme.md" message

data/test/facebook_data.yml

@@ -1,4 +1,8 @@
-oauth_token: 115349521819193|2.qpo_Ei2sucL3L_yjapnhhQ__.3600.1272762000-2905623|GKjZ-GL5nGIN4lFDZSa-zzFcXvM.
+# for testing the GraphAPI classs
+# OAuth token should have stream_publish permissions 
+oauth_token: 
+
+# for testing the OAuth class
 app_id: 
 secret: 
 callback_url: 

data/test/koala/facebook_no_access_token_tests.rb

@@ -1,7 +1,8 @@
 class FacebookNoAccessTokenTests < Test::Unit::TestCase
+  
   describe "Koala GraphAPI without an access token" do
     before :each do
-      @graph = Koala::GraphAPI.new
+      @graph = Koala::Facebook::GraphAPI.new
     end
   
     it "should get public data about a user" do
@@ -26,7 +27,7 @@ class FacebookNoAccessTokenTests < Test::Unit::TestCase
     it "should not be able to get data about 'me'" do
       begin
         @graph.get_object("me")
-      rescue Koala::GraphAPIError => @right_err
+      rescue Koala::Facebook::GraphAPIError => @right_err
       rescue Exception => wrong_err
       end
       @right_err.should_not be_nil
@@ -40,7 +41,7 @@ class FacebookNoAccessTokenTests < Test::Unit::TestCase
     it "shouldn't be able to access connections from users" do
       begin
         @graph.get_connections("lukeshepard", "likes")
-      rescue Koala::GraphAPIError => @right_err
+      rescue Koala::Facebook::GraphAPIError => @right_err
       rescue Exception => wrong_err
       end
       @right_err.should_not be_nil
@@ -54,7 +55,7 @@ class FacebookNoAccessTokenTests < Test::Unit::TestCase
     it "should not be able to put an object" do
       begin
         @result = @graph.put_object("lukeshepard", "feed", :message => "Hello, world")
-      rescue Koala::GraphAPIError => @right_err
+      rescue Koala::Facebook::GraphAPIError => @right_err
       rescue Exception => wrong_err
       end
       @right_err.should_not be_nil
@@ -64,7 +65,7 @@ class FacebookNoAccessTokenTests < Test::Unit::TestCase
     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::GraphAPIError => @right_err
+      rescue Koala::Facebook::GraphAPIError => @right_err
       rescue Exception => wrong_err
       end
       @right_err.should_not be_nil
@@ -74,7 +75,7 @@ class FacebookNoAccessTokenTests < Test::Unit::TestCase
       begin
         # random public post on the ContextOptional wall
         @result = @graph.put_comment("7204941866_119776748033392", "The hackathon was great!")
-      rescue Koala::GraphAPIError => @right_err
+      rescue Koala::Facebook::GraphAPIError => @right_err
       rescue Exception => wrong_err
       end
       @right_err.should_not be_nil
@@ -83,7 +84,7 @@ class FacebookNoAccessTokenTests < Test::Unit::TestCase
     it "should not be able to like an object" do
       begin
         @result = @graph.put_like("7204941866_119776748033392")
-      rescue Koala::GraphAPIError => @right_err
+      rescue Koala::Facebook::GraphAPIError => @right_err
       rescue Exception => wrong_err
       end
       @right_err.should_not be_nil
@@ -95,7 +96,7 @@ class FacebookNoAccessTokenTests < Test::Unit::TestCase
       begin
         # test post on the Ruby SDK Test application
         @result = @graph.delete_object("115349521819193_113815981982767")
-      rescue Koala::GraphAPIError => @right_err
+      rescue Koala::Facebook::GraphAPIError => @right_err
       rescue Exception => wrong_err
       end
       @right_err.should_not be_nil
@@ -107,11 +108,8 @@ class FacebookNoAccessTokenTests < Test::Unit::TestCase
       result["data"].should be_an(Array)
     end
 
-    # REQUEST
-    # the above tests test this already, but we should do it explicitly
-    it "should be able to send get-only requests" do
-      # to be written
-    end
+    # API
+    # the above tests test this already, but we should consider additional api tests
     
   end # describe
 

data/test/koala/facebook_with_access_token_tests.rb

@@ -3,7 +3,7 @@ class FacebookWithAccessTokenTests < Test::Unit::TestCase
     before :each do
       token = $testing_data["oauth_token"]
       raise Exception, "Must supply access token to run FacebookWithAccessTokenTests!" unless token
-      @graph = Koala::GraphAPI.new(token)
+      @graph = Koala::Facebook::GraphAPI.new(token)
     end
     
     after :each do 
@@ -95,11 +95,8 @@ class FacebookWithAccessTokenTests < Test::Unit::TestCase
       result["data"].should be_an(Array)
     end
 
-    # REQUEST
-    # the above tests test this already, but we should do it explicitly
-    it "should be able to send get and put requests" do
-      # to be written
-    end
+    # API
+    # the above tests test this already, but we should consider additional api tests
     
   end # describe
 

data/test/koala_tests.rb

@@ -1,4 +1,3 @@
-puts __FILE__
 require 'test/unit'
 require 'rubygems'
 require 'spec/test/unit'
@@ -25,6 +24,8 @@ $testing_data = YAML.load_file("facebook_data.yml") rescue {}
 unless $testing_data["oauth_token"]
   puts "Access token tests will fail until you store a valid token in facebook_data.yml"
 end
-unless cookies = $testing_data["cookie_hash"]
-  puts "Cookie 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

metadata

@@ -5,7 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  version: "0.4"
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Alex Koppel, Rafi Jacoby, Context Optional
@@ -13,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-01 00:00:00 -07:00
+date: 2010-05-03 00:00:00 -07:00
 default_executable: 
 dependencies: []