garage_client 2.3.3 → 2.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 01091c33f1717e47d9c9924aafdf5847b365db08
-  data.tar.gz: ab7c2d9b32b4231d4cb4d94620dc4c0adfc14f7e
+SHA256:
+  metadata.gz: 580980067ed04267e85d03e5a9f0fdfef39ebac8142e9110a9bc42f622e2fb02
+  data.tar.gz: 59bc77a7d6499d2f22e7bb3434b0756d2315abfe104cbd883bef653fe2cda52b
 SHA512:
-  metadata.gz: 8cbdf835d83bf950e9efa95d38bea94c2df496886fb5495e098e0648fb4092f34faba05acabd7c743e64d0892bcd90f16f9e49119a1115bae926e33091720b25
-  data.tar.gz: 26a64ed17b4ae544897eea66ca80072ec9ec63760c213a4f05b24cc36ed66de55e57488f39c1224adee73625879fd8c93bf23292dcd297aef9af84af56ed2bf4
+  metadata.gz: 8a7cba1f1cba35a7bf16bb0c2f00bbcb046a759ed372bddea33878a355bef8a7e39f8b9914645d2d25e86a36e66544632122b186b966afc7f37527d469fb3518
+  data.tar.gz: e58414b3291d9b60dae0d7d82f516e7b587b9005facc1b2f889a6fa0f3632111109f2cac3e434c68409765f7d31a8c7f4f12bc9f0e7c4a8de45b0622581f6c43

data/.travis.yml

@@ -2,8 +2,10 @@ language: ruby
 
 rvm:
   - ruby-head
-  - 2.3.1
-  - 2.2.5
+  - 2.5.3
+  - 2.4.5
+  - 2.3.8
+  - 2.2.10
 matrix:
   allow_failures:
     - rvm: "ruby-head"

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 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.
+
 ## 2.3.3
 - Fix a bug to not resolve application name when garage_client-rails is bundled.
 - Stop to support ruby version < 2.2.2.

data/README.md

@@ -93,10 +93,12 @@ There are the following options:
 - `adapter` - faraday adapter for http client (default: `:net_http`)
 - `cacher` - take a cacher class in which caching logic is defined (default: nil)
 - `name` - Client's application name, which is embedded in User-Agent by default (default: nil. For Rails, `Rails.application.class.parent_name.underscore` is set by default.)
+  - `name` must be configured globally.
 - `headers` - default http headers (default: `{ "Accept" => "application/json", "User-Agent" => "garage_client #{VERSION} #{name}" }`)
 - `endpoint` - Garage application API endpoint (default: nil)
 - `path_prefix` - API path prefix (default: `'/v1'`)
 - `verbose` - Enable verbose http log (default: `false`)
+- `tracing` - (client instance only) Enable distributed tracing and set a logical name of the down stream service. See detail in "Tracing" section below.
 
 You can configure the global settings:
 
@@ -115,7 +117,6 @@ client = GarageClient::Client.new(
   adapter: :test,
   headers: { "Host" => "garage.example.com" },
   endpoint: "http://localhost:3000",
-  name: 'my-awesome-client',
   path_prefix: "/v2",
   verbose: true,
 )
@@ -199,3 +200,17 @@ end
 
 GarageClient::Client.new(cacher: MyCacher)
 ```
+
+## Tracing
+GarageClient supports distributed tracing. To enable tracing, specify `tracing.tracer` option for `GarageClient::Client` instance.
+Choose one of supported tracers from below. If you want to add new tracer, please give us a PR.
+
+### aws-xray
+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/faraday'
+GarageClient::Client.new(..., tracing: { tracer: 'aws-xray', service: 'user' })
+```
+
+`service` will be `name` of the sub segments.

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,4 +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", ">= 0.30.0"
 end

data/lib/garage_client.rb

@@ -1,4 +1,3 @@
-require 'active_support/all'
 require 'faraday'
 require 'faraday_middleware'
 

data/lib/garage_client/cachers/base.rb

@@ -11,7 +11,13 @@ module GarageClient
         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 }
+          #
+          # XXX: We can't use #merge! here because Faraday::Env does not implement
+          # the method as same as Hash#merge! with Faraday v0.12.1.
+          @env.each do |k, v|
+            original = response.env[k]
+            response.env[k] = v if !original && v
+          end
         else
           response = yield
           store.write(key, response, options) if written_to_cache?

data/lib/garage_client/client.rb

@@ -20,6 +20,7 @@ module GarageClient
     property :path_prefix
     property :verbose
 
+    # @option opts [Hash] :tracing enable tracing. See README for detail.
     def initialize(options = {})
       require_necessaries(options)
       @options = options
@@ -69,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)
@@ -85,9 +99,6 @@ module GarageClient
       if !options[:endpoint] && !default_options.endpoint
         raise "Missing endpoint configuration"
       end
-      if !options[:name] && !default_options.name
-        raise "Missing name configuration"
-      end
     end
 
     def default_options

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.3.3'
+  VERSION = '2.4.4'
 end

data/spec/features/tracing_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+require 'aws/xray'
+
+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
+
+    let(:io) { Aws::Xray::TestSocket.new }
+    let(:client) do
+      GarageClient::Client.new(
+        adapter: [:test, stubs],
+        endpoint: 'http://127.0.0.1',
+        tracing: {
+          tracer: 'aws-xray',
+          service: 'target-app',
+        },
+      )
+    end
+    let(:stubs) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        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('/campaign')
+      expect(res.body.campaign).to eq(false)
+
+      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')
+    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.3.3
+  version: 2.4.4
 platform: ruby
 authors:
 - Cookpad Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2021-01-14 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
@@ -178,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: aws-xray
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.30.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.30.0
 description: Ruby client library for the Garage API
 email:
 - kaihatsu@cookpad.com
@@ -210,6 +210,7 @@ files:
 - lib/garage_client/response/raise_http_exception.rb
 - lib/garage_client/version.rb
 - spec/features/configuration_spec.rb
+- spec/features/tracing_spec.rb
 - spec/fixtures/example.yaml
 - spec/fixtures/examples.yaml
 - spec/fixtures/examples_dictionary.yaml
@@ -245,13 +246,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby client library for the Garage API
 test_files:
 - spec/features/configuration_spec.rb
+- spec/features/tracing_spec.rb
 - spec/fixtures/example.yaml
 - spec/fixtures/examples.yaml
 - spec/fixtures/examples_dictionary.yaml