restful_resource 2.5.3 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e46af8066f1ca4d4e59dae90cd6283676f65e146ed62ab56c506eeafb189b95
-  data.tar.gz: fdbb7277f080e8c00ff73e5b01f26954d67dd04189456a4500276b0a435b8a41
+  metadata.gz: 015747ee95ac4e52617a009da36dcccb671aa6f8437662287f9dadf951f2049e
+  data.tar.gz: c27835d8a584d1d5c228725892ceca06cb215cbdee088d7c2b6884228371aab1
 SHA512:
-  metadata.gz: 2039984d78d5131c8a88cb45fd7cc65a2626b2d2bee7977642ce10d84fd19f8d158ef7a7202f07e36dbf5ba4404cbf772f2f56f0f92497d1571f60f052dcfc68
-  data.tar.gz: c382b0c2d0f1f4901a990ef771104d0350536e6bd773bed632dcfc74d4f090577044b255bf49544fc2939ff9848d60efdbd020d0f55d16f6bb1db5e70e06eb8a
+  metadata.gz: 9d987975b117009d80e0179663ab643a24d055220b01f149be44d12024968732166ec9a589d9517f27150630a8794b0e2557b8fe72ff332be8a3472dab74deb6
+  data.tar.gz: 1cebc647b6ddfca2d0fee0ab9bb9d32ef1820f3d06d613a7417b38f9c28617569bfcfe3f6dac7fe71eff47c8c8b7041876cbc54a90fb6d78438e39ae720cac13

data/.circleci/config.yml

@@ -7,7 +7,9 @@ jobs:
       - checkout
       - run:
           name: Bundle Install
-          command: bundle check || bundle install
+          command: |
+            gem install bundler && \
+            bundle check || bundle install
       - run:
           name: Run rspec in parallel
           command: |
@@ -18,3 +20,10 @@ jobs:
                               $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
       - store_test_results:
           path: test_results
+
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - build

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+2.6.1
+---
+- Support only `faraday-0.15.x`
+    - `0.16.x` breaks `faraday-http-cache`
+
+2.6.0 (yanked)
+---
+
+- Upgrade to `faraday-0.16.x`
+- Add `X-Client-Timeout` header on requests if a client timeout is set
+
+2.5.3
+---
+
+- Raise `RestfulResource::HttpClient::GatewayTimeout` when response status is `504`
+
+
+2.5.2
+---
+
+- Add ability to set `timeout` and `open_timeout` options on connection
+
 2.5.1
 ---
 

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    restful_resource (2.6.1)
+      activesupport
+      faraday (~> 0.15.0)
+      faraday-cdn-metrics
+      faraday-encoding
+      faraday-http-cache
+      faraday_middleware
+      link_header
+      rack
+      typhoeus
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    ast (2.4.0)
+    carwow_rubocop (3.0.3)
+      rubocop (>= 0.68)
+      rubocop-performance
+      rubocop-rspec
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday-cdn-metrics (0.1.0)
+      faraday (~> 0.11)
+    faraday-encoding (0.0.5)
+      faraday
+    faraday-http-cache (2.0.0)
+      faraday (~> 0.8)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    ffi (1.11.1)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    link_header (0.0.8)
+    method_source (0.9.2)
+    minitest (5.12.2)
+    multipart-post (2.1.1)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.7)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.73.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.4.1)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.34.1)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    zeitwerk (2.1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  carwow_rubocop
+  pry
+  rake
+  restful_resource!
+  rspec
+  rspec-its
+  rspec_junit_formatter
+
+BUNDLED WITH
+   2.0.2

data/lib/restful_resource/base.rb

@@ -12,7 +12,7 @@ module RestfulResource
       timeout: nil,
       open_timeout: nil,
       faraday_config: nil,
-      faraday_options: nil)
+      faraday_options: {})
 
       @base_url = URI.parse(base_url)
 

data/lib/restful_resource/http_client.rb

@@ -88,7 +88,7 @@ module RestfulResource
       timeout: nil,
       open_timeout: nil,
       faraday_config: nil,
-      faraday_options: nil)
+      faraday_options: {})
       api_name = instrumentation[:api_name]            ||= 'api'
       instrumentation[:request_instrument_name]        ||= "http.#{api_name}"
       instrumentation[:cache_instrument_name]          ||= "http_cache.#{api_name}"
@@ -202,7 +202,7 @@ module RestfulResource
       cache_instrument_name: nil,
       server_cache_instrument_name: nil,
       faraday_config: nil,
-      faraday_options: nil)
+      faraday_options: {})
 
       @connection = Faraday.new(nil, faraday_options) do |b|
         b.request :json
@@ -253,6 +253,7 @@ module RestfulResource
         req.url request.url
 
         req.headers = req.headers.merge(request.headers)
+        req.headers = req.headers.merge(x_client_timeout: req.options[:timeout]) if req.options[:timeout]
       end
 
       Response.new(body: response.body, headers: response.headers, status: response.status)
@@ -264,6 +265,12 @@ module RestfulResource
       response = e.response
       raise ClientError, request unless response
 
+      handle_error(request, response)
+    rescue Faraday::ServerError => e
+      handle_error(request, e.response)
+    end
+
+    def handle_error(request, response)
       case response[:status]
       when 404 then raise HttpClient::ResourceNotFound.new(request, response)
       when 409 then raise HttpClient::Conflict.new(request, response)

data/lib/restful_resource/version.rb

@@ -1,3 +1,3 @@
 module RestfulResource
-  VERSION = '2.5.3'.freeze
+  VERSION = '2.6.1'.freeze
 end

data/restful_resource.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-its'
 
   spec.add_dependency 'activesupport'
-  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday', '~> 0.15.0'
   spec.add_dependency 'faraday-cdn-metrics'
   spec.add_dependency 'faraday-encoding'
   spec.add_dependency 'faraday-http-cache'

data/spec/restful_resource/base_authorization_spec.rb

@@ -2,12 +2,8 @@ require_relative '../spec_helper'
 
 describe RestfulResource::Base, 'authorization' do
   before do
-    class FirstClient < RestfulResource::Base
-    end
-
-    class SecondClient < RestfulResource::Base
-    end
-
+    class FirstClient < RestfulResource::Base; end
+    class SecondClient < RestfulResource::Base; end
     class NotConfiguredClient < RestfulResource::Base; end
 
     class FirstTest < FirstClient

data/spec/restful_resource/base_spec.rb

@@ -3,8 +3,10 @@ require_relative '../spec_helper'
 RSpec.describe RestfulResource::Base do
   before do
     @mock_http = double('mock_http')
-    allow(described_class).to receive(:http).and_return(@mock_http)
-    described_class.configure(base_url: 'http://api.carwow.co.uk/')
+    allow(Make).to receive(:http).and_return(@mock_http)
+    Make.configure(base_url: 'http://api.carwow.co.uk/')
+    allow(Model).to receive(:http).and_return(@mock_http)
+    Model.configure(base_url: 'http://api.carwow.co.uk/')
   end
 
   it 'acts as an openobject' do
@@ -143,9 +145,14 @@ RSpec.describe RestfulResource::Base do
   end
 
   describe '#base_url' do
+    before do
+      @mock_http = double('mock_http')
+      allow(TestA).to receive(:http).and_return(@mock_http)
+      allow(TestB).to receive(:http).and_return(@mock_http)
+    end
+
     it 'is different for each subclass of Base' do
       BaseA.configure(base_url: 'http://a.carwow.co.uk')
-
       BaseB.configure(base_url: 'http://b.carwow.co.uk')
 
       expect_get('http://a.carwow.co.uk/testa/1', RestfulResource::Response.new)
@@ -385,6 +392,7 @@ RSpec.describe RestfulResource::Base do
     let(:faraday_options) { double }
 
     it 'passes arguments to HttpClient' do
+      client = Class.new(described_class)
       expect(RestfulResource::HttpClient).to receive(:new).with(username: username,
                                                                 password: password,
                                                                 auth_token: auth_token,
@@ -397,7 +405,7 @@ RSpec.describe RestfulResource::Base do
                                                                 faraday_options: faraday_options
                                                                )
 
-      described_class.configure(base_url: 'http://foo.bar',
+      client.configure(base_url: 'http://foo.bar',
                                 username: username,
                                 password: password,
                                 auth_token: auth_token,

data/spec/restful_resource/http_client_spec.rb

@@ -1,8 +1,8 @@
 require_relative '../spec_helper'
 
 RSpec.describe RestfulResource::HttpClient do
-  def faraday_connection
-    Faraday.new do |builder|
+  def faraday_connection(opts = {})
+    Faraday.new(opts) do |builder|
       builder.request :url_encoded
       builder.response :raise_error
       builder.adapter :test do |stubs|
@@ -292,4 +292,50 @@ RSpec.describe RestfulResource::HttpClient do
       expect(response.status).to eq 200
     end
   end
+
+  describe 'X-Client-Timeout' do
+    let(:http_client) { described_class.new(connection: connection, timeout: timeout) }
+    let(:connection) do
+      conn = faraday_connection do |stubs|
+        stubs.get('http://httpbin.org/get', required_headers) { |_env| [200, {}, nil] }
+      end
+
+      conn.options[:timeout] = timeout
+
+      conn
+    end
+
+
+    context 'when explicit timeout set on connection' do
+      let(:timeout) { 5 }
+      let(:required_headers) { { 'X-Client-Timeout' => 5 } }
+      it 'sets X-Client-Timeout correctly' do
+        response = http_client.get('http://httpbin.org/get')
+
+        expect(response.status).to eq 200
+      end
+    end
+
+    context 'when not explicit timeout set' do
+      let(:timeout) { nil }
+      let(:required_headers) { {} }
+
+      it 'sets X-Client-Timeout correctly' do
+        response = http_client.get('http://httpbin.org/get')
+
+        expect(response.status).to eq 200
+      end
+    end
+
+    context 'when set on request' do
+      let(:timeout) { nil }
+      let(:required_headers) { { 'X-Client-Timeout' => 1 } }
+
+      it 'sets X-Client-Timeout correctly' do
+        response = http_client.get('http://httpbin.org/get', timeout: 1)
+
+        expect(response.status).to eq 200
+      end
+    end
+  end
 end

data/spec/restful_resource/rails_validations_spec.rb

@@ -3,8 +3,8 @@ require_relative '../spec_helper'
 RSpec.describe RestfulResource::RailsValidations do
   before do
     @mock_http = double('mock_http')
-    RestfulResource::Base.configure(base_url: 'http://api.carwow.co.uk/')
-    allow(RestfulResource::Base).to receive(:http).and_return(@mock_http)
+    Dealer.configure(base_url: 'http://api.carwow.co.uk/')
+    allow(Dealer).to receive(:http).and_return(@mock_http)
   end
 
   context '#patch without errors' do

data/spec/restful_resource/redirections_spec.rb

@@ -3,8 +3,8 @@ require_relative '../spec_helper'
 RSpec.describe RestfulResource::Redirections do
   before do
     @mock_http = double('mock_http')
-    allow(RestfulResource::Base).to receive(:http).and_return(@mock_http)
-    RestfulResource::Base.configure(base_url: 'http://api.carwow.co.uk/')
+    allow(ModelWithRedirections).to receive(:http).and_return(@mock_http)
+    ModelWithRedirections.configure(base_url: 'http://api.carwow.co.uk/')
   end
 
   describe '#post' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_resource
 version: !ruby/object:Gem::Version
-  version: 2.5.3
+  version: 2.6.1
 platform: ruby
 authors:
 - David Santoro
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2019-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,16 +113,16 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: faraday-cdn-metrics
   requirement: !ruby/object:Gem::Requirement
@@ -237,6 +237,7 @@ files:
 - ".rubocop_todo.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile