dor-services-client 6.1.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f324272fcd773616044c4ddc11f93664d52efa263f47cdcc21059dd07bee7562
-  data.tar.gz: 1abbe32573c71a368d69a46ce1a18c6eb587a35a6e2ad7e2dead9670e9c276a5
+  metadata.gz: 9bfa9e7819d9794826fb95861eb36bcaa9f426280dd96267b2739f4693606c1f
+  data.tar.gz: df0c3d033e30d17ecafed72c66406dc33ae6f8f682434e43feb8a47f9b97358f
 SHA512:
-  metadata.gz: ece82eaa29c075d3e6b5c66d18e133f200984c7ef0ab5cdb810ed11e729de893fe8be0e5610a67452dd6fbc5cb0264e9aa6983f8d3d342926e04c9ad45a39b33
-  data.tar.gz: 906962b8dabe3ebb34fab6a41ffa8dd52e5c1e68315587d3763a8897cf3d2fd182929d3cd3b1e9e58de6e988415ddd351071e44ee3bcaf42cafde272e1d35269
+  metadata.gz: 4edbf5f3ee992ed4accae4225e16d294c9b5aeb8d9c7507164afd2242933040cbf4067b79388c254dfab6263a224d8d6b85655a07a5cf22f4236f41318d5297a
+  data.tar.gz: d52a6f01e86def397871069447cda06886fd1fc5e94f9af98c651d6d8b7e88e8b170530e89bbf35b89d764aa0ad82a743eb9a1434723db45af920df7a7a4d34e

data/README.md

@@ -40,11 +40,16 @@ private
 
 def client
   @client ||= Dor::Services::Client.configure(url: Settings.dor_services.url,
-                                              token: Settings.dor_services.token)
+                                              token: Settings.dor_services.token,
+                                              enable_get_retries: true)
 end
 ```
 
-Note that the client may **not** be used without first having been configured, and the `url` keyword is **required**. The `token` argument is optional (though when using the client with staging and production servers, you will always need to supply it in practice). For more about dor-services-app's token-based authentication, see [its README](https://github.com/sul-dlss/dor-services-app#authentication).
+Note:
+* The client may **not** be used without first having been configured
+* The `url` keyword is **required**.
+* The `token` argument is optional (though when using the client with staging and production servers, you will always need to supply it in practice). For more about dor-services-app's token-based authentication, see [its README](https://github.com/sul-dlss/dor-services-app#authentication).
+* The `enable_get_retries` argument is optional. When enabled, it will perform retries of `GET` requests only. This should only be used in situations in which blocking is not an issue, e.g., an asynchronous job.
 
 ## API Coverage
 

data/lib/dor/services/client/connection_wrapper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # Wraps connections to allow GET requests to be retriable.
+      class ConnectionWrapper
+        delegate :get, to: :get_connection
+        delegate :post, :delete, :put, :patch, to: :connection
+
+        def initialize(connection:, get_connection:)
+          @connection = connection
+          @get_connection = get_connection
+        end
+
+        private
+
+        attr_reader :connection, :get_connection
+      end
+    end
+  end
+end

data/lib/dor/services/client/version.rb

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '6.1.0'
+      VERSION = '6.2.0'
     end
   end
 end

data/lib/dor/services/client.rb

@@ -79,9 +79,11 @@ module Dor
       class << self
         # @param [String] url the base url of the endpoint the client should connect to (required)
         # @param [String] token a bearer token for HTTP authentication (required)
-        def configure(url:, token:)
+        # @param [Boolean] enable_get_retries retries get requests on errors
+        def configure(url:, token:, enable_get_retries: false)
           instance.url = url
           instance.token = token
+          instance.enable_get_retries = enable_get_retries
 
           # Force connection to be re-established when `.configure` is called
           instance.connection = nil
@@ -92,18 +94,22 @@ module Dor
         delegate :background_job_results, :marcxml, :objects, :object, :virtual_objects, to: :instance
       end
 
-      attr_writer :url, :token, :connection
+      attr_writer :url, :token, :connection, :enable_get_retries
 
       private
 
-      attr_reader :token
+      attr_reader :token, :enable_get_retries
 
       def url
         @url || raise(Error, 'url has not yet been configured')
       end
 
       def connection
-        @connection ||= Faraday.new(url) do |builder|
+        @connection ||= ConnectionWrapper.new(connection: build_connection, get_connection: build_connection(with_retries: enable_get_retries))
+      end
+
+      def build_connection(with_retries: false)
+        Faraday.new(url) do |builder|
           builder.use ErrorFaradayMiddleware
           builder.use Faraday::Request::UrlEncoded
 
@@ -113,6 +119,10 @@ module Dor
           builder.adapter Faraday.default_adapter
           builder.headers[:user_agent] = user_agent
           builder.headers[TOKEN_HEADER] = "Bearer #{token}"
+          if with_retries
+            builder.request :retry, max: 4, interval: 1,
+                                    backoff_factor: 2, exceptions: ['Faraday::Error', 'Timeout::Error']
+          end
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.2.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -232,6 +232,7 @@ files:
 - lib/dor/services/client/async_result.rb
 - lib/dor/services/client/background_job_results.rb
 - lib/dor/services/client/collections.rb
+- lib/dor/services/client/connection_wrapper.rb
 - lib/dor/services/client/embargo.rb
 - lib/dor/services/client/error_faraday_middleware.rb
 - lib/dor/services/client/events.rb