garage_client 2.1.1

data/spec/garage_client/configuration_spec.rb

@@ -0,0 +1,106 @@
+require "spec_helper"
+
+describe GarageClient::Configuration do
+  let(:configuration) do
+    described_class.new
+  end
+
+  describe "#adapter" do
+    context "in default configuration" do
+      it "returns :net_http" do
+        configuration.adapter.should == :net_http
+      end
+    end
+
+    context "after configured" do
+      before do
+        configuration.adapter = :test
+      end
+
+      it "returns configured value" do
+        configuration.adapter.should == :test
+      end
+    end
+  end
+
+  describe "#endpoint" do
+    context "not configured" do
+      it "raises RuntimeError" do
+        expect { configuration.endpoint }.to raise_error(RuntimeError, /missing endpoint/)
+      end
+    end
+
+    context "after configured" do
+      before do
+        configuration.endpoint = "http://example.com"
+      end
+
+      it "returns configured value" do
+        configuration.endpoint.should == "http://example.com"
+      end
+    end
+  end
+
+  describe "#headers" do
+    context "in default configuration" do
+      it "returns default headers as Hash" do
+        configuration.headers.should == {
+          "Accept" => "application/json",
+          "User-Agent" => "garage_client #{GarageClient::VERSION}",
+        }
+      end
+    end
+
+    context "after configured" do
+      before do
+        configuration.headers = { "HTTP_ACCEPT" => "application/json" }
+      end
+
+      it "returns configured value" do
+        configuration.headers.should == { "HTTP_ACCEPT" => "application/json" }
+      end
+    end
+  end
+
+  describe "#default_headers" do
+    it "returns configuration.headers" do
+      configuration.default_headers.should == configuration.headers
+    end
+  end
+
+  describe "#path_prefix" do
+    context "in default configuration" do
+      it "returns /v1" do
+        configuration.path_prefix.should == "/v1"
+      end
+    end
+
+    context "after configured" do
+      before do
+        configuration.path_prefix = "/v2"
+      end
+
+      it "returns configured value" do
+        configuration.path_prefix.should == "/v2"
+      end
+    end
+  end
+
+  describe "#verbose" do
+    context "in default configuration" do
+      it "returns false" do
+        configuration.verbose.should == false
+      end
+    end
+
+    context "after configured" do
+      before do
+        configuration.verbose = nil
+      end
+
+      it "returns configured value" do
+        configuration.verbose.should == nil
+      end
+    end
+  end
+end

data/spec/garage_client/error_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe GarageClient::Error do
+  context 'without argument' do
+    it 'raises GarageClient::Error' do
+      expect { raise GarageClient::Error }.to raise_error(GarageClient::Error, /GarageClient::Error/)
+    end
+  end
+
+  context 'with string' do
+    let(:message) do
+      'error_message'
+    end
+
+    it 'raises GarageClient::Error with error message' do
+      expect { raise GarageClient::Error, message }.to raise_error(GarageClient::Error, message)
+    end
+  end
+
+  context 'with Faraday::Response' do
+    let(:client) do
+      Faraday.new do |builder|
+        builder.adapter :test, Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.get('/example') { [404, {}, ''] }
+        end
+      end
+    end
+
+    let(:response) do
+      client.get('/example')
+    end
+
+    it 'raises GarageClient::Error with response summary' do
+      expect { raise GarageClient::Error, response.env }.to raise_error(GarageClient::Error, /GET .+ 404/)
+    end
+  end
+end

data/spec/garage_client/request/json_encoded_spec.rb

@@ -0,0 +1,66 @@
+require "spec_helper"
+
+describe GarageClient::Request::JsonEncoded do
+  let(:client) do
+    GarageClient::Client.new(headers: headers)
+  end
+
+  let(:headers) do
+    {}
+  end
+
+  let(:params) do
+    { key: "value" }
+  end
+
+  context "with Content-Type: application/json" do
+    let(:headers) do
+      { "Content-Type" => "application/json" }
+    end
+
+    it "encodes request body to JSON" do
+      stub_post("/examples").with(body: params.to_json)
+      expect { client.post("/examples", params) }.not_to raise_error
+    end
+  end
+
+  context "without Content-Type" do
+    it "encodes request body to JSON" do
+      stub_post("/examples").with(body: params.to_json)
+      expect { client.post("/examples", params) }.not_to raise_error
+    end
+  end
+
+  context "without body" do
+    let(:params) do
+      nil
+    end
+
+    it "does nothing" do
+      stub_post("/examples").with(body: nil)
+      expect { client.post("/examples", params) }.not_to raise_error
+    end
+  end
+
+
+  context "with Content-Type: multipart/form-data" do
+    let(:headers) do
+      { "Content-Type" => "multipart/form-data" }
+    end
+
+    it "does nothing" do
+      stub_post("/examples").with(
+        body: [
+          "-------------RubyMultipartPost",
+          "Content-Disposition: form-data; name=\"key\"",
+          "",
+          "value",
+          "-------------RubyMultipartPost--",
+          "",
+          "",
+        ].join("\r\n")
+      )
+      expect { client.post("/examples", params) }.not_to raise_error
+    end
+  end
+end

data/spec/garage_client/resource_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe GarageClient::Resource do
+  let(:client) { GarageClient::Client.new }
+  let(:response_body) { JSON.parse(fixture('example.yaml')['body']) }
+  let(:resource) { GarageClient::Resource.new(client, response_body) }
+
+  describe '#properties' do
+    it 'returns available properties' do
+      resource.properties.should include(
+        :id,
+        :created,
+        :updated,
+        :name,
+        :url,
+        :description,
+        :serving,
+        :published,
+        :edited,
+        :tier,
+        :ingredients,
+        :steps
+      )
+    end
+  end
+
+  describe '#links' do
+    it 'returns available links' do
+      resource.links.should include(:self, :canonical, :nested_examples)
+    end
+  end
+
+  describe '#update' do
+    before do
+      stub_put('/examples/1').to_return(fixture('example.yaml'))
+    end
+
+    it 'returns response with updated resource' do
+      response = resource.update(:name => 'new name')
+      response.should be_kind_of(GarageClient::Response)
+      response.body.should be_kind_of(GarageClient::Resource)
+    end
+  end
+
+  describe '#destroy' do
+    before do
+      stub_delete('/examples/1').to_return(:status => 204, :body => '')
+    end
+
+    it 'returns response' do
+      response = resource.destroy
+      response.should be_kind_of(GarageClient::Response)
+      response.body.should be_nil
+    end
+  end
+
+  describe 'create nested resource' do
+    before do
+      stub_post('/examples/1/nested_examples').to_return(fixture('example.yaml'))
+    end
+
+    it 'returns response' do
+      response = resource.create_nested_examples(:name => 'name')
+      response.should be_kind_of(GarageClient::Response)
+      response.body.should be_kind_of(GarageClient::Resource)
+    end
+  end
+
+  describe 'property' do
+    context 'with non-existent property' do
+      it 'raise no method error' do
+        expect { resource.non_existent_field }.to raise_error(NoMethodError)
+      end
+    end
+
+    context 'with primitive value' do
+      it 'returns value' do
+        resource.name.should == 'recipe title'
+      end
+    end
+
+    context 'with resource value' do
+      it 'returns resource' do
+        resource.user.should be_kind_of(GarageClient::Resource)
+      end
+    end
+  end
+
+  describe 'link' do
+    context 'with existent link' do
+      before do
+        stub_get('/examples/1/nested_examples').to_return(fixture('examples.yaml'))
+      end
+
+      it 'returns response' do
+        response = resource.nested_examples
+        response.should be_kind_of(GarageClient::Response)
+        response.body.should be_kind_of(Array)
+      end
+    end
+  end
+end

data/spec/garage_client/response_spec.rb

@@ -0,0 +1,450 @@
+require 'spec_helper'
+
+describe GarageClient::Response do
+  let(:response) do
+    described_class.new(client, raw_response)
+  end
+
+  let(:client) do
+    GarageClient::Client.new
+  end
+
+  let(:raw_response) do
+    double(headers: headers, body: env.body, env: env)
+  end
+
+  let(:headers) do
+    { 'Link' => link }
+  end
+
+  let(:env) do
+    double(:env, body: body).tap do |e|
+      allow(e).to receive(:[]).with(:body).and_return(body)
+    end
+  end
+
+  let(:body) do
+    {}
+  end
+
+  let(:link) do
+    %w[
+      </v1/examples?page=1>; rel="first",
+      </v1/examples?page=2>; rel="prev",
+      </v1/examples?page=4>; rel="next",
+      </v1/examples?page=5>; rel="last"
+    ].join(" ")
+  end
+
+  describe "#respond_to?" do
+    context "with same property" do
+      before do
+        body["name"] = "example"
+      end
+
+      it "returns true" do
+        response.respond_to?(:name).should == true
+      end
+    end
+
+    context "with same method" do
+      it "returns true" do
+        response.respond_to?(:body).should == true
+      end
+    end
+
+    context "with neithor same property nor same method" do
+      it "returns false" do
+        response.respond_to?(:name).should == false
+      end
+    end
+
+    context "with private method name and no include_private option" do
+      it "returns false" do
+        response.respond_to?(:parsed_link_header).should == false
+      end
+    end
+
+    context "with private method name and include_private option" do
+      it "returns true" do
+        response.respond_to?(:parsed_link_header, true).should == true
+      end
+    end
+  end
+
+  describe "#has_next_page?" do
+    context "without Link header" do
+      before do
+        headers.delete("Link")
+      end
+
+      it "returns false" do
+        response.has_next_page?.should == false
+      end
+    end
+
+    context "without next link" do
+      let(:link) do
+        ""
+      end
+
+      it "returns false" do
+        response.has_next_page?.should == false
+      end
+    end
+
+    context "with next link" do
+      it "returns true" do
+        response.has_next_page?.should == true
+      end
+    end
+  end
+
+  describe "#has_prev_page?" do
+    context "without Link header" do
+      before do
+        headers.delete("Link")
+      end
+
+      it "returns false" do
+        response.has_prev_page?.should == false
+      end
+    end
+
+    context "without prev link" do
+      let(:link) do
+        ""
+      end
+
+      it "returns false" do
+        response.has_prev_page?.should == false
+      end
+    end
+
+    context "with prev link" do
+      it "returns true" do
+        response.has_prev_page?.should == true
+      end
+    end
+  end
+
+  describe "#has_first_page?" do
+    context "without Link header" do
+      before do
+        headers.delete("Link")
+      end
+
+      it "returns false" do
+        response.has_first_page?.should == false
+      end
+    end
+
+    context "without first link" do
+      let(:link) do
+        ""
+      end
+
+      it "returns false" do
+        response.has_first_page?.should == false
+      end
+    end
+
+    context "with first link" do
+      it "returns true" do
+        response.has_first_page?.should == true
+      end
+    end
+  end
+
+  describe "#has_last_page?" do
+    context "without Link header" do
+      before do
+        headers.delete("Link")
+      end
+
+      it "returns false" do
+        response.has_last_page?.should == false
+      end
+    end
+
+    context "without last link" do
+      let(:link) do
+        ""
+      end
+
+      it "returns false" do
+        response.has_last_page?.should == false
+      end
+    end
+
+    context "with last link" do
+      it "returns true" do
+        response.has_last_page?.should == true
+      end
+    end
+  end
+
+  describe "#next_page_path" do
+    context "without Link header" do
+      before do
+        headers.delete("Link")
+      end
+
+      it "returns nil" do
+        response.next_page_path.should == nil
+      end
+    end
+
+    context "without next link" do
+      let(:link) do
+        ""
+      end
+
+      it "returns nil" do
+        response.next_page_path.should == nil
+      end
+    end
+
+    context "with next link" do
+      it "returns next page path" do
+        response.next_page_path.should == "/v1/examples?page=4"
+      end
+    end
+  end
+
+  describe "#prev_page_path" do
+    context "without Link header" do
+      before do
+        headers.delete("Link")
+      end
+
+      it "returns nil" do
+        response.prev_page_path.should == nil
+      end
+    end
+
+    context "without prev link" do
+      let(:link) do
+        ""
+      end
+
+      it "returns nil" do
+        response.prev_page_path.should == nil
+      end
+    end
+
+    context "with prev link" do
+      it "returns prev page path" do
+        response.prev_page_path.should == "/v1/examples?page=2"
+      end
+    end
+  end
+
+  describe "#first_page_path" do
+    context "without Link header" do
+      before do
+        headers.delete("Link")
+      end
+
+      it "returns nil" do
+        response.first_page_path.should == nil
+      end
+    end
+
+    context "without first link" do
+      let(:link) do
+        ""
+      end
+
+      it "returns nil" do
+        response.first_page_path.should == nil
+      end
+    end
+
+    context "with first link" do
+      it "returns first page path" do
+        response.first_page_path.should == "/v1/examples?page=1"
+      end
+    end
+  end
+
+  describe "#last_page_path" do
+    context "without Link header" do
+      before do
+        headers.delete("Link")
+      end
+
+      it "returns nil" do
+        response.last_page_path.should == nil
+      end
+    end
+
+    context "without last link" do
+      let(:link) do
+        ""
+      end
+
+      it "returns nil" do
+        response.last_page_path.should == nil
+      end
+    end
+
+    context "with last link" do
+      it "returns last page path" do
+        response.last_page_path.should == "/v1/examples?page=5"
+      end
+    end
+  end
+end
+
+describe Faraday::Response do
+  let(:mime_dict) { 'application/vnd.cookpad.dictionary+json' }
+  let(:client) { GarageClient::Client.new }
+  let(:response) { client.get('/examples') }
+
+  describe '#link' do
+    context 'with resources collection' do
+      context 'without paginated resources' do
+        before do
+          stub_get('/examples').to_return(fixture('examples_without_pagination.yaml'))
+        end
+
+        it 'returns link header' do
+          response.link.should be_nil
+        end
+      end
+
+      context 'with paginated resources' do
+        before do
+          stub_get('/examples').to_return(fixture('examples.yaml'))
+        end
+
+        it 'returns link header' do
+          response.link.should == %q{</v1/examples?page=2&per_page=1>; rel="next"}
+        end
+      end
+    end
+  end
+
+  describe '#total_count' do
+    context 'with resources collection' do
+      context 'without paginated resources' do
+        before do
+          stub_get('/examples').to_return(fixture('examples_without_pagination.yaml'))
+        end
+
+        it 'returns nil' do
+          response.total_count.should be_nil
+        end
+      end
+
+      context 'with paginated resources' do
+        before do
+          stub_get('/examples').to_return(fixture('examples.yaml'))
+        end
+
+        it 'returns total count' do
+          response.total_count.should == 1
+        end
+      end
+    end
+  end
+
+  describe '#body' do
+    let(:single_response) { client.get('/examples/1') }
+    let(:array_response) { client.get('/examples') }
+    let(:dictionary_response) { client.get('/examples', nil, :headers => { 'Accept' => mime_dict }) }
+
+    context 'with single resource' do
+      let(:response) { single_response }
+
+      before do
+        stub_get('/examples/1').to_return(fixture('example.yaml'))
+      end
+
+      it 'returns resource' do
+        response.body.should be_kind_of(GarageClient::Resource)
+      end
+    end
+
+    context 'with resources collection' do
+      context 'with array response' do
+        let(:response) { array_response }
+
+        before do
+          stub_get('/examples').to_return(fixture('examples.yaml'))
+        end
+
+        it 'returns resources array' do
+          response.body.should be_kind_of(Array)
+          response.body.first.should be_kind_of(GarageClient::Resource)
+        end
+      end
+
+      context 'with dictionary response' do
+        let(:response) { dictionary_response }
+
+        before do
+          stub_get('/examples').to_return(fixture('examples_dictionary.yaml'))
+        end
+
+        it 'returns resources array' do
+          response.body.should be_kind_of(Hash)
+          response.body['1'].should be_kind_of(GarageClient::Resource)
+        end
+      end
+    end
+  end
+
+  describe 'delegation' do
+    before do
+      stub_get('/examples').to_return(fixture('examples.yaml'))
+    end
+
+    it 'delegates undefined method call to  resource' do
+      response.size.should == 1
+      response.first.should be_kind_of(GarageClient::Resource)
+    end
+  end
+
+  describe 'http errors' do
+    {
+      401 => GarageClient::Unauthorized,
+      403 => GarageClient::Forbidden,
+      404 => GarageClient::NotFound,
+      406 => GarageClient::NotAcceptable,
+      409 => GarageClient::Conflict,
+      415 => GarageClient::UnsupportedMediaType,
+      422 => GarageClient::UnprocessableEntity,
+      500 => GarageClient::InternalServerError,
+      503 => GarageClient::ServiceUnavailable,
+    }.each do |status, exception|
+      context "when HTTP status is #{status}" do
+        before do
+          stub_get('/examples/xyz').to_return(:status => status)
+        end
+
+        it "should raise #{exception.name} error" do
+          expect {
+            client.get('/examples/xyz')
+          }.to raise_error(exception) { |e|
+            e.should be_a_kind_of(GarageClient::Error)
+            e.response.should be_respond_to(:[])
+          }
+        end
+      end
+    end
+  end
+
+  describe 'response type error' do
+    before do
+      stub_get('/examples').to_return(body: 'error')
+    end
+
+    it 'raises error' do
+      expect { client.get('/examples') }.to raise_error(GarageClient::InvalidResponseType) {|e|
+        e.should be_a_kind_of(GarageClient::Error)
+      }
+    end
+  end
+end