koala 1.6.0 → 1.7.0rc1

data/spec/cases/api_spec.rb

@@ -50,10 +50,30 @@ describe "Koala::Facebook::API" do
   it "returns the entire response if http_component => :response" do
     http_component = :response
     response = mock('Mock KoalaResponse', :body => '', :status => 200)
-    Koala.stub(:make_request).and_return(response)    
+    Koala.stub(:make_request).and_return(response)
     @service.api('anything', {}, 'get', :http_component => http_component).should == response
   end
 
+  it "turns arrays of non-enumerables into comma-separated arguments" do
+    args = [12345, {:foo => [1, 2, "3", :four]}]
+    expected = ["/12345", {:foo => "1,2,3,four"}, "get", {}]
+    response = mock('Mock KoalaResponse', :body => '', :status => 200)
+    Koala.should_receive(:make_request).with(*expected).and_return(response)
+    @service.api(*args)
+  end
+
+  it "doesn't turn arrays containing enumerables into comma-separated strings" do
+    params = {:foo => [1, 2, ["3"], :four]}
+    args = [12345, params]
+    # we leave this as is -- the HTTP layer can either handle it appropriately
+    # (if appropriate behavior is defined)
+    # or raise an exception
+    expected = ["/12345", params, "get", {}]
+    response = mock('Mock KoalaResponse', :body => '', :status => 200)
+    Koala.should_receive(:make_request).with(*expected).and_return(response)
+    @service.api(*args)
+  end
+
   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)

data/spec/cases/graph_api_batch_spec.rb

@@ -507,7 +507,6 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
       pictures = @api.batch do |batch_api|
         batch_api.get_picture('me')
       end
-      puts pictures.inspect
       pictures.first.should =~ /http\:\/\// # works both live & stubbed
     end
 
@@ -517,7 +516,34 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
         batch_api.get_connections(@app_id, 'insights', {}, {"access_token" => @app_api.access_token})
       end
       me['id'].should_not be_nil
-      insights.should be_an(Array)
+      insights.should be_an(Koala::Facebook::GraphCollection)
+    end
+
+    it "preserves batch-op specific access tokens in GraphCollection returned from batch" do
+      # Provide an alternate token for a batch operation
+      @other_access_token_args = { 'access_token' => @app_api.access_token }
+
+      # make a batch call for insights using another token
+      me, insights = @api.batch do |batch_api|
+        batch_api.get_object('me')
+        batch_api.get_connections(@app_id, 'insights', {}, @other_access_token_args)
+      end
+
+      # The alternate token is returned with the next page parameters
+      # The GraphCollection should receive a request for the next_page_params during paging
+      insights.should_receive(:next_page_params).and_return([stub("base"), @other_access_token_args.dup])
+
+      # The alternate access token should pass through to making the request
+      # Koala should receive a request during paging using the alternate token
+      Koala.should_receive(:make_request).with(
+          anything,
+          hash_including(@other_access_token_args.dup),
+          anything,
+          anything
+      ).and_return(Koala::HTTPService::Response.new(200, "", ""))
+
+      # Page the collection
+      insights.next_page
     end
 
     it "inserts errors in the appropriate place, without breaking other results" do
@@ -551,37 +577,33 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
 
     describe 'with post-processing callback' do
       let(:me_result) { stub("me result") }
-      let(:friends_result) { stub("friends result") }
+      let(:friends_result) { [stub("friends result")] }
 
-      let(:me_callback) { lambda {|data| me_result } }
-      let(:friends_callback) { lambda {|data| friends_result } }
+      let(:me_callback) { lambda {|arg| {"result" => me_result, "args" => arg} } }
+      let(:friends_callback) { lambda {|arg| {"result" => friends_result, "args" => arg} } }
 
       it 'calls the callback with the appropriate data' do
-        me_callback.should_receive(:call).with(hash_including(
-          'id' => KoalaTest.user1
-        ))
-        friends_callback.should_receive(:call).with([
-          hash_including('id' => KoalaTest.user2)
-        ])
-        @api.batch do |batch_api|
+        me, friends = @api.batch do |batch_api|
           batch_api.get_object('me', &me_callback)
           batch_api.get_connections('me', 'friends', &friends_callback)
         end
