ncfoundry 4.9.2

data/spec/cfoundry/errors_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe 'Errors' do
+  describe CFoundry::Timeout do
+    let(:parent) { Timeout::Error.new }
+
+    subject { CFoundry::Timeout.new("POST", '/blah', parent) }
+
+    describe '#to_s' do
+      subject { super().to_s }
+      it { should eq "POST /blah timed out" }
+    end
+
+    describe '#method' do
+      subject { super().method }
+      it { should eq "POST" }
+    end
+
+    describe '#uri' do
+      subject { super().uri }
+      it { should eq '/blah' }
+    end
+
+    describe '#parent' do
+      subject { super().parent }
+      it { should eq parent }
+    end
+  end
+
+  describe CFoundry::InvalidTarget do
+    let(:target) { "http://--foo-bar" }
+    subject { CFoundry::InvalidTarget.new(target) }
+
+    describe '#to_s' do
+      subject { super().to_s }
+      it { should eq "Invalid target URI: #{target}"}
+    end
+
+    describe '#target' do
+      subject { super().target }
+      it { should eq target }
+    end
+  end
+
+  describe CFoundry::APIError do
+    let(:request) { { :method => "GET", :url => "http://api.example.com/foo", :headers => {} } }
+    let(:response_body) { "NOT FOUND" }
+    let(:response) { { :status => 404, :headers => {}, :body => response_body } }
+
+    subject { CFoundry::APIError.new(nil, nil, request, response) }
+
+    describe '#to_s' do
+      subject { super().to_s }
+      it { should eq "404: NOT FOUND" }
+    end
+
+    describe '#request' do
+      subject { super().request }
+      it { should eq request }
+    end
+
+    describe '#response' do
+      subject { super().response }
+      it { should eq response }
+    end
+
+    describe "#initialize" do
+
+      context "Response body is JSON" do
+
+        let(:response_body) { "{\"description\":\"Something went wrong\"}"}
+
+        it "sets description to description field in parsed JSON" do
+          expect(CFoundry::APIError.new(nil, nil, request, response).description).to eq("Something went wrong")
+        end
+      end
+
+
+      context "Response body is not JSON" do
+
+        let(:response_body) { "Some plain text"}
+
+        it "sets description to body text" do
+          expect(CFoundry::APIError.new(nil, nil, request, response).description).to eq("Some plain text")
+        end
+      end
+
+      it "allows override of description" do
+        expect(CFoundry::APIError.new("My description", nil, request, response).description).to eq("My description")
+      end
+
+    end
+
+    describe "#request_trace" do
+      describe '#request_trace' do
+        subject { super().request_trace }
+        it { should include "REQUEST: " }
+      end
+    end
+
+    describe "#response_trace" do
+      describe '#response_trace' do
+        subject { super().response_trace }
+        it { should include "RESPONSE: " }
+      end
+    end
+
+    it "sets error code to response error code by default" do
+      expect(CFoundry::APIError.new(nil, nil, request, response).error_code).to eq(404)
+    end
+
+    it "allows override of error code" do
+      expect(CFoundry::APIError.new(nil, 303, request, response).error_code).to eq(303)
+    end
+
+  end
+end

data/spec/cfoundry/rest_client_spec.rb

@@ -0,0 +1,367 @@
+require "spec_helper"
+
+describe CFoundry::RestClient do
+  let(:token) { nil }
+  let(:target) { "https://api.example.com" }
+  let(:rest_client) { CFoundry::RestClient.new(target, token) }
+
+  describe '#request' do
+    let(:path) { "some-path" }
+    let(:url) { "#{target}/#{path}" }
+    let(:verb) { "GET" }
+    let(:options) { {} }
+
+    def check_request(verb = :get, &block)
+      request_stub = stub_request(verb, url).to_return do |req|
+        block.call(req)
+        {}
+      end
+      subject
+      expect(request_stub).to have_been_requested
+    end
+
+    subject { rest_client.request(verb, path, options) }
+
+    describe 'headers' do
+      %w[Authorization X-Request-Id Content-Type].each do |header_name|
+        it "should not include the #{header_name} by default" do
+          check_request do |req|
+            expect(req.headers).not_to have_key(header_name)
+          end
+        end
+      end
+
+      it "should not provide specific accept mimetypes by default" do
+        check_request do |req|
+          expect(req.headers["Accept"]).to eql("*/*")
+        end
+      end
+
+      it 'should always include a content length' do
+        check_request do |req|
+          expect(req.headers["Content-Length"]).to eql(0)
+        end
+      end
+
+      context "when a payload is passed" do
+        context "when the payload is a string" do
+          let(:options) { { :payload => "some payload"} }
+
+          it 'includes a content length matching the payload size' do
+            check_request do |req|
+              expect(req.headers["Content-Length"]).to eql("some payload".length)
+            end
+          end
+        end
+
+        context "when the payload is a hash and the content-type is JSON" do
+          let(:options) { { :payload => { "key" => "value" }, :content => :json } }
+
+          it 'includes a content length matching the JSON encoded length' do
+            check_request do |req|
+              expect(req.headers["Content-Length"]).to eql('{"key":"value"}'.length)
+            end
+          end
+        end
+
+        context "when the payload is a hash (i.e. multipart upload)" do
+          let(:verb) { "PUT" }
+          let(:options) { {:payload => {"key" => "value"}} }
+
+          it 'includes a nonzero content length' do
+            check_request(:put) do |req|
+              expect(req.headers["Content-Length"].to_i).to be > 0
+            end
+          end
+        end
+      end
+
+      context "when params are passed" do
+        context "when params is an empty hash" do
+          let(:options) { {:params => {}} }
+
+          it "does not add a query string delimiter (the question mark)" do
+            request_stub = stub_request(:get, "https://api.example.com/some-path")
+            subject
+            expect(request_stub).to have_been_requested
+          end
+        end
+
+        context "when params has values" do
+          let(:options) { {:params => {"key" => "value"}} }
+
+          it "appends a query string and delimiter" do
+            request_stub = stub_request(:get, "https://api.example.com/some-path?key=value")
+            subject
+            expect(request_stub).to have_been_requested
+          end
+        end
+      end
+
+      context 'and the token is set' do
+        let(:token_header) { "bearer something" }
+        let(:token) { CFoundry::AuthToken.new(token_header) }
+
+        it 'should include Authorization in the header' do
+          check_request do |req|
+            expect(req.headers["Authorization"]).to eq(token_header)
+          end
+        end
+      end
+
+      context 'and the request_id is set' do
+        before { rest_client.request_id = "SomeRequestId" }
+
+        it 'should include X-Request-Id in the header' do
+          check_request do |req|
+            expect(req.headers["X-Request-Id"]).to eq "SomeRequestId"
+          end
+        end
+      end
+
+      context 'and the content is passed in' do
+        let(:options) { {:content => "text/xml"} }
+
+        it 'should include Content-Type in the header' do
+          check_request do |req|
+            expect(req.headers["Content-Type"]).to eq "text/xml"
+          end
+        end
+      end
+
+      context 'and custom headers are passed in' do
+        let(:options) { {:headers => {"X-Foo" => "Bar"}} }
+
+        it 'should include the custom header in the header' do
+          check_request do |req|
+            expect(req.headers["X-Foo"]).to eq "Bar"
+          end
+        end
+
+        context 'and it overrides an existing one' do
+          let(:options) { {:content => "text/xml", :headers => {"Content-Type" => "text/html"}} }
+
+          it 'uses the custom header' do
+            check_request do |req|
+              expect(req.headers["Content-Type"]).to eq "text/html"
+            end
+          end
+        end
+      end
+    end
+
+    describe 'errors' do
+      context "when the target refuses the connection" do
+        let(:target) { "http://localhost:2358974958" }
+
+        it "raises CFoundry::TargetRefused" do
+          stub_request(:get, url).to_raise(Errno::ECONNREFUSED)
+          expect { subject }.to raise_error(CFoundry::TargetRefused)
+        end
+      end
+
+      context "when the target is not a HTTP(S) URI" do
+        let(:target) { "ftp://foo-bar.com" }
+
+        it "raises CFoundry::InvalidTarget" do
+          expect { subject }.to raise_error(CFoundry::InvalidTarget)
+        end
+      end
+
+      context "when the target URI is invalid" do
+        let(:target) { "@#*#^! rubby" }
+
+        it "raises CFoundry::InvalidTarget" do
+          expect { subject }.to raise_error(CFoundry::InvalidTarget)
+        end
+      end
+    end
+
+    describe "the return value" do
+      before do
+        stub_request(:get, url).to_return({
+          :status => 201,
+          :headers => {"Content-Type" => "application/json"},
+          :body => '{ "foo": 1 }'
+        })
+      end
+
+      it "returns a request hash and a response hash" do
+        expect(subject).to be_an(Array)
+        expect(subject.length).to eq(2)
+      end
+
+      describe "the returned request hash" do
+        it "returns a hash of :headers, :url, :body and :verb" do
+          expect(subject[0]).to eq({
+            :url => url,
+            :method => "GET",
+            :headers => {"Content-Length" => 0},
+            :body => nil
+          })
+        end
+      end
+
+      describe "the returned response hash" do
+        it "returns a hash of :headers, :status, :body" do
+          expect(subject[1]).to eq({
+            :status => "201",
+            :headers => {"content-type" => "application/json"},
+            :body => '{ "foo": 1 }'
+          })
+        end
+      end
+    end
+
+    describe "when the path starts with a slash" do
+      let(:path) { "/some-path/some-segment" }
+
+      it "doesn't add a double slash" do
+        stub = stub_request(:get, "https://api.example.com/some-path/some-segment")
+        subject
+        expect(stub).to have_been_requested
+      end
+    end
+
+    describe "when the path does not start with a slash" do
+      let(:path) { "some-path/some-segment" }
+
+      it "doesn't add a double slash" do
+        stub = stub_request(:get, "https://api.example.com/some-path/some-segment")
+        subject
+        expect(stub).to have_been_requested
+      end
+    end
+
+    describe "when the path is a full url" do
+      let(:path) { "http://example.com" }
+
+      it "requests the given url" do
+        stub = stub_request(:get, "http://example.com")
+        subject
+        expect(stub).to have_been_requested
+      end
+    end
+
+    describe "when the path is malformed" do
+      let(:path) { "#%&*$(#%&$%)" }
+
+      it "blows up" do
+        expect { subject }.to raise_error(URI::InvalidURIError)
+      end
+    end
+
+    describe 'trace' do
+      before do
+        rest_client.trace = true
+        stub_request(:get, url).to_return(:status => 200, :headers => {"content-type" => "application/json"}, :body => '{"some": "json"}')
+      end
+
+      it "prints the request and the response" do
+        expect(rest_client).to receive(:print_request).with({:headers => {"Content-Length" => 0}, :url => "https://api.example.com/some-path", :method => "GET", :body => nil})
+        expect(rest_client).to receive(:print_response).with({:status => "200", :headers => {"content-type" => "application/json"}, :body => '{"some": "json"}'})
+        subject
+      end
+    end
+
+    describe "following redirects" do
+      before do
+        stub_request(:post, "https://api.example.com/apps").to_return(
+          :status => 301,
+          :headers => {"location" => "https://api.example.com/apps/some-guid"}
+        )
+        stub_request(:get, "https://api.example.com/apps/some-guid").to_return(
+          :status => 200,
+          :body => '{"some": "json"}'
+        )
+      end
+
+      it "follows redirects correctly, returning the response to the 2nd redirect" do
+        request, response = rest_client.request("POST", "apps")
+        expect(response).to eql(
+          :status => "200",
+          :headers => {},
+          :body => '{"some": "json"}'
+        )
+      end
+    end
+  end
+
+  describe CFoundry::RestClient::HTTPFactory do
+    describe ".create" do
+      let(:proxy_options) { [] }
+      let(:target_uri) { "http://api.example.com" }
+
+      subject { CFoundry::RestClient::HTTPFactory.create(URI.parse(target_uri), proxy_options) }
+
+      context "when no proxy URI is set" do
+        before do
+          @original_no_proxy_env = ENV["NO_PROXY"]
+          ENV["NO_PROXY"] = "example.com"
+        end
+
+        after do
+          ENV["NO_PROXY"] = @original_no_proxy_env
+        end
+
+        it "should return an instance of the plain Net:HTTP class" do
+          expect(subject).to be_instance_of(Net::HTTP)
+          expect(subject.use_ssl?).to be_falsey
+          expect(subject.proxy?).to_not be_truthy
+        end
+      end
+
+      context "when the target is an https URI" do
+        before do
+          @original_no_proxy_env = ENV["NO_PROXY"]
+          ENV["NO_PROXY"] = "example.com"
+        end
+
+        after do
+          ENV["NO_PROXY"] = @original_no_proxy_env
+        end
+
+        let(:target_uri) { "https://example.com" }
+        it "should return an instance of the plain Net:HTTP class with use_ssl" do
+          expect(subject).to be_instance_of(Net::HTTP)
+          expect(subject.use_ssl?).to be_truthy
+          expect(subject.proxy?).to_not be_truthy
+        end
+      end
+
+      context "when a http proxy URI without user/password is set " do
+        let(:proxy_options) { ["exapmle.com", 8080, nil, nil] }
+
+        it "should return an instance of the proxy class" do
+          expect(subject.proxy?).to be_truthy
+          expect(subject.proxy_address).to eql("exapmle.com")
+          expect(subject.proxy_port).to eql(8080)
+        end
+      end
+
+      context "when a http proxy URI with user/password is set " do
+        let(:proxy_options) { ["exapmle.com", "8080", "user", "pass"] }
+
+        it "should return an instance of the proxy class" do
+          expect(subject.proxy?).to be_truthy
+          expect(subject.proxy_user).to eql("user")
+          expect(subject.proxy_pass).to eql("pass")
+        end
+      end
+    end
+  end
+
+  describe "#target=" do
+    let(:token) { "some-token" }
+
+    it "invalidates the token if the target has changed" do
+      rest_client.target = "http://some-target.com"
+      expect(rest_client.token).to be_nil
+    end
+
+    it "does not invalidate the token if the target has not changed" do
+      rest_client.target = target
+      expect(rest_client.token).to eq token
+    end
+  end
+end

data/spec/cfoundry/trace_helpers_spec.rb

@@ -0,0 +1,91 @@
+require "spec_helper"
+
+describe CFoundry::TraceHelpers do
+  let(:tracehelper_test_class) { Class.new { include CFoundry::TraceHelpers } }
+  let(:request) do
+    {
+      :method => "GET",
+      :url => "http://api.example.com/foo",
+      :headers => { "bb-foo" => "bar", "accept" => "*/*" }
+    }
+  end
+  let(:response) { { :status => 404, :body => "not found", :headers => {} } }
+
+  shared_examples "request_trace tests" do
+    it { should include request_trace }
+    it { should include header_trace }
+    it { should include body_trace }
+  end
+
+  shared_examples "response_trace tests" do
+    before { response[:body] = response_body }
+
+    it "traces the provided response" do
+      expect(tracehelper_test_class.new.response_trace(response)).to eq(response_trace)
+    end
+  end
+
+  describe "#request_trace" do
+    let(:request_trace) { "REQUEST: GET http://api.example.com/foo" }
+    let(:header_trace) { "REQUEST_HEADERS:\n  accept : */*\n  bb-foo : bar" }
+    let(:body_trace) { "" }
+
+    subject { tracehelper_test_class.new.request_trace(request) }
+
+    context "without a request body" do
+      include_examples "request_trace tests"
+    end
+
+    context "with a request body" do
+      let(:body_trace) { "REQUEST_BODY: Some body text" }
+
+      before { request[:body] = "Some body text" }
+
+      include_examples "request_trace tests"
+    end
+
+    it "returns nil if request is nil" do
+      expect(tracehelper_test_class.new.request_trace(nil)).to eq(nil)
+    end
+
+    context "with protected attributes" do
+      let(:header_trace) { "REQUEST_HEADERS:\n  Authorization : [PRIVATE DATA HIDDEN]" }
+      let(:request) do
+        {
+            :method => "GET",
+            :url => "http://api.example.com/foo",
+            :headers => { 'Authorization' => "SECRET STUFF" }
+        }
+      end
+      include_examples "request_trace tests"
+    end
+  end
+
+
+  describe "#response_trace" do
+    context "with a non-JSON response body" do
+      let(:response_trace) { "RESPONSE: [404]\nRESPONSE_HEADERS:\n\nRESPONSE_BODY:\nSome body" }
+      let(:response_body) { "Some body"}
+
+      include_examples "response_trace tests"
+    end
+
+    context "with a JSON response body" do
+      let(:response_body) { "{\"name\": \"vcap\",\"build\": 2222,\"support\": \"http://support.example.com\"}" }
+      let(:response_trace) { "RESPONSE: [404]\nRESPONSE_HEADERS:\n\nRESPONSE_BODY:\n#{MultiJson.dump(MultiJson.load(response_body), :pretty => true)}" }
+
+      include_examples "response_trace tests"
+    end
+    
+    context "with credentials in the response body" do
+      let(:response_body) { '{"resources": [{"entity": {"credentials": {"super_secret_stuff": "goes here"}, "other_stuff": "still here"}}]}' }
+      let(:response_trace) { "RESPONSE: [404]\nRESPONSE_HEADERS:\n\nRESPONSE_BODY:\n#{MultiJson.dump({"resources" => [{"entity" => {"credentials" => "[PRIVATE DATA HIDDEN]", "other_stuff" => "still here"}}]}, :pretty => true)}" }
+
+      include_examples "response_trace tests"
+    end
+
+    it "returns nil if response is nil" do
+      expect(tracehelper_test_class.new.response_trace(nil)).to eq(nil)
+    end
+  end
+end