koala 1.1.0rc2 → 1.1.0rc3

data/.gitignore

@@ -2,3 +2,4 @@ pkg
 .project
 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,9 +1,12 @@
 v1.1
 New methods:
--- Batch API support through Koala::Facebook::GraphAPI.batch (thanks, seejohnrun!)
+-- 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!)   
+-- 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!)
@@ -12,9 +15,10 @@ Updated methods:
 Internal improvements:
 -- 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
--- Support for global proxy and timeout settings (thanks, itchy!)
--- Support for setting certificate path and file to address Net::HTTP errors under Ruby 1.9.2
+-- 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:
@@ -24,13 +28,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
@@ -40,6 +44,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/koala.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name    = %q{koala}
-  s.version = "1.1.0rc2"
-  s.date    = %q{2011-06-06}
+  s.version = "1.1.0rc3"
+  s.date    = %q{2011-06-30}
 
   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,20 +28,20 @@ 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"])
       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"])
       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"])
     s.add_dependency(%q<rake>,      ["~> 0.8.7"])

data/lib/koala.rb

@@ -1,7 +1,7 @@
 require 'cgi'
 require 'digest/md5'
 
-require 'json'
+require 'multi_json'
 
 # OpenSSL and Base64 are required to support signed_request
 require 'openssl'
@@ -12,7 +12,9 @@ require 'koala/http_services'
 require 'koala/http_services/net_http_service'
 require 'koala/oauth'
 require 'koala/graph_api'
-require 'koala/graph_api_batch'
+require 'koala/graph_batch_api'
+require 'koala/batch_operation'
+require 'koala/graph_collection'
 require 'koala/rest_api'
 require 'koala/realtime_updates'
 require 'koala/test_users'
@@ -53,8 +55,8 @@ module Koala
 
         # parse the body as JSON and run it through the error checker (if provided)
         # Note: Facebook sometimes sends results like "true" and "false", which aren't strictly objects
-        # and cause JSON.parse to fail -- so we account for that by wrapping the result in []
-        body = JSON.parse("[#{result.body.to_s}]")[0]
+        # and cause MultiJson.decode to fail -- so we account for that by wrapping the result in []
+        body = MultiJson.decode("[#{result.body.to_s}]")[0]
         yield body if error_checking_block
 
         # if we want a component other than the body (e.g. redirect header for images), return that
@@ -66,9 +68,12 @@ module Koala
     
     class GraphAPI < API
       include GraphAPIMethods
-      include GraphAPIBatchMethods
     end
     
+    class GraphBatchAPI < GraphAPI
+      include GraphBatchAPIMethods      
+    end
+        
     class RestAPI < API
       include RestAPIMethods
     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

@@ -29,19 +29,6 @@ module Koala
       # 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 self.included(base)
-        base.class_eval do
-          def self.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
-          end
-        end
-      end
-
       # Objects
 
       def get_object(id, args = {}, options = {})
@@ -109,9 +96,9 @@ 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)
@@ -120,36 +107,30 @@ module Koala
         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] || {} 
+        put_object(*parse_media_args(picture_args, "photos"))
+      end
         
-        args["source"] = Koala::UploadableIO.new(*picture_args.slice(0, 1 + args_offset))
-
-        options[:http_service] = Koala.base_http_service if args["source"].requires_base_http_service
-
-        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
@@ -202,34 +183,6 @@ module Koala
         end
       end      
       
-      # API access
-
-      # Make a call which may or may not be batched
-      def graph_call(path, args = {}, verb = "get", options = {}, &post_processing)
-        # Direct access to the Facebook API
-        # see any of the above methods for example invocations
-        unless GraphAPI.batch_mode?
-          result = api(path, args, verb, options) do |response|
-            if error = GraphAPI.check_response(response)
-              raise error
-            end
-          end
-          
-          # now process as appropriate (get picture header, make GraphCollection, etc.)
-          post_processing ? post_processing.call(result) : result
-        else
-          # for batch APIs, we queue up the call details (incl. post-processing)
-          GraphAPI.batch_calls << BatchOperation.new(
-            :url => path,
-            :args => args,
-            :method => verb,
-            :access_token => @access_token,
-            :http_options => options,
-            :post_processing => post_processing
-          )
-          nil # batch operations return nothing immediately 
-        end
-      end
       
       # GraphCollection support
       def get_page(params)
@@ -240,58 +193,66 @@ module Koala
         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
       
-      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 ","
+      # 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
-        [base,new_params]
+
+        # now process as appropriate (get picture header, make GraphCollection, etc.)
+        post_processing ? post_processing.call(result) : result
       end
       
+      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
+      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