koala 1.0.0 → 1.1.0

data/.autotest

@@ -0,0 +1,12 @@
+# Override autotest default magic to rerun all tests every time a
+# change is detected on the file system.
+class Autotest
+  
+  def get_to_green
+    begin
+      rerun_all_tests
+      wait_for_changes unless all_good
+    end until all_good
+  end
+                            
+end

data/.gitignore

@@ -1,3 +1,5 @@
 pkg
 .project
-Gemfile.lock
+Gemfile.lock
+.rvmrc
+*.rbc

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.8.7 # (current default)
+  - 1.9.2
+  - rbx
+  - rbx-2.0
+  - ree
+  - jruby
+  - ruby-head

data/CHANGELOG

@@ -1,3 +1,26 @@
+v1.1
+New methods:
+-- Added Batch API support (thanks, seejohnrun and spiegela!)
+  -- includes file uploads, error handling, and FQL
+-- Added GraphAPI#put_video
+-- Added GraphAPI#get_comments_for_urls (thanks, amrnt!)
+-- Added RestAPI#fql_multiquery, which simplifies the results (thanks, amrnt!)
+-- HTTP services support global proxy and timeout settings (thanks, itchy!)
+-- Net::HTTP supports global ca_path, ca_file, and verify_mode settings (thanks, spiegela!)
+Updated methods:
+-- RealtimeUpdates now uses a GraphAPI object instead of its own API
+-- RestAPI#rest_call now has an optional last argument for method, for calls requiring POST, DELETE, etc. (thanks, sshilo!)
+-- Filename can now be specified when uploading (e.g. for Ads API) (thanks, sshilo!)
+-- get_objects([]) returns [] instead of a Facebook error in non-batch mode (thanks, aselder!)
+Internal improvements:
+-- Koala is now more compatible with other Rubies (JRuby, Rubinius, etc.)
+-- HTTP services are more modular and can be changed on the fly (thanks, chadk!)
+  -- Includes support for uploading StringIOs and other non-files via Net::HTTP even when using TyphoeusService
+-- Koala now uses multi_json to improve compatibility with Rubinius and other Ruby versions
+-- Koala now uses the modern Typhoeus API (thanks, aselder!)
+-- Koala now uses the current modern Net::HTTP interface (thanks, romanbsd!)
+-- Fixed bugs and typos (thanks, waynn, mokevnin, and tikh!)
+
 v1.0
 New methods:
 -- Photo and file upload now supported through #put_picture
@@ -6,13 +29,13 @@ New methods:
 -- Added put_connection and delete_connection convenience methods
 Updated methods:
 -- Search can now search places, checkins, etc. (thanks, rickyc!)
--- You can now pass :beta => true in the http options to use Facebook's beta tier.
+-- You can now pass :beta => true in the http options to use Facebook's beta tier
 -- TestUser#befriend now requires user info hashes (id and access token) due to Facebook API changes (thanks, pulsd and kbighorse!)
 -- All methods now accept an http_options hash as their optional last parameter (thanks, spiegela!)
 -- url_for_oauth_code can now take a :display option (thanks, netbe!)
 -- Net::HTTP can now accept :timeout and :proxy options (thanks, gilles!)
 -- Test users now supports using test accounts across multiple apps
-Internal improvements: 
+Internal improvements:
 -- For public requests, Koala now uses http by default (instead of https) to improve speed
   -- This can be overridden through Koala.always_use_ssl= or by passing :use_ssl => true in the options hash for an api call
 -- Read-only REST API requests now go through the faster api-read server
@@ -22,6 +45,7 @@ Internal improvements:
 -- Updated parse_signed_request to match Facebook's current implementation (thanks, imajes!)
 -- APIError is now < StandardError, not Exception
 -- Added KoalaError for non-API errors
