artirix_data_models 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bfb65d885ba816daff5dafaf4f725cbacf35a6e
-  data.tar.gz: 84baf5c1431d2b39438ae646e85c450183227f35
+  metadata.gz: 5297e305a2a81af12a820270e60c3e926abfa36f
+  data.tar.gz: fac1f5b4d525b6dad5bde63d1883884ea99ccf70
 SHA512:
-  metadata.gz: 04d9eb00b920c981e36cda90369f200df8c7449c5d9178a8bcd9f59d5c593ce3c6d3178ea2e7fb9954585e5a55ed323a7e02fafdf54141e605e6882a73c8e07b
-  data.tar.gz: 55772da2c303dd510e28956f13cebbad4e475b08c6a243813e3f373c08a73d2328ddfaca8c632829f6099f6732573d9ad1159afa673ac32aa36be2b6e77eacea
+  metadata.gz: 2c68c1d44aeeb2c7252076b3cc7f18134cedd20b5d3aacb8d24b986e85125dadac0212a52e6c06564420fc70bc8db5aebcc001e92e4dac9e14aac6771659f240
+  data.tar.gz: e8f4037838acd44d925970f9254049205a885fa428d3502f1771c52baa26b2c7d0c83dbe541d6c32823bfb852a9a0c16e6ff4d4be0d80551b849de39e99c2c44

data/README.md

@@ -327,6 +327,9 @@ end
 
 ## Changes
 
+### 0.24.0
+- add `headers` to Gateway, to Connection and to DAO methods. It expect a hash of key-value that will be passed to the Faraday call after the body of the request.
+
 ### 0.23.0
 - DAORegistry now DI'ed into the DAOs and models, by adding `dao_registry_loader` or a direct `dao_registry`.
 - DAORegistry with support for Identity Map

data/lib/artirix_data_models/daos/basic_model_dao.rb

@@ -162,7 +162,7 @@ class ArtirixDataModels::BasicModelDAO
   # PERFORM CALLS #
   #################
 
-  def perform_get(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, timeout: nil, gateway: nil)
+  def perform_get(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, timeout: nil, gateway: nil, headers: nil)
     g = gateway.presence || preloaded_gateway
     raise_no_gateway unless g.present?
 
@@ -172,11 +172,12 @@ class ArtirixDataModels::BasicModelDAO
           timeout:          timeout,
           fake:             fake?,
           fake_response:    fake_response,
-          cache_adaptor:    cache_adaptor
+          cache_adaptor:    cache_adaptor,
+          headers:          headers
   end
 
 
-  def perform_post(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, timeout: nil, gateway: nil)
+  def perform_post(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, timeout: nil, gateway: nil, headers: nil)
     g = gateway.presence || preloaded_gateway
     raise_no_gateway unless g.present?
 
@@ -186,10 +187,11 @@ class ArtirixDataModels::BasicModelDAO
            timeout:          timeout,
            fake:             fake?,
            fake_response:    fake_response,
-           cache_adaptor:    cache_adaptor
+           cache_adaptor:    cache_adaptor,
+           headers:          headers
   end
 
-  def perform_put(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, timeout: nil, gateway: nil)
+  def perform_put(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, timeout: nil, gateway: nil, headers: nil)
     g = gateway.presence || preloaded_gateway
     raise_no_gateway unless g.present?
 
@@ -199,10 +201,11 @@ class ArtirixDataModels::BasicModelDAO
           timeout:          timeout,
           fake:             fake?,
           fake_response:    fake_response,
-          cache_adaptor:    cache_adaptor
+          cache_adaptor:    cache_adaptor,
+          headers:          headers
   end
 
-  def perform_delete(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, timeout: nil, gateway: nil)
+  def perform_delete(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, timeout: nil, gateway: nil, headers: nil)
     g = gateway.presence || preloaded_gateway
     raise_no_gateway unless g.present?
 
@@ -212,7 +215,8 @@ class ArtirixDataModels::BasicModelDAO
              timeout:          timeout,
              fake:             fake?,
              fake_response:    fake_response,
-             cache_adaptor:    cache_adaptor
+             cache_adaptor:    cache_adaptor,
+             headers:          headers
   end
 
   # old names

data/lib/artirix_data_models/gateways/data_gateway.rb

@@ -46,6 +46,7 @@ class ArtirixDataModels::DataGateway
            timeout: nil,
            authorization_bearer: nil,
            authorization_token_hash: nil,
+           headers: nil,
            **_ignored_options)
 
     if fake
@@ -59,7 +60,8 @@ class ArtirixDataModels::DataGateway
                 json_body:                json_body,
                 timeout:                  timeout,
                 authorization_bearer:     authorization_bearer,
-                authorization_token_hash: authorization_token_hash
+                authorization_token_hash: authorization_token_hash,
+                headers:                  headers
       end
 
     else
@@ -69,7 +71,8 @@ class ArtirixDataModels::DataGateway
                        json_body:                json_body,
                        timeout:                  timeout,
                        authorization_bearer:     authorization_bearer,
-                       authorization_token_hash: authorization_token_hash
+                       authorization_token_hash: authorization_token_hash,
+                       headers:                  headers
     end
 
     parse_response result:           result,
@@ -102,7 +105,8 @@ class ArtirixDataModels::DataGateway
               json_body: true,
               timeout: nil,
               authorization_bearer: nil,
-              authorization_token_hash: nil)
+              authorization_token_hash: nil,
+              headers: nil)
 
     pars = {
       path:                     path,
@@ -110,7 +114,8 @@ class ArtirixDataModels::DataGateway
       json_body:                json_body,
       timeout:                  timeout,
       authorization_bearer:     authorization_bearer,
-      authorization_token_hash: authorization_token_hash
+      authorization_token_hash: authorization_token_hash,
+      headers:                  headers
     }
 
     response = connect(method, pars)
@@ -126,7 +131,8 @@ class ArtirixDataModels::DataGateway
               json_body: true,
               timeout: nil,
               authorization_bearer: nil,
-              authorization_token_hash: nil)
+              authorization_token_hash: nil,
+              headers: nil)
 
     timeout                  = timeout.nil? ? @timeout : timeout
     authorization_bearer     = authorization_bearer.nil? ? @authorization_bearer : authorization_bearer
@@ -150,6 +156,10 @@ class ArtirixDataModels::DataGateway
           req.body = body
         end
       end
+
+      Array(headers).each do |key, value|
+        req.headers[key.to_s] = value
+      end
     end
   rescue Faraday::ConnectionFailed, Faraday::Error::TimeoutError, Errno::ETIMEDOUT => e
     raise ConnectionError,
@@ -257,7 +267,7 @@ class ArtirixDataModels::DataGateway
 
         raise InvalidConnectionError, 'no url given, nor is it present in `config.url`' unless url.present?
 
-        Faraday.new(url: url, request: {params_encoder: Faraday::FlatParamsEncoder}) do |faraday|
+        Faraday.new(url: url, request: { params_encoder: Faraday::FlatParamsEncoder }) do |faraday|
           faraday.request :url_encoded # form-encode POST params
           faraday.response :logger # log requests to STDOUT
 

data/lib/artirix_data_models/spec_support/gateway_mock.rb

@@ -1,7 +1,7 @@
 # :nocov:
 def given_gateway_config(connection_url = nil)
   connection_url ||= 'http://example.com/other'
-  
+
   before(:each) do
     config = ArtirixDataModels.configuration
 
@@ -25,7 +25,8 @@ def mock_gateway_response(response:,
                           timeout: nil,
                           authorization_bearer: nil,
                           authorization_token_hash: nil,
-                          gateway: nil)
+                          gateway: nil,
+                          headers: nil)
   gateway ||= ArtirixDataModels::DAORegistry.gateway
 
   params_hash = {
@@ -34,7 +35,8 @@ def mock_gateway_response(response:,
     json_body:                json_body,
     timeout:                  timeout,
     authorization_bearer:     authorization_bearer,
-    authorization_token_hash: authorization_token_hash
+    authorization_token_hash: authorization_token_hash,
+    headers:                  headers
   }
 
   allow(gateway).to receive(:perform).with(method, params_hash).and_return response
@@ -53,7 +55,8 @@ def mock_gateway_not_found_response(method:,
                                     timeout: nil,
                                     authorization_bearer: nil,
                                     authorization_token_hash: nil,
-                                    gateway: nil)
+                                    gateway: nil,
+                                    headers: nil)
 
   gateway ||= ArtirixDataModels::DAORegistry.gateway
 
@@ -63,7 +66,8 @@ def mock_gateway_not_found_response(method:,
     json_body:                json_body,
     timeout:                  timeout,
     authorization_bearer:     authorization_bearer,
-    authorization_token_hash: authorization_token_hash
+    authorization_token_hash: authorization_token_hash,
+    headers:                  headers
   }
 
   allow(gateway).to receive(:perform).with(method, params_hash).and_raise ArtirixDataModels::DataGateway::NotFound

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

@@ -43,8 +43,18 @@ 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: 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)
+      params_hash = {
+        path:                     nil,
+        body:                     nil,
+        json_body:                true,
+        timeout:                  nil,
+        authorization_bearer:     nil,
+        authorization_token_hash: nil,
+        headers:                  nil
+      }
+
+      expect(gateway).to receive(:perform).with(:get, params_hash.merge(path: path_full)).and_return(json_full).at_most(:once)
+      expect(gateway).to receive(:perform).with(:get, params_hash.merge(path: path_partial)).and_return(json_partial).at_most(:once)
     end
   end
 

data/lib/artirix_data_models/version.rb

@@ -1,3 +1,3 @@
 module ArtirixDataModels
-  VERSION = '0.23.0'
+  VERSION = '0.24.0'
 end

data/spec/support/a_finder_enabled_ui_model_dao.rb

@@ -19,7 +19,16 @@ 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: path_for_find_by, body: nil, json_body: true, timeout: nil).and_return(json_find_by).at_most(:once)
+      expected_params = {
+        path:                     path_for_find_by,
+        body:                     nil,
+        json_body:                true,
+        timeout:                  nil,
+        authorization_bearer:     nil,
+        authorization_token_hash: nil,
+        headers:                  nil
+      }
+      expect(gateway).to receive(:perform).with(:get, expected_params).and_return(json_find_by).at_most(:once)
     end
   end
 

data/spec/support/a_search_enabled_ui_model_dao.rb

@@ -23,7 +23,17 @@ 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: path_for_search, body: nil, json_body: true, timeout: nil).and_return(json_search).at_most(:once)
+      params_hash = {
+        path:                     path_for_search,
+        body:                     nil,
+        json_body:                true,
+        timeout:                  nil,
+        authorization_bearer:     nil,
+        authorization_token_hash: nil,
+        headers:                  nil
+      }
+
+      expect(gateway).to receive(:perform).with(:get, params_hash).and_return(json_search).at_most(:once)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artirix_data_models
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Eduardo Turiño
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2016-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport