artirix_data_models 0.14.2 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 580cad486d7e57555b86e4435a284adcd88e0aa2
-  data.tar.gz: 95cf3729a52a7e2116383dac48a8064f267f0d11
+  metadata.gz: 51f51b7e92c257a5ff0e8a696329be341af4073e
+  data.tar.gz: 36a9206139840f5587956864af6419b9fdc86511
 SHA512:
-  metadata.gz: 6fa9d6d2f715dbcb3864b3c52b91dedce5fc6cf3de96b609172981d35e1e7283030027c938e77ec570b83c43efd2aa0674a72f87962214217efe723bcebacf01
-  data.tar.gz: a1b16317e95cedb8a09d09902e4c6e16966675fc22202204bbc52e2d8a68d6b1b7a8b85107f96b25af113e7e522ed9d10e637d477df89ac998e6e73cd874ae2f
+  metadata.gz: 68de5e70048bfe05eb6654d4669eb2cfccb09a2c504af5c7cde7e5e1878ec32f18b05d04c05feae9d0106f5a631fe3cf35a3b670d8be54d0bef3da2e20396efb
+  data.tar.gz: 198a1aef72b32cb6bc4a5253ce24faa9f239a4871af7f22a680e87259d65adafa98ca3b1f321ac09ea46e56461aff039aefc24a268cc6535f7da060dbc4954dd

data/README.md

@@ -268,6 +268,25 @@ end
 
 ## Changes
 
+### 0.15.0
+- `Gateway` `perform` and `connect` now accept the extra arguments as keyword arguments:
+
+```ruby
+  gateway.perform :get, path: '/this/is/required' body: nil, json_body: true, timeout: 10 
+```
+
+The internals are adapted but if a client app was mocking Gateway's `perform` directly, this could be a breaking change.
+- added the `timeout` option to perform gateway (and DAO methods). It will add timeout to the Faraday request
+
+```ruby
+def connect(method, path:, body: nil, json_body: true, timeout: nil)
+  connection.send(method, path) do |req|
+     req.options.timeout = timeout if timeout.present?
+     # ...
+  end
+end
+```
+
 ### 0.14.2
 - Cache service: expire_cache now can receive options `add_wildcard` and `add_prefix` (both `true` by default), that will control the modifications on the given pattern
 

data/lib/artirix_data_models/daos/basic_model_dao.rb

@@ -139,29 +139,57 @@ class ArtirixDataModels::BasicModelDAO
   # PERFORM CALLS #
   #################
 
-  def perform_get(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, gateway: nil)
+  def perform_get(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, timeout: nil, gateway: nil)
     g = gateway.presence || preloaded_gateway
     raise_no_gateway unless g.present?
-    g.get path, response_adaptor: response_adaptor, body: body, fake: fake?, fake_response: fake_response, cache_adaptor: cache_adaptor
+
+    g.get path,
+          response_adaptor: response_adaptor,
+          body:             body,
+          timeout:          timeout,
+          fake:             fake?,
+          fake_response:    fake_response,
+          cache_adaptor:    cache_adaptor
   end
 
 
-  def perform_post(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, gateway: nil)
+  def perform_post(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, timeout: nil, gateway: nil)
     g = gateway.presence || preloaded_gateway
     raise_no_gateway unless g.present?
-    g.post path, response_adaptor: response_adaptor, body: body, fake: fake?, fake_response: fake_response, cache_adaptor: cache_adaptor
+
+    g.post path,
+           response_adaptor: response_adaptor,
+           body:             body,
+           timeout:          timeout,
+           fake:             fake?,
+           fake_response:    fake_response,
+           cache_adaptor:    cache_adaptor
   end
 
-  def perform_put(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, gateway: nil)
+  def perform_put(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, timeout: nil, gateway: nil)
     g = gateway.presence || preloaded_gateway
     raise_no_gateway unless g.present?
-    g.put path, response_adaptor: response_adaptor, body: body, fake: fake?, fake_response: fake_response, cache_adaptor: cache_adaptor
+
+    g.put path,
+          response_adaptor: response_adaptor,
+          body:             body,
+          timeout:          timeout,
+          fake:             fake?,
+          fake_response:    fake_response,
+          cache_adaptor:    cache_adaptor
   end
 
-  def perform_delete(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, gateway: nil)
+  def perform_delete(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, timeout: nil, gateway: nil)
     g = gateway.presence || preloaded_gateway
     raise_no_gateway unless g.present?
