dor-services-client 8.9.0 → 9.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd831afabe6f8b712e16458615dee51078f11b1c21493049c31b7d2902ec4ef5
-  data.tar.gz: 614d459c2f0c0b983e6571287c5ed8085c374c250286e704c47f54b397327717
+  metadata.gz: a0cdf365381c6038c6b2cc8450158528c83f1daf5e7d41cff74f8fc5b48a6848
+  data.tar.gz: c82464b2f24334a7f7640d17435d5c0dc7de72d898ed3de6034747dd0555026d
 SHA512:
-  metadata.gz: dd27923de9216158f004ee5a823d42aef5b80fd248601a8b9d1dcdadbc15fd75ce8d9d7e9f519413c2685087acbf6531bf3f77a126926d8af17617e7b7d05087
-  data.tar.gz: d3117d28b8380223d7a4df9724db53ed97fbd4b570af68c3fd44905d8d961f415dffe6a9e79761cdd659e7101aac26b52e550691b7628c537fba4915483c571d
+  metadata.gz: ad1b643a11d1254d44dcbcdad0ac308a16eaadc0ad658407247e23250c6a1c0ba466ced3ebab25652cd7d72d0cec73fbf8ccaa2ee9b44b25d817f1d2ea77a960
+  data.tar.gz: c88e40ce8d62e1e64d77e8f31a856a27bc7d88af254a3116d70621cb83fbcd3b189e5c40b28bea42c73d73f1a32adade49aff0ee570dcdcbdaa0f2e310d07d71

data/.rubocop.yml

@@ -12,6 +12,12 @@ Metrics/BlockLength:
     - 'dor-services-client.gemspec'
     - 'spec/**/*'
 
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+RSpec/ExampleLength:
+  Max: 10
+
 Gemspec/DateAssignment: # (new in 1.10)
   Enabled: true
 Layout/SpaceBeforeBrackets: # (new in 1.7)

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:
@@ -46,12 +40,6 @@ RSpec/MultipleExpectations:
     - 'spec/dor/services/client/object_spec.rb'
     - 'spec/dor/services/client/response_error_formatter_spec.rb'
 
-# Offense count: 7
-# Configuration parameters: AllowSubject, Max.
-RSpec/MultipleMemoizedHelpers:
-  Exclude:
-    - 'spec/dor/services/client/objects_spec.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 RSpec/MultipleSubjects:

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

@@ -26,23 +26,31 @@ module Dor
         end
 
         # Updates the object
-        # @param [Cocina::Models::DRO,Cocina::Models::Collection,Cocina::Models::AdminPolicy] params model object
+        # @param [Cocina::Models::DROWithMetadata|CollectionWithMetadata|AdminPolicyWithMetadata|DRO|Collection|AdminPolicy] params model object
+        # @param [boolean] skip_lock do not provide ETag
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [Cocina::Models::DRO,Cocina::Models::Collection,Cocina::Models::AdminPolicy] the returned model
-        def update(params:)
+        # @raise [BadRequestError] when ETag not provided.
+        # @return [Cocina::Models::DROWithMetadata,Cocina::Models::CollectionWithMetadata,Cocina::Models::AdminPolicyWithMetadata] the returned model
+        # rubocop:disable Metrics/AbcSize
+        def update(params:, skip_lock: false)
+          # Raised if Cocina::Models::*WithMetadata not provided.
+          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.body = params.to_json
+            req.headers['If-Match'] = params[:lock] unless skip_lock
+            req.body = build_json_from_cocina(params)
           end
 
           raise_exception_based_on_response!(resp) unless resp.success?
 
-          Cocina::Models.build(JSON.parse(resp.body))
+          build_cocina_from_response(resp)
         end
+        # rubocop:enable Metrics/AbcSize
 
         # 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.rb

@@ -45,9 +45,14 @@ module Dor
         # Retrieves the Cocina model
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [Cocina::Models::DRO,Cocina::Models::Collection,Cocina::Models::AdminPolicy] the returned model
+        # @return [Cocina::Models::DROWithMetadata,Cocina::Models::CollectionWithMetadata,Cocina::Models::AdminPolicyWithMetadata] the returned model
         def find
-          find_with_metadata.first
+          resp = connection.get do |req|
+            req.url object_path
+          end
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          build_cocina_from_response(resp)
         end
 
         # Retrieves the Cocina model and response metadata
@@ -64,9 +69,12 @@ module Dor
           model = Cocina::Models.build(JSON.parse(resp.body))
 
           # Don't use #slice here as Faraday will downcase the keys.
-          metadata = ObjectMetadata.new(updated_at: resp.headers['Last-Modified'], created_at: resp.headers['X-Created-At'])
+          metadata = ObjectMetadata.new(updated_at: resp.headers['Last-Modified'],
+                                        created_at: resp.headers['X-Created-At'],
+                                        etag: resp.headers['ETag'])
           [model, metadata]
         end
+        deprecation_deprecate find_with_metadata: 'Use find instead with provides models with metadata.'
 
         # Get a list of the collections. (Similar to Valkyrie's find_inverse_references_by)
         # @raise [UnexpectedResponse] if the request is unsuccessful.

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

@@ -9,11 +9,12 @@ module Dor
       class ObjectMetadata
         extend Deprecation
 
-        attr_reader :created_at, :updated_at
+        attr_reader :created_at, :updated_at, :etag
 
-        def initialize(created_at:, updated_at:)
+        def initialize(created_at:, updated_at:, etag: nil)
           @created_at = created_at
           @updated_at = updated_at
+          @etag = etag
         end
 
         def [](key)

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

@@ -12,20 +12,6 @@ module Dor
         # @param assign_doi [Boolean]
         # @return [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAPO] the returned model
         def register(params:, assign_doi: false)
-          json_str = register_response(params: params, assign_doi: assign_doi)
-          json = JSON.parse(json_str)
-
-          Cocina::Models.build(json)
-        end
-
-        private
-
-        # make the registration request to the server
-        # @param params [Hash] optional params (see dor-services-app)
-        # @param assign_doi [Boolean]
-        # @raise [UnexpectedResponse] on an unsuccessful response from the server
-        # @return [String] the raw JSON from the server
-        def register_response(params:, assign_doi:)
           resp = connection.post do |req|
             req.url "#{api_version}/objects"
             req.headers['Content-Type'] = 'application/json'
@@ -34,9 +20,10 @@ module Dor
             req.params[:assign_doi] = true if assign_doi
             req.body = params.to_json
           end
-          return resp.body if resp.success?
 
-          raise_exception_based_on_response!(resp)
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          build_cocina_from_response(resp)
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '8.9.0'
+      VERSION = '9.1.1'
     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,24 +29,31 @@ 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
-                            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
+
+        def build_cocina_from_response(response)
+          cocina_object = Cocina::Models.build(JSON.parse(response.body))
+          Cocina::Models.with_metadata(cocina_object, response.headers['ETag'], created: date_from_header(response, 'X-Created-At'),
+                                                                                modified: date_from_header(response, 'Last-Modified'))
+        end
+
+        def build_json_from_cocina(cocina_object)
+          Cocina::Models.without_metadata(cocina_object).to_json
+        end
+
+        def date_from_header(response, key)
+          response.headers[key]&.to_datetime
         end
-        # rubocop:enable Metrics/MethodLength
       end
     end
   end

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
@@ -46,6 +65,10 @@ module Dor
       # 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 a 412 Precondition Failed.
+      # This occurs when you sent an etag with If-Match, but the etag didn't match the latest version
+      class PreconditionFailedResponse < UnexpectedResponse; end
+
       # Error that is raised when the remote server returns a 400 Bad Request; apps should not retry the request
       class BadRequestError < UnexpectedResponse; end
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 8.9.0
+  version: 9.1.1
 platform: ruby
 authors:
 - Justin Coyne
 - Michael Giarlo
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-18 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -213,7 +213,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - jcoyne@justincoyne.com
 - leftwing@alumni.rutgers.edu
@@ -262,7 +262,7 @@ homepage: https://github.com/sul-dlss/dor-services-client
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -280,8 +280,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A client for dor-services-app
 test_files: []