+-- Net::HTTP's SSL verification is no longer disabled by default
 Test improvements:
 -- Incorporated joshk's awesome rewrite of the entire Koala test suite (thanks, joshk!)
 -- Expanded HTTP service tests (added Typhoeus test suite and additional Net::HTTP test cases)

data/Gemfile

@@ -1,3 +1,7 @@
 source :rubygems
 
 gemspec
+
+if defined? JRUBY_VERSION
+  gem "jruby-openssl"
+end

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/koala.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name    = %q{koala}
-  s.version = "1.0.0"
-  s.date    = %q{2011-05-01}
+  s.version = "1.1.0"
+  s.date    = %q{2011-07-18}
 
   s.summary     = %q{A lightweight, flexible library for Facebook with support for the Graph API, the REST API, realtime updates, and OAuth authentication.}
   s.description = %q{Koala is a lightweight, flexible Ruby SDK for Facebook.  It allows read/write access to the social graph via the Graph and REST APIs, as well as support for realtime updates and OAuth and Facebook Connect authentication.  Koala is fully tested and supports Net::HTTP and Typhoeus connections out of the box and can accept custom modules for other services.}
@@ -28,22 +28,22 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<json>,          ["~> 1.0"])
+      s.add_runtime_dependency(%q<multi_json>,      ["~> 1.0"])
       s.add_runtime_dependency(%q<multipart-post>,  ["~> 1.0"])
-      s.add_development_dependency(%q<rspec>,     ["~> 2.5.0"])
+      s.add_development_dependency(%q<rspec>,     ["~> 2.5"])
       s.add_development_dependency(%q<rake>,      ["~> 0.8.7"])
       s.add_development_dependency(%q<typhoeus>,  ["~> 0.2.4"])
     else
-      s.add_dependency(%q<json>,      ["~> 1.0"])
+      s.add_dependency(%q<multi_json>,      ["~> 1.0"])
       s.add_dependency(%q<multipart-post>,  ["~> 1.0"])
-      s.add_dependency(%q<rspec>,     ["~> 2.5.0"])
+      s.add_dependency(%q<rspec>,     ["~> 2.5"])
       s.add_dependency(%q<rake>,      ["~> 0.8.7"])
       s.add_dependency(%q<typhoeus>,  ["~> 0.2.4"])
     end
   else
-    s.add_dependency(%q<json>,      ["~> 1.0"])
+    s.add_dependency(%q<multi_json>,      ["~> 1.0"])
     s.add_dependency(%q<multipart-post>,  ["~> 1.0"])
-    s.add_dependency(%q<rspec>,     ["~> 2.5.0"])
+    s.add_dependency(%q<rspec>,     ["~> 2.5"])
     s.add_dependency(%q<rake>,      ["~> 0.8.7"])
     s.add_dependency(%q<typhoeus>,  ["~> 0.2.4"])
   end

data/lib/koala/batch_operation.rb

