koala 1.2.0 → 1.3.0

data/.gitignore

@@ -2,4 +2,6 @@ pkg
 .project
 Gemfile.lock
 .rvmrc
-*.rbc
+*.rbc
+*~
+.yardoc/

data/.rspec

@@ -0,0 +1 @@
+--color --order rand

data/.travis.yml

@@ -7,3 +7,7 @@ rvm:
   - rbx-2.0
   - ree
   - jruby
+
+branches:
+  except:
+    - rdoc

data/.yardopts

@@ -0,0 +1,3 @@
+--readme          readme.md
+--title           "Koala Documentation"
+--no-private

data/CHANGELOG

@@ -1,3 +1,46 @@
+v1.3
+New methods:
+-- OAuth#url_for_dialog creates URLs for Facebook dialog pages
+-- API#set_app_restrictions handles JSON-encoding app restrictions
+-- GraphCollection.parse_page_url now exposes useful functionality for non-Rails apps
+-- RealtimeUpdates#subscription_path and TestUsers#test_user_accounts_path are now public
+Updated methods:
+-- REST API methods are now deprecated (see http://developers.facebook.com/blog/post/616/)
+-- OAuth#url_for_access_token and #url_for_oauth_code now include any provided options as URL parameters
+-- APIError#raw_response allows access to the raw error response received from Facebook
+-- Utils.deprecate only prints each message once (no more spamming)
+-- API#get_page_access_token now accepts additional arguments and HTTP options (like other calls)
+-- TestUsers and RealtimeUpdates methods now take http_options arguments
+-- All methods with http_options can now take :http_component => :response for the complete response
+-- OAuth#get_user_info_from_cookies returns nil rather than an error if the cookies are expired (thanks, herzio)
+-- TestUsers#delete_all now uses the Batch API and is much faster
+Internal improvements:
+-- FQL queries now use the Graph API behind-the-scenes
+-- Cleaned up file and class organization, with aliases for backward compatibility
+-- Added YARD documentation throughout
+-- Fixed bugs in RealtimeUpdates, TestUsers, elsewhere
+-- Reorganized file and class structure non-destructively
+Testing improvements:
+-- Expanded/improved test coverage
+-- The test suite no longer users any hard-coded user IDs
+-- KoalaTest.test_user_api allows access to the TestUsers instance
+-- Configured tests to run in random order using RSpec 2.8.0rc1 
+
+v1.2.1
+New methods:
+-- RestAPI.set_app_properties handles JSON-encoding application properties
+Updated methods:
+-- OAuth.get_user_from_cookie works with the new signed cookie format (thanks, gmccreight!)
+-- Beta server URLs are now correct
+-- OAuth.parse_signed_request now raises an informative error if the signed_request is malformed
+Internal improvements:
+-- Koala::Multipart middleware properly encoding nested parameters (hashes) in POSTs
+-- Updated readme, changelog, etc.
+Testing improvements:
+-- Live tests with test users now clean up all fake users they create
+-- Removed duplicate test cases
+-- Live tests with test users no longer delete each object they create, speeding things up
+
 v1.2
 New methods:
 -- API is now the main API class, contains both Graph and REST methods

data/Gemfile

@@ -1,7 +1,21 @@
 source :rubygems
 
+group :development do
+  gem "yard"
+end
+
 group :development, :test do
   gem "typhoeus"
+
+  # Testing infrastructure
+  gem 'guard'
+  gem 'guard-rspec'
+
+  if RUBY_PLATFORM =~ /darwin/
+    # OS X integration
+    gem "ruby_gntp"
+    gem "rb-fsevent", "~> 0.4.3.1"
+  end
 end
 
 if defined? JRUBY_VERSION

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/koala.gemspec

@@ -5,7 +5,7 @@ require 'koala/version'
 Gem::Specification.new do |s|
   s.name    = %q{koala}
   s.version = Koala::VERSION
-  s.date    = %q{2011-09-27}
+  s.date    = %q{2011-10-04}
 
   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.}
@@ -32,17 +32,17 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<multi_json>,      ["~> 1.0"])
       s.add_runtime_dependency(%q<faraday>,  ["~> 0.7.0"])
-      s.add_development_dependency(%q<rspec>,     ["~> 2.5"])
+      s.add_development_dependency(%q<rspec>,     ["~> 2.8.0rc1"])
       s.add_development_dependency(%q<rake>,      ["~> 0.8.7"])
     else
       s.add_dependency(%q<multi_json>,      ["~> 1.0"])
-      s.add_dependency(%q<rspec>,     ["~> 2.5"])
+      s.add_dependency(%q<rspec>,     ["~> 2.8.0rc1"])
       s.add_dependency(%q<rake>,      ["~> 0.8.7"])
       s.add_dependency(%q<faraday>,  ["~> 0.7.0"])
     end
   else
     s.add_dependency(%q<multi_json>,      ["~> 1.0"])
-    s.add_dependency(%q<rspec>,     ["~> 2.5"])
+    s.add_dependency(%q<rspec>,     ["~> 2.8.0rc1"])
     s.add_dependency(%q<rake>,      ["~> 0.8.7"])
     s.add_dependency(%q<faraday>,  ["~> 0.7.0"])
   end

data/lib/koala/api/batch_operation.rb

@@ -0,0 +1,83 @@
+require 'koala/api'
+
+module Koala
+  module Facebook
+    class GraphBatchAPI < API
+      # @private
+      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
+
+    # @private
+    # legacy support for when BatchOperation lived directly under Koala::Facebook
+    BatchOperation = GraphBatchAPI::BatchOperation
+  end
+end