koala 1.2.0beta1 → 1.2.1

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

@@ -5,7 +5,7 @@ describe "Koala::Facebook::API" do
     @service = Koala::Facebook::API.new
   end
 
-  it "should not include an access token if none was given" do
+  it "doesn't include an access token if none was given" do
     Koala.should_receive(:make_request).with(
       anything,
       hash_not_including('access_token' => 1),
@@ -16,7 +16,7 @@ describe "Koala::Facebook::API" do
     @service.api('anything')
   end
 
-  it "should include an access token if given" do
+  it "includes an access token if given" do
     token = 'adfadf'
     service = Koala::Facebook::API.new token
 
@@ -30,13 +30,13 @@ describe "Koala::Facebook::API" do
     service.api('anything')
   end
 
-  it "should have an attr_reader for access token" do
+  it "has an attr_reader for access token" do
     token = 'adfadf'
     service = Koala::Facebook::API.new token
     service.access_token.should == token
   end
 
-  it "should get the attribute of a Koala::Response given by the http_component parameter" do
+  it "gets the attribute of a Koala::Response given by the http_component parameter" do
     http_component = :method_name
 
     response = mock('Mock KoalaResponse', :body => '', :status => 200)
@@ -47,7 +47,7 @@ describe "Koala::Facebook::API" do
     @service.api('anything', {}, 'get', :http_component => http_component)
   end
 
-  it "should return the body of the request as JSON if no http_component is given" do
+  it "returns the body of the request as JSON if no http_component is given" do
     response = stub('response', :body => 'body', :status => 200)
     Koala.stub(:make_request).and_return(response)
 
@@ -57,7 +57,7 @@ describe "Koala::Facebook::API" do
     @service.api('anything').should == json_body
   end
 
-  it "should execute an error checking block if provided" do
+  it "executes an error checking block if provided" do
     body = '{}'
     Koala.stub(:make_request).and_return(Koala::Response.new(200, body, {}))
 
@@ -70,13 +70,13 @@ describe "Koala::Facebook::API" do
     end
   end
 
-  it "should raise an API error if the HTTP response code is greater than or equal to 500" do
+  it "raises an API error if the HTTP response code is greater than or equal to 500" do
     Koala.stub(:make_request).and_return(Koala::Response.new(500, 'response body', {}))
 
     lambda { @service.api('anything') }.should raise_exception(Koala::Facebook::APIError)
   end
 
-  it "should handle rogue true/false as responses" do
+  it "handles rogue true/false as responses" do
     Koala.should_receive(:make_request).and_return(Koala::Response.new(200, 'true', {}))
     @service.api('anything').should be_true
 
@@ -85,17 +85,42 @@ describe "Koala::Facebook::API" do
   end
 
   describe "with regard to leading slashes" do
-    it "should add a leading / to the path if not present" do
+    it "adds a leading / to the path if not present" do
       path = "anything"
       Koala.should_receive(:make_request).with("/#{path}", anything, anything, anything).and_return(Koala::Response.new(200, 'true', {}))
       @service.api(path)
     end
 
-    it "shouldn't change the path if a leading / is present" do
+    it "doesn't change the path if a leading / is present" do
       path = "/anything"
       Koala.should_receive(:make_request).with(path, anything, anything, anything).and_return(Koala::Response.new(200, 'true', {}))
       @service.api(path)
     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/http_service_spec.rb

@@ -20,6 +20,7 @@ describe "Koala::HTTPService" do
       @builder = stub("Faraday connection builder")
       @builder.stub(:request)
       @builder.stub(:adapter)
+      @builder.stub(:use)
     end
 
     it "is defined" do
@@ -27,7 +28,7 @@ describe "Koala::HTTPService" do
     end
 
     it "adds multipart" do
-      @builder.should_receive(:request).with(:multipart)
+      @builder.should_receive(:use).with(Koala::MultipartRequest)
       Koala::HTTPService::DEFAULT_MIDDLEWARE.call(@builder)
     end
 
@@ -63,12 +64,12 @@ describe "Koala::HTTPService" do
 
       it "returns the beta REST server if options[:rest_api]" do
         server = Koala::HTTPService.server(@options.merge(:rest_api => true))
-        server.should =~ Regexp.new("beta.#{Koala::Facebook::REST_SERVER}")
+        server.should =~ Regexp.new(Koala::Facebook::REST_SERVER.gsub(/\.facebook/, ".beta.facebook"))
       end
 
       it "returns the beta rest server if !options[:rest_api]" do
         server = Koala::HTTPService.server(@options)
-        server.should =~ Regexp.new("beta.#{Koala::Facebook::GRAPH_SERVER}")
+        server.should =~ Regexp.new(Koala::Facebook::GRAPH_SERVER.gsub(/\.facebook/, ".beta.facebook"))
       end
     end
 
@@ -77,12 +78,12 @@ describe "Koala::HTTPService" do
         @options = {:video => true}
       end
 
-      it "should return the REST video server if options[:rest_api]" do
+      it "returns the REST video server if options[:rest_api]" do
         server = Koala::HTTPService.server(@options.merge(:rest_api => true))
         server.should =~ Regexp.new(Koala::Facebook::REST_SERVER.gsub(/\.facebook/, "-video.facebook"))
       end
 
-      it "should return the graph video server if !options[:rest_api]" do
+      it "returns the graph video server if !options[:rest_api]" do
         server = Koala::HTTPService.server(@options)
         server.should =~ Regexp.new(Koala::Facebook::GRAPH_SERVER.gsub(/\.facebook/, "-video.facebook"))
       end
@@ -90,11 +91,11 @@ describe "Koala::HTTPService" do
   end
 
   describe "#encode_params" do
-    it "should return an empty string if param_hash evaluates to false" do
+    it "returns an empty string if param_hash evaluates to false" do
       Koala::HTTPService.encode_params(nil).should == ''
     end
 
-    it "should convert values to JSON if the value is not a String" do
+    it "converts values to JSON if the value is not a String" do
       val = 'json_value'
       not_a_string = 'not_a_string'
       not_a_string.stub(:is_a?).and_return(false)
@@ -113,7 +114,7 @@ describe "Koala::HTTPService" do
       end.should be_true
     end
 
-    it "should escape all values" do
+    it "escapes all values" do
       args = Hash[*(1..4).map {|i| [i.to_s, "Value #{i}($"]}.flatten]
 
       result = Koala::HTTPService.encode_params(args)
@@ -123,7 +124,7 @@ describe "Koala::HTTPService" do
       end
     end
 
-    it "should convert all keys to Strings" do
+    it "converts all keys to Strings" do
       args = Hash[*(1..4).map {|i| [i, "val#{i}"]}.flatten]
 
       result = Koala::HTTPService.encode_params(args)
@@ -427,16 +428,16 @@ describe "Koala::HTTPService" do
       :net_http => Koala::NetHTTPService
     }.each_pair do |adapter, module_class|
       describe module_class.to_s do
-        it "should respond to deprecated_interface" do
+        it "responds to deprecated_interface" do
            module_class.should respond_to(:deprecated_interface)
         end
       
-        it "should issue a deprecation warning" do
+        it "issues a deprecation warning" do
           Koala::Utils.should_receive(:deprecate)
           module_class.deprecated_interface
         end
       
-        it "should set the default adapter to #{adapter}" do
+        it "sets the default adapter to #{adapter}" do
           module_class.deprecated_interface
           Faraday.default_adapter.should == adapter
         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=)
@@ -35,14 +39,14 @@ describe "Koala" do
     end
   end
 
-  define "make_request" do
+  describe "make_request" do
     it "passes all its arguments to the http_service" do
-      http_service = stub("http_service")
       path = "foo"
       args = {:a => 2}
       verb = "get"
       options = {:c => :d}
-      http_service.should_receive(:make_request).with(path, args, verb, options)
+      
+      Koala.http_service.should_receive(:make_request).with(path, args, verb, options)
       Koala.make_request(path, args, verb, options)
     end
   end

data/spec/cases/multipart_request_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Koala::MultipartRequest do
+  it "is a subclass of Faraday::Request::Multipart" do
+    Koala::MultipartRequest.superclass.should == Faraday::Request::Multipart
+  end
+  
+  it "defines mime_type as multipart/form-data" do
+    Koala::MultipartRequest.mime_type.should == 'multipart/form-data'
+  end
+  
+  describe ".process_request?" do
+    before :each do
+      @env = {}
+      @multipart = Koala::MultipartRequest.new
+      @multipart.stub(:request_type).and_return("")
+    end
+    
+    # no way to test the call to super, unfortunately
+    it "returns true if env[:body] is a hash with at least one hash in its values" do
+      @env[:body] = {:a => {:c => 2}}
+      @multipart.process_request?(@env).should be_true
+    end
+
+    it "returns true if env[:body] is a hash with at least one array in its values" do
+      @env[:body] = {:a => [:c, 2]}
+      @multipart.process_request?(@env).should be_true
+    end
+
+    it "returns true if env[:body] is a hash with mixed objects in its values" do
+      @env[:body] = {:a => [:c, 2], :b => {:e => :f}}
+      @multipart.process_request?(@env).should be_true
+    end
+
+    it "returns false if env[:body] is a string" do
+      @env[:body] = "my body"
+      @multipart.process_request?(@env).should be_false
+    end
+
+    it "returns false if env[:body] is a hash without an array or hash value" do
+      @env[:body] = {:a => 3}
+      @multipart.process_request?(@env).should be_false
+    end    
+  end
+  
+  describe ".process_params" do
+    before :each do
+      @parent = Faraday::Request::Multipart.new
+      @multipart = Koala::MultipartRequest.new 
+      @block = lambda {|k, v| "#{k}=#{v}"}     
+    end
+    
+    it "is identical to the parent for requests without a prefix" do
+      hash = {:a => 2, :c => "3"}
+      @multipart.process_params(hash, &@block).should == @parent.process_params(hash, &@block)
+    end
+    
+    it "replaces encodes [ and ] if the request has a prefix" do
+      hash = {:a => 2, :c => "3"}
+      prefix = "foo"
+      # process_params returns an array
+      @multipart.process_params(hash, prefix, &@block).join("&").should == @parent.process_params(hash, prefix, &@block).join("&").gsub(/\[/, "%5B").gsub(/\]/, "%5D")
+    end
+  end
+  
+end