@@ -0,0 +1,74 @@
+module Koala
+  module Facebook
+    class BatchOperation
+      attr_reader :access_token, :http_options, :post_processing, :files, :batch_api, :identifier
+
+      @identifier = 0
+
+      def self.next_identifier
+        @identifier += 1
+      end
+
+      def initialize(options = {})
+        @identifier = self.class.next_identifier
+        @args = (options[:args] || {}).dup # because we modify it below
+        @access_token = options[:access_token]
+        @http_options = (options[:http_options] || {}).dup # dup because we modify it below
+        @batch_args = @http_options.delete(:batch_args) || {}
+        @url = options[:url]
+        @method = options[:method].to_sym
+        @post_processing = options[:post_processing]
+        
+        process_binary_args
+        
+        raise Koala::KoalaError, "Batch operations require an access token, none provided." unless @access_token
+      end
+      
+      def to_batch_params(main_access_token)
+        # set up the arguments
+        args_string = Koala.http_service.encode_params(@access_token == main_access_token ? @args : @args.merge(:access_token => @access_token))
+        
+        response = {
+          :method => @method.to_s, 
+          :relative_url => @url,
+        }
+         
+        # handle batch-level arguments, such as name, depends_on, and attached_files
+        @batch_args[:attached_files] = @files.keys.join(",") if @files
+        response.merge!(@batch_args) if @batch_args
+        
+        # for get and delete, we append args to the URL string
+        # otherwise, they go in the body
+        if args_string.length > 0
+          if args_in_url?
+            response[:relative_url] += (@url =~ /\?/ ? "&" : "?") + args_string if args_string.length > 0
+          else
+            response[:body] = args_string if args_string.length > 0
+          end
+        end
+        
+        response
+      end
+  
+      protected
+      
+      def process_binary_args
+        # collect binary files
+        @args.each_pair do |key, value| 
+          if UploadableIO.binary_content?(value)
+            @files ||= {}
+            # we use a class-level counter to ensure unique file identifiers across multiple batch operations
+            # (this is thread safe, since we just care about uniqueness)
+            # so remove the file from the original hash and add it to the file store
+            id = "op#{identifier}_file#{@files.keys.length}"
+            @files[id] = @args.delete(key).is_a?(UploadableIO) ? value : UploadableIO.new(value)
+          end
+        end          
+      end
+      
+      def args_in_url?
+        @method == :get || @method == :delete 
+      end   
+    end
+  end
+end

data/lib/koala/graph_api.rb

@@ -28,7 +28,7 @@ module Koala
       # 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.
-         
+
       # Objects
 
       def get_object(id, args = {}, options = {})
@@ -37,10 +37,10 @@ module Koala
       end
     
       def get_objects(ids, args = {}, options = {})
-        # 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.
-        graph_call("", args.merge("ids" => ids.join(",")), "get", options)
+        # Fetchs all of the given objects from the graph.
+        # If any of the IDs are invalid, they'll raise an exception.
+        return [] if ids.empty?
+        graph_call("", args.merge("ids" => ids.respond_to?(:join) ? ids.join(",") : ids), "get", options)
       end
       
       def put_object(parent_object, connection_name, args = {}, options = {})
@@ -71,10 +71,19 @@ module Koala
           
       def get_connections(id, connection_name, args = {}, options = {})
         # Fetchs the connections for given object.
-        result = graph_call("#{id}/#{connection_name}", args, "get", options)
-        result ? GraphCollection.new(result, self) : nil # when facebook is down nil can be returned
+        graph_call("#{id}/#{connection_name}", args, "get", options) do |result|
+          result ? GraphCollection.new(result, self) : nil # when facebook is down nil can be returned
+        end
       end
 
+      def get_comments_for_urls(urls = [], args = {}, options = {})
+        # Fetchs the comments for given URLs (array or comma-separated string)
+        # see https://developers.facebook.com/blog/post/490
+        return [] if urls.empty?
+        args.merge!(:ids => urls.respond_to?(:join) ? urls.join(",") : urls)
+        get_object("comments", args, options)
+      end
+          
       def put_connections(id, connection_name, args = {}, options = {})
         # Posts a certain connection
         raise APIError.new({"type" => "KoalaMissingAccessToken", "message" => "Write operations require an access token"}) unless @access_token
@@ -87,44 +96,41 @@ module Koala
         graph_call("#{id}/#{connection_name}", args, "delete", options)
       end
 
-      # Pictures
-      # to delete pictures, use delete_object(photo_id)
-      # note: you'll need the user_photos permission to actually access photos after uploading them 
+      # Media (photos and videos)
+      # to delete photos or videos, use delete_object(object_id)
+      # note: you'll need the user_photos or user_videos permissions to actually access media after upload 
     
       def get_picture(object, args = {}, options = {})
         # Gets a picture object, returning the URL (which Facebook sends as a header)
-        result = graph_call("#{object}/picture", args, "get", options.merge(:http_component => :headers))
-        result["Location"]
+        graph_call("#{object}/picture", args, "get", options.merge(:http_component => :headers)) do |result|
+          result["Location"]
+        end
       end    
       
