dor-services-client 6.1.0 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f324272fcd773616044c4ddc11f93664d52efa263f47cdcc21059dd07bee7562
-  data.tar.gz: 1abbe32573c71a368d69a46ce1a18c6eb587a35a6e2ad7e2dead9670e9c276a5
+  metadata.gz: 89c1a897efc199c5f31da3d68f9c3fd2bdc4c09759579a30a339477651081ced
+  data.tar.gz: da3a34afb64f21ff964ddffdaeba44d1a8fa45fb15126d4cbb77b3e1f89f3cc5
 SHA512:
-  metadata.gz: ece82eaa29c075d3e6b5c66d18e133f200984c7ef0ab5cdb810ed11e729de893fe8be0e5610a67452dd6fbc5cb0264e9aa6983f8d3d342926e04c9ad45a39b33
-  data.tar.gz: 906962b8dabe3ebb34fab6a41ffa8dd52e5c1e68315587d3763a8897cf3d2fd182929d3cd3b1e9e58de6e988415ddd351071e44ee3bcaf42cafde272e1d35269
+  metadata.gz: 1fbd52e84678d731a29392b94b13fd68fba69e57fb70e0f4af906dc1838ef741ec02cd6e0b9adf9d0c4919d8d19b8c815d34c4933b14b9660fe05f79436f1f61
+  data.tar.gz: 36f45f7241b8de8900b6e93a2fbe39240e1a0280c2ff9dc78c9be1e14d2e3a41252d43b6799c22dd3e509b4e2a399db17bb359054226680ed89cff5737234852

data/.github/pull_request_template.md

@@ -1,4 +1,12 @@
 ## Why was this change made?
 
 
-## Was the documentation (README, API, wiki, consul, etc.) updated?
+
+## How was this change tested?
+
+
+
+## Which documentation and/or configurations were updated?
+
+
+

data/.rubocop_todo.yml

@@ -32,5 +32,5 @@ Style/Documentation:
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
-Layout/LineLength:
+Metrics/LineLength:
   Max: 164

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
 
@@ -164,6 +169,9 @@ object_client.workspace.reset
 
 # Update embargo
 object_client.embargo.update(embargo_date: date_string, requesting_user: username_string)
+
+# Search for administrative tags:
+Dor::Services::Client.administrative_tags.search(q: 'Project')
 ```
 
 ## Asynchronous results

data/dor-services-client.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '>= 4.2', '< 7'
-  spec.add_dependency 'cocina-models', '~> 0.32.0' # leave pinned to patch level until cocina-models hits 1.0
+  spec.add_dependency 'cocina-models', '~> 0.33.0' # leave pinned to patch level until cocina-models hits 1.0
   spec.add_dependency 'deprecation', '>= 0'
   spec.add_dependency 'faraday', '>= 0.15', '< 2'
   spec.add_dependency 'moab-versioning', '~> 4.0'

data/lib/dor/services/client.rb

@@ -36,6 +36,9 @@ module Dor
       # Error that is raised when the remote server returns a 401 Unauthorized
       class UnauthorizedResponse < UnexpectedResponse; end
 
+      # Error that is raised when the remote server returns a 409 Conflict
+      class ConflictResponse < UnexpectedResponse; end
+
       # Error that is raised when the remote server returns some unparsable response
       class MalformedResponse < Error; end
 
@@ -56,6 +59,11 @@ module Dor
         @object = Object.new(connection: connection, version: DEFAULT_VERSION, object_identifier: object_identifier)
       end
 
+      # @return [Dor::Services::Client::AdministrativeTagSearch] an instance of the `Client::AdministrativeTagSearch` class
+      def administrative_tags
+        @administrative_tags ||= AdministrativeTagSearch.new(connection: connection, version: DEFAULT_VERSION)
+      end
+
       # @return [Dor::Services::Client::Objects] an instance of the `Client::Objects` class
       def objects
         @objects ||= Objects.new(connection: connection, version: DEFAULT_VERSION)
@@ -79,9 +87,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
@@ -89,21 +99,26 @@ module Dor
           self
         end
 
-        delegate :background_job_results, :marcxml, :objects, :object, :virtual_objects, to: :instance
+        delegate :background_job_results, :marcxml, :objects, :object,
+                 :virtual_objects, :administrative_tags, 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 +128,7 @@ module Dor
           builder.adapter Faraday.default_adapter
           builder.headers[:user_agent] = user_agent
           builder.headers[TOKEN_HEADER] = "Bearer #{token}"
+          builder.request :retry, max: 4, interval: 1, backoff_factor: 2 if with_retries
         end
       end
 

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'active_support/json' # required for serializing time as iso8601
+
+module Dor
+  module Services
+    class Client
+      # API calls that are about searching AdministrativeTags
+      class AdministrativeTagSearch < VersionedService
+        # rubocop:disable Naming/UncommunicativeMethodParamName
+        def search(q:)
+          resp = connection.get do |req|
+            req.url "#{api_version}/administrative_tags/search?q=#{q}"
+          end
+
+          # Since argo is using this as a proxy, no need to parse the response.
+          return resp.body if resp.success?
+
+          raise_exception_based_on_response!(resp)
+        end
+        # rubocop:enable Naming/UncommunicativeMethodParamName
+      end
+    end
+  end
+end

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.5.0'
     end
   end
 end

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

@@ -19,18 +19,22 @@ module Dor
 
         attr_reader :connection, :api_version
 
+        # rubocop:disable Metrics/MethodLength
         def raise_exception_based_on_response!(response, object_identifier = nil)
           exception_class = case response.status
                             when 404
                               NotFoundResponse
                             when 401
                               UnauthorizedResponse
+                            when 409
+                              ConflictResponse
                             else
                               UnexpectedResponse
                             end
           raise exception_class,
                 ResponseErrorFormatter.format(response: response, object_identifier: object_identifier)
         end
+        # rubocop:enable Metrics/MethodLength
       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.5.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-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.33.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.33.0
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -228,10 +228,12 @@ files:
 - dor-services-client.gemspec
 - lib/dor/services/client.rb
 - lib/dor/services/client/accession.rb
+- lib/dor/services/client/administrative_tag_search.rb
 - lib/dor/services/client/administrative_tags.rb
 - 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