koala 0.9.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

@@ -0,0 +1,5 @@
+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,10 +1,74 @@
+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
+  -- Added UploadableIO class to manage file uploads
+-- Added a delete_like method (thanks to waseem)
+-- 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
+-- 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:
+-- 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
+-- Replaced parse_signed_request with a version from Facebook that also supports the new signed params proposal
+  -- Note: invalid requests will now raise exceptions rather than return nil, in keeping with other SDKs
+-- Delete methods will now raise an error if there's no access token (like put_object and delete_like)
+-- 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)
+-- Live tests now verify that the access token has the necessary permissions before starting
+-- Replaced the 50-person network test, which often took 15+ minutes to run live, with a 5-person test
+
+v0.10.0
+-- Added test user module
+-- Fixed bug when raising APIError after Facebook fails to exchange session keys
+-- Made access_token accessible via the readonly access_token property on all our API classes
+
+v0.9.1
+-- Tests are now compatible with Ruby 1.9.2
+-- Added JSON to runtime dependencies
+-- Removed examples directory (referenced from github instead)
+
 v0.9.0
 -- Added parse_signed_request to handle Facebook's new authentication scheme
   -- note: creates dependency on OpenSSL (OpenSSL::HMAC) for decryption
--- Added GraphCollection class to provide paging support for GraphAPI get_connections and search methods (thanks to jagthedrummer)    
+-- Added GraphCollection class to provide paging support for GraphAPI get_connections and search methods (thanks to jagthedrummer)
 -- Added get_page method to easily fetch pages of results from GraphCollections
 -- Exchanging sessions for tokens now works properly when provided invalid/expired session keys
--- You can now include a :typhoeus_options key in TyphoeusService#make_request's options hash to control the Typhoeus call (for example, to set :disable_ssl_peer_verification => true) 
+-- You can now include a :typhoeus_options key in TyphoeusService#make_request's options hash to control the Typhoeus call (for example, to set :disable_ssl_peer_verification => true)
 -- All paths provided to HTTP services start with leading / to improve compatibility with stubbing libraries
 -- If Facebook returns nil for search or get_connections requests, Koala now returns nil rather than throwing an exception
 
@@ -13,7 +77,7 @@ v0.8.0
   -- Removed string overloading for the methods, per 0.7.3, which caused Marshaling issues
   -- Removed ability to provide a string as the second argument to url_for_access_token, per 0.5.0
 
-v0.7.4 
+v0.7.4
 -- Fixed bug with get_user_from_cookies
 
 v0.7.3
@@ -24,18 +88,18 @@ v0.7.3
     -- Using those methods triggers a deprecation warning
     -- This will be removed by 1.0
   -- There are new info methods (get_access_token_info, get_app_access_token_info, get_token_info_from_session_keys, and get_user_info_from_cookies) that natively return hashes, for when you want the expiration date
--- Responses with HTTP status 500+ now properly throw errors under Net::HTTP 
+-- Responses with HTTP status 500+ now properly throw errors under Net::HTTP
 -- Updated changelog
 -- Added license
 
 v0.7.2
 -- Added support for exchanging session keys for OAuth access tokens (get_token_from_session_key for single keys, get_tokens_from_session_keys for multiple)
 -- Moved Koala files into a koala/ subdirectory to minimize risk of name collisions
--- Added OAuth Playground git submodule as an example 
+-- Added OAuth Playground git submodule as an example
 -- Updated tests, readme, and changelog
 
 v0.7.1
--- Updated RealtimeUpdates#list_subscriptions and GraphAPI#get_connections to now return an 
+-- Updated RealtimeUpdates#list_subscriptions and GraphAPI#get_connections to now return an
 array of results directly (rather than a hash with one key)
 -- Fixed a bug with Net::HTTP-based HTTP service in which the headers hash was improperly formatted
 -- Updated readme
@@ -82,7 +146,7 @@ v0.3.1
 v0.3
 -- Renamed Graph API class from Facebook::GraphAPI to FacebookGraph::API
 -- Created FacebookGraph::OAuth class for tokens and OAuth URLs
--- Updated method for including HTTP service (think we've got it this time) 
+-- Updated method for including HTTP service (think we've got it this time)
 -- Updated tests
 -- Added CHANGELOG and gemspec
 

data/Gemfile

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

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2010 Alex Koppel
+Copyright (c) 2010-2011 Alex Koppel
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest

@@ -2,20 +2,6 @@ CHANGELOG
 LICENSE
 Manifest
 Rakefile
-examples/oauth_playground/Capfile
-examples/oauth_playground/LICENSE
-examples/oauth_playground/Rakefile
-examples/oauth_playground/config.ru
-examples/oauth_playground/config/deploy.rb
-examples/oauth_playground/config/facebook.yml
-examples/oauth_playground/lib/load_facebook.rb
-examples/oauth_playground/lib/oauth_playground.rb
-examples/oauth_playground/readme.md
-examples/oauth_playground/spec/oauth_playground_spec.rb
-examples/oauth_playground/spec/spec_helper.rb
-examples/oauth_playground/tmp/restart.txt
-examples/oauth_playground/views/index.erb
-examples/oauth_playground/views/layout.erb
 init.rb
 koala.gemspec
 lib/koala.rb
@@ -23,20 +9,29 @@ lib/koala/graph_api.rb
 lib/koala/http_services.rb
 lib/koala/realtime_updates.rb
 lib/koala/rest_api.rb
+lib/koala/test_users.rb
+lib/koala/uploadable_io.rb
 readme.md
 spec/facebook_data.yml
 spec/koala/api_base_tests.rb
+spec/koala/assets/beach.jpg
 spec/koala/graph_and_rest_api/graph_and_rest_api_no_token_tests.rb
 spec/koala/graph_and_rest_api/graph_and_rest_api_with_token_tests.rb
 spec/koala/graph_api/graph_api_no_access_token_tests.rb
+spec/koala/graph_api/graph_api_tests.rb
 spec/koala/graph_api/graph_api_with_access_token_tests.rb
 spec/koala/graph_api/graph_collection_tests.rb
+spec/koala/http_services/http_service_tests.rb
+spec/koala/http_services/net_http_service_tests.rb
+spec/koala/http_services/typhoeus_service_tests.rb
 spec/koala/live_testing_data_helper.rb
-spec/koala/net_http_service_tests.rb
 spec/koala/oauth/oauth_tests.rb
 spec/koala/realtime_updates/realtime_updates_tests.rb
 spec/koala/rest_api/rest_api_no_access_token_tests.rb
+spec/koala/rest_api/rest_api_tests.rb
 spec/koala/rest_api/rest_api_with_access_token_tests.rb
+spec/koala/test_users/test_users_tests.rb
+spec/koala/uploadable_io/uploadable_io_tests.rb
 spec/koala_spec.rb
 spec/koala_spec_helper.rb
 spec/koala_spec_without_mocks.rb

data/Rakefile

@@ -1,16 +1,16 @@
-# Rakefile
-require 'rubygems'
 require 'rake'
-require 'echoe'
 
-# gem management
-Echoe.new('koala', '0.9.0') do |p|
-  p.summary    = "A lightweight, flexible library for Facebook with support for the Graph API, the old REST API, realtime updates, and OAuth validation."
-  p.description = "Koala is a lightweight, flexible Ruby SDK for Facebook.  It allows read/write access to the social graph via the Graph API and the older REST API, 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."
-  p.url            = "http://github.com/arsduo/koala"
-  p.author         = ["Alex Koppel", "Chris Baclig", "Rafi Jacoby", "Context Optional"]
-  p.email          = "alex@alexkoppel.com"
-  p.ignore_pattern = ["tmp/*", "script/*", "pkg/*"]
-  p.development_dependencies = []
-  p.retain_gemspec = true
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommened for running the tests'
+end
+
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["--color", '--format doc']
 end

data/autotest/discover.rb

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

data/koala.gemspec

@@ -1,30 +1,50 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{koala}
-  s.version = "0.9.0"
+  s.name    = %q{koala}
+  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.}
+  s.homepage    = %q{http://github.com/arsduo/koala}
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Koppel, Chris Baclig, Rafi Jacoby, Context Optional"]
-  s.date = %q{2010-09-30}
-  s.description = %q{Koala is a lightweight, flexible Ruby SDK for Facebook.  It allows read/write access to the social graph via the Graph API and the older REST API, 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.}
-  s.email = %q{alex@alexkoppel.com}
-  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "lib/koala.rb", "lib/koala/graph_api.rb", "lib/koala/http_services.rb", "lib/koala/realtime_updates.rb", "lib/koala/rest_api.rb"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest", "Rakefile", "examples/oauth_playground/Capfile", "examples/oauth_playground/LICENSE", "examples/oauth_playground/Rakefile", "examples/oauth_playground/config.ru", "examples/oauth_playground/config/deploy.rb", "examples/oauth_playground/config/facebook.yml", "examples/oauth_playground/lib/load_facebook.rb", "examples/oauth_playground/lib/oauth_playground.rb", "examples/oauth_playground/readme.md", "examples/oauth_playground/spec/oauth_playground_spec.rb", "examples/oauth_playground/spec/spec_helper.rb", "examples/oauth_playground/tmp/restart.txt", "examples/oauth_playground/views/index.erb", "examples/oauth_playground/views/layout.erb", "init.rb", "koala.gemspec", "lib/koala.rb", "lib/koala/graph_api.rb", "lib/koala/http_services.rb", "lib/koala/realtime_updates.rb", "lib/koala/rest_api.rb", "readme.md", "spec/facebook_data.yml", "spec/koala/api_base_tests.rb", "spec/koala/graph_and_rest_api/graph_and_rest_api_no_token_tests.rb", "spec/koala/graph_and_rest_api/graph_and_rest_api_with_token_tests.rb", "spec/koala/graph_api/graph_api_no_access_token_tests.rb", "spec/koala/graph_api/graph_api_with_access_token_tests.rb", "spec/koala/graph_api/graph_collection_tests.rb", "spec/koala/live_testing_data_helper.rb", "spec/koala/net_http_service_tests.rb", "spec/koala/oauth/oauth_tests.rb", "spec/koala/realtime_updates/realtime_updates_tests.rb", "spec/koala/rest_api/rest_api_no_access_token_tests.rb", "spec/koala/rest_api/rest_api_with_access_token_tests.rb", "spec/koala_spec.rb", "spec/koala_spec_helper.rb", "spec/koala_spec_without_mocks.rb", "spec/mock_facebook_responses.yml", "spec/mock_http_service.rb"]
-  s.homepage = %q{http://github.com/arsduo/koala}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Koala", "--main", "readme.md"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{koala}
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{A lightweight, flexible library for Facebook with support for the Graph API, the old REST API, realtime updates, and OAuth validation.}
+  s.email   = %q{alex@alexkoppel.com}
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.extra_rdoc_files = ["readme.md", "CHANGELOG"]
+  s.rdoc_options     = ["--line-numbers", "--inline-source", "--title", "Koala"]
+
+  s.require_paths     = ["lib"]
+
+  s.rubygems_version  = %q{1.4.2}
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    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<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<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<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
 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