+      # Can be called in multiple ways:
+      #
+      #   put_picture(file, [content_type], ...)
+      #   put_picture(path_to_file, [content_type], ...)
+      #
+      # You can pass in uploaded files directly from Rails or Sinatra.
+      # (See lib/koala/uploadable_io.rb for supported frameworks)
+      #
+      # Optional parameters can be added to the end of the argument list:
+      # - args:       a hash of request parameters (default: {})
+      # - target_id:  ID of the target where to post the picture (default: "me")
+      # - options:    a hash of http options passed to the HTTPService module
+      # 
+      #   put_picture(file, content_type, {:message => "Message"}, 01234560)
+      #   put_picture(params[:file], {:message => "Message"})
+      
       def put_picture(*picture_args)
-        # Can be called in multiple ways:
-        #
-        #   put_picture(file, [content_type], ...)
-        #   put_picture(path_to_file, [content_type], ...)
-        #
-        # You can pass in uploaded files directly from Rails or Sinatra.
-        # (See lib/koala/uploadable_io.rb for supported frameworks)
-        #
-        # Optional parameters can be added to the end of the argument list:
-        # - args:       a hash of request parameters (default: {})
-        # - target_id:  ID of the target where to post the picture (default: "me")
-        # - options:    a hash of http options passed to the HTTPService module
-        # 
-        #   put_picture(file, content_type, {:message => "Message"}, 01234560)
-        #   put_picture(params[:file], {:message => "Message"})
-        
-        raise KoalaError.new("Wrong number of arguments for put_picture") unless picture_args.size.between?(1, 5)
-        
-        args_offset = picture_args[1].kind_of?(Hash) || picture_args.size == 1 ? 0 : 1
-        
-        args      = picture_args[1 + args_offset] || {}
-        target_id = picture_args[2 + args_offset] || "me"
-        options   = picture_args[3 + args_offset] || {} 
-        
-        args["source"] = Koala::UploadableIO.new(*picture_args.slice(0, 1 + args_offset))
+        put_object(*parse_media_args(picture_args, "photos"))
+      end
         
-        self.put_object(target_id, "photos", args, options)
+      def put_video(*video_args)
+        args = parse_media_args(video_args, "videos")
+        args.last[:video] = true
+        put_object(*args)
       end
     
       # Wall posts
@@ -172,86 +178,81 @@ module Koala
             
       def search(search_terms, args = {}, options = {})
         args.merge!({:q => search_terms}) unless search_terms.nil?
-        result = graph_call("search", args, "get", options)
-        result ? GraphCollection.new(result, self) : nil # when facebook is down nil can be returned
-      end      
-      
-      # API access
-    
-      def graph_call(*args)
-        # Direct access to the Facebook API
-        # see any of the above methods for example invocations
-        response = api(*args) do |response|
-          # check for Graph API-specific errors
-          if response.is_a?(Hash) && error_details = response["error"]
-            raise APIError.new(error_details)
-          end
+        graph_call("search", args, "get", options) do |result|
+          result ? GraphCollection.new(result, self) : nil # when facebook is down nil can be returned
         end
+      end      
       
-        response
-      end 
       
       # GraphCollection support
-      
       def get_page(params)
         # Pages through a set of results stored in a GraphCollection
         # Used for connections and search results
-        result = graph_call(*params)
-        result ? GraphCollection.new(result, self) : nil # when facebook is down nil can be returned
+        graph_call(*params) do |result|
+          result ? GraphCollection.new(result, self) : nil # when facebook is down nil can be returned
+        end
       end
       
-    end
-    
-    
-    class GraphCollection < Array
-      #This class is a light wrapper for collections returned
-      #from the Graph API.
-      #
-      #It extends Array to allow direct access to the data colleciton
-      #which should allow it to drop in seamlessly.
-      #
-      #It also allows access to paging information and the
-      #ability to get the next/previous page in the collection
-      #by calling next_page or previous_page.
-      attr_reader :paging
-      attr_reader :api
       
-      def initialize(response, api)
-        super response["data"]
-        @paging = response["paging"]
-        @api = api
-      end
-            
-      # defines methods for NEXT and PREVIOUS pages
-      %w{next previous}.each do |this|
-        
-        # def next_page
-        # def previous_page
-        define_method "#{this.to_sym}_page" do
-          base, args = send("#{this}_page_params")
-          base ? @api.get_page([base, args]) : nil
+      # Batch API
+      def batch(http_options = {}, &block)
+        batch_client = GraphBatchAPI.new(access_token)
+        if block
+          yield batch_client
+          batch_client.execute(http_options)
+        else
+          batch_client
         end
-        
-        # def next_page_params
-        # def previous_page_params
-        define_method "#{this.to_sym}_page_params" do
-          return nil unless @paging and @paging[this]
-          parse_page_url(@paging[this])
+      end        
+      
+      def self.included(base)
+        base.class_eval do
+          def self.batch
+            raise NoMethodError, "The BatchAPI signature has changed (the original implementation was not thread-safe).  Please see https://github.com/arsduo/koala/wiki/Batch-requests.  (This message will be removed in the final 1.1 release.)"
+          end
+        end
+      end
+      
+      # Direct access to the Facebook API
+      # see any of the above methods for example invocations
+      def graph_call(path, args = {}, verb = "get", options = {}, &post_processing)
+        result = api(path, args, verb, options) do |response|
+          error = check_response(response)
+          raise error if error
         end
+
+        # now process as appropriate (get picture header, make GraphCollection, etc.)
+        post_processing ? post_processing.call(result) : result
       end
       
-      def parse_page_url(url)
-        match = url.match(/.com\/(.*)\?(.*)/)
-        base = match[1]
-        args = match[2]
-        params = CGI.parse(args)
-        new_params = {}
-        params.each_pair do |key,value|
-          new_params[key] = value.join ","
+      def check_response(response)
+        # check for Graph API-specific errors
+        # this returns an error, which is immediately raised (non-batch)
+        # or added to the list of batch results (batch)
+        if response.is_a?(Hash) && error_details = response["error"]
+          APIError.new(error_details) 
         end
-        [base,new_params]
       end
       
+      private
+      
+      def parse_media_args(media_args, method)
+        # photo and video uploads can accept different types of arguments (see above)
+        # so here, we parse the arguments into a form directly usable in put_object
+        raise KoalaError.new("Wrong number of arguments for put_#{method == "photos" ? "picture" : "video"}") unless media_args.size.between?(1, 5)
+        
+        args_offset = media_args[1].kind_of?(Hash) || media_args.size == 1 ? 0 : 1
+        
+        args      = media_args[1 + args_offset] || {}
+        target_id = media_args[2 + args_offset] || "me"
+        options   = media_args[3 + args_offset] || {} 
+        
+        args["source"] = Koala::UploadableIO.new(*media_args.slice(0, 1 + args_offset))
+
+        options[:http_service] = Koala.base_http_service if args["source"].requires_base_http_service
+
+        [target_id, method, args, options]
+      end      
     end
   end
-end
+end  

data/lib/koala/graph_batch_api.rb

