garage_client 2.4.0 → 2.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 67db70f420fa5fc41a2a070c99dbbd37eb70f909
-  data.tar.gz: a1caece74b9d92acfc6df7a7e5429e330969401f
+SHA256:
+  metadata.gz: b719783d93f2fe8a23421f6a05946aa376623d953c99ba1a3cf5435a5d248ac0
+  data.tar.gz: 40287bfa976d8608d43a67cd3b50135e1618a28232346508f6ad319d50cf1262
 SHA512:
-  metadata.gz: 323b4e8bab3eca3cafcdffa6c83c5960b745b1ad7827298d79fd59ad7f44df3e29186a0a295766ae5d2864c29c7e593c671302fbc9b06c96a4a1e59ffd0882f7
-  data.tar.gz: e7bf77480f8e5f46f511f7d66ecba31fdc5da866570a16c3fd683eb6d72e7046be0d65bcbc2b521960169e621193e45046891d11556f343dc175b34d3492848a
+  metadata.gz: bebf81e6430a3765d0f4f970aeca63c6ee059050c2d5f1a9a58b611d17b80f0a6bc91f756f85dee2a2c3d5e7a091ef75a3b5fd87b282288e238494dac213b6cc
+  data.tar.gz: 20a0ae03b1803f66a2b3f1ad47329990326f96004c667091600d474c63c7a2e0d65ea037aa026af6880677137e11432b6b284cbd8ba078e8593443aa5f6d7c8e

data/.travis.yml

@@ -2,8 +2,10 @@ language: ruby
 
 rvm:
   - ruby-head
-  - 2.3.1
-  - 2.2.5
+  - 3.0.0
+  - 2.7.2
+  - 2.6.6
+  - 2.5.8
 matrix:
   allow_failures:
     - rvm: "ruby-head"

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 2.4.5
+- Drop support for Ruby 2.5
+- Remove implicit dependency on Active Support
+
+## 2.4.4
+- Remove activesupport dependency
+- Fix request ID not being propagated
+
+## 2.4.3
+- Support query methods on GarageClient::Resource
+- Use Module#module_parent_name for Rails 6.0
+
+## 2.4.2
+- Fixes for latest aws-xray gem. Require `aws/xray/faraday`.
+
+## 2.4.1
+- Record http request/response even if API returns errors.
+
 ## 2.4.0
 - Support distributed tracing.
 

data/README.md

@@ -209,7 +209,7 @@ Choose one of supported tracers from below. If you want to add new tracer, pleas
 Bundle [aws-xray](https://github.com/taiki45/aws-xray) gem in your `Gemfile`, then configure `GarageClient::Client` instance with `tracing.service` option:
 
 ```ruby
-require 'aws/xray'
+require 'aws/xray/faraday'
 GarageClient::Client.new(..., tracing: { tracer: 'aws-xray', service: 'user' })
 ```
 

data/garage_client.gemspec

@@ -16,14 +16,11 @@ Gem::Specification.new do |s|
   s.authors       = ['Cookpad Inc.']
   s.email         = ['kaihatsu@cookpad.com']
 
-  s.add_dependency 'activesupport', '> 3.2.0'
   s.add_dependency 'faraday', '>= 0.8.0'
   s.add_dependency 'faraday_middleware'
   s.add_dependency 'hashie', '>= 1.2.0'
   s.add_dependency 'link_header'
 
-  s.add_dependency 'system_timer' if RUBY_VERSION < '1.9'
-
   s.add_development_dependency "rails"
   s.add_development_dependency "rake", ">= 0.9.2"
   s.add_development_dependency "rspec"
@@ -32,5 +29,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "pry"
   # Until bug fixed: https://github.com/colszowka/simplecov/issues/281
   s.add_development_dependency "simplecov", "~> 0.7.1"
-  s.add_development_dependency "aws-xray"
+  s.add_development_dependency "aws-xray", ">= 0.30.0"
 end

data/lib/garage_client.rb

@@ -1,4 +1,3 @@
-require 'active_support/all'
 require 'faraday'
 require 'faraday_middleware'
 
@@ -24,11 +23,15 @@ end
 
 module GarageClient
   class << self
-    GarageClient::Configuration.keys.each do |key|
-      delegate key, "#{key}=", to: :configuration
-    end
+    [*GarageClient::Configuration.keys, :default_headers].each do |key|
+      define_method(key) do
+        configuration.public_send(key)
+      end
 
-    delegate 'default_headers', 'default_headers=', to: :configuration
+      define_method("#{key}=") do |value|
+        configuration.public_send("#{key}=", value)
+      end
+    end
 
     def configuration
       @configuration ||= GarageClient::Configuration.new

data/lib/garage_client/client.rb

@@ -27,7 +27,7 @@ module GarageClient
     end
 
     def headers
-      @headers ||= GarageClient.configuration.headers.merge(given_headers.stringify_keys)
+      @headers ||= GarageClient.configuration.headers.merge(given_headers.transform_keys(&:to_s))
     end
     alias :default_headers :headers
 
@@ -58,17 +58,6 @@ module GarageClient
 
     def connection
       Faraday.new(headers: headers, url: endpoint) do |builder|
-        if options[:tracing]
-          case options[:tracing][:tracer]
-          when 'aws-xray'
-            service = options[:tracing][:service]
-            raise 'Configure target service name with `tracing.service`' unless service
-            builder.use Aws::Xray::Faraday, service
-          else
-            raise "`tracing` option specified but GarageClient does not support the tracer: #{options[:tracing][:tracer]}"
-          end
-        end
-
         # Response Middlewares
         builder.use Faraday::Response::Logger if verbose
         builder.use FaradayMiddleware::Mashify
@@ -81,6 +70,19 @@ module GarageClient
         builder.use GarageClient::Request::JsonEncoded
         builder.use GarageClient::Request::PropagateRequestId
 
+        # Tracing Middlewares
+        if options[:tracing]
+          case options[:tracing][:tracer]
+          when 'aws-xray'
+            service = options[:tracing][:service]
+            raise 'Configure target service name with `tracing.service`' unless service
+            require 'aws/xray/faraday'
+            builder.use Aws::Xray::Faraday, service
+          else
+            raise "`tracing` option specified but GarageClient does not support the tracer: #{options[:tracing][:tracer]}"
+          end
+        end
+
         # Low-level Middlewares
         apply_auth_middleware builder
         builder.adapter(*adapter)

data/lib/garage_client/railtie.rb

@@ -9,7 +9,13 @@ module GarageClient
     def self.set_default_name
       unless GarageClient.configuration.options[:name]
         GarageClient.configure do |c|
-          c.name = ::Rails.application.class.parent_name.underscore
+          klass = ::Rails.application.class
+          parent_name = if klass.respond_to?(:module_parent_name)
+            klass.module_parent_name
+          else
+            klass.parent_name
+          end
+          c.name = parent_name.underscore
         end
       end
     end

data/lib/garage_client/request/propagate_request_id.rb

@@ -2,8 +2,8 @@ module GarageClient
   module Request
     class PropagateRequestId < Faraday::Middleware
       def call(env)
-        if Thread.current[:request_id] && !env[:request_headers]["HTTP_X_REQUEST_ID"]
-          env[:request_headers]["HTTP_X_REQUEST_ID"] = Thread.current[:request_id]
+        if Thread.current[:request_id] && !env[:request_headers]["X-Request-Id"]
+          env[:request_headers]["X-Request-Id"] = Thread.current[:request_id]
         end
         @app.call(env)
       end

data/lib/garage_client/resource.rb

@@ -41,6 +41,8 @@ module GarageClient
         else
           value
         end
+      elsif query_method?(name)
+        data.__send__(name)
       elsif links.include?(name)
         path = data._links[name].href
         client.get(path, *args)
@@ -53,11 +55,20 @@ module GarageClient
     end
 
     def respond_to_missing?(name, include_private)
-      !!(properties.include?(name) || links.include?(name) || nested_resource_creation_method?(name))
+      !!(properties.include?(name) || query_method?(name) || links.include?(name) || nested_resource_creation_method?(name))
     end
 
     def nested_resource_creation_method?(name)
       !!(name =~ /\Acreate_(.+)\z/ && links.include?($1.to_sym))
     end
+
+    private
+
+    def query_method?(name)
+      if name.to_s.end_with?('?')
+        key = name.to_s[0..-2]
+        properties.include?(key.to_sym)
+      end
+    end
   end
 end

data/lib/garage_client/version.rb

@@ -1,3 +1,3 @@
 module GarageClient
-  VERSION = '2.4.0'
+  VERSION = '2.4.5'
 end

data/spec/features/tracing_spec.rb

@@ -5,6 +5,7 @@ RSpec.describe 'Tracing support' do
   context 'when `tracing` option is specified' do
     around do |ex|
       Aws::Xray.config.client_options = { sock: io }
+      Aws::Xray.config.sampling_rate = 1
       Aws::Xray.trace(name: 'test-app') { ex.run }
     end
 
@@ -21,13 +22,13 @@ RSpec.describe 'Tracing support' do
     end
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.get('/campain') { |env| [200, {'Content-Type' => 'application/json'}, '{"campain": false}'] }
+        stub.get('/campaign') { |env| [200, {'Content-Type' => 'application/json'}, '{"campaign": false}'] }
       end
     end
 
     specify 'client enables tracing and sends trace data to a local agent' do
-      res = client.get('/campain')
-      expect(res.body.campain).to eq(false)
+      res = client.get('/campaign')
+      expect(res.body.campaign).to eq(false)
 
       io.rewind
       sent_jsons = io.read.split("\n")
@@ -35,5 +36,48 @@ RSpec.describe 'Tracing support' do
       body = JSON.parse(sent_jsons[1])
       expect(body['name']).to eq('target-app')
     end
+
+    context 'API returns client errors' do
+      let(:stubs) do
+        Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.get('/campaign') { |env| [404, {'Content-Type' => 'application/json'}, '{"error": "not_found"}'] }
+        end
+      end
+
+      specify 'client traces HTTP request and response and records errors' do
+        expect { client.get('/campaign') }.to raise_error(GarageClient::NotFound)
+
+        io.rewind
+        sent_jsons = io.read.split("\n")
+        expect(sent_jsons.size).to eq(2)
+        body = JSON.parse(sent_jsons[1])
+        expect(body['name']).to eq('target-app')
+        expect(body['error']).to eq(true)
+        expect(body['http']['request']['method']).to eq('GET')
+        expect(body['http']['response']['status']).to eq(404)
+      end
+    end
+
+    context 'API returns server errors' do
+      let(:stubs) do
+        Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.get('/campaign') { |env| [500, {'Content-Type' => 'application/json'}, '{"error": "internal_server_error"}'] }
+        end
+      end
+
+      specify 'client traces HTTP request and response and marks as fault' do
+        expect { client.get('/campaign') }.to raise_error(GarageClient::InternalServerError)
+
+        io.rewind
+        sent_jsons = io.read.split("\n")
+        expect(sent_jsons.size).to eq(2)
+        body = JSON.parse(sent_jsons[1])
+        expect(body['name']).to eq('target-app')
+        expect(body['error']).to eq(false)
+        expect(body['fault']).to eq(true)
+        expect(body['http']['request']['method']).to eq('GET')
+        expect(body['http']['response']['status']).to eq(500)
+      end
+    end
   end
 end

data/spec/garage_client/cacher_spec.rb

@@ -64,10 +64,6 @@ describe GarageClient::Cachers::Base do
 
   # 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__)))
@@ -75,7 +71,7 @@ describe GarageClient::Cachers::Base do
 
       it "load data" do
         expect(res).to be_instance_of Faraday::Response
-        expect(res.env[:body]).to eq fixture("example.yaml")[:body]
+        expect(res.env[:body]).to eq fixture("example.yaml")["body"]
       end
     end
 
@@ -86,7 +82,7 @@ describe GarageClient::Cachers::Base do
 
       it "load data" do
         expect(res).to be_instance_of Faraday::Response
-        expect(res.env[:body]).to eq fixture("example.yaml")[:body]
+        expect(res.env[:body]).to eq fixture("example.yaml")["body"]
       end
     end
   end

data/spec/garage_client/request/propagate_request_id_spec.rb

@@ -13,7 +13,7 @@ describe GarageClient::Request::PropagateRequestId do
   end
 
   it 'sends request_id via header' do
-    stub_get("/examples").with(headers: { 'HTTP_X_REQUEST_ID' => 'request_id' })
+    stub_get("/examples").with(headers: { 'X-Request-Id' => 'request_id' })
     expect { client.get("/examples") }.not_to raise_error
   end
 
@@ -24,7 +24,7 @@ describe GarageClient::Request::PropagateRequestId do
 
     it 'does not send request_id via header' do
       stub_get("/examples").with do |request|
-        !request.headers.include?('HTTP_X_REQUEST_ID')
+        !request.headers.include?('X-Request-Id')
       end
       expect { client.get("/examples") }.not_to raise_error
     end
@@ -32,11 +32,11 @@ describe GarageClient::Request::PropagateRequestId do
 
   context 'if already has request_id' do
     let(:client) do
-      GarageClient::Client.new(headers: { 'HTTP_X_REQUEST_ID' => 'another_id' })
+      GarageClient::Client.new(headers: { 'X-Request-Id' => 'another_id' })
     end
 
     it 'does not overwrite request_id' do
-      stub_get("/examples").with(headers: { 'HTTP_X_REQUEST_ID' => 'another_id' })
+      stub_get("/examples").with(headers: { 'X-Request-Id' => 'another_id' })
       expect { client.get("/examples") }.not_to raise_error
     end
   end

data/spec/garage_client/resource_spec.rb

@@ -84,6 +84,12 @@ describe GarageClient::Resource do
         resource.user.should be_kind_of(GarageClient::Resource)
       end
     end
+
+    context 'with property query' do
+      it 'returns presence' do
+        resource.name?.should == true
+      end
+    end
   end
 
   describe 'link' do

data/spec/spec_helper.rb

@@ -47,7 +47,7 @@ end
 def fixture(file)
   prefix = File.expand_path('../fixtures', __FILE__)
   path = File.join(prefix, file)
-  HashWithIndifferentAccess.new(YAML.load_file(path))
+  YAML.load_file(path)
 end
 
 RSpec.configure do |config|

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: garage_client
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.5
 platform: ruby
 authors:
 - Cookpad Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-29 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 3.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +170,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.30.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.30.0
 description: Ruby client library for the Garage API
 email:
 - kaihatsu@cookpad.com
@@ -260,8 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby client library for the Garage API