ddy_remote_resource 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdcc65c8c1ef37e590832d19cb42875c41be7e8c02510c17e92eb0a5a3bf6122
-  data.tar.gz: '09d6e13818904b4ba85ec25ecb068515034cc653e559e5acd19f3e14c7074d07'
+  metadata.gz: d0032d56e8df7f6e90e146abb65b29a41a59a63e39747c6b0b7585c02f577069
+  data.tar.gz: 4454b9226626e5a2028dc871c83d15347da8a373d104e641810c3f002e8e94c0
 SHA512:
-  metadata.gz: c54a32a3078e3ec62a3a24459b59441267c9d1829042d65c84e44de551f6507fdbec08a2bcb61f27c7e26abbe44f61678d02504d57f6dc8fbf772d195281a496
-  data.tar.gz: 205982b8664b2d0fb78dacfb215b6b456305a63b3eef8fe0ccd036439f7ed826bd5d874b43d73a5a715f97c452d6d612e0d0a230e56ea95d3c871f4a0d78ba4a
+  metadata.gz: 327330942d08e782894d10b46be1c6a6fc560f4cab2a4f7bb77a2b2958853ad929a024ccc00c560a3672e48c55a5844e9064e9c7fc00ae9839228d904038f2b6
+  data.tar.gz: f6d6b6c025c695cd68f4697b9a001046d54a29b32f51aabbec187ff9359bf32da6db83510cc5a3a251729159100e06b11054986a009d55386ece26e5f372ed8b

data/.gitignore

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

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

data/lib/remote_resource/version.rb

@@ -1,3 +1,3 @@
 module RemoteResource
-  VERSION = '1.1.2'.freeze
+  VERSION = '1.2.0'.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      = ''

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|

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.2' }
+  it { is_expected.to eql '1.2.0' }
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ddy_remote_resource
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
+- Digidentity
 - Jan van der Pas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2021-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,22 +207,22 @@ dependencies:
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
   type: :runtime
   prerelease: false
   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::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -239,7 +240,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,7 +320,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: RemoteResource, a gem to use resources with REST services.