restful_resource 2.5.1 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1f405ccf5d3f49ac11166ce73e0268fc4203203a63b3e31999d9f2cfbc416bc
-  data.tar.gz: 6d07fc35aad7fcf4ee6d2a0236476bd30ac68bbea0cc252a85e5b6d79ad216b8
+  metadata.gz: cb0d551d284814e63b1abe31b03f349ad6c75a8b39249a5c34f9d329c2853941
+  data.tar.gz: 9c840127de8523bbbda9e2040ae321d7d8211e5cb2c65ed8d0c9bbaed764e54b
 SHA512:
-  metadata.gz: ff4a2dea42bcc6bdcd56f539757dad0b3c4ab185d4bf73be11d098176b7af030f4cce005addf6d5e9d6f907605de0406f81b53645110549ee67395b56bacc2f9
-  data.tar.gz: 75decbc1a7c0058bc7476efbf05981a6bee4771663e285734b3c587a41c4b61b26f87960717216d0a28ff5e1bcade60e7f025232dc577cb9a273d13844852d5e
+  metadata.gz: 87673da4a908520471c159f872cff232c9ed120421ba1ac8c6cb8307d8a3f1c7782881791b8a2c27afc1cc4e286f29fd1f60fbfbb108c394e6ef963b903b1ae2
+  data.tar.gz: 0ee761effc856af7cbfe4605c277e3df5f6c589c58e07f172effc4128c7d557f55200a1355b56a20ac223d18c3d48094481fbb94a35205b6ee20d0cc0d71e22b

data/lib/restful_resource/base.rb

@@ -9,6 +9,8 @@ module RestfulResource
       logger: nil,
       cache_store: nil,
       instrumentation: {},
+      timeout: nil,
+      open_timeout: nil,
       faraday_config: nil,
       faraday_options: nil)
 
@@ -19,6 +21,8 @@ module RestfulResource
                                               auth_token: auth_token,
                                               logger: logger,
                                               cache_store: cache_store,
+                                              timeout: timeout,
+                                              open_timeout: open_timeout,
                                               instrumentation: instrumentation,
                                               faraday_config: faraday_config,
                                               faraday_options: faraday_options

data/lib/restful_resource/http_client.rb

@@ -69,6 +69,9 @@ module RestfulResource
       end
     end
 
+    DEFAULT_TIMEOUT_IN_SECS = 10
+    DEFAULT_OPEN_TIMEOUT_IN_SECS = 2
+
     def initialize(username: nil,
       password: nil,
       auth_token: nil,
@@ -76,8 +79,8 @@ module RestfulResource
       cache_store: nil,
       connection: nil,
       instrumentation: {},
-      open_timeout: 2,
-      timeout: 10,
+      timeout: nil,
+      open_timeout: nil,
       faraday_config: nil,
       faraday_options: nil)
       api_name = instrumentation[:api_name]            ||= 'api'
@@ -101,6 +104,8 @@ module RestfulResource
       @connection = connection || initialize_connection(logger: logger,
                                                         cache_store: cache_store,
                                                         instrumenter: ActiveSupport::Notifications,
+                                                        timeout: timeout,
+                                                        open_timeout: open_timeout,
                                                         request_instrument_name: instrumentation.fetch(:request_instrument_name, nil),
                                                         cache_instrument_name: instrumentation.fetch(:cache_instrument_name, nil),
                                                         server_cache_instrument_name: instrumentation.fetch(:server_cache_instrument_name, nil),
@@ -115,8 +120,6 @@ module RestfulResource
       end
 
       @connection.headers[:user_agent] = build_user_agent(instrumentation[:app_name])
-      @default_open_timeout = open_timeout
-      @default_timeout = timeout
     end
 
     def get(url, headers: {}, open_timeout: nil, timeout: nil)
@@ -184,11 +187,11 @@ module RestfulResource
 
     private
 
-    attr_reader :default_open_timeout, :default_timeout
-
     def initialize_connection(logger: nil,
       cache_store: nil,
       instrumenter: nil,
+      timeout: nil,
+      open_timeout: nil,
       request_instrument_name: nil,
       cache_instrument_name: nil,
       server_cache_instrument_name: nil,
@@ -215,6 +218,9 @@ module RestfulResource
 
         b.use :instrumentation, name: request_instrument_name if instrumenter && request_instrument_name
 
+        b.options.timeout = timeout || DEFAULT_TIMEOUT_IN_SECS
+        b.options.open_timeout = open_timeout || DEFAULT_OPEN_TIMEOUT_IN_SECS
+
         faraday_config&.call(b)
 
         b.response :encoding
@@ -234,14 +240,15 @@ module RestfulResource
 
     def http_request(request)
       response = @connection.send(request.method) do |req|
-        req.options.open_timeout = request.open_timeout || default_open_timeout # seconds
-        req.options.timeout = request.timeout || default_timeout # seconds
+        req.options.timeout = request.timeout if request.timeout
+        req.options.open_timeout = request.open_timeout if request.open_timeout
 
         req.body = request.body unless request.body.nil?
         req.url request.url
 
         req.headers = req.headers.merge(request.headers)
       end
+
       Response.new(body: response.body, headers: response.headers, status: response.status)
     rescue Faraday::ConnectionFailed
       raise

data/lib/restful_resource/version.rb

@@ -1,3 +1,3 @@
 module RestfulResource
-  VERSION = '2.5.1'.freeze
+  VERSION = '2.5.2'.freeze
 end

data/restful_resource.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.4'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'carwow_rubocop', '~> 2.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'carwow_rubocop'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency 'rspec-its'
 

data/spec/restful_resource/base_spec.rb

@@ -379,6 +379,8 @@ RSpec.describe RestfulResource::Base do
     let(:logger) { double }
     let(:cache_store) { double }
     let(:instrumentation) { double }
+    let(:timeout) { double }
+    let(:open_timeout) { double }
     let(:faraday_config) { double }
     let(:faraday_options) { double }
 
@@ -389,6 +391,8 @@ RSpec.describe RestfulResource::Base do
                                                                 logger: logger,
                                                                 cache_store: cache_store,
                                                                 instrumentation: instrumentation,
+                                                                timeout: timeout,
+                                                                open_timeout: open_timeout,
                                                                 faraday_config: faraday_config,
                                                                 faraday_options: faraday_options
                                                                )
@@ -400,6 +404,8 @@ RSpec.describe RestfulResource::Base do
                                 logger: logger,
                                 cache_store: cache_store,
                                 instrumentation: instrumentation,
+                                timeout: timeout,
+                                open_timeout: open_timeout,
                                 faraday_config: faraday_config,
                                 faraday_options: faraday_options
                                )

data/spec/restful_resource/http_client_configuration_spec.rb

@@ -111,6 +111,13 @@ describe RestfulResource::HttpClient do
         end
       end
 
+      describe 'when provided a timeout' do
+        let(:connection) { described_class.new(timeout: 111, open_timeout: 222).instance_variable_get('@connection') }
+
+        it { expect(connection.options.timeout).to eq(111) }
+        it { expect(connection.options.open_timeout).to eq(222) }
+      end
+
       describe 'when provided a cache store' do
         let(:connection) { described_class.new(cache_store: 'redis').instance_variable_get('@connection') }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_resource
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.2
 platform: ruby
 authors:
 - David Santoro
@@ -9,36 +9,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-21 00:00:00.000000000 Z
+date: 2019-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: carwow_rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -57,16 +57,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -288,8 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple activerecord inspired rest resource base class implemented using