garage_client 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 648321b65499a513c8305e6aac962afb10bf99f6
-  data.tar.gz: 17c99e87555fadc63de66ac384d09a354feeb00b
+  metadata.gz: 394abb9093e09a4a7d79452fc44c20792d66485b
+  data.tar.gz: 6bb87e45add606d55241e3bc90c56cb0ad176800
 SHA512:
-  metadata.gz: dc3e8ea2288e52f6ec2e9d9ef1b9f92318478ea543852cf77706ca53665f20d5d63e6445d88496ad0a415733772241addb8a67ffc4529e54415883ccab20e6d4
-  data.tar.gz: 57c200a989fc68dcd096ced3dc853ca92eb4d03246e2d26afec236c60fd3d06332d284ed642723b8f3e396b3f6fd643f15c0e0c105ba275579009ea347d006a6
+  metadata.gz: 7419abf0acb63420fb45c5ac28c10f3161846159889f85568801845c3cfe56002851525f21f3df3d0d1a09355dd8aa2ac9a343f1478f4159be6a82ee7d428595
+  data.tar.gz: da747820a31de77ee57195c2bb119e04fe30506a4f906ea05f4858b3c410bd4b08e8b832d174efc439d01139ffa223c8f9321ced332c9b1dd957f9e8e0003b33

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+
+rvm:
+  - ruby-head
+  - 2.2
+  - 2.1
+  - 2.0.0
+matrix:
+  allow_failures:
+    - rvm: "ruby-head"
+  fast_finish: true
+
+cache: bundler
+
+sudo: false

data/README.md

@@ -1,4 +1,4 @@
-# GarageClient
+# GarageClient [![Build Status](https://travis-ci.org/cookpad/garage_client.svg?branch=master)](https://travis-ci.org/cookpad/garage_client)
 GarageClient is a simple Ruby library to provide a primitive client interface to the Garage application API.
 
 ## Install

data/lib/garage_client/cachers/base.rb

@@ -7,20 +7,27 @@ module GarageClient
       end
 
       def call
-        response = read_from_cache? && store.read(key, options) || yield
-        store.write(key, response, options) if written_to_cache?
+        response = store.read(key, options) if read_from_cache?
+        if response
+          # Faraday::Response#marshal_dump is drop request object and url
+          # https://github.com/lostisland/faraday/blob/edacd5eb57ea13accab3097649690ae5f48f421a/lib/faraday/response.rb#L74
+          response.env.merge!(@env) {|_, self_val, other_val| self_val || other_val }
+        else
+          response = yield
+          store.write(key, response, options) if written_to_cache?
+        end
         response
       end
 
       private
 
       # Return boolean to tell if we need to cache the response or not.
-      def allowed_to_read_cache?
+      def read_from_cache?
         raise NotImplementedError, "You must implement #{self.class}##{__method__}"
       end
 
       # Return boolean to tell if we can try to check cache or not.
-      def allowed_to_write_cache?
+      def written_to_cache?
         raise NotImplementedError, "You must implement #{self.class}##{__method__}"
       end
 

data/lib/garage_client/client.rb

@@ -4,7 +4,7 @@ module GarageClient
 
     def self.property(key)
       define_method(key) do
-        options.fetch(key, GarageClient.configuration.send(key))
+        options.fetch(key) { GarageClient.configuration.send(key) }
       end
 
       define_method("#{key}=") do |value|

data/lib/garage_client/version.rb

@@ -1,3 +1,3 @@
 module GarageClient
-  VERSION = '2.1.1'
+  VERSION = '2.1.2'
 end

data/spec/fixtures/faraday_0.8.9_response.dump

@@ -0,0 +1,54 @@
+U:Faraday::Response{:statusi
�:	bodyI"�{
+           "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"
+    }
+  }
+}
+:ET:response_headersIC:Faraday::Utils::Headers{I"content-type;TI"$application/json; charset=utf-8;T:@names{I"content-type;T@	

data/spec/fixtures/faraday_0.9.1_response.dump

@@ -0,0 +1,54 @@
+U:Faraday::Response{:statusi
�:	bodyI"�{
+           "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"
+    }
+  }
+}
+:ET:response_headersIC:Faraday::Utils::Headers{I"content-type;TI"$application/json; charset=utf-8;T:@names{I"content-type;T@	

data/spec/garage_client/cacher_spec.rb

@@ -1,13 +1,34 @@
 require "spec_helper"
 
 describe GarageClient::Cachers::Base do
-  let(:client) do
-    GarageClient::Client.new(cacher: cacher_class)
+  let(:store) do
+    Class.new do
+      def initialize
+        @table = {}
+      end
+
+      def read(key, options = {})
+        value = @table[key]
+        Marshal.load(value) if value
+      end
+
+      def write(key, value, options = {})
+        @table[key] = Marshal.dump(value)
+      end
+    end.new
   end
 
   let(:cacher_class) do
-    store = store
+    cache_store = store
     Class.new(GarageClient::Cachers::Base) do
+      @store = cache_store
+
+      class << self
+        attr_reader :store
+      end
+
+      delegate :store, to: :class
+
       private
 
       def key
@@ -21,30 +42,18 @@ describe GarageClient::Cachers::Base do
       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
 
+  let(:client) do
+    GarageClient::Client.new(cacher: cacher_class)
+  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)
+        stub_get("/examples").to_return(fixture("examples.yaml")).times(1).then.to_raise("Not use Cache.")
+        stub_get("/example").to_return(fixture("example.yaml")).times(1).then.to_raise("Not use Cache.")
         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
@@ -52,4 +61,33 @@ describe GarageClient::Cachers::Base do
       end
     end
   end
+
+  # Check dump data. Because cache data not broken on the version up of faraday.
+  describe "check Faraday::Response marshal" do
+    specify do
+      expect(Faraday::VERSION).to be < "1.0.0", "This spec is no longer needed. Delete this 'describe' section!"
+    end
+
+    context "v0.9.1's marshal data" do
+      let(:res) do
+        Marshal.load(File.read(File.expand_path('../fixtures/faraday_0.9.1_response.dump', __dir__)))
+      end
+
+      it "load data" do
+        expect(res).to be_instance_of Faraday::Response
+        expect(res.env[:body]).to eq fixture("example.yaml")[:body]
+      end
+    end
+
+    context "v0.8.9's marshal data" do
+      let(:res) do
+        Marshal.load(File.read(File.expand_path('../fixtures/faraday_0.8.9_response.dump', __dir__)))
+      end
+
+      it "load data" do
+        expect(res).to be_instance_of Faraday::Response
+        expect(res.env[:body]).to eq fixture("example.yaml")[:body]
+      end
+    end
+  end
 end

data/spec/garage_client/client_spec.rb

@@ -4,6 +4,24 @@ describe GarageClient::Client do
   let(:client) { GarageClient::Client.new(options) }
   let(:options) { {} }
 
+  describe 'laziness of properties' do
+    before { allow(GarageClient.configuration).to receive(:endpoint).and_raise('error') }
+
+    context 'when is specified options' do
+      let(:options) { { endpoint: 'http://example.com' } }
+
+      it 'does not evaluate global configuration' do
+        expect { client.endpoint }.not_to raise_error
+      end
+    end
+
+    context 'when is not specified options' do
+      it 'evaluates global configuration' do
+        expect { client.endpoint }.to raise_error('error')
+      end
+    end
+  end
+
   describe "#adapter" do
     context "without :adapter option value" do
       it "returns default value" do
@@ -135,8 +153,8 @@ describe GarageClient::Client do
 
   describe "#endpoint=" do
     it "overwrites it" do
-      client.adapter = "http://example.com"
-      client.adapter.should == "http://example.com"
+      client.endpoint = "http://example.com"
+      client.endpoint.should == "http://example.com"
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: garage_client
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Cookpad Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-25 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -201,6 +201,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -226,6 +227,8 @@ files:
 - spec/fixtures/examples.yaml
 - spec/fixtures/examples_dictionary.yaml
 - spec/fixtures/examples_without_pagination.yaml
+- spec/fixtures/faraday_0.8.9_response.dump
+- spec/fixtures/faraday_0.9.1_response.dump
 - spec/garage_client/cacher_spec.rb
 - spec/garage_client/client_spec.rb
 - spec/garage_client/configuration_spec.rb
@@ -254,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby client library for the Garage API
@@ -264,6 +267,8 @@ test_files:
 - spec/fixtures/examples.yaml
 - spec/fixtures/examples_dictionary.yaml
 - spec/fixtures/examples_without_pagination.yaml
+- spec/fixtures/faraday_0.8.9_response.dump
+- spec/fixtures/faraday_0.9.1_response.dump
 - spec/garage_client/cacher_spec.rb
 - spec/garage_client/client_spec.rb
 - spec/garage_client/configuration_spec.rb