-    g.delete path, response_adaptor: response_adaptor, body: body, fake: fake?, fake_response: fake_response, cache_adaptor: cache_adaptor
+
+    g.delete path,
+             response_adaptor: response_adaptor,
+             body:             body,
+             timeout:          timeout,
+             fake:             fake?,
+             fake_response:    fake_response,
+             cache_adaptor:    cache_adaptor
   end
 
   # old names

data/lib/artirix_data_models/gateways/data_gateway.rb

@@ -22,13 +22,13 @@ class ArtirixDataModels::DataGateway
     call :delete, path, **opts
   end
 
-  def call(method, path, json_body: true, response_adaptor: nil, body: nil, fake: false, fake_response: nil, cache_adaptor: nil, **_ignored_options)
+  def call(method, path, json_body: true, response_adaptor: nil, body: nil, fake: false, fake_response: nil, cache_adaptor: nil, timeout: nil, **_ignored_options)
     if fake
       result = fake_response.respond_to?(:call) ? fake_response.call : fake_response
     elsif cache_adaptor.present?
-      result = cache_adaptor.call { perform(method, path, body, json_body) }
+      result = cache_adaptor.call { perform(method, path: path, body: body, json_body: json_body, timeout: timeout) }
     else
-      result = perform(method, path, body, json_body)
+      result = perform(method, path: path, body: body, json_body: json_body, timeout: timeout)
     end
 
     parse_response result:           result,
@@ -39,31 +39,32 @@ class ArtirixDataModels::DataGateway
 
   private
 
-  def perform_get(path, body = nil, json_body = true)
-    perform :get, path, body, json_body
+  def perform_get(path, **opts)
+    perform :get, path: path, **opts
   end
 
-  def perform_post(path, body = nil, json_body = true)
-    perform :post, path, body, json_body
+  def perform_post(path, **opts)
+    perform :post, path: path, **opts
   end
 
-  def perform_put(path, body = nil, json_body = true)
-    perform :put, path, body, json_body
+  def perform_put(path, **opts)
+    perform :put, path: path, **opts
   end
 
-  def perform_delete(path, body = nil, json_body = true)
-    perform :delete, path, body, json_body
+  def perform_delete(path, **opts)
+    perform :delete, path: path, **opts
   end
 
-  def perform(method, path, body = nil, json_body = true)
-    response = connect(method, path, body, json_body)
+  def perform(method, path:, body: nil, json_body: true, timeout: nil)
+    response = connect(method, path: path, body: body, json_body: json_body, timeout: timeout)
     treat_response(response, method, path)
   end
 
-  def connect(method, path, body = nil, json_body = true)
-    # binding.pry if method == :delete
+  def connect(method, path:, body: nil, json_body: true, timeout: nil)
     connection.send(method, path) do |req|
-      # binding.pry if method == :delete
+
+      req.options.timeout = timeout if timeout.present?
+
       unless body.nil?
         if json_body
           req.body                    = body_to_json body
@@ -73,7 +74,7 @@ class ArtirixDataModels::DataGateway
         end
       end
     end
-  rescue Faraday::ConnectionFailed => e
+  rescue Faraday::ConnectionFailed, Faraday::Error::TimeoutError, Errno::ETIMEDOUT => e
     raise ConnectionError,
           path:    path,
           method:  method,

data/lib/artirix_data_models/spec_support/gateway_mock.rb

@@ -12,25 +12,25 @@ def given_gateway_config(connection_url = nil)
 end
 
 
-def mock_gateway_response(response:, method:, path:, body: nil, json_body: true, gateway: nil)
+def mock_gateway_response(response:, method:, path:, body: nil, json_body: true, timeout: nil, gateway: nil)
   gateway ||= ArtirixDataModels::DAORegistry.gateway
-  allow(gateway).to receive(:perform).with(method, path, body, json_body).and_return response
+  allow(gateway).to receive(:perform).with(method, path: path, body: body, json_body: json_body, timeout: timeout).and_return response
 
   # check with body already parsed
   unless body.nil?
     body = body.kind_of?(String) ? body : body.to_json
-    allow(gateway).to receive(:perform).with(method, path, body, json_body).and_return response
+    allow(gateway).to receive(:perform).with(method, path: path, body: body, json_body: json_body, timeout: timeout).and_return response
   end
 end
 
-def mock_gateway_not_found_response(method:, path:, body: nil, json_body: true, gateway: nil)
+def mock_gateway_not_found_response(method:, path:, body: nil, json_body: true, timeout: nil, gateway: nil)
   gateway ||= ArtirixDataModels::DAORegistry.gateway
-  allow(gateway).to receive(:perform).with(method, path, body, json_body).and_raise ArtirixDataModels::DataGateway::NotFound
+  allow(gateway).to receive(:perform).with(method, path: path, body: body, json_body: json_body, timeout: timeout).and_raise ArtirixDataModels::DataGateway::NotFound
 
   # check with body already parsed
   unless body.nil?
     body = body.kind_of?(String) ? body : body.to_json
-    allow(gateway).to receive(:perform).with(method, path, body, json_body).and_raise ArtirixDataModels::DataGateway::NotFound
+    allow(gateway).to receive(:perform).with(method, path: path, body: body, json_body: json_body, timeout: timeout).and_raise ArtirixDataModels::DataGateway::NotFound
   end
 end
 

data/lib/artirix_data_models/spec_support/shared_examples/an_artirix_data_model_dao.rb

@@ -43,8 +43,8 @@ shared_examples_for 'an ArtirixDataModel DAO' do
   # mock gateway calls
   Given(:gateway) do
     ArtirixDataModels::DataGateway.new.tap do |gateway|
-      expect(gateway).to receive(:perform).with(:get, path_full, nil, true).and_return(json_full).at_most(:once)
-      expect(gateway).to receive(:perform).with(:get, path_partial, nil, true).and_return(json_partial).at_most(:once)
+      expect(gateway).to receive(:perform).with(:get, path: path_full, body: nil, json_body: true, timeout: nil).and_return(json_full).at_most(:once)
+      expect(gateway).to receive(:perform).with(:get, path: path_partial, body: nil, json_body: true, timeout: nil).and_return(json_partial).at_most(:once)
     end
   end
 

data/lib/artirix_data_models/version.rb

@@ -1,3 +1,3 @@
 module ArtirixDataModels
-  VERSION = '0.14.2'
+  VERSION = '0.15.0'
 end

data/spec/artirix_data_models/gateways/data_gateway_spec.rb

@@ -43,6 +43,29 @@ RSpec.describe ArtirixDataModels::DataGateway, type: :model do
     end
   end
 
+  context 'requests with timeout' do
+    Given(:connection_url) { 'http://10.255.255.1' }
+    Given(:connection) do
+      Faraday.new(url: connection_url, request: { params_encoder: Faraday::FlatParamsEncoder }) do |faraday|
+        faraday.request :url_encoded # form-encode without body only path params
+        faraday.response :logger # log requests to STDOUT
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    Given(:gateway) do
+      described_class.new connection: connection
+    end
+
+    Given(:path_with_timeout) { '/anywhere' }
+
+    describe '#get' do
+      When(:result) { gateway.get path_with_timeout, timeout: 1 }
+
+      Then { result == Failure(ArtirixDataModels::DataGateway::ConnectionError) }
+    end
+  end
+
   context 'requests' do
     Given(:connection_url) { 'http://example.com' }
     Given(:connection_stubs) { Faraday::Adapter::Test::Stubs.new }

data/spec/support/a_finder_enabled_ui_model_dao.rb

@@ -19,7 +19,7 @@ shared_examples_for 'a finder enabled UI ModelDAO' do
   # mock gateway calls
   Given(:gateway) do
     ArtirixDataModels::DataGateway.new.tap do |gateway|
-      expect(gateway).to receive(:perform).with(:get, path_for_find_by, nil, true).and_return(json_find_by).at_most(:once)
+      expect(gateway).to receive(:perform).with(:get, path: path_for_find_by, body: nil, json_body: true, timeout: nil).and_return(json_find_by).at_most(:once)
     end
   end
 

data/spec/support/a_search_enabled_ui_model_dao.rb

@@ -23,7 +23,7 @@ shared_examples_for 'a search enabled UI ModelDAO' do
   # mock gateway calls
   Given(:gateway) do
     ArtirixDataModels::DataGateway.new.tap do |gateway|
-      expect(gateway).to receive(:perform).with(:get, path_for_search, nil, true).and_return(json_search).at_most(:once)
+      expect(gateway).to receive(:perform).with(:get, path: path_for_search, body: nil, json_body: true, timeout: nil).and_return(json_search).at_most(:once)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: artirix_data_models
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.15.0
 platform: ruby
 authors:
 - Eduardo Turiño