almodovar 1.7.6 → 1.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bf8daf20a34b735694f237e74c7d6a3dbd2d3aeb383ed8a9fb4b9fee48d14b3
-  data.tar.gz: 946f4449c0931dc085259a6238eae7b42306264b90bba73d9ba2291b24e72918
+  metadata.gz: 697594700427d3065a55287788a6a398f9dafa7f067c98bfe5b432ea9704e48d
+  data.tar.gz: 9a74aa72c439726bbca0d9d5a04ead6b0f1e759c51746a35b1ad7cb43b35886b
 SHA512:
-  metadata.gz: 2c815dad7020c2e24db4fdd5f8633522638cba2e9eae3c2a9d7e682902653e5c83dc2f1ee618ba6c541054af14ad3ceedc1edcf1151256415c976d05b3e5f347
-  data.tar.gz: 5595081a995e00af88b03720c555ab573048b1b5359f461cd818e41d6e0885cf658df79bbf865c024525b415c0f81013bcbb1dfca6b1dec168b2c118f974921b
+  metadata.gz: eb397b25f5f8dea9e1b73907053aae819093f373a74f035f253b40121209faad5264b65530b45a5aef606393ee912af2b6796786f492a88147f1d94a310585a9
+  data.tar.gz: fe665afd24a05d52d126813da704dbbf48a1748be61f161de084df0c69a3d365c0fa0f1eacbf54ce74de8ad2f3639fbc44ed00ae18c57e60338d8d5d814e8322

data/README.rdoc

@@ -1,4 +1,4 @@
-=Almodovar {<img src="http://travis-ci.org/bebanjo/almodovar.png" />}[http://travis-ci.org/bebanjo/almodovar]
+=Almodovar {<img src="https://github.com/bebanjo/almodovar/workflows/CI/badge.svg" />}[http://travis-ci.org/bebanjo/almodovar]
 
 Almodovar is a client for BeBanjo's Sequence & Movida API written in Ruby (it's actually a generic client which plays nice with any RESTful API following some conventions).
   

data/lib/almodovar.rb

@@ -21,24 +21,41 @@ module Almodovar
   DEFAULT_RECEIVE_TIMEOUT = 120
 
   class << self
+
+    # default_options allows to configure some settings on the underlying HTTP client used by Almodovar:
+    #   - send_timeout: Request sending timeout in sec. Defaults to 120
+    #   - connect_timeout: Connect timeout in sec. Defaults to 30
+    #   - receive_timeout: Response receiving timeout in sec. Defaults to 120
+    #   - user_agent: User-Agent header in HTTP request. defaults to Almodovar/#{Almodovar::VERSION}
+    #   - force_basic_auth: flag for sending Authorization header w/o getting 401 first. Useful during tests
+    #   - headers: is for providing default headers Hash that all HTTP
+    #     requests should have, such as custom 'X-Request-Id' header in tracing.
+    #     As Almodovar does not expose http API, this accept a proc which will be
+    #     evaluated per request. You can override :headers with Almodovar::HTTPClient headers method
+    #     or using Hash parameter in HTTP request methods but this is not accessible on default Almodovar usage.
     def default_options
       default = {
         send_timeout: DEFAULT_SEND_TIMEOUT,
         connect_timeout: DEFAULT_CONNECT_TIMEOUT,
         receive_timeout: DEFAULT_RECEIVE_TIMEOUT,
         user_agent: "Almodovar/#{Almodovar::VERSION}",
-        force_basic_auth: false
+        force_basic_auth: false,
+        headers: nil,
       }
       default.merge(@default_options || {})
     end
 
     def default_options=(options = {})
-      @default_options = {
-        send_timeout: options[:send_timeout],
-        connect_timeout: options[:connect_timeout],
-        receive_timeout: options[:receive_timeout],
-        force_basic_auth: options[:force_basic_auth]
-      }
+      @default_options ||= {}
+      # Only assign provided keys too keep defaults when merging
+      %i(send_timeout connect_timeout receive_timeout force_basic_auth headers).each do |key|
+        @default_options[key] = options[key] if options.has_key?(key)
+      end
+      @default_options
+    end
+
+    def reset_options
+      @default_options = nil
     end
   end
 end

data/lib/almodovar/http_client.rb

@@ -38,8 +38,15 @@ module Almodovar
 
     private
 
-    def merge_headers(headers)
-      (self.headers ||= {}).merge(headers)
+    def merge_headers(req_headers)
+      (default_headers || {}).
+        merge(self.headers ||= {}).
+        merge(req_headers)
+    end
+
+    def default_headers
+      defaults = Almodovar::default_options[:headers] || {}
+      defaults = defaults.is_a?(Proc) ? defaults.call() : defaults
     end
 
     def requires_auth?

data/lib/almodovar/version.rb

@@ -1,3 +1,3 @@
 module Almodovar
-  VERSION = '1.7.6'
+  VERSION = '1.7.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: almodovar
 version: !ruby/object:Gem::Version
-  version: 1.7.6
+  version: 1.7.7
 platform: ruby
 authors:
 - BeBanjo S.L.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-10 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -108,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: ballsbreaking@bebanjo.com
 executables: []
 extensions: []
@@ -130,7 +130,7 @@ homepage: http://wiki.github.com/bebanjo/almodovar/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.rdoc
@@ -147,8 +147,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: BeBanjo API client
 test_files: []