ddy_remote_resource 1.1.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68b41d6c4490a883cf8a45c157e9b21481979201f03c48b425a4bf197b585023
-  data.tar.gz: 49732f6fd37dde6a9ee6925cd3fec7c916a35e1135caa69330295a7d9935041a
+  metadata.gz: b75b31568bd5a246694f34d65c20226e97c2620f7afd6f11750af62ed594b458
+  data.tar.gz: 3bdce3777b2ea4fc6a72371ec9e117a3f41bd304316cd0f8eb064e8fa3c0fa8e
 SHA512:
-  metadata.gz: 8eae58c3c4319e9be19b2ae48e211f1f0709f0f0d784f86ae5234bf44bddf10f92542eff20303d4802db8f6fbd70f51b7982ebb80863ec41789bd01a0c690e3a
-  data.tar.gz: 45744c286779f3a90b257fd5968305c2db6d29be4c11f2cf2d5e05941c477ff838c5e4aa4be95f4bc62537572b7d9f19259faee755c4e4b283340595d57b181b
+  metadata.gz: d0c20de26d1ae69f00878158fa2730fffa0cf43a1b6981a55faec3e435950009700fee9d600160698b45b235d9ffa42c8ee8848bb8e5a8eaab6935461976d554
+  data.tar.gz: 9cd8475b745edad03b039567d5353b7a7b5077ad4d2721bd91b6b114a35d4a44554d417b060f3a069e20fa911232e5ec080183c1328f09e4e2ea1301713d3025

data/.gitignore

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

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.5.3

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 2.1.1
+  - 2.6.8

data/lib/remote_resource/errors.rb

@@ -42,6 +42,12 @@ module RemoteResource
       @response.code
     end
 
+    # The return code can contain additional information when response_code=0
+    # see https://curl.se/libcurl/c/libcurl-errors.html for the full list
+    def return_code
+      @response.return_code
+    end
+
     def response_body
       @response.body # TODO: Filter sensitive information using: RemoteResource::Util.filter_params
     end
@@ -53,6 +59,7 @@ module RemoteResource
     def to_s
       message = "HTTP request failed for #{resource_klass}"
       message << " with response_code=#{response_code}" if response_code.present?
+      message << " with return_code=#{return_code}" if return_code.present? && response_code.zero?
       message << " with http_action=#{http_action}"
       message << " with request_url=#{request_url}"
       message

data/lib/remote_resource/request.rb

@@ -14,6 +14,9 @@ module RemoteResource
 
     DEFAULT_EXTENSION = '.json'.freeze
 
+    DEFAULT_CONNECT_TIMEOUT = 30
+    DEFAULT_READ_TIMEOUT = 120
+
     attr_reader :resource, :resource_klass, :http_action, :attributes
 
     def initialize(resource, http_action, attributes = {}, connection_options = {})
@@ -41,7 +44,7 @@ module RemoteResource
     def perform
       SUPPORTED_HTTP_METHODS.include?(http_action) || raise(RemoteResource::HTTPMethodUnsupported, "Requested HTTP method=#{http_action.to_s} is NOT supported, the HTTP action MUST be a supported HTTP action=#{SUPPORTED_HTTP_METHODS.join(', ')}")
 
-      connection_response = connection.public_send(http_action, request_url, params: query, body: body, headers: headers)
+      connection_response = connection.public_send(http_action, request_url, params: query, body: body, headers: headers, **timeout_options)
       response            = RemoteResource::Response.new(connection_response, connection_options.merge(request: self, connection_request: connection_response.request))
 
       if response.success? || response.unprocessable_entity?
@@ -118,47 +121,57 @@ module RemoteResource
       headers
     end
 
+    def timeout_options
+      connecttimeout = connection_options[:connecttimeout].presence || DEFAULT_CONNECT_TIMEOUT
+      timeout = connection_options[:timeout].presence || DEFAULT_READ_TIMEOUT
+
+      { connecttimeout: connecttimeout, timeout: timeout }
+    end
+
     private
 
     def raise_http_error(request, response)
+      # Special case if a request has a time out, as Typhoeus does not set a 408 response_code
+      raise RemoteResource::HTTPRequestTimeout.new(request, response) if response.timed_out?
+
       case response.try(:response_code)
       when 301, 302, 303, 307 then
         raise RemoteResource::HTTPRedirectionError.new(request, response)
-      when 400 then
+      when 400
         raise RemoteResource::HTTPBadRequest.new(request, response)
-      when 401 then
+      when 401
         raise RemoteResource::HTTPUnauthorized.new(request, response)
-      when 403 then
+      when 403
         raise RemoteResource::HTTPForbidden.new(request, response)
-      when 404 then
+      when 404
         raise RemoteResource::HTTPNotFound.new(request, response)
-      when 405 then
+      when 405
         raise RemoteResource::HTTPMethodNotAllowed.new(request, response)
-      when 406 then
+      when 406
         raise RemoteResource::HTTPNotAcceptable.new(request, response)
-      when 408 then
+      when 408
         raise RemoteResource::HTTPRequestTimeout.new(request, response)
-      when 409 then
+      when 409
         raise RemoteResource::HTTPConflict.new(request, response)
-      when 410 then
+      when 410
         raise RemoteResource::HTTPGone.new(request, response)
-      when 418 then
+      when 418
         raise RemoteResource::HTTPTeapot.new(request, response)
-      when 444 then
+      when 444
         raise RemoteResource::HTTPNoResponse.new(request, response)
-      when 494 then
+      when 494
         raise RemoteResource::HTTPRequestHeaderTooLarge.new(request, response)
-      when 495 then
+      when 495
         raise RemoteResource::HTTPCertError.new(request, response)
-      when 496 then
+      when 496
         raise RemoteResource::HTTPNoCert.new(request, response)
-      when 497 then
+      when 497
         raise RemoteResource::HTTPToHTTPS.new(request, response)
-      when 499 then
+      when 499
         raise RemoteResource::HTTPClientClosedRequest.new(request, response)
-      when 400..499 then
+      when 400..499
         raise RemoteResource::HTTPClientError.new(request, response)
-      when 500..599 then
+      when 500..599
         raise RemoteResource::HTTPServerError.new(request, response)
       else
         raise RemoteResource::HTTPError.new(request, response)

data/lib/remote_resource/response.rb

@@ -16,6 +16,10 @@ module RemoteResource
       @connection_response.success?
     end
 
+    def timed_out?
+      @connection_response.timed_out?
+    end
+
     def unprocessable_entity?
       response_code == 422
     end
@@ -24,7 +28,11 @@ module RemoteResource
       @response_code ||= @connection_response.response_code
     end
 
-    alias_method :code, :response_code
+    alias code response_code
+
+    def return_code
+      @return_code ||= @connection_response.return_code
+    end
 
     def headers
       @headers ||= @connection_response.headers

data/lib/remote_resource/version.rb

@@ -1,3 +1,3 @@
 module RemoteResource
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2.2'.freeze
 end

data/remote_resource.gemspec

@@ -6,8 +6,8 @@ require 'remote_resource/version'
 Gem::Specification.new do |spec|
   spec.name          = 'ddy_remote_resource'
   spec.version       = RemoteResource::VERSION
-  spec.authors       = ['Jan van der Pas']
-  spec.email         = ['jvanderpas@digidentity.eu']
+  spec.authors       = ['Digidentity', 'Jan van der Pas']
+  spec.email         = ['development@digidentity.com']
   spec.summary       = %q{RemoteResource, a gem to use resources with REST services.}
   spec.description   = %q{RemoteResource, a gem to use resources with REST services. A replacement for ActiveResource gem.}
   spec.homepage      = ''
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 10.4'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'pry', '~> 0.10'
@@ -27,11 +27,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
   spec.add_development_dependency 'terminal-notifier-guard', '~> 1.6'
 
-  spec.add_runtime_dependency 'activesupport', '>= 4.1', '< 6'
-  spec.add_runtime_dependency 'activemodel', '>= 4.1', '< 6'
+  spec.add_runtime_dependency 'activesupport', '>= 4.1', '< 7'
+  spec.add_runtime_dependency 'activemodel', '>= 4.1', '< 7'
   spec.add_runtime_dependency 'virtus', '~> 1.0', '>= 1.0.4'
   spec.add_runtime_dependency 'mime-types', '~> 3.0'
-  spec.add_runtime_dependency 'ethon', '~> 0.7', '>= 0.7.1'
-  spec.add_runtime_dependency 'typhoeus', '~> 0.7', '>= 0.7.0'
+  spec.add_runtime_dependency 'ethon'
+  spec.add_runtime_dependency 'typhoeus', '>= 0.7'
   spec.add_runtime_dependency 'request_store', '~> 1.4.1'
 end

data/spec/integration/create_spec.rb

@@ -44,7 +44,7 @@ RSpec.describe '.create' do
 
     let!(:expected_request) do
       mock_request = stub_request(:post, 'https://www.example.com/posts.json')
-      mock_request.with(query: nil, body: JSON.generate(expected_request_body), headers: expected_default_headers)
+      mock_request.with(query: nil, body: expected_request_body.to_json, headers: expected_default_headers)
       mock_request.to_return(status: 201, body: JSON.generate(response_body))
       mock_request
     end
@@ -81,7 +81,7 @@ RSpec.describe '.create' do
 
     let!(:expected_request) do
       mock_request = stub_request(:post, 'https://www.example.com/posts.json')
-      mock_request.with(query: nil, body: JSON.generate(expected_request_body), headers: expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
+      mock_request.with(query: nil, body: expected_request_body.to_json, headers: expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
       mock_request.to_return(status: 201, body: JSON.generate(response_body))
       mock_request
     end
@@ -114,7 +114,7 @@ RSpec.describe '.create' do
 
     let!(:expected_request) do
       mock_request = stub_request(:post, 'https://www.example.com/posts.json')
-      mock_request.with(query: nil, body: JSON.generate(expected_request_body), headers: expected_default_headers)
+      mock_request.with(query: nil, body: expected_request_body.to_json, headers: expected_default_headers)
       mock_request.to_return(status: 422, body: JSON.generate(response_body))
       mock_request
     end

data/spec/integration/save_spec.rb

@@ -48,7 +48,7 @@ RSpec.describe '#save' do
     describe 'default behaviour' do
       let!(:expected_request) do
         mock_request = stub_request(:patch, 'https://www.example.com/posts/12.json')
-        mock_request.with(query: nil, body: JSON.generate(expected_request_body), headers: expected_default_headers)
+        mock_request.with(query: nil, body: expected_request_body.to_json, headers: expected_default_headers)
         mock_request.to_return(status: 200, body: JSON.generate(response_body))
         mock_request
       end
@@ -77,7 +77,7 @@ RSpec.describe '#save' do
     describe 'with connection_options[:headers]' do
       let!(:expected_request) do
         mock_request = stub_request(:patch, 'https://www.example.com/posts/12.json')
-        mock_request.with(query: nil, body: JSON.generate(expected_request_body), headers: expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
+        mock_request.with(query: nil, body: expected_request_body.to_json, headers: expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
         mock_request.to_return(status: 200, body: JSON.generate(response_body))
         mock_request
       end
@@ -111,7 +111,7 @@ RSpec.describe '#save' do
 
       let!(:expected_request) do
         mock_request = stub_request(:patch, 'https://www.example.com/posts/12.json')
-        mock_request.with(query: nil, body: JSON.generate(expected_request_body), headers: expected_default_headers)
+        mock_request.with(query: nil, body: expected_request_body.to_json, headers: expected_default_headers)
         mock_request.to_return(status: 422, body: JSON.generate(response_body))
         mock_request
       end
@@ -148,7 +148,7 @@ RSpec.describe '#save' do
     describe 'with a 500 response' do
       let!(:expected_request) do
         mock_request = stub_request(:patch, 'https://www.example.com/posts/12.json')
-        mock_request.with(query: nil, body: JSON.generate(expected_request_body), headers: expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
+        mock_request.with(query: nil, body: expected_request_body.to_json, headers: expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
         mock_request.to_return(status: 500)
         mock_request
       end

data/spec/lib/remote_resource/request_spec.rb

@@ -168,7 +168,9 @@ RSpec.describe RemoteResource::Request do
       let(:expected_connection_options) { request.connection_options }
 
       it 'makes a GET request with the connection_options[:params] as query' do
-        expect(connection).to receive(:get).with(expected_request_url, params: expected_params, body: expected_body, headers: expected_headers).and_call_original
+        expect(connection).to receive(:get).with(expected_request_url, params: expected_params,
+                                                 body: expected_body, headers: expected_headers,
+                                                 connecttimeout: 30, timeout: 120).and_call_original
         request.perform
       end
 
@@ -191,7 +193,9 @@ RSpec.describe RemoteResource::Request do
       let(:expected_connection_options) { request.connection_options }
 
       it 'makes a PUT request with the attributes as body' do
-        expect(connection).to receive(:put).with(expected_request_url, params: expected_params, body: expected_body, headers: expected_headers).and_call_original
+        expect(connection).to receive(:put).with(expected_request_url, params: expected_params,
+                                                 body: expected_body, headers: expected_headers,
+                                                 connecttimeout: 30, timeout: 120).and_call_original
         request.perform
       end
 
@@ -214,7 +218,9 @@ RSpec.describe RemoteResource::Request do
       let(:expected_connection_options) { request.connection_options }
 
       it 'makes a PATCH request with the attributes as body' do
-        expect(connection).to receive(:patch).with(expected_request_url, params: expected_params, body: expected_body, headers: expected_headers).and_call_original
+        expect(connection).to receive(:patch).with(expected_request_url, params: expected_params,
+                                                   body: expected_body, headers: expected_headers,
+                                                   connecttimeout: 30, timeout: 120).and_call_original
         request.perform
       end
 
@@ -237,7 +243,9 @@ RSpec.describe RemoteResource::Request do
       let(:expected_connection_options) { request.connection_options }
 
       it 'makes a POST request with the attributes as body' do
-        expect(connection).to receive(:post).with(expected_request_url, params: expected_params, body: expected_body, headers: expected_headers).and_call_original
+        expect(connection).to receive(:post).with(expected_request_url, params: expected_params,
+                                                  body: expected_body, headers: expected_headers,
+                                                  connecttimeout: 30, timeout: 120).and_call_original
         request.perform
       end
 
@@ -260,7 +268,9 @@ RSpec.describe RemoteResource::Request do
       let(:expected_connection_options) { request.connection_options }
 
       it 'makes a DELETE request with the connection_options[:params] as query' do
-        expect(connection).to receive(:delete).with(expected_request_url, params: expected_params, body: expected_body, headers: expected_headers).and_call_original
+        expect(connection).to receive(:delete).with(expected_request_url, params: expected_params,
+                                                    body: expected_body, headers: expected_headers,
+                                                    connecttimeout: 30, timeout: 120).and_call_original
         request.perform
       end
 
@@ -586,10 +596,37 @@ RSpec.describe RemoteResource::Request do
     end
   end
 
+  describe '#timeout_options' do
+    it 'is not given by default' do
+      expect(request.connection_options).not_to include :connecttimeout, :timeout
+    end
+
+    context 'with custom timeouts' do
+      let(:connection_options) do
+        { connecttimeout: 1, timeout: 2 }
+      end
+
+      it 'sets the timeouts from connection_options' do
+        aggregate_failures do
+          expect(request.connection_options[:connecttimeout]).to eq 1
+          expect(request.connection_options[:timeout]).to eq 2
+        end
+      end
+    end
+  end
+
   describe '#raise_http_error' do
-    let(:connection_response) { instance_double(Typhoeus::Response, request: instance_double(Typhoeus::Request)) }
+    let(:connection_response) { instance_double(Typhoeus::Response, request: instance_double(Typhoeus::Request), timed_out?: false) }
     let(:response) { RemoteResource::Response.new(connection_response, connection_options) }
 
+    context 'when the response has timed out' do
+      let(:connection_response) { instance_double(Typhoeus::Response, request: instance_double(Typhoeus::Request), timed_out?: true) }
+
+      it 'raises a RemoteResource::HTTPRequestTimeout' do
+        expect { request.send(:raise_http_error, request, response) }.to raise_error RemoteResource::HTTPRequestTimeout
+      end
+    end
+
     context 'when the response code is 301, 302, 303 or 307' do
       response_codes = [301, 302, 303, 307]
       response_codes.each do |response_code|
@@ -645,6 +682,17 @@ RSpec.describe RemoteResource::Request do
       end
     end
 
+    context 'when the response code is 0 and no other error is raised' do
+      it 'raises a RemoteResource::HTTPError with correct error message' do
+        allow(response).to receive(:response_code) { 0 }
+        allow(connection_response).to receive(:return_code) { :ssl_connect }
+        allow(connection_response).to receive(:response_code) { 0 }
+
+        error_message = 'HTTP request failed for RemoteResource::RequestDummy with response_code=0 with return_code=ssl_connect with http_action=get with request_url=http://www.foobar.com/request_dummy.json'
+        expect { request.send(:raise_http_error, request, response) }.to raise_error RemoteResource::HTTPError, error_message
+      end
+    end
+
     context 'when the response code is nothing and no other error is raised' do
       it 'raises a RemoteResource::HTTPError' do
         allow(response).to receive(:response_code) { nil }

data/spec/lib/remote_resource/version_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
 
 RSpec.describe RemoteResource::VERSION do
-  it { is_expected.to eql '1.1.1' }
+  it { is_expected.to eql '1.2.2' }
 end

metadata

@@ -1,29 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: ddy_remote_resource
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.2
 platform: ruby
 authors:
+- Digidentity
 - Jan van der Pas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2021-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +118,7 @@ dependencies:
         version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -127,7 +128,7 @@ dependencies:
         version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +138,7 @@ dependencies:
         version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -147,7 +148,7 @@ dependencies:
         version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -186,30 +187,21 @@ dependencies:
   name: ethon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :runtime
@@ -217,9 +209,6 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
@@ -239,7 +228,7 @@ dependencies:
 description: RemoteResource, a gem to use resources with REST services. A replacement
   for ActiveResource gem.
 email:
-- jvanderpas@digidentity.eu
+- development@digidentity.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -319,8 +308,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.10
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: RemoteResource, a gem to use resources with REST services.