dor-services-client 8.9.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd831afabe6f8b712e16458615dee51078f11b1c21493049c31b7d2902ec4ef5
-  data.tar.gz: 614d459c2f0c0b983e6571287c5ed8085c374c250286e704c47f54b397327717
+  metadata.gz: 6420f39cd3b4f4d1e125929725e7a749fdef2b4a3b41008fd6d6d440708aaba8
+  data.tar.gz: 3690b2a21d44ad9cc830a04f58117731bc4ab53f5d495edc5c4a0846150cd737
 SHA512:
-  metadata.gz: dd27923de9216158f004ee5a823d42aef5b80fd248601a8b9d1dcdadbc15fd75ce8d9d7e9f519413c2685087acbf6531bf3f77a126926d8af17617e7b7d05087
-  data.tar.gz: d3117d28b8380223d7a4df9724db53ed97fbd4b570af68c3fd44905d8d961f415dffe6a9e79761cdd659e7101aac26b52e550691b7628c537fba4915483c571d
+  metadata.gz: 1130a9e3510b4db1a1d383647de3e9c3c87f8b426c40586326ff88c300bb7508749c29eab8fcc35c5cb91db1cc0458fbc3b1949f12004bc3a4fa2cad9109db68
+  data.tar.gz: 63459db88fccc089c36c02b8a6496988edfa628844b04eb8991563c3fce014c88def669b5f452f48144a1e4c0bd87b2172bb1c674567295b31b280924f86124f

data/.rubocop.yml

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

data/.rubocop_todo.yml

@@ -46,12 +46,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/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 BadRequestError, '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.0.0'
     end
   end
 end

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

@@ -30,6 +30,8 @@ module Dor
                               NotFoundResponse
                             when 409
                               ConflictResponse
+                            when 412
+                              PreconditionFailedResponse
                             else
                               UnexpectedResponse
                             end
@@ -37,6 +39,20 @@ module Dor
                 ResponseErrorFormatter.format(response: response, object_identifier: object_identifier)
         end
         # rubocop:enable Metrics/MethodLength
+
+        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
       end
     end
   end

data/lib/dor/services/client.rb

@@ -46,6 +46,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 8.9.0
+  version: 9.0.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-18 00:00:00.000000000 Z
+date: 2022-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport