koala 1.0.0 → 1.1.0

data/spec/cases/http_services/http_service_spec.rb

@@ -17,38 +17,113 @@ describe "Koala::HTTPService" do
       end
     end
     
+    describe "proxy accessor" do
+      it "should be added" do
+        # in Ruby 1.8, .methods returns strings
+        # in Ruby 1.9, .method returns symbols 
+        Bear.methods.collect {|m| m.to_sym}.should include(:proxy)
+        Bear.methods.collect {|m| m.to_sym}.should include(:proxy=)
+      end
+    end
+    
+    describe "timeout accessor" do
+      it "should be added" do
+        # in Ruby 1.8, .methods returns strings
+        # in Ruby 1.9, .method returns symbols 
+        Bear.methods.collect {|m| m.to_sym}.should include(:timeout)
+        Bear.methods.collect {|m| m.to_sym}.should include(:timeout=)
+      end
+    end
+    
     describe "server" do
-      describe "without options[:beta]" do
-        it "should return the rest server if options[:rest_api]" do
+      describe "with no options" do
+        it "returns the REST server if options[:rest_api]" do
           Bear.server(:rest_api => true).should == Koala::Facebook::REST_SERVER
         end
 
-        it "should return the rest server if !options[:rest_api]" do
+        it "returns the graph server if !options[:rest_api]" do
           Bear.server(:rest_api => false).should == Koala::Facebook::GRAPH_SERVER
           Bear.server({}).should == Koala::Facebook::GRAPH_SERVER
         end
       end
-      
-      describe "without options[:beta]" do
+
+      describe "with options[:beta]" do
         before :each do
           @options = {:beta => true}
         end
         
-        it "should return the rest server if options[:rest_api]" do
+        it "returns the beta REST server if options[:rest_api]" do
           server = Bear.server(@options.merge(:rest_api => true))
-          server.should =~ Regexp.new(Koala::Facebook::REST_SERVER)
-          server.should =~ /beta\./
+          server.should =~ Regexp.new("beta.#{Koala::Facebook::REST_SERVER}")
         end
 
-        it "should return the rest server if !options[:rest_api]" do
-          server = Bear.server(:beta => true)
-          server.should =~ Regexp.new(Koala::Facebook::GRAPH_SERVER)
-          server.should =~ /beta\./
+        it "returns the beta rest server if !options[:rest_api]" do
+          server = Bear.server(@options)
+          server.should =~ Regexp.new("beta.#{Koala::Facebook::GRAPH_SERVER}")
         end
       end
       
+      describe "with options[:video]" do
+        before :each do
+          @options = {:video => true}
+        end
+        
+        it "should return the REST video server if options[:rest_api]" do
+          server = Bear.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
+          server = Bear.server(@options)
+          server.should =~ Regexp.new(Koala::Facebook::GRAPH_SERVER.gsub(/\.facebook/, "-video.facebook"))
+        end
+      end
     end
 
+    describe "#encode_params" do
+      it "should return an empty string if param_hash evaluates to false" do
+        Bear.encode_params(nil).should == ''
+      end
+
+      it "should convert 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)
+        MultiJson.should_receive(:encode).with(not_a_string).and_return(val)
+
+        string = "hi"
+
+        args = {
+          not_a_string => not_a_string,
+          string => string
+        }
+
+        result = Bear.encode_params(args)
+        result.split('&').find do |key_and_val|
+          key_and_val.match("#{not_a_string}=#{val}")
+        end.should be_true
+      end
+
+      it "should escape all values" do
+        args = Hash[*(1..4).map {|i| [i.to_s, "Value #{i}($"]}.flatten]
+
+        result = Bear.encode_params(args)
+        result.split('&').each do |key_val|
+          key, val = key_val.split('=')
+          val.should == CGI.escape(args[key])
+        end
+      end
+
+      it "should convert all keys to Strings" do
+        args = Hash[*(1..4).map {|i| [i, "val#{i}"]}.flatten]
+
+        result = Bear.encode_params(args)
+        result.split('&').each do |key_val|
+          key, val = key_val.split('=')
+          key.should == args.find{|key_val_arr| key_val_arr.last == val}.first.to_s
+        end
+      end
+    end
   end
 
 end

data/spec/cases/http_services/net_http_service_spec.rb

@@ -1,14 +1,27 @@
 require 'spec_helper'
 
 
-module Horse
-  include Koala::NetHTTPService
-end
+Horse = Koala::NetHTTPService
 
 describe "NetHTTPService module holder class Horse" do
   before :each do
-    # reset the always_use_ssl parameter
-    Horse.always_use_ssl = nil
+    # reset global settings
+    Horse.always_use_ssl = Horse.proxy = Horse.timeout = nil
+  end
+
+  it "has a ca_file accessor" do
+    Horse.methods.collect {|m| m.to_sym}.should include(:ca_file)
+    Horse.methods.collect {|m| m.to_sym}.should include(:ca_file=)
+  end
+
+  it "has a ca_path accessor" do
+    Horse.methods.collect {|m| m.to_sym}.should include(:ca_path)
+    Horse.methods.collect {|m| m.to_sym}.should include(:ca_path=)
+  end
+
+  it "has a verify_mode accessor" do
+    Horse.methods.collect {|m| m.to_sym}.should include(:verify_mode)
+    Horse.methods.collect {|m| m.to_sym}.should include(:verify_mode=)
   end
 
   it "should define a make_request static module method" do
@@ -22,21 +35,19 @@ describe "NetHTTPService module holder class Horse" do
   describe "when making a request" do
     before(:each) do
       # Setup stubs for make_request to execute without exceptions
-      @mock_http_response = stub('Net::HTTPResponse', :code => 1)
       @mock_body = stub('Net::HTTPResponse body')
-      @http_request_result = [@mock_http_response, @mock_body]
-
-      # to_ary is called in Ruby 1.9 to provide backwards compatibility
-      # with the response, body = http.get() syntax we use
-      @mock_http_response.stub!(:to_ary).and_return(@http_request_result)
+      @mock_http_response = stub('Net::HTTPResponse', :code => 1, :body => @mock_body)
 
       @http_yield_mock = mock('Net::HTTP start yielded object')
 
-      @http_yield_mock.stub(:post).and_return(@http_request_result)
-      @http_yield_mock.stub(:get).and_return(@http_request_result)
+      @http_yield_mock.stub(:post).and_return(@mock_http_response)
+      @http_yield_mock.stub(:get).and_return(@mock_http_response)
 
       @http_mock = stub('Net::HTTP object', 'use_ssl=' => true, 'verify_mode=' => true)
       @http_mock.stub(:start).and_yield(@http_yield_mock)
+      @http_mock.stub(:ca_path=)
+      @http_mock.stub(:ca_file=)
+      @http_mock.stub(:verify_mode=)
 
       Net::HTTP.stub(:new).and_return(@http_mock)
     end
@@ -84,7 +95,7 @@ describe "NetHTTPService module holder class Horse" do
         Horse.make_request('anything', @args, 'anything')
       end
     end
-    
+
     describe "if always_use_ssl is true" do
       before :each do
         Horse.always_use_ssl = true
@@ -129,6 +140,228 @@ describe "NetHTTPService module holder class Horse" do
       end
     end
 
+    describe "proxy options" do
+      before :each do
+        Horse.proxy = "http://defaultproxy"
+      end
+      after :all do
+        Horse.proxy = nil
+      end
+
+      it "should use passed proxy option if provided" do
+        Net::HTTP.should_receive(:new).with(Koala::Facebook::GRAPH_SERVER, anything, "passedproxy", 80, nil, nil).and_return(@http_mock)
+        Horse.make_request('anything', {} , 'anything', {:proxy => "http://passedproxy"})
+      end
+
+      it "should use default proxy if default is provided and NO proxy option passed" do
+        Net::HTTP.should_receive(:new).with(Koala::Facebook::GRAPH_SERVER, anything, "defaultproxy", 80, nil, nil).and_return(@http_mock)
+        Horse.make_request('anything', {} , 'anything', {})
+      end
+
+      it "should NOT use a proxy if default is NOT provided and NO proxy option passed" do
+        Horse.proxy = nil
+        Net::HTTP.should_receive(:new).with(Koala::Facebook::GRAPH_SERVER, anything).and_return(@http_mock)
+        Horse.make_request('anything', {} , 'anything', {})
+      end
+    end
+
+    describe "timeout options" do
+      before :each do
+        Horse.timeout = 20 # seconds
+      end
+      after :all do
+        Horse.timeout = nil # seconds
+      end
+
+      it "should use passed timeout option if provided" do
+        @http_mock.should_receive('open_timeout=').with(10)
+        @http_mock.should_receive('read_timeout=').with(10)
+        Horse.make_request('anything', {} , 'anything', {:timeout => 10})
+      end
+
+      it "should use default timout if default is provided and NO timeout option passed" do
+        @http_mock.should_receive('open_timeout=').with(20)
+        @http_mock.should_receive('read_timeout=').with(20)
+        Horse.make_request('anything', {} , 'anything', {})
+      end
+
+      it "should NOT use a timeout if default is NOT provided and NO timeout option passed" do
+        Horse.timeout = nil # seconds
+        @http_mock.should_not_receive('open_timeout=')
+        @http_mock.should_not_receive('read_timeout=')
+        Horse.make_request('anything', {} , 'anything', {})
+      end
+    end
+
+    describe "ca_file options" do
+      after :each do
+        Horse.always_use_ssl = nil
+        Horse.ca_file = nil
+      end
+
+      it "should not use a ca_file if the request is not via SSL" do
+        Horse.always_use_ssl = false
+        @http_mock.should_not_receive(:ca_file=)
+        Horse.make_request('anything', {} , 'anything', {:ca_file => '/no/file'})
+      end
+
+      describe "when via SSL" do
+        before :each do
+          Horse.always_use_ssl = true
+          @global_ca_file_path = '/global/ca/file/path'
+        end
+
+        context "if the file doesn't exist" do
+          it "raises Errno::ENOENT if the default ca_file does not exist" do
+            Horse.ca_file = @global_ca_file_path
+
+            File.should_receive(:exists?).with(@global_ca_file_path).and_return(false)
+            expect { Horse.make_request('anything', {} , 'anything', {}) }.to raise_exception(Errno::ENOENT)
+          end
+
+          it "raises Errno::ENOENT if options[:ca_file] does not exist" do
+            File.should_receive(:exists?).with(@global_ca_file_path).and_return(false)
+            expect { Horse.make_request('anything', {} , 'anything', {:ca_file => @global_ca_file_path}) }.to raise_exception(Errno::ENOENT)
+          end
+        end
+
+        context "if the file exists" do
+          before :each do
+            File.stub(:exists?).and_return(true)
+          end
+
+          it "should use options[:ca_file] if provided" do
+            given_ca_file = '/ca/file'
+
+            Horse.ca_file = @global_ca_file_path
+            @http_mock.should_not_receive(:ca_file=).with(@global_ca_file_path)
+            @http_mock.should_receive(:ca_file=).with(given_ca_file)
+
+            Horse.make_request('anything', {} , 'anything', {:ca_file => given_ca_file})
+          end
+
+          it "should use default ca_file if default is provided and NO ca_file option is passed" do
+            Horse.ca_file = @global_ca_file_path
+            @http_mock.should_receive(:ca_file=).with(@global_ca_file_path)
+
+            Horse.make_request('anything', {} , 'anything', {})
+          end
+
+          it "should NOT use a ca_file if default is NOT provided and NO ca_file option is passed" do
+            @http_mock.should_not_receive(:ca_file=)
+
+            Horse.make_request('anything', {} , 'anything', {})
+          end
+        end
+      end
+    end
+
+    describe "ca_path options" do
+      after :each do
+        Horse.always_use_ssl = nil
+        Horse.ca_path = nil
+      end
+
+      it "should not use a ca_path if the request is not via SSL" do
+        Horse.always_use_ssl = false
+        @http_mock.should_not_receive('ca_path=')
+        Horse.make_request('anything', {} , 'anything', {:ca_file => '/no/file'})
+      end
+
+      describe "when via SSL" do
+        before :each do
+          Horse.always_use_ssl = true
+          @global_ca_path = '/global/ca/path'
+        end
+
+        context "if the directory doesn't exist" do
+          it "should not use a default ca_path if the default ca_path does not exist" do
+            Horse.ca_path = @global_ca_path
+
+            File.should_receive(:directory?).with(@global_ca_path).and_return(false)
+            expect { Horse.make_request('anything', {} , 'anything', {}) }.to raise_exception(Errno::ENOENT)
+          end
+
+          it "should not use a default ca_path if the default ca_path does not exist" do
+            File.should_receive(:directory?).with(@global_ca_path).and_return(false)
+            expect { Horse.make_request('anything', {} , 'anything', {:ca_path => @global_ca_path}) }.to raise_exception(Errno::ENOENT)
+          end
+        end
+
+        context "if the directory exists" do
+          before :each do
+            File.stub(:directory?).and_return(true)
+          end
+
+          it "should use passed ca_path options if provided" do
+            given_ca_path = '/ca/path'
+
+            Horse.ca_path = @global_ca_path
+            @http_mock.should_not_receive(:ca_ath=).with(@global_ca_path)
+            @http_mock.should_receive(:ca_path=).with(given_ca_path)
+
+            Horse.make_request('anything', {} , 'anything', {:ca_path => given_ca_path})
+          end
+
+          it "should use default ca_path if default is provided and NO ca_path option is passed" do
+            Horse.ca_path = @global_ca_path
+            @http_mock.should_receive(:ca_path=).with(@global_ca_path)
+
+            Horse.make_request('anything', {} , 'anything', {})
+          end
+
+          it "should NOT use a ca_path if default is NOT provided and NO ca_path option is passed" do
+            @http_mock.should_not_receive(:ca_path=)
+
+            Horse.make_request('anything', {} , 'anything', {})
+          end
+        end
+      end
+    end
+
+    describe "verify_mode options" do
+      after :each do
+        Horse.always_use_ssl = nil
+        Horse.verify_mode = nil
+      end
+
+      it "does not set verify mode if it's not SSL" do
+        Horse.always_use_ssl = nil
+        @http_mock.should_not_receive(:verify_mode=)
+        Horse.make_request('anything', {} , 'anything', {:verify_mode => "abc"})
+      end
+
+      context "when making an SSL request" do
+        before :each do
+          Horse.always_use_ssl = true
+        end
+
+        it "sets verify mode if provided in the options" do
+          mode = "foo"
+          @http_mock.should_receive(:verify_mode=).with(mode)
+          Horse.make_request('anything', {} , 'anything', {:verify_mode => mode})
+        end
+
+        it "sets verify mode to the default if provided (and none set in options)" do
+          Horse.verify_mode = "foo"
+          @http_mock.should_receive(:verify_mode=).with(Horse.verify_mode)
+          Horse.make_request('anything', {} , 'anything', {})
+        end
+
+        it "sets verify mode to the default if provided (and none set in options)" do
+          mode = "bar"
+          Horse.verify_mode = "foo"
+          @http_mock.should_receive(:verify_mode=).with(mode)
+          Horse.make_request('anything', {} , 'anything', {:verify_mode => mode})
+        end
+
+        it "sets verify mode to OpenSSL::SSL::VERIFY_PEER if no default or option is provided" do
+          @http_mock.should_receive(:verify_mode=).with(OpenSSL::SSL::VERIFY_PEER)
+          Horse.make_request('anything', {} , 'anything', {})
+        end
+      end
+    end
+
     it "should use the graph server by default" do
       Net::HTTP.should_receive(:new).with(Koala::Facebook::GRAPH_SERVER, anything).and_return(@http_mock)
       Horse.make_request('anything', {}, 'anything')
@@ -139,17 +372,11 @@ describe "NetHTTPService module holder class Horse" do
       Horse.make_request('anything', {}, 'anything', :rest_api => true)
     end
 
-    it "no longer sets verify_mode to no verification" do
-      @http_mock.should_not_receive('verify_mode=')
-
-      Horse.make_request('anything', {}, 'anything')
-    end
-
     it "should start an HTTP connection" do
       @http_mock.should_receive(:start).and_yield(@http_yield_mock)
       Horse.make_request('anything', {}, 'anything')
     end
-    
+
     it 'creates a HTTP Proxy object when options contain a proxy' do
       Net::HTTP.should_receive(:new).with(anything, anything, 'proxy', 1234, 'user', 'pass').and_return(@http_mock)
       Horse.make_request('anything', {}, 'anything', {:proxy => 'http://user:pass@proxy:1234'})
@@ -163,14 +390,14 @@ describe "NetHTTPService module holder class Horse" do
 
     describe "via POST" do
       it "should use Net::HTTP to make a POST request" do
-        @http_yield_mock.should_receive(:post).and_return(@http_request_result)
+        @http_yield_mock.should_receive(:post).and_return(@mock_http_response)
 
         Horse.make_request('anything', {}, 'post')
       end
 
       it "should go to the specified path adding a / if it doesn't exist" do
         path = mock('Path')
-        @http_yield_mock.should_receive(:post).with(path, anything).and_return(@http_request_result)
+        @http_yield_mock.should_receive(:post).with(path, anything).and_return(@mock_http_response)
 
         Horse.make_request(path, {}, 'post')
       end
@@ -180,7 +407,7 @@ describe "NetHTTPService module holder class Horse" do
         params = mock('Encoded parameters')
         Horse.should_receive(:encode_params).with(args).and_return(params)
 
-        @http_yield_mock.should_receive(:post).with(anything, params).and_return(@http_request_result)
+        @http_yield_mock.should_receive(:post).with(anything, params).and_return(@mock_http_response)
 
         Horse.make_request('anything', args, 'post')
       end
@@ -195,11 +422,11 @@ describe "NetHTTPService module holder class Horse" do
 
           @file_stub = stub('fake File', "kind_of?" => true, "path" => 'anypath.jpg')
 
-          @http_yield_mock.stub(:request).with(@multipart_request_stub).and_return(@http_request_result)
+          @http_yield_mock.stub(:request).with(@multipart_request_stub).and_return(@mock_http_response)
         end
 
         it "should use multipart/form-data if any parameter is a valid file hash" do
-          @http_yield_mock.should_receive(:request).with(@multipart_request_stub).and_return(@http_request_result)
+          @http_yield_mock.should_receive(:request).with(@multipart_request_stub).and_return(@mock_http_response)
 
           Horse.make_request('anything', {}, 'post')
         end
@@ -227,7 +454,7 @@ describe "NetHTTPService module holder class Horse" do
 
     describe "via GET" do
       it "should use Net::HTTP to make a GET request" do
-        @http_yield_mock.should_receive(:get).and_return(@http_request_result)
+        @http_yield_mock.should_receive(:get).and_return(@mock_http_response)
 
         Horse.make_request('anything', {}, 'get')
       end
@@ -238,7 +465,7 @@ describe "NetHTTPService module holder class Horse" do
         args = {}
 
         Horse.should_receive(:encode_params).with(args).and_return(params)
-        @http_yield_mock.should_receive(:get).with("#{path}?#{params}").and_return(@http_request_result)
+        @http_yield_mock.should_receive(:get).with("#{path}?#{params}").and_return(@mock_http_response)
 
         Horse.make_request(path, args, 'get')
       end
@@ -267,51 +494,6 @@ describe "NetHTTPService module holder class Horse" do
     end # describe return value
   end # describe when making a request
 
-  describe "when encoding parameters" do
-    it "should return an empty string if param_hash evaluates to false" do
-      Horse.encode_params(nil).should == ''
-    end
-
-    it "should convert values to JSON if the value is not a String" do
-      val = 'json_value'
-      not_a_string = 'not_a_string'
-      not_a_string.stub(:class).and_return('NotAString')
-      not_a_string.should_receive(:to_json).and_return(val)
-
-      string = "hi"
-
-      args = {
-        not_a_string => not_a_string,
-        string => string
-      }
-
-      result = Horse.encode_params(args)
-      result.split('&').find do |key_and_val|
-        key_and_val.match("#{not_a_string}=#{val}")
-      end.should be_true
-    end
-
-    it "should escape all values" do
-      args = Hash[*(1..4).map {|i| [i.to_s, "Value #{i}($"]}.flatten]
-
-      result = Horse.encode_params(args)
-      result.split('&').each do |key_val|
-        key, val = key_val.split('=')
-        val.should == CGI.escape(args[key])
-      end
-    end
-
-    it "should convert all keys to Strings" do
-      args = Hash[*(1..4).map {|i| [i, "val#{i}"]}.flatten]
-
-      result = Horse.encode_params(args)
-      result.split('&').each do |key_val|
-        key, val = key_val.split('=')
-        key.should == args.find{|key_val_arr| key_val_arr.last == val}.first.to_s
-      end
-    end
-  end
-
   describe "when detecting if multipart posting is needed" do
     it "should be true if any parameter value requires multipart post" do
       koala_io = mock("Koala::IO")
@@ -326,11 +508,11 @@ describe "NetHTTPService module holder class Horse" do
 
       Horse.params_require_multipart?(args).should be_true
     end
-    
+
     describe "when encoding multipart/form-data params" do
       it "should replace Koala::UploadableIO values with UploadIO values" do
         upload_io = UploadIO.new(__FILE__, "fake type")
-        
+
         uploadable_io = stub('Koala::UploadableIO')
         uploadable_io.should_receive(:kind_of?).with(Koala::UploadableIO).and_return(true)
         uploadable_io.should_receive(:to_upload_io).and_return(upload_io)
@@ -338,13 +520,13 @@ describe "NetHTTPService module holder class Horse" do
           "not_a_file" => "not a file",
           "file" => uploadable_io
         }
-        
+
         result = Horse.encode_multipart_params(args)
 
         result["not_a_file"] == args["not_a_file"]
         result["file"] == upload_io
       end
     end
-    
+
   end
 end