dor-services-client 9.0.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6420f39cd3b4f4d1e125929725e7a749fdef2b4a3b41008fd6d6d440708aaba8
-  data.tar.gz: 3690b2a21d44ad9cc830a04f58117731bc4ab53f5d495edc5c4a0846150cd737
+  metadata.gz: 92add95b112e8d9c6cdce2ba2e91e08d4a49cb4d3329868c34441fe272fcc9c2
+  data.tar.gz: 18e2a92e7a11955f46ce18f832a0942dbbac87e300d3910e9cbddbb8ee7681fa
 SHA512:
-  metadata.gz: 1130a9e3510b4db1a1d383647de3e9c3c87f8b426c40586326ff88c300bb7508749c29eab8fcc35c5cb91db1cc0458fbc3b1949f12004bc3a4fa2cad9109db68
-  data.tar.gz: 63459db88fccc089c36c02b8a6496988edfa628844b04eb8991563c3fce014c88def669b5f452f48144a1e4c0bd87b2172bb1c674567295b31b280924f86124f
+  metadata.gz: aab5c196702ecdf1fca112cc9e65ab4e0136a9f4d79a0f96e8b31a7d4b71cf3d2daa978cf59234190fba35d0674f31449f6a8c4ac5a2fac9c9fd38e933a4102e
+  data.tar.gz: 8882218dba3fa8266a19ea4c299569fd62c1b41b32119bf897b65d4333687df943c407e84bb3f48d213317caa40b8245ea4810eaf6e69f32b836bc6e262cc2aa

data/.rubocop.yml

@@ -13,6 +13,9 @@ Metrics/BlockLength:
     - 'spec/**/*'
 
 RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/ExampleLength:
   Max: 10
 
 Gemspec/DateAssignment: # (new in 1.10)

data/.rubocop_todo.yml

@@ -25,12 +25,6 @@ RSpec/AnyInstance:
     - 'spec/dor/services/client/metadata_spec.rb'
     - 'spec/dor/services/client/object_version_spec.rb'
 
-# Offense count: 1
-# Configuration parameters: Max, CountAsOne.
-RSpec/ExampleLength:
-  Exclude:
-    - 'spec/dor/services/client/metadata_spec.rb'
-
 # Offense count: 6
 RSpec/IdenticalEqualityAssertion:
   Exclude:

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

@@ -20,9 +20,9 @@ module Dor
 
           # This method needs its own exception handling logic due to how the endpoint service (SearchWorks) operates
           # raise a NotFoundResponse because the resource being requested was not found in the ILS (via dor-services-app)
-          raise NotFoundResponse, ResponseErrorFormatter.format(response: resp) if resp.success? && resp.body.blank?
+          raise NotFoundResponse.new(response: resp) if resp.success? && resp.body.blank?
 
-          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp)
+          raise UnexpectedResponse.new(response: resp)
         end
 
         # Gets MARCXML corresponding to a barcode or catkey
@@ -45,9 +45,9 @@ module Dor
           # DOR Services App does not respond with a 404 when no match in Symphony.
           # Rather, it responds with a 500 containing "Record not found in Symphony" in the body.
           # raise a NotFoundResponse because the resource being requested was not found in the ILS (via dor-services-app)
-          raise NotFoundResponse, ResponseErrorFormatter.format(response: resp) if !resp.success? && resp.body.match?(/Record not found in Symphony/)
+          raise NotFoundResponse.new(response: resp) if !resp.success? && resp.body.match?(/Record not found in Symphony/)
 
-          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp) unless resp.success?
+          raise UnexpectedResponse.new(response: resp) unless resp.success?
 
           resp.body
         end

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

@@ -33,16 +33,19 @@ module Dor
         # @raise [BadRequestError] when ETag not provided.
         # @return [Cocina::Models::DROWithMetadata,Cocina::Models::CollectionWithMetadata,Cocina::Models::AdminPolicyWithMetadata] the returned model
         # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
         def update(params:, skip_lock: false)
+          raise ArgumentError, 'Cocina object not provided.' unless params.respond_to?(:externalIdentifier)
+
           # Raised if Cocina::Models::*WithMetadata not provided.
-          raise BadRequestError, 'ETag not provided.' unless skip_lock || params.respond_to?(:lock)
+          raise ArgumentError, 'ETag not provided.' unless skip_lock || params.respond_to?(:lock)
 
           resp = connection.patch do |req|
             req.url object_path
             req.headers['Content-Type'] = 'application/json'
             # asking the service to return JSON (else it'll be plain text)
             req.headers['Accept'] = 'application/json'
-            req.headers['If-Match'] = params[:lock] unless skip_lock
+            req.headers['If-Match'] = params.lock unless skip_lock
             req.body = build_json_from_cocina(params)
           end
 
@@ -51,6 +54,7 @@ module Dor
           build_cocina_from_response(resp)
         end
         # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/MethodLength
 
         # Pull in metadata from Symphony and updates descriptive metadata
         # @raise [NotFoundResponse] when the response is a 404 (object not found)

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

@@ -53,15 +53,19 @@ module Dor
 
         # Open new version for an object
         # @param params [Hash] optional params (see dor-services-app)
-        # @raise [MalformedResponse] when the response is not parseable.
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [String] the current version
+        # @return [Cocina::Models::DROWithMetadata|CollectionWithMetadata|AdminPolicyWithMetadata] cocina model with updated version
         def open(**params)
-          version = open_new_version_response(**params)
-          raise MalformedResponse, "Version of #{object_identifier} is empty" if version.empty?
+          resp = connection.post do |req|
+            req.url open_new_version_path
+            req.headers['Content-Type'] = 'application/json'
+            req.body = params.to_json if params.any?
+          end
 
-          version
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          build_cocina_from_response(resp)
         end
 
         # Close current version for an object
@@ -99,22 +103,6 @@ module Dor
           "#{api_version}/objects/#{object_identifier}"
         end
 
-        # Make request to server to open a new version
-        # @param params [Hash] optional params (see dor-services-app)
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] on an unsuccessful response from the server
-        # @return [String] the plain text from the server
-        def open_new_version_response(**params)
-          resp = connection.post do |req|
-            req.url open_new_version_path
-            req.headers['Content-Type'] = 'application/json'
-            req.body = params.to_json if params.any?
-          end
-          return resp.body if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
         def base_path
           "#{object_path}/versions"
         end

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

@@ -8,9 +8,9 @@ module Dor
       # API calls that are about a repository objects
       class Objects < VersionedService
         # Creates a new object in DOR
-        # @param params [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAPO]
+        # @param params [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAdminPolicy]
         # @param assign_doi [Boolean]
-        # @return [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAPO] the returned model
+        # @return [Cocina::Models::DROWithMetadata,Cocina::Models::CollectionWithMetadata,Cocina::Models::AdminPolicyWithMetadata] the returned model
         def register(params:, assign_doi: false)
           resp = connection.post do |req|
             req.url "#{api_version}/objects"

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '9.0.0'
+      VERSION = '10.0.0'
     end
   end
 end

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

@@ -5,6 +5,16 @@ module Dor
     class Client
       # @abstract API calls to a versioned endpoint
       class VersionedService
+        EXCEPTION_CLASS = {
+          400 => BadRequestError,
+          401 => UnauthorizedResponse,
+          404 => NotFoundResponse,
+          409 => ConflictResponse,
+          412 => PreconditionFailedResponse
+        }.freeze
+
+        JSON_API_MIME_TYPE = 'application/vnd.api+json'
+
         def initialize(connection:, version:)
           @connection = connection
           @api_version = version
@@ -19,26 +29,17 @@ 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 400
-                              BadRequestError
-                            when 401
-                              UnauthorizedResponse
-                            when 404
-                              NotFoundResponse
-                            when 409
-                              ConflictResponse
-                            when 412
-                              PreconditionFailedResponse
-                            else
-                              UnexpectedResponse
-                            end
-          raise exception_class,
-                ResponseErrorFormatter.format(response: response, object_identifier: object_identifier)
+          data = if response.headers.fetch('content-type', '').start_with?(JSON_API_MIME_TYPE)
+                   JSON.parse(response.body)
+                 else
+                   {}
+                 end
+          exception_class = EXCEPTION_CLASS.fetch(response.status, UnexpectedResponse)
+          raise exception_class.new(response: response,
+                                    object_identifier: object_identifier,
+                                    errors: data.fetch('errors', []))
         end
-        # rubocop:enable Metrics/MethodLength
 
         def build_cocina_from_response(response)
           cocina_object = Cocina::Models.build(JSON.parse(response.body))

data/lib/dor/services/client.rb

@@ -38,7 +38,26 @@ module Dor
 
       # Error that is raised when the remote server returns some unexpected response
       # this could be any 4xx or 5xx status (except the ones that are direct children of the Error class above)
-      class UnexpectedResponse < Error; end
+      class UnexpectedResponse < Error
+        # @param [Faraday::Response] response
+        # @param [String] object_identifier (nil)
+        # @param [Hash<String,Object>] errors (nil) the JSON-API errors object
+        # rubocop:disable Lint/MissingSuper
+        def initialize(response:, object_identifier: nil, errors: nil)
+          @response = response
+          @object_identifier = object_identifier
+          @errors = errors
+        end
+        # rubocop:enable Lint/MissingSuper
+
+        attr_accessor :errors
+
+        def to_s
+          return errors.map { |e| "#{e['title']} (#{e['detail']})" }.join(', ') if errors.present?
+
+          ResponseErrorFormatter.format(response: @response, object_identifier: @object_identifier)
+        end
+      end
 
       # Error that is raised when the remote server returns a 401 Unauthorized
       class UnauthorizedResponse < UnexpectedResponse; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 10.0.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport