garage_client 2.1.1

data/spec/features/configuration_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe "Configuration of GarageClient" do
+  let(:client) { GarageClient::Client.new(options) }
+  let(:options) { {} }
+
+  describe "header configuration" do
+    before do
+      options[:headers] = { "User-Agent" => "my agent" }
+    end
+
+    it "sends configured User-Agent" do
+      stub_request(:get, "https://garage.example.com/v1/me").
+        with(headers: { 'User-Agent'=>'my agent' }).
+        to_return(:status => 200, :body => "", :headers => {})
+
+      client.get('/v1/me')
+    end
+  end
+
+  describe "header configuration with global configuration" do
+    around do |example|
+      prev = GarageClient.configuration
+      GarageClient.instance_variable_set(
+        :@configuration,
+        GarageClient::Configuration.new(endpoint: "https://garage.example.com")
+      )
+
+      example.run
+
+      GarageClient.instance_variable_set(:@configuration, prev)
+    end
+
+    it "uses global configured User-Agent" do
+      GarageClient.configure do |c|
+        c.headers = { "User-Agent" => "my agent" }
+      end
+
+      stub_request(:get, "https://garage.example.com/v1/me").
+        with(headers: { 'User-Agent'=>'my agent' }).
+        to_return(:status => 200, :body => "", :headers => {})
+
+      client.get('/v1/me')
+    end
+  end
+end

data/spec/fixtures/example.yaml

@@ -0,0 +1,56 @@
+headers:
+  Content-Type: application/json; charset=utf-8
+body: |
+  {
+             "id": 1,
+        "created": "2000-01-01T00:00:00+09:00",
+        "updated": "2000-01-01T00:00:00+09:00",
+           "name": "recipe title",
+            "url": "http://example.com/examples/1",
+           "user": {
+                 "id": 2294,
+                "url": "http://example.com/kitchen/2294",
+               "name": "Fern1",
+             "_links": {
+                        "self": {
+                 "href": "/v1/users/2294"
+               },
+                   "bookmarks": {
+                 "href": "/v1/users/2294/bookmarks"
+               },
+               "bookmark_tags": {
+                 "href": "/v1/users/2294/bookmark_tags"
+               },
+                   "canonical": {
+                 "href": "/v1/users/2294"
+               },
+               "diary_entries": {
+                 "href": "/v1/users/2294/diary_entries"
+               },
+                   "feedbacks": {
+                 "href": "/v1/users/2294/feedbacks"
+               },
+                     "recipes": {
+                 "href": "/v1/users/2294/recipes"
+               }
+             }
+           },
+    "description": "this is my favorite recipe.",
+        "serving": null,
+      "published": "2000-01-01T00:00:00+09:00",
+         "edited": null,
+           "tier": "example.com:User",
+    "ingredients": [],
+          "steps": [],
+         "_links": {
+           "self": {
+        "href": "/examples/1"
+      },
+      "canonical": {
+        "href": "/examples/1"
+      },
+      "nested_examples": {
+        "href": "/examples/1/nested_examples"
+      }
+    }
+  }

data/spec/fixtures/examples.yaml

@@ -0,0 +1,60 @@
+headers:
+  Content-Type: application/json; charset=utf-8
+  X-List-TotalCount: "1"
+  Link: </v1/examples?page=2&per_page=1>; rel="next"
+body: |
+  [
+    {
+               "id": 1,
+          "created": "2000-01-01T00:00:00+09:00",
+          "updated": "2000-01-01T00:00:00+09:00",
+             "name": "recipe title",
+              "url": "http://example.com/examples/1",
+             "user": {
+                   "id": 2294,
+                  "url": "http://example.com/kitchen/2294",
+                 "name": "Fern1",
+               "_links": {
+                          "self": {
+                   "href": "/v1/users/2294"
+                 },
+                     "bookmarks": {
+                   "href": "/v1/users/2294/bookmarks"
+                 },
+                 "bookmark_tags": {
+                   "href": "/v1/users/2294/bookmark_tags"
+                 },
+                     "canonical": {
+                   "href": "/v1/users/2294"
+                 },
+                 "diary_entries": {
+                   "href": "/v1/users/2294/diary_entries"
+                 },
+                     "feedbacks": {
+                   "href": "/v1/users/2294/feedbacks"
+                 },
+                       "recipes": {
+                   "href": "/v1/users/2294/recipes"
+                 }
+               }
+             },
+      "descriptien": "this is my favorite recipe.",
+          "serving": null,
+        "published": "2000-01-01T00:00:00+09:00",
+           "edited": null,
+             "tier": "example.com:User",
+      "ingredients": [],
+            "steps": [],
+           "_links": {
+             "self": {
+          "href": "/examples/1"
+        },
+        "canonical": {
+          "href": "/examples/1"
+        },
+        "nested_examples": {
+          "href": "/examples/1/nested_examples"
+        }
+      }
+    }
+  ]

data/spec/fixtures/examples_dictionary.yaml

@@ -0,0 +1,60 @@
+headers:
+  Content-Type: application/vnd.cookpad.dictionary+json; charset=utf-8
+  X-List-TotalCount: "1"
+  Link: </v1/examples?page=2&per_page=1>; rel="next"
+body: |
+  {
+    "1": {
+               "id": 1,
+          "created": "2000-01-01T00:00:00+09:00",
+          "updated": "2000-01-01T00:00:00+09:00",
+             "name": "recipe title",
+              "url": "http://example.com/examples/1",
+             "user": {
+                   "id": 2294,
+                  "url": "http://example.com/kitchen/2294",
+                 "name": "Fern1",
+               "_links": {
+                          "self": {
+                   "href": "/v1/users/2294"
+                 },
+                     "bookmarks": {
+                   "href": "/v1/users/2294/bookmarks"
+                 },
+                 "bookmark_tags": {
+                   "href": "/v1/users/2294/bookmark_tags"
+                 },
+                     "canonical": {
+                   "href": "/v1/users/2294"
+                 },
+                 "diary_entries": {
+                   "href": "/v1/users/2294/diary_entries"
+                 },
+                     "feedbacks": {
+                   "href": "/v1/users/2294/feedbacks"
+                 },
+                       "recipes": {
+                   "href": "/v1/users/2294/recipes"
+                 }
+               }
+             },
+      "descriptien": "this is my favorite recipe.",
+          "serving": null,
+        "published": "2000-01-01T00:00:00+09:00",
+           "edited": null,
+             "tier": "cookpad.com:User",
+      "ingredients": [],
+            "steps": [],
+           "_links": {
+             "self": {
+          "href": "/examples/1"
+        },
+        "canonical": {
+          "href": "/examples/1"
+        },
+        "nested_examples": {
+          "href": "/examples/1/nested_examples"
+        }
+      }
+    }
+  }

data/spec/fixtures/examples_without_pagination.yaml

@@ -0,0 +1,58 @@
+headers:
+  Content-Type: application/json; charset=utf-8
+body: |
+  [
+    {
+               "id": 1,
+          "created": "2000-01-01T00:00:00+09:00",
+          "updated": "2000-01-01T00:00:00+09:00",
+             "name": "recipe title",
+              "url": "http://example.com/examples/1",
+             "user": {
+                   "id": 2294,
+                  "url": "http://example.com/kitchen/2294",
+                 "name": "Fern1",
+               "_links": {
+                          "self": {
+                   "href": "/v1/users/2294"
+                 },
+                     "bookmarks": {
+                   "href": "/v1/users/2294/bookmarks"
+                 },
+                 "bookmark_tags": {
+                   "href": "/v1/users/2294/bookmark_tags"
+                 },
+                     "canonical": {
+                   "href": "/v1/users/2294"
+                 },
+                 "diary_entries": {
+                   "href": "/v1/users/2294/diary_entries"
+                 },
+                     "feedbacks": {
+                   "href": "/v1/users/2294/feedbacks"
+                 },
+                       "recipes": {
+                   "href": "/v1/users/2294/recipes"
+                 }
+               }
+             },
+      "description": "this is my favorite recipe.",
+          "serving": null,
+        "published": "2000-01-01T00:00:00+09:00",
+           "edited": null,
+             "tier": "cookpad.com:User",
+      "ingredients": [],
+            "steps": [],
+           "_links": {
+             "self": {
+          "href": "/examples/1"
+        },
+        "canonical": {
+          "href": "/v1/examples/1"
+        },
+        "nested_examples": {
+          "href": "/examples/1/nested_examples"
+        }
+      }
+    }
+  ]

data/spec/garage_client/cacher_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+describe GarageClient::Cachers::Base do
+  let(:client) do
+    GarageClient::Client.new(cacher: cacher_class)
+  end
+
+  let(:cacher_class) do
+    store = store
+    Class.new(GarageClient::Cachers::Base) do
+      private
+
+      def key
+        @env[:url].to_s
+      end
+
+      def read_from_cache?
+        true
+      end
+
+      def written_to_cache?
+        true
+      end
+
+      def store
+        Class.new do
+          def initialize
+            @table = {}
+          end
+
+          def read(key, options = {})
+            @table[key]
+          end
+
+          def write(key, value, options = {})
+            @table[key] = value
+          end
+        end.new
+      end
+    end
+  end
+
+  describe "caching" do
+    context "with cache-enabled GarageClient::Client" do
+      it "caches response along passed cacher class" do
+        stub_get("/examples").to_return(fixture("examples.yaml")).times(1)
+        stub_get("/example").to_return(fixture("example.yaml")).times(1)
+        client.get("/examples").body.should be_a Array
+        client.get("/examples").body.should be_a Array
+        client.get("/example").body.should be_a GarageClient::Resource
+        client.get("/example").body.should be_a GarageClient::Resource
+      end
+    end
+  end
+end

data/spec/garage_client/client_spec.rb

@@ -0,0 +1,228 @@
+require 'spec_helper'
+
+describe GarageClient::Client do
+  let(:client) { GarageClient::Client.new(options) }
+  let(:options) { {} }
+
+  describe "#adapter" do
+    context "without :adapter option value" do
+      it "returns default value" do
+        client.adapter.should == GarageClient.configuration.adapter
+      end
+    end
+
+    context "with :adapter option value" do
+      before do
+        options[:adapter] = :test
+      end
+
+      it "returns it" do
+        client.adapter.should == :test
+      end
+    end
+  end
+
+  describe "#endpoint" do
+    context "without :endpoint option value" do
+      it "returns default value" do
+        client.endpoint.should == GarageClient.configuration.endpoint
+      end
+    end
+
+    context "with :endpoint option value" do
+      before do
+        options[:endpoint] = "http://example.com"
+      end
+
+      it "returns it" do
+        client.endpoint.should == "http://example.com"
+      end
+    end
+  end
+
+  describe "#path_prefix" do
+    context "without :path_prefix option value" do
+      it "returns default value" do
+        client.path_prefix.should == GarageClient.configuration.path_prefix
+      end
+    end
+
+    context "with :path_prefix option value" do
+      before do
+        options[:path_prefix] = "/v2"
+      end
+
+      it "returns it" do
+        client.path_prefix.should == "/v2"
+      end
+    end
+  end
+
+  describe "#verbose" do
+    context "without :verbose option value" do
+      it "returns default value" do
+        client.verbose.should == GarageClient.configuration.verbose
+      end
+    end
+
+    context "with :verbose option value" do
+      before do
+        options[:verbose] = nil
+      end
+
+      it "returns it" do
+        client.verbose.should == nil
+      end
+    end
+  end
+
+  describe "#headers" do
+    context "without :headers option value" do
+      it "returns default value" do
+        client.headers.should == GarageClient.configuration.headers
+      end
+    end
+
+    context "with :headers option value" do
+      before do
+        options[:headers] = { "Content-Type" => "text/plain" }
+      end
+
+      it "returns headers merged with default values" do
+        client.headers.should == {
+          "Accept" => "application/json",
+          "Content-Type" => "text/plain",
+          "User-Agent" => "garage_client #{GarageClient::VERSION}"
+        }
+      end
+    end
+
+    context "with User-Agent header option" do
+      before do
+        options[:headers] = { "User-Agent" => "my agent" }
+      end
+
+      it "returns changed User-Agent" do
+        client.headers["User-Agent"].should eq "my agent"
+      end
+    end
+  end
+
+  describe "authorization" do
+    before do
+      client.access_token = 'abc'
+      stub_get('/example').with(
+        headers: {
+          'Accept' => 'application/json',
+          'Accept-Encoding' => /.*/,
+          'User-Agent' => /.*/,
+          'Authorization' => 'Bearer abc'
+        }
+      ).to_return(fixture('example.yaml'))
+    end
+
+    it "requests with expected beaer authorization header" do
+      expect { client.get('/example') }.not_to raise_error
+    end
+  end
+
+  describe "#adapter=" do
+    it "overwrites it" do
+      client.adapter = :test
+      client.adapter.should == :test
+    end
+  end
+
+  describe "#endpoint=" do
+    it "overwrites it" do
+      client.adapter = "http://example.com"
+      client.adapter.should == "http://example.com"
+    end
+  end
+
+  describe "#headers=" do
+    it "updates merged headers" do
+      client.headers = { "Content-Type" => "text/plain" }
+      client.headers.should == { "Content-Type" => "text/plain" }
+    end
+  end
+
+  describe "#path_prefix=" do
+    it "overwrites it" do
+      client.adapter = "/v2"
+      client.adapter.should == "/v2"
+    end
+  end
+
+  describe "#verbose=" do
+    it "overwrites it" do
+      client.verbose = nil
+      client.verbose.should == nil
+    end
+  end
+
+  describe '#get' do
+    context 'with collection resource' do
+      before do
+        stub_get('/examples').to_return(fixture('examples.yaml'))
+      end
+
+      it 'returns response' do
+        response = client.get('/examples')
+        response.should be_kind_of(GarageClient::Response)
+        response.body.should be_kind_of(Array)
+        response.body.first.should be_kind_of(GarageClient::Resource)
+      end
+    end
+
+    context 'with single resource' do
+      before do
+        stub_get('/examples/1').to_return(fixture('example.yaml'))
+      end
+
+      it 'returns response' do
+        response = client.get('/examples/1')
+        response.should be_kind_of(GarageClient::Response)
+        response.body.should be_kind_of(GarageClient::Resource)
+      end
+    end
+  end
+
+  describe '#post' do
+    before do
+      stub_post('/examples').to_return(fixture('example.yaml'))
+    end
+
+    it 'returns created resource' do
+      response = client.post('/examples', :name => 'example name')
+      response.should be_kind_of(GarageClient::Response)
+      response.body.should be_kind_of(GarageClient::Resource)
+    end
+  end
+
+  describe '#me' do
+    before do
+      stub_get('/me').to_return(fixture('example.yaml'))
+    end
+
+    it 'returns response' do
+      response = client.me
+      response.should be_kind_of(GarageClient::Response)
+      response.body.should be_kind_of(GarageClient::Resource)
+    end
+  end
+
+  describe 'validation' do
+    context 'when endpoint configuration is missing' do
+      around do |example|
+        old, GarageClient.endpoint = GarageClient.endpoint, nil
+        example.run
+        GarageClient.endpoint = old
+      end
+
+      it 'raises RuntimeError' do
+        expect { client }.to raise_error(RuntimeError, /missing endpoint/)
+      end
+    end
+  end
+end