@@ -0,0 +1,87 @@
+module Koala
+  module Facebook
+      module GraphBatchAPIMethods
+        
+      def self.included(base)
+        base.class_eval do
+          alias_method :graph_call_outside_batch, :graph_call
+          alias_method :graph_call, :graph_call_in_batch
+          
+          alias_method :check_graph_api_response, :check_response
+          alias_method :check_response, :check_graph_batch_api_response
+        end
+      end
+      
+      def batch_calls
+        @batch_calls ||= []
+      end
+            
+      def graph_call_in_batch(path, args = {}, verb = "get", options = {}, &post_processing)
+          # for batch APIs, we queue up the call details (incl. post-processing)
+          batch_calls << BatchOperation.new(
+            :url => path,
+            :args => args,
+            :method => verb,
+            :access_token => options['access_token'] || access_token,
+            :http_options => options,
+            :post_processing => post_processing
+          )
+          nil # batch operations return nothing immediately 
+      end
+
+      def check_graph_batch_api_response(response)
+        if response.is_a?(Hash) && response["error"] && !response["error"].is_a?(Hash)
+          APIError.new("type" => "Error #{response["error"]}", "message" => response["error_description"])
+        else
+          check_graph_api_response(response)
+        end
+      end
+
+      def execute(http_options = {})
+        return [] unless batch_calls.length > 0
+        # Turn the call args collected into what facebook expects
+        args = {}
+        args["batch"] = MultiJson.encode(batch_calls.map { |batch_op|
+          args.merge!(batch_op.files) if batch_op.files
+          batch_op.to_batch_params(access_token)
+        })
+        
+        graph_call_outside_batch('/', args, 'post', http_options) do |response|
+          # map the results with post-processing included
+          index = 0 # keep compat with ruby 1.8 - no with_index for map
+          response.map do |call_result|
+            # Get the options hash
+            batch_op = batch_calls[index]
+            index += 1
+
+            if call_result
+              # (see note in regular api method about JSON parsing)
+              body = MultiJson.decode("[#{call_result['body'].to_s}]")[0]
+              
+              unless call_result["code"].to_i >= 500 || error = check_response(body)
+                # Get the HTTP component they want
+                data = case batch_op.http_options[:http_component] 
+                when :status
+                  call_result["code"].to_i
+                when :headers
+                  # facebook returns the headers as an array of k/v pairs, but we want a regular hash
+                  call_result['headers'].inject({}) { |headers, h| headers[h['name']] = h['value']; headers}
+                else
+                  body
+                end
+
+                # process it if we are given a block to process with
+                batch_op.post_processing ? batch_op.post_processing.call(data) : data
+              else
+                error || APIError.new({"type" => "HTTP #{call_result["code"].to_s}", "message" => "Response body: #{body}"})
+              end
+            else
+              nil
+            end
+          end          
+        end
+      end
+      
+    end
+  end
+end

data/lib/koala/graph_collection.rb

@@ -0,0 +1,54 @@
+module Koala
+  module Facebook
+    class GraphCollection < Array
+      # This class is a light wrapper for collections returned
+      # from the Graph API.
+      #
+      # It extends Array to allow direct access to the data colleciton
+      # which should allow it to drop in seamlessly.
+      #
+      # It also allows access to paging information and the
+      # ability to get the next/previous page in the collection
+      # by calling next_page or previous_page.
+      attr_reader :paging
+      attr_reader :api
+      
+      def initialize(response, api)
+        super response["data"]
+        @paging = response["paging"]
+        @api = api
+      end
+            
+      # defines methods for NEXT and PREVIOUS pages
+      %w{next previous}.each do |this|
+        
+        # def next_page
+        # def previous_page
+        define_method "#{this.to_sym}_page" do
+          base, args = send("#{this}_page_params")
+          base ? @api.get_page([base, args]) : nil
+        end
+        
+        # def next_page_params
+        # def previous_page_params
+        define_method "#{this.to_sym}_page_params" do
+          return nil unless @paging and @paging[this]
+          parse_page_url(@paging[this])
+        end
+      end
+      
+      def parse_page_url(url)
+        match = url.match(/.com\/(.*)\?(.*)/)
+        base = match[1]
+        args = match[2]
+        params = CGI.parse(args)
+        new_params = {}
+        params.each_pair do |key,value|
+          new_params[key] = value.join ","
+        end
+        [base,new_params]
+      end
+      
+    end
+  end
+end