+        me["args"].should include("id" => KoalaTest.user1)
+        friends["args"].first.should include("id" => KoalaTest.user2)
       end
 
       it 'passes GraphCollections, not raw data' do
-        friends_callback.should_receive(:call).with(kind_of(Koala::Facebook::API::GraphCollection))
-        @api.batch do |batch_api|
+        me, friends = @api.batch do |batch_api|
           batch_api.get_object('me')
           batch_api.get_connections('me', 'friends', &friends_callback)
         end
+        friends["args"].should be_a(Koala::Facebook::API::GraphCollection)
       end
 
       it "returns the result of the callback" do
         @api.batch do |batch_api|
           batch_api.get_object('me', &me_callback)
           batch_api.get_connections('me', 'friends', &friends_callback)
-        end.should == [me_result, friends_result]
+        end.map {|r| r["result"]}.should == [me_result, friends_result]
       end
     end
 
@@ -663,4 +685,4 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
       end
     end
   end
-end
+end

data/spec/cases/graph_api_spec.rb

@@ -10,27 +10,22 @@ describe 'Koala::Facebook::GraphAPIMethods' do
   end
 
   describe 'post-processing for' do
-    let(:post_processing) { lambda {} }
+    let(:result) { stub("result") }
+    let(:post_processing) { lambda {|arg| {"result" => result, "args" => arg} } }
 
     # Most API methods have the same signature, we test get_object representatively
     # and the other methods which do some post-processing locally
     context '#get_object' do
       it 'returns result of block' do
-        result = {"id" => 1, "name" => 1, "updated_time" => 1}
-        @api.stub(:api).and_return(result)
-        post_processing.should_receive(:call).
-          with(result).and_return('new result')
-        @api.get_object('koppel', &post_processing).should == 'new result'
+        @api.stub(:api).and_return(stub("other results"))
+        @api.get_object('koppel', &post_processing)["result"].should == result
       end
     end
 
     context '#get_picture' do
       it 'returns result of block' do
-        result = "http://facebook.com/"
-        @api.stub(:api).and_return("Location" => result)
-        post_processing.should_receive(:call).
-          with(result).and_return('new result')
-        @api.get_picture('lukeshepard', &post_processing).should == 'new result'
+        @api.stub(:api).and_return("Location" => stub("other result"))
+        @api.get_picture('lukeshepard', &post_processing)["result"].should == result
       end
     end
 
@@ -45,12 +40,11 @@ describe 'Koala::Facebook::GraphAPIMethods' do
       it 'is called with resolved response' do
         resolved_result = {
           'query1' => [{'id' => 123}],
-          'query2' => [{'id'=>456}]
+          'query2' => [{'id' => 456}]
         }
-        post_processing.should_receive(:call).
-          with(resolved_result).and_return('id'=>'123', 'id'=>'456')
-        @api.fql_multiquery({}, &post_processing).should ==
-          {'id'=>'123', 'id'=>'456'}
+        response = @api.fql_multiquery({}, &post_processing)
+        response["args"].should == resolved_result
+        response["result"].should == result
       end
     end
 
@@ -58,10 +52,9 @@ describe 'Koala::Facebook::GraphAPIMethods' do
       it 'returns result of block' do
         token = Koala::MockHTTPService::APP_ACCESS_TOKEN
         @api.stub(:api).and_return("access_token" => token)
-        post_processing.should_receive(:call).
-          with(token).and_return('base64-encoded access token')
-        @api.get_page_access_token('facebook', &post_processing).should ==
-          'base64-encoded access token'
+        response = @api.get_page_access_token('facebook', &post_processing)
+        response["args"].should == token
+        response["result"].should == result
       end
     end
   end

data/spec/cases/http_service_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "Koala::HTTPService" do
+describe Koala::HTTPService do
   it "has a faraday_middleware accessor" do
     Koala::HTTPService.methods.map(&:to_sym).should include(:faraday_middleware)
     Koala::HTTPService.methods.map(&:to_sym).should include(:faraday_middleware=)
@@ -45,15 +45,43 @@ describe "Koala::HTTPService" do
     end
   end
 
+  describe Koala::HTTPService::DEFAULT_SERVERS do
+    let(:defaults) { Koala::HTTPService::DEFAULT_SERVERS }
+
+    it "defines the graph server" do
+      defaults[:graph_server].should == "graph.facebook.com"
+    end
+
+    it "defines the rest server" do
+      defaults[:rest_server].should == "api.facebook.com"
+    end
+
+    it "defines the dialog host" do
+      defaults[:dialog_host].should == "www.facebook.com"
+    end
+
+    it "defines the path replacement regular expression" do
+      defaults[:host_path_matcher].should == /\.facebook/
+    end
+
+    it "defines the video server replacement for uploads" do
+      defaults[:video_replace].should == "-video.facebook"
+    end
+
+    it "defines the beta tier replacement" do
+      defaults[:beta_replace].should == ".beta.facebook"
+    end
+  end
+
   describe "server" do
     describe "with no options" do
       it "returns the REST server if options[:rest_api]" do
-        Koala::HTTPService.server(:rest_api => true).should =~ Regexp.new(Koala::Facebook::REST_SERVER)
+        Koala::HTTPService.server(:rest_api => true).should =~ Regexp.new(Koala.config.rest_server)
       end
 
       it "returns the graph server if !options[:rest_api]" do
-        Koala::HTTPService.server(:rest_api => false).should =~ Regexp.new(Koala::Facebook::GRAPH_SERVER)
-        Koala::HTTPService.server({}).should =~ Regexp.new(Koala::Facebook::GRAPH_SERVER)
+        Koala::HTTPService.server(:rest_api => false).should =~ Regexp.new(Koala.config.graph_server)
+        Koala::HTTPService.server({}).should =~ Regexp.new(Koala.config.graph_server)
       end
     end
 
@@ -64,12 +92,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(Koala::Facebook::REST_SERVER.gsub(/\.facebook/, ".beta.facebook"))
+        server.should =~ Regexp.new(Koala.config.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(Koala::Facebook::GRAPH_SERVER.gsub(/\.facebook/, ".beta.facebook"))
+        server.should =~ Regexp.new(Koala.config.graph_server.gsub(/\.facebook/, ".beta.facebook"))
       end
     end
 
@@ -80,12 +108,12 @@ describe "Koala::HTTPService" 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"))
+        server.should =~ Regexp.new(Koala.config.rest_server.gsub(/\.facebook/, "-video.facebook"))
       end
 
       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"))
+        server.should =~ Regexp.new(Koala.config.graph_server.gsub(/\.facebook/, "-video.facebook"))
       end
     end
   end
@@ -212,8 +240,10 @@ describe "Koala::HTTPService" do
       end
 
       it "uses the default builder block if HTTPService.faraday_middleware block is not defined" do
+        block = Proc.new {}
+        stub_const("Koala::HTTPService::DEFAULT_MIDDLEWARE", block)
         Koala::HTTPService.stub(:faraday_middleware).and_return(nil)
-        Faraday.should_receive(:new).with(anything, anything, &Koala::HTTPService::DEFAULT_MIDDLEWARE).and_return(@mock_connection)
+        Faraday.should_receive(:new).with(anything, anything, &block).and_return(@mock_connection)
         Koala::HTTPService.make_request("anything", {}, "get")
       end
 

data/spec/cases/koala_spec.rb

@@ -1,38 +1,22 @@
 require 'spec_helper'
 
 describe Koala do
-
-  
   it "has an http_service accessor" do
     Koala.should respond_to(:http_service)
     Koala.should respond_to(:http_service=)
   end
-  
+
   describe "constants" do
     it "has a version" do
       Koala.const_defined?("VERSION").should be_true
     end
-
-    describe Koala::Facebook do      
-      it "defines GRAPH_SERVER" do
-        Koala::Facebook::GRAPH_SERVER.should == "graph.facebook.com"
-      end
-
-      it "defines REST_SERVER" do
-        Koala::Facebook::REST_SERVER.should == "api.facebook.com"
-      end
-      
-      it "defines DIALOG_HOST" do
-        Koala::Facebook::DIALOG_HOST.should == "www.facebook.com"
-      end
-    end
   end
-  
+
   context "for deprecated services" do
     before :each do
       @service = Koala.http_service
     end
-    
+
     after :each do
       Koala.http_service = @service
     end
@@ -42,7 +26,7 @@ describe Koala do
       mock_service.should_receive(:deprecated_interface)
       Koala.http_service = mock_service
     end
-    
+
     it "does not set the service if it's deprecated" do
       mock_service = stub("http service")
       mock_service.stub(:deprecated_interface)
@@ -63,10 +47,38 @@ describe Koala do
       args = {:a => 2}
       verb = "get"
       options = {:c => :d}
-      
+
       Koala.http_service.should_receive(:make_request).with(path, args, verb, options)
       Koala.make_request(path, args, verb, options)
     end
   end
 
-end
+  describe ".configure" do
+    it "yields a configurable object" do
+      expect {
+        Koala.configure {|c| c.foo = "bar"}
+      }.not_to raise_exception
+    end
+
+    it "caches the config (singleton)" do
+      c = Koala.config
+      expect(c.object_id).to eq(Koala.config.object_id)
+    end
+  end
+
+  describe ".config" do
+    it "exposes the basic configuration" do
+      Koala::HTTPService::DEFAULT_SERVERS.each_pair do |k, v|
+        expect(Koala.config.send(k)).to eq(v)
+      end
+    end
+
+    it "exposes the values configured" do
+      Koala.configure do |config|
+        config.graph_server = "some-new.graph_server.com"
+      end
+      Koala.config.graph_server.should == "some-new.graph_server.com"
+    end
+  end
+
+end

data/spec/cases/oauth_spec.rb

@@ -148,7 +148,6 @@ describe "Koala::Facebook::OAuth" do
 
         it "returns all the cookie components from valid cookie string" do
           cookie_data = KoalaTest.oauth_test_data["valid_cookies"]
-          puts cookie_data.inspect
           parsing_results = @oauth.get_user_info_from_cookies(cookie_data)
           number_of_components = cookie_data["fbs_#{@app_id.to_s}"].scan(/\=/).length
           parsing_results.length.should == number_of_components
@@ -190,7 +189,7 @@ describe "Koala::Facebook::OAuth" do
         end
 
         it "does not uses get_user_info_from_cookies to parse the cookies" do
-          @oauth.should_not_receive(:get_user_info_from_cookies).with(@cookie).and_return({})
+          @oauth.should_not_receive(:get_user_info_from_cookies).with(@cookie)
           @oauth.get_user_from_cookies(@cookie)
         end
 
@@ -205,6 +204,11 @@ describe "Koala::Facebook::OAuth" do
           result = @oauth.get_user_from_cookies(bad_cookie_hash)
           result.should be_nil
         end
+
+        it "is deprecated" do
+          Koala::Utils.should_receive(:deprecate)
+          @oauth.get_user_from_cookies({})
+        end
       end
 
       describe "for unsigned cookies" do
@@ -237,37 +241,37 @@ describe "Koala::Facebook::OAuth" do
     describe "#url_for_oauth_code" do
       it "generates a properly formatted OAuth code URL with the default values" do
         url = @oauth.url_for_oauth_code
-        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&redirect_uri=#{CGI.escape @callback_url}")
+        url.should match_url("https://#{Koala.config.dialog_host}/dialog/oauth?client_id=#{@app_id}&redirect_uri=#{CGI.escape @callback_url}")
       end
 
       it "generates a properly formatted OAuth code URL when a callback is given" do
         callback = "foo.com"
         url = @oauth.url_for_oauth_code(:callback => callback)
-        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&redirect_uri=#{callback}")
+        url.should match_url("https://#{Koala.config.dialog_host}/dialog/oauth?client_id=#{@app_id}&redirect_uri=#{callback}")
       end
 
       it "generates a properly formatted OAuth code URL when permissions are requested as a string" do
         permissions = "publish_stream,read_stream"
         url = @oauth.url_for_oauth_code(:permissions => permissions)
-        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&scope=#{CGI.escape permissions}&redirect_uri=#{CGI.escape @callback_url}")
+        url.should match_url("https://#{Koala.config.dialog_host}/dialog/oauth?client_id=#{@app_id}&scope=#{CGI.escape permissions}&redirect_uri=#{CGI.escape @callback_url}")
       end
 
       it "generates a properly formatted OAuth code URL when permissions are requested as a string" do
         permissions = ["publish_stream", "read_stream"]
         url = @oauth.url_for_oauth_code(:permissions => permissions)
-        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&scope=#{CGI.escape permissions.join(",")}&redirect_uri=#{CGI.escape @callback_url}")
+        url.should match_url("https://#{Koala.config.dialog_host}/dialog/oauth?client_id=#{@app_id}&scope=#{CGI.escape permissions.join(",")}&redirect_uri=#{CGI.escape @callback_url}")
       end
 
       it "generates a properly formatted OAuth code URL when both permissions and callback are provided" do
         permissions = "publish_stream,read_stream"
         callback = "foo.com"
         url = @oauth.url_for_oauth_code(:callback => callback, :permissions => permissions)
-        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&scope=#{CGI.escape permissions}&redirect_uri=#{CGI.escape callback}")
+        url.should match_url("https://#{Koala.config.dialog_host}/dialog/oauth?client_id=#{@app_id}&scope=#{CGI.escape permissions}&redirect_uri=#{CGI.escape callback}")
       end
 
       it "generates a properly formatted OAuth code URL when a display is given as a string" do
         url = @oauth.url_for_oauth_code(:display => "page")
-        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&display=page&redirect_uri=#{CGI.escape @callback_url}")
+        url.should match_url("https://#{Koala.config.dialog_host}/dialog/oauth?client_id=#{@app_id}&display=page&redirect_uri=#{CGI.escape @callback_url}")
       end
 
       it "raises an exception if no callback is given in initialization or the call" do
@@ -295,13 +299,13 @@ describe "Koala::Facebook::OAuth" do
 
       it "generates a properly formatted OAuth token URL when provided a code" do
         url = @oauth.url_for_access_token(@code)
-        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/access_token?client_id=#{@app_id}&code=#{@code}&client_secret=#{@secret}&redirect_uri=#{CGI.escape @callback_url}")
+        url.should match_url("https://#{Koala.config.graph_server}/oauth/access_token?client_id=#{@app_id}&code=#{@code}&client_secret=#{@secret}&redirect_uri=#{CGI.escape @callback_url}")
       end
 
       it "generates a properly formatted OAuth token URL when provided a callback" do
         callback = "foo.com"
         url = @oauth.url_for_access_token(@code, :callback => callback)
-        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/access_token?client_id=#{@app_id}&code=#{@code}&client_secret=#{@secret}&redirect_uri=#{CGI.escape callback}")
+        url.should match_url("https://#{Koala.config.graph_server}/oauth/access_token?client_id=#{@app_id}&code=#{@code}&client_secret=#{@secret}&redirect_uri=#{CGI.escape callback}")
       end
 
       it "includes any additional options as URL parameters, appropriately escaped" do
@@ -319,7 +323,7 @@ describe "Koala::Facebook::OAuth" do
     describe "#url_for_dialog" do
       it "builds the base properly" do
         dialog_type = "my_dialog_type"
-        @oauth.url_for_dialog(dialog_type).should =~ /^http:\/\/#{Koala::Facebook::DIALOG_HOST}\/dialog\/#{dialog_type}/
+        @oauth.url_for_dialog(dialog_type).should =~ /^http:\/\/#{Koala.config.dialog_host}\/dialog\/#{dialog_type}/
       end
 
       it "adds the app_id/client_id to the url" do
@@ -541,7 +545,7 @@ describe "Koala::Facebook::OAuth" do
       end
 
       it "fetches a proper token string from Facebook when asked for the app token" do
-        result = @oauth.send(:fetch_token_string, {:type => 'client_cred'}, true)
+        result = @oauth.send(:fetch_token_string, {:grant_type => 'client_credentials'}, true)
         result.should =~ /^access_token/
       end
     end