koala 1.2.0beta3 → 1.2.0beta4

data/CHANGELOG

@@ -4,10 +4,15 @@ New methods:
   -- Old classes are aliased with deprecation warnings (non-breaking change)
 -- TestUsers#update lets you update the name or password of an existing test user
 -- API.get_page_access_token lets you easily fetch the access token for a page you manage (thanks, marcgg!)
+-- Added version.rb (Koala::VERSION)
 Updated methods:
 -- OAuth now parses Facebook's new signed cookie format
 -- API.put_picture now accepts URLs to images (thanks, marcgg!)
 -- Bug fixes to put_picture, parse_signed_request, and the test suite (thanks, johnbhall and Will S.!)
+-- Smarter GraphCollection use
+  -- Any pageable result will now become a GraphCollection
+  -- Non-pageable results from get_connections no longer error
+  -- GraphCollection.raw_results allows access to original result data
 Internal improvements:
 -- Koala now uses Faraday to make requests, replacing the HTTPServices (see wiki)
   -- Koala::HTTPService.http_options allows specification of default Faraday connection options
@@ -17,6 +22,7 @@ Internal improvements:
   -- Koala no longer automatically switches to Net::HTTP when uploading IO objects to Facebook
 -- RealTimeUpdates and TestUsers are no longer subclasses of API, but have their own .api objects
   -- The old .graph_api accessor is aliases to .api with a deprecation warning
+-- Removed deprecation warnings for pre-1.1 batch interface
 Testing improvements:
 -- Live test suites now run against test users by default
   -- Test suite can be repeatedly run live without having to update facebook_data.yml
@@ -24,7 +30,7 @@ Testing improvements:
 -- Faraday adapter for live tests can be specified with ADAPTER=[your adapter] in the rspec command
 -- Live tests can be run against the beta server by specifying BETA=true in the rspec command
 -- Tests now pass against all rubies on Travis CI
--- Expanded test coverage
+-- Expanded and refactored test coverage
 -- Fixed bug with YAML parsing in Ruby 1.9
 
 v1.1

data/koala.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name    = %q{koala}
-  s.version = "1.2.0beta3"
-  s.date    = %q{2011-09-12}
+  s.version = "1.2.0beta4"
+  s.date    = %q{2011-09-21}
 
   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.}

data/lib/koala.rb

@@ -8,7 +8,6 @@ require 'openssl'
 require 'base64'
 
 # include koala modules
-require 'koala/http_service'
 require 'koala/oauth'
 require 'koala/graph_api'
 require 'koala/graph_batch_api'
@@ -17,11 +16,17 @@ require 'koala/graph_collection'
 require 'koala/rest_api'
 require 'koala/realtime_updates'
 require 'koala/test_users'
-require 'koala/utils'
+
+# HTTP module so we can communicate with Facebook
+require 'koala/http_service'
 
 # add KoalaIO class
 require 'koala/uploadable_io'
 
+# miscellaneous
+require 'koala/utils'
+require 'koala/version'
+
 module Koala
 
   module Facebook

data/lib/koala/graph_api.rb

@@ -71,9 +71,7 @@ module Koala
 
       def get_connections(id, connection_name, args = {}, options = {})
         # Fetchs the connections for given object.
-        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
+        graph_call("#{id}/#{connection_name}", args, "get", options)
       end
 
       def put_connections(id, connection_name, args = {}, options = {})
@@ -174,9 +172,7 @@ module Koala
 
       def search(search_terms, args = {}, options = {})
         args.merge!({:q => search_terms}) unless search_terms.nil?
-        graph_call("search", args, "get", options) do |result|
-          result ? GraphCollection.new(result, self) : nil # when facebook is down nil can be returned
-        end
+        graph_call("search", args, "get", options)
       end
 
       # Convenience Methods
@@ -199,14 +195,12 @@ module Koala
       def get_page(params)
         # Pages through a set of results stored in a GraphCollection
         # Used for connections and search results
-        graph_call(*params) do |result|
-          result ? GraphCollection.new(result, self) : nil # when facebook is down nil can be returned
-        end
+        graph_call(*params)
       end
 
       # Batch API
       def batch(http_options = {}, &block)
-        batch_client = GraphBatchAPI.new(access_token)
+        batch_client = GraphBatchAPI.new(access_token, self)
         if block
           yield batch_client
           batch_client.execute(http_options)
@@ -214,15 +208,7 @@ module Koala
           batch_client
         end
       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)
@@ -231,10 +217,15 @@ module Koala
           raise error if error
         end
 
-        # now process as appropriate (get picture header, make GraphCollection, etc.)
+        # turn this into a GraphCollection if it's pageable
+        result = GraphCollection.evaluate(result, self)
+        
+        # now process as appropriate for the given call (get picture header, etc.)
         post_processing ? post_processing.call(result) : result
       end
 
+      private
+      
       def check_response(response)
         # check for Graph API-specific errors
         # this returns an error, which is immediately raised (non-batch)
@@ -244,8 +235,6 @@ module Koala
         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

data/lib/koala/graph_batch_api.rb

@@ -4,6 +4,13 @@ module Koala
 
       def self.included(base)
         base.class_eval do
+          attr_reader :original_api
+          
+          def initialize(access_token, api)
+            super(access_token)
+            @original_api = api
+          end
+
           alias_method :graph_call_outside_batch, :graph_call
           alias_method :graph_call, :graph_call_in_batch
 
@@ -46,7 +53,7 @@ module Koala
           batch_op.to_batch_params(access_token)
         })
 
-        graph_call_outside_batch('/', args, 'post', http_options) do |response|
+        batch_result = 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|
@@ -80,6 +87,9 @@ module Koala
             end
           end
         end
+        
+        # turn any results that are pageable into GraphCollections
+        batch_result.inject([]) {|processed_results, raw| processed_results << GraphCollection.evaluate(raw, @original_api)}
       end
 
     end

data/lib/koala/graph_collection.rb

@@ -10,12 +10,17 @@ module Koala
       # 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
+      attr_reader :paging, :api, :raw_response
 
+      def self.evaluate(response, api)
+        # turn the response into a GraphCollection if it's pageable; if not, return the original response
+        response.is_a?(Hash) && response["data"].is_a?(Array) ? self.new(response, api) : response
+      end
+    
       def initialize(response, api)
         super response["data"]
         @paging = response["paging"]
+        @raw_response = response
         @api = api
       end
 

data/lib/koala/realtime_updates.rb

@@ -71,7 +71,7 @@ module Koala
       end
 
       def list_subscriptions
-        @graph_api.graph_call(subscription_path)["data"]
+        @graph_api.graph_call(subscription_path)
       end
 
       def graph_api

data/lib/koala/test_users.rb

@@ -35,7 +35,7 @@ module Koala
       end
 
       def list
-        @api.graph_call(accounts_path)["data"]
+        @api.graph_call(accounts_path)
       end
 
       def delete(test_user)
@@ -72,7 +72,6 @@ module Koala
       end
 
       def create_network(network_size, installed = true, permissions = '')
-        network_size = 50 if network_size > 50 # FB's max is 50
         users = (0...network_size).collect { create(installed, permissions) }
         friends = users.clone
         users.each do |user|

data/lib/koala/version.rb

@@ -0,0 +1,3 @@
+module Koala
+  VERSION = "1.2.0beta4"
+end

data/spec/cases/{api_base_spec.rb → api_spec.rb}

@@ -98,4 +98,29 @@ describe "Koala::Facebook::API" do
     end
   end
 
+  describe "with an access token" do
+    before(:each) do
+      @api = Koala::Facebook::API.new(@token)
+    end
+
+    it_should_behave_like "Koala RestAPI"
+    it_should_behave_like "Koala RestAPI with an access token"
+
+    it_should_behave_like "Koala GraphAPI"
+    it_should_behave_like "Koala GraphAPI with an access token"
+    it_should_behave_like "Koala GraphAPI with GraphCollection"
+  end
+
+  describe "without an access token" do
+    before(:each) do
+      @api = Koala::Facebook::API.new
+    end
+
+    it_should_behave_like "Koala RestAPI"
+    it_should_behave_like "Koala RestAPI without an access token"
+
+    it_should_behave_like "Koala GraphAPI"
+    it_should_behave_like "Koala GraphAPI without an access token"
+    it_should_behave_like "Koala GraphAPI with GraphCollection"
+  end
 end

data/spec/cases/graph_and_rest_api_spec.rb

@@ -19,30 +19,4 @@ describe "Koala::Facebook::GraphAndRestAPI" do
       api = Koala::Facebook::GraphAndRestAPI.new("token")
     end
   end
-
-  describe "with an access token" do
-    before(:each) do
-      @api = Koala::Facebook::API.new(@token)
-    end
-
-    it_should_behave_like "Koala RestAPI"
-    it_should_behave_like "Koala RestAPI with an access token"
-
-    it_should_behave_like "Koala GraphAPI"
-    it_should_behave_like "Koala GraphAPI with an access token"
-    it_should_behave_like "Koala GraphAPI with GraphCollection"
-  end
-
-  describe "without an access token" do
-    before(:each) do
-      @api = Koala::Facebook::API.new
-    end
-
-    it_should_behave_like "Koala RestAPI"
-    it_should_behave_like "Koala RestAPI without an access token"
-
-    it_should_behave_like "Koala GraphAPI"
-    it_should_behave_like "Koala GraphAPI without an access token"
-    it_should_behave_like "Koala GraphAPI with GraphCollection"
-  end
 end

data/spec/cases/graph_api_batch_spec.rb

@@ -430,7 +430,7 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
   end
 
   describe "usage tests" do
-    it "can get two results at once" do
+    it "gets two results at once" do
       me, koppel = @api.batch do |batch_api|
         batch_api.get_object('me')
         batch_api.get_object(KoalaTest.user1)
@@ -439,7 +439,15 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
       koppel['id'].should_not be_nil
     end
 
-    it 'should be able to make mixed calls inside of a batch' do
+    it 'makes mixed calls inside of a batch' do
+      me, friends = @api.batch do |batch_api|
+        batch_api.get_object('me')
+        batch_api.get_connections('me', 'friends')
+      end
+      friends.should be_a(Koala::Facebook::GraphCollection)
+    end
+    
+    it 'turns pageable results into GraphCollections' do
       me, friends = @api.batch do |batch_api|
         batch_api.get_object('me')
         batch_api.get_connections('me', 'friends')
@@ -448,14 +456,14 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
       friends.should be_an(Array)
     end
 
-    it 'should be able to make a get_picture call inside of a batch' do
+    it 'makes a get_picture call inside of a batch' do
       pictures = @api.batch do |batch_api|
         batch_api.get_picture('me')
       end
       pictures.first.should_not be_empty
     end
 
-    it "should handle requests for two different tokens" do
+    it "handles requests for two different tokens" do
       me, insights = @api.batch do |batch_api|
         batch_api.get_object('me')
         batch_api.get_connections(@app_id, 'insights', {}, {"access_token" => @app_api.access_token})
@@ -571,30 +579,4 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
       end
     end
   end
-
-  describe "new interface" do
-    it "includes a deprecation warning on GraphAPI" do
-      begin
-        Koala::Facebook::GraphAPI.batch do
-        end
-      rescue NoMethodError => @err
-      end
-
-      # verify the message points people to the wiki page
-      @err.should
-      @err.message.should =~ /https\:\/\/github.com\/arsduo\/koala\/wiki\/Batch-requests/
-    end
-
-    it "includes a deprecation warning on GraphAndRESTAPI" do
-      begin
-        Koala::Facebook::GraphAndRestAPI.batch do
-        end
-      rescue NoMethodError => @err
-      end
-
-      # verify the message points people to the wiki page
-      @err.should
-      @err.message.should =~ /https\:\/\/github.com\/arsduo\/koala\/wiki\/Batch-requests/
-    end
-  end
 end

data/spec/cases/graph_api_spec.rb

@@ -19,24 +19,4 @@ describe "Koala::Facebook::GraphAPI" do
       api = Koala::Facebook::GraphAPI.new("token")
     end
   end
-
-  context "with an access token" do
-    before :each do
-      @api = Koala::Facebook::API.new(@token)
-    end
-
-    it_should_behave_like "Koala GraphAPI"
-    it_should_behave_like "Koala GraphAPI with an access token"
-    it_should_behave_like "Koala GraphAPI with GraphCollection"
-  end
-
-  context "without an access token" do
-    before :each do
-      @api = Koala::Facebook::API.new
-    end
-
-    it_should_behave_like "Koala GraphAPI"
-    it_should_behave_like "Koala GraphAPI without an access token"
-    it_should_behave_like "Koala GraphAPI with GraphCollection"
-  end
 end

data/spec/cases/graph_collection_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe Koala::Facebook::GraphCollection do
+  before(:each) do
+    @result = {
+      "data" => [1, 2, :three],
+      "paging" => {:paging => true}
+    }
+    @api = Koala::Facebook::API.new("123")
+    @collection = Koala::Facebook::GraphCollection.new(@result, @api)
+  end
+
+  it "subclasses Array" do
+    Koala::Facebook::GraphCollection.ancestors.should include(Array)
+  end
+  
+  it "creates an array-like object" do
+    Koala::Facebook::GraphCollection.new(@result, @api).should be_an(Array)
+  end
+  
+  it "contains the result data" do
+    @result["data"].each_with_index {|r, i| @collection[i].should == r}
+  end
+
+  it "has a read-only paging attribute" do
+    @collection.methods.map(&:to_sym).should include(:paging)
+    @collection.methods.map(&:to_sym).should_not include(:paging=)
+  end
+  
+  it "sets paging to results['paging']" do
+    @collection.paging.should == @result["paging"]
+  end
+  
+  it "sets raw_response to the original results" do
+    @collection.raw_response.should == @result
+  end
+  
+  it "sets the API to the provided API" do
+    @collection.api.should == @api
+  end
+    
+  describe "when getting a whole page" do
+    before(:each) do
+      @second_page = {
+        "data" => [:second, :page, :data],
+        "paging" => {}
+      }
+      @base = stub("base")
+      @args = stub("args")
+      @page_of_results = stub("page of results")
+    end
+
+    it "should return the previous page of results" do
+      @collection.should_receive(:previous_page_params).and_return([@base, @args])
+      @api.should_receive(:api).with(@base, @args, anything, anything).and_return(@second_page)
+      Koala::Facebook::GraphCollection.should_receive(:new).with(@second_page, @api).and_return(@page_of_results)
+      @collection.previous_page.should == @page_of_results
+    end
+
+    it "should return the next page of results" do
+      @collection.should_receive(:next_page_params).and_return([@base, @args])
+      @api.should_receive(:api).with(@base, @args, anything, anything).and_return(@second_page)
+      Koala::Facebook::GraphCollection.should_receive(:new).with(@second_page, @api).and_return(@page_of_results)
+
+      @collection.next_page.should == @page_of_results
+    end
+
+    it "should return nil it there are no other pages" do
+      %w{next previous}.each do |this|
+        @collection.should_receive("#{this}_page_params".to_sym).and_return(nil)
+        @collection.send("#{this}_page").should == nil
+      end
+    end
+  end
+
+  describe "when parsing page paramters" do
+    it "should return the base as the first array entry" do
+      base = "url_path"
+      @collection.parse_page_url("anything.com/#{base}?anything").first.should == base
+    end
+
+    it "should return the arguments as a hash as the last array entry" do
+      args_hash = {"one" => "val_one", "two" => "val_two"}
+      @collection.parse_page_url("anything.com/anything?#{args_hash.map {|k,v| "#{k}=#{v}" }.join("&")}").last.should == args_hash
+    end
+  end
+
+  describe "#evaluate" do
+    it "returns the original result if it's provided a non-hash result" do
+      result = []
+      Koala::Facebook::GraphCollection.evaluate(result, @api).should == result
+    end
+    
+    it "returns the original result if it's provided a nil result" do
+      result = nil
+      Koala::Facebook::GraphCollection.evaluate(result, @api).should == result
+    end
+    
+    it "returns the original result if the result doesn't have a data key" do
+      result = {"paging" => {}}
+      Koala::Facebook::GraphCollection.evaluate(result, @api).should == result
+    end
+    
+    it "returns the original result if the result's data key isn't an array" do
+      result = {"data" => {}, "paging" => {}}
+      Koala::Facebook::GraphCollection.evaluate(result, @api).should == result
+    end
+        
+    it "returns a new GraphCollection of the result if it has an array data key and a paging key" do
+      result = {"data" => [], "paging" => {}}
+      expected = :foo
+      Koala::Facebook::GraphCollection.should_receive(:new).with(result, @api).and_return(expected)
+      Koala::Facebook::GraphCollection.evaluate(result, @api).should == expected
+    end
+  end
+end

data/spec/cases/koala_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 
 describe "Koala" do
+  it "has a version" do
+    Koala.const_defined?("VERSION").should be_true
+  end
+  
   it "has an http_service accessor" do
     Koala.should respond_to(:http_service)
     Koala.should respond_to(:http_service=)

data/spec/cases/test_users_spec.rb

@@ -13,6 +13,13 @@ describe "Koala::Facebook::TestUsers" do
         raise Exception, "Must supply OAuth app id, secret, app_access_token, and callback to run live subscription tests!"
       end
     end
+    
+    after :each do
+      # clean up any test users
+      ((@network || []) + [@user1, @user2]).each do |u|
+        puts "Unable to delete test user #{u.inspect}" if u && (!@test_users.delete(u) rescue false)
+      end
+    end
 
     describe "when initializing" do
       # basic initialization
@@ -131,11 +138,6 @@ describe "Koala::Facebook::TestUsers" do
           @user2 = @test_users.create(true, "read_stream,user_interests")
         end
 
-        after :each do
-          @test_users.delete(@user1) if @user1
-          @test_users.delete(@user2) if @user2
-        end
-
         it "should delete a user by id" do
           @test_users.delete(@user1['id']).should be_true
           @user1 = nil
@@ -191,11 +193,6 @@ describe "Koala::Facebook::TestUsers" do
           @user2 = @test_users.create(true, "read_stream,user_interests")
         end
 
-        after :each do
-          @test_users.delete(@user1)
-          @test_users.delete(@user2)
-        end
-
         it "should list test users" do
           result = @test_users.list
           result.should be_an(Array)
@@ -251,10 +248,11 @@ describe "Koala::Facebook::TestUsers" do
         end
       end
 
-      it "should limit to a 50 person network" do
-        @test_users.should_receive(:create).exactly(50).times
+      it "has no built-in network size limit" do
+        times = 100
+        @test_users.should_receive(:create).exactly(times).times
         @test_users.stub!(:befriend)
-        @network = @test_users.create_network(51)
+        @network = @test_users.create_network(times)
       end
 
       it "should pass on the installed and permissions parameters to create" do

data/spec/fixtures/mock_facebook_responses.yml

@@ -87,10 +87,10 @@ graph_api:
         with_token: '[{"headers":[{"name":"Location","value":"http://google.com"}]}]'
     batch=<%= MultiJson.encode([{"method" => "get", "relative_url" => "me"},{"method" => "get", "relative_url" => "me/friends"}]) %>:
       post:
-        with_token: '[{"body":"{\"id\":\"123\"}"}, {"body":"{\"data\":[]}"}]'
+        with_token: '[{"body":"{\"id\":\"123\"}"}, {"body":"{\"data\":[],\"paging\":{}}"}]'
     batch=<%= MultiJson.encode([{"method"=>"get", "relative_url"=>"me"}, {"method"=>"get", "relative_url"=>"#{OAUTH_DATA["app_id"]}/insights?access_token=#{CGI.escape APP_ACCESS_TOKEN}"}]) %>:
       post:
-        with_token: '[{"body":"{\"id\":\"123\"}"}, {"body":"{\"data\":[]}"}]'
+        with_token: '[{"body":"{\"id\":\"123\"}"}, {"body":"{\"data\":[],\"paging\":{}}"}]'
     batch=<%= MultiJson.encode([{"method"=>"get", "relative_url"=>"#{OAUTH_DATA["app_id"]}/insights"}, {"method"=>"get", "relative_url"=>"koppel?access_token=#{CGI.escape APP_ACCESS_TOKEN}"}]) %>:
       post:
         with_token: '[{"body": "{\"error\":{\"type\":\"AnError\", \"message\":\"An error occurred!.\"}}"},{"body":"{\"id\":\"123\"}"}]'
@@ -113,7 +113,7 @@ graph_api:
         with_token: '[null,{"body":"{}"}]'
     batch=<%= MultiJson.encode([{"method" => "get", "relative_url" => "me/friends?limit=5", "name" => "get-friends", "omit_response_on_success" => false}, {"method" => "get", "relative_url" => "?ids=#{CGI.escape "{result=get-friends:$.data.*.id}"}"}]) %>:
       post:
-        with_token: '[{"body":"{\"data\":[]}"},{"body":"{}"}]'
+        with_token: '[{"body":"{\"data\":[],\"paging\":{}}"},{"body":"{}"}]'
     batch=<%= MultiJson.encode([{"method" => "get", "relative_url" => "me/friends?limit=5"}, {"method" => "get", "relative_url" => "?ids=#{CGI.escape "{result=i-dont-exist:$.data.*.id}"}"}]) %>:
       post:
         with_token: '{"error":190,"error_description":"Error validating access token."}'
@@ -211,7 +211,7 @@ graph_api:
     no_args:
       get:
         <<: *token_required
-        with_token: '{"data": [{}]}'
+        with_token: '{"data": [{}], "paging": {}}'
 
   /lukeshepard/picture:
     type=large:
@@ -261,7 +261,7 @@ graph_api:
       get:
         with_token: '{"data": [{"id": "507731521_100412693339488"}], "paging": {"previous": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000", "next": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000"}}'
         no_token: '{"data": [{"id": "507731521_100412693339488"}], "paging": {"previous": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000", "next": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000"}}'
-    "limit=25&q=facebook&until=2010-09-23T21:17:33+0000":
+    "limit=25&q=facebook&until=<%= TEST_DATA['search_time'] %>":
       get:
         with_token: '{"data": [{"id": "507731521_100412693339488"}], "paging": {"previous": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000", "next": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000"}}'
         no_token: '{"data": [{"id": "507731521_100412693339488"}], "paging": {"previous": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000", "next": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000"}}'

data/spec/support/graph_api_shared_examples.rb

@@ -17,9 +17,7 @@ shared_examples_for "Koala GraphAPI" do
   describe "graph_call" do
     it "should pass all arguments to the api method" do
       args = [KoalaTest.user1, {}, "get", {:a => :b}]
-
       @api.should_receive(:api).with(*args)
-
       @api.graph_call(*args)
     end
 
@@ -27,6 +25,27 @@ shared_examples_for "Koala GraphAPI" do
       Koala.stub(:make_request).and_return(Koala::Response.new(500, {"error" => "An error occurred!"}, {}))
       lambda { @api.graph_call(KoalaTest.user1, {}) }.should raise_exception(Koala::Facebook::APIError)
     end
+    
+    it "passes the results through GraphCollection.evaluate" do
+      result = {}
+      @api.stub(:api).and_return(result)
+      Koala::Facebook::GraphCollection.should_receive(:evaluate).with(result, @api)
+      @api.graph_call("/me")
+    end
+    
+    it "returns the results of GraphCollection.evaluate" do
+      expected = {}
+      @api.stub(:api).and_return([])
+      Koala::Facebook::GraphCollection.should_receive(:evaluate).and_return(expected)
+      @api.graph_call("/me").should == expected
+    end
+    
+    it "returns the post_processing block's results if one is supplied" do
+      other_result = [:a, 2, :three]
+      block = Proc.new {|r| other_result}
+      @api.stub(:api).and_return({})
+      @api.graph_call("/me", {}, "get", {}, &block).should == other_result
+    end 
   end
 
   # SEARCH
@@ -349,12 +368,6 @@ end
 
 # GraphCollection
 shared_examples_for "Koala GraphAPI with GraphCollection" do
-
-  it "should create an array-like object" do
-    call = @api.graph_call("contextoptional/photos")
-    Koala::Facebook::GraphCollection.new(call, @api).should be_an(Array)
-  end
-
   describe "when getting a collection" do
     # GraphCollection methods
     it "should get a GraphCollection when getting connections" do
@@ -380,74 +393,14 @@ shared_examples_for "Koala GraphAPI with GraphCollection" do
     end
 
     it "should get a GraphCollection when paging through results" do
-      @results = @api.get_page(["search", {"q"=>"facebook", "limit"=>"25", "until"=>"2010-09-23T21:17:33+0000"}])
+      @results = @api.get_page(["search", {"q"=>"facebook", "limit"=>"25", "until"=> KoalaTest.search_time}])
       @results.should be_a(Koala::Facebook::GraphCollection)
     end
 
     it "should return nil if the page call fails with nil" do
       # this happens sometimes
       @api.should_receive(:graph_call).and_return(nil)
-      @api.get_page(["search", {"q"=>"facebook", "limit"=>"25", "until"=>"2010-09-23T21:17:33+0000"}]).should be_nil
-    end
-
-    # GraphCollection attributes
-    describe "the GraphCollection" do
-      before(:each) do
-        @result = @api.get_connections(KoalaTest.page, "photos")
-      end
-
-      it "should have a read-only paging attribute" do
-        @result.methods.map(&:to_sym).should include(:paging)
-        @result.methods.map(&:to_sym).should_not include(:paging=)
-      end
-
-      describe "when getting a whole page" do
-        before(:each) do
-          @second_page = stub("page of Fb graph results")
-          @base = stub("base")
-          @args = stub("args")
-          @page_of_results = stub("page of results")
-        end
-
-        it "should return the previous page of results" do
-          @result.should_receive(:previous_page_params).and_return([@base, @args])
-          @api.should_receive(:graph_call).with(@base, @args).and_yield(@second_page)
-          Koala::Facebook::GraphCollection.should_receive(:new).with(@second_page, @api).and_return(@page_of_results)
-
-          @result.previous_page#.should == @page_of_results
-        end
-
-        it "should return the next page of results" do
-          @result.should_receive(:next_page_params).and_return([@base, @args])
-          @api.should_receive(:graph_call).with(@base, @args).and_yield(@second_page)
-          Koala::Facebook::GraphCollection.should_receive(:new).with(@second_page, @api).and_return(@page_of_results)
-
-          @result.next_page#.should == @page_of_results
-        end
-
-        it "should return nil it there are no other pages" do
-          %w{next previous}.each do |this|
-            @result.should_receive("#{this}_page_params".to_sym).and_return(nil)
-            @result.send("#{this}_page").should == nil
-          end
-        end
-      end
-
-      describe "when parsing page paramters" do
-        before(:each) do
-          @graph_collection = Koala::Facebook::GraphCollection.new({"data" => []}, Koala::Facebook::API.new)
-        end
-
-        it "should return the base as the first array entry" do
-          base = "url_path"
-          @graph_collection.parse_page_url("anything.com/#{base}?anything").first.should == base
-        end
-
-        it "should return the arguments as a hash as the last array entry" do
-          args_hash = {"one" => "val_one", "two" => "val_two"}
-          @graph_collection.parse_page_url("anything.com/anything?#{args_hash.map {|k,v| "#{k}=#{v}" }.join("&")}").last.should == args_hash
-        end
-      end
+      @api.get_page(["search", {"q"=>"facebook", "limit"=>"25", "until"=> KoalaTest.search_time}]).should be_nil
     end
   end
 end

data/spec/support/koala_test.rb

@@ -3,7 +3,7 @@ module KoalaTest
 
   class << self
     attr_accessor :oauth_token, :app_id, :secret, :app_access_token, :code, :session_key
-    attr_accessor :oauth_test_data, :subscription_test_data
+    attr_accessor :oauth_test_data, :subscription_test_data, :search_time
   end
     
   # Test setup
@@ -84,6 +84,9 @@ module KoalaTest
     self.secret = data["oauth_test_data"]["secret"]
     self.code = data["oauth_test_data"]["code"]
     self.session_key = data["oauth_test_data"]["session_key"]
+    
+    # fix the search time so it can be used in the mock responses
+    self.search_time = data["search_time"] || (Time.now - 3600).to_s
   end
 
   def self.testing_permissions
@@ -97,15 +100,34 @@ module KoalaTest
     print "Setting up test users..."
     @test_user_api = Koala::Facebook::TestUsers.new(:app_id => self.app_id, :secret => self.secret)
 
-    # create two test users with specific names and befriend them
-    @live_testing_user = @test_user_api.create(true, testing_permissions, :name => user1_name)
-    @live_testing_friend = @test_user_api.create(true, testing_permissions, :name => user2_name)
-    @test_user_api.befriend(@live_testing_user, @live_testing_friend)
-    self.oauth_token = @live_testing_user["access_token"]
+    RSpec.configure do |config|
+      config.before :all do
+        # before each test module, create two test users with specific names and befriend them
+        KoalaTest.create_test_users
+      end
+      
+      config.after :all do
+        # after each test module, delete the test users to avoid cluttering up the application
+        KoalaTest.destroy_test_users
+      end
+    end
 
     puts "done."
   end
 
+  def self.create_test_users
+    @live_testing_user = @test_user_api.create(true, KoalaTest.testing_permissions, :name => KoalaTest.user1_name)
+    @live_testing_friend = @test_user_api.create(true, KoalaTest.testing_permissions, :name => KoalaTest.user2_name)
+    @test_user_api.befriend(@live_testing_user, @live_testing_friend)
+    self.oauth_token = @live_testing_user["access_token"]
+  end
+  
+  def self.destroy_test_users
+    [@live_testing_user, @live_testing_friend].each do |u|
+      puts "Unable to delete test user #{u.inspect}" if u && !(@test_user_api.delete(u) rescue false)
+    end
+  end
+
   def self.validate_user_info(token)
     print "Validating permissions for live testing..."
     # make sure we have the necessary permissions

data/spec/support/mock_http_service.rb

@@ -18,7 +18,8 @@ module Koala
     TEST_DATA = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'fixtures', 'facebook_data.yml'))
     TEST_DATA.merge!('oauth_token' => Koala::MockHTTPService::ACCESS_TOKEN)
     TEST_DATA['oauth_test_data'].merge!('code' => Koala::MockHTTPService::OAUTH_CODE)
-
+    TEST_DATA['search_time'] = (Time.now - 3600).to_s
+    
     # Useful in mock_facebook_responses.yml
     OAUTH_DATA = TEST_DATA['oauth_test_data']
     OAUTH_DATA.merge!({

metadata

@@ -1,72 +1,86 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: koala
-version: !ruby/object:Gem::Version
-  version: 1.2.0beta3
-  prerelease: 5
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 1
+  - 2
+  - 0beta4
+  version: 1.2.0beta4
 platform: ruby
-authors:
+authors: 
 - Alex Koppel, Chris Baclig, Rafi Jacoby, Context Optional
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-12 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: &70118378561560 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+
+date: 2011-09-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  name: multi_json
   prerelease: false
-  version_requirements: *70118378561560
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: &70118378560320 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 0
         version: 0.7.0
-  type: :runtime
+  name: faraday
   prerelease: false
-  version_requirements: *70118378560320
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70118378559340 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :development
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
+        version: "2.5"
+  name: rspec
   prerelease: false
-  version_requirements: *70118378559340
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70118378557940 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 7
         version: 0.8.7
-  type: :development
+  name: rake
   prerelease: false
-  version_requirements: *70118378557940
-description: 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.
+  type: :development
+  version_requirements: *id004
+description: 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.
 email: alex@alexkoppel.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - readme.md
 - CHANGELOG
-files:
+files: 
 - .autotest
 - .gitignore
 - .travis.yml
@@ -89,12 +103,14 @@ files:
 - lib/koala/test_users.rb
 - lib/koala/uploadable_io.rb
 - lib/koala/utils.rb
+- lib/koala/version.rb
 - readme.md
-- spec/cases/api_base_spec.rb
+- spec/cases/api_spec.rb
 - spec/cases/error_spec.rb
 - spec/cases/graph_and_rest_api_spec.rb
 - spec/cases/graph_api_batch_spec.rb
 - spec/cases/graph_api_spec.rb
+- spec/cases/graph_collection_spec.rb
 - spec/cases/http_service_spec.rb
 - spec/cases/koala_spec.rb
 - spec/cases/oauth_spec.rb
@@ -115,44 +131,47 @@ files:
 - spec/support/ordered_hash.rb
 - spec/support/rest_api_shared_examples.rb
 - spec/support/uploadable_io_shared_examples.rb
+has_rdoc: true
 homepage: http://github.com/arsduo/koala
 licenses: []
+
 post_install_message: 
-rdoc_options:
+rdoc_options: 
 - --line-numbers
 - --inline-source
 - --title
 - Koala
-require_paths:
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
       - 0
-      hash: -3213298653109204495
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '1.2'
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.8
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: A lightweight, flexible library for Facebook with support for the Graph API,
-  the REST API, realtime updates, and OAuth authentication.
-test_files:
-- spec/cases/api_base_spec.rb
+summary: A lightweight, flexible library for Facebook with support for the Graph API, the REST API, realtime updates, and OAuth authentication.
+test_files: 
+- spec/cases/api_spec.rb
 - spec/cases/error_spec.rb
 - spec/cases/graph_and_rest_api_spec.rb
 - spec/cases/graph_api_batch_spec.rb
 - spec/cases/graph_api_spec.rb
+- spec/cases/graph_collection_spec.rb
 - spec/cases/http_service_spec.rb
 - spec/cases/koala_spec.rb
 - spec/cases/oauth_spec.rb