dor-services-client 10.2.0 → 12.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06256135ae4d1e556af51bd67aa764f3bdf4095503b5e7c41daf9fa32093be49
-  data.tar.gz: 9007c044ff70251c24b9216b447b4190c4162b4f97b8ce2d8c488223d75d0d92
+  metadata.gz: 60325a5c1cf8adb36234b64f76d44b3a0bfd35f432bc015c709a093127cb5280
+  data.tar.gz: 54a8ca1543a6c04c2e5d706f1ccff2a36d3b2e58b578da6416a88361caedc199
 SHA512:
-  metadata.gz: 5ec452bfeb53407eed48aa5342a339e4137c95542547fcf098c7b9d91ba9cb0930e1afb3d42a2ce5c6e6bc0a779e6bd4555250cdb4fb37d566eb1d034b450f4f
-  data.tar.gz: eda0ad02dec02532b6430a46d997d9df4d5aeb963274efd9f08fedbb645d41721b81791d6a7641b7bd0e9834e9a02bafc8ae9e1ce4ece19e747a61b253351837
+  metadata.gz: 69b8b22b5fcef3eb6da7979bdf1134297ee1ec241aa2f547c919526be53d45e390cc1237524f47e4c728555f23c9a59a7ab58d21bd9af9121482110985dd1254
+  data.tar.gz: ebe5b8069b3649324115218bd35249cbb16030ee9d6e3096f8e46bfd468ea8aa4ac3293a519478ce3c36edaba292dbf536bb0e0a6a1ff48a05a26a2ff92ac606

data/README.md

@@ -138,14 +138,6 @@ object_client.metadata.descriptive
 # Get the public XML representation
 object_client.metadata.public_xml
 
-# Update legacy XML representation
-object_client.metadata.legacy_update(
-  descriptive: {
-    updated: Time.now,
-    content: '<descMetadata/>'
-  }
-)
-
 # Return the Cocina metadata
 object_client.find
 

data/dor-services-client.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.7', '< 4' # dor-services-app needs 2.7 due to fedora3
 
   spec.add_dependency 'activesupport', '>= 4.2', '< 8'
-  spec.add_dependency 'cocina-models', '~> 0.77.0' # leave pinned to patch level until cocina-models hits 1.0
+  spec.add_dependency 'cocina-models', '~> 0.80.0' # leave pinned to patch level until cocina-models hits 1.0
   spec.add_dependency 'deprecation', '>= 0'
   spec.add_dependency 'faraday', '~> 2.0'
   spec.add_dependency 'faraday-retry'

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

@@ -17,7 +17,7 @@ module Dor
         # @param params [Hash<Symbol,String>] optional parameter hash
         # @option params [String] :significance set significance (major/minor/patch) of version change - required
         # @option params [String] :description set description of version change - required
-        # @option params [String] :opening_user_name add opening username to the events datastream - optional
+        # @option params [String] :opening_user_name add opening username to the event - optional
         # @option params [String] :workflow the workflow to start - defaults to 'assemblyWF'
         # @return [Boolean] true on success
         # @raise [NotFoundResponse] when the response is a 404 (object not found)

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

@@ -13,32 +13,6 @@ module Dor
           @object_identifier = object_identifier
         end
 
-        # Updates using the legacy SDR/Fedora3 metadata
-        # @param [Hash<Symbol,Hash>] opts the options for legacy update
-        # @option opts [Hash] :administrative Data for administrative metadata
-        # @option opts [Hash] :content Data for structural metadata
-        # @option opts [Hash] :descriptive Data for descriptive metadata
-        # @option opts [Hash] :geo Data for geographic metadata
-        # @option opts [Hash] :identity Data for identity metadata
-        # @option opts [Hash] :provenance Data for provenance metadata
-        # @option opts [Hash] :relationships Data for RELS-EXT metadata
-        # @option opts [Hash] :rights Data for access rights metadata
-        # @option opts [Hash] :technical Data for technical metadata
-        # @option opts [Hash] :version Data for version metadata
-        # @example:
-        #  legacy_update(descriptive: { updated: '2001-12-20', content: '<descMetadata />' })
-        def legacy_update(opts)
-          opts = opts.slice(:administrative, :content, :descriptive, :geo, :identity, :provenance, :relationships, :rights, :technical, :version)
-          resp = connection.patch do |req|
-            req.url "#{base_path}/legacy"
-            req.headers['Content-Type'] = 'application/json'
-            req.body = opts.to_json
-          end
-          return if resp.success?
-
-          raise_exception_based_on_response!(resp, object_identifier)
-        end
-
         # @return [String, NilClass] The Dublin Core XML representation of the object or nil if response is 404
         # @raise [UnexpectedResponse] on an unsuccessful response from the server
         def dublin_core
@@ -87,47 +61,6 @@ module Dor
           raise_exception_based_on_response!(resp, object_identifier)
         end
 
-        # Update the MODS XML metadata
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @return [boolean] true on success
-        def update_mods(mods_xml)
-          resp = connection.put do |req|
-            req.url "#{base_path}/mods"
-            req.headers['Content-Type'] = 'application/xml'
-            req.body = mods_xml
-          end
-          return if resp.success?
-
-          raise_exception_based_on_response!(resp, object_identifier)
-        end
-
-        # rubocop:disable Lint/StructNewOverride
-        Datastream = Struct.new(:label, :dsid, :pid, :size, :mimeType, :versionId, keyword_init: true)
-        # rubocop:enable Lint/StructNewOverride
-
-        # @return [Array] the list of datastreams for the item
-        # @raise [UnexpectedResponse] on an unsuccessful response from the server
-        def datastreams
-          resp = connection.get do |req|
-            req.url "#{base_path}/datastreams"
-          end
-          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
-
-          JSON.parse(resp.body).map { |params| Datastream.new(**params.symbolize_keys!) }
-        end
-
-        # @param [String] dsid the identifier for the datastream
-        # @return [String] the contents of the specified datastream
-        # @raise [UnexpectedResponse] on an unsuccessful response from the server
-        def datastream(dsid)
-          resp = connection.get do |req|
-            req.url "#{base_path}/datastreams/#{dsid}"
-          end
-          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
-
-          resp.body
-        end
-
         private
 
         attr_reader :object_identifier

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

@@ -28,13 +28,14 @@ module Dor
         # Updates the object
         # @param [Cocina::Models::DROWithMetadata|CollectionWithMetadata|AdminPolicyWithMetadata|DRO|Collection|AdminPolicy] params model object
         # @param [boolean] skip_lock do not provide ETag
+        # @param [boolean] validate validate the response object
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
         # @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)
+        def update(params:, skip_lock: false, validate: false)
           raise ArgumentError, 'Cocina object not provided.' unless params.respond_to?(:externalIdentifier)
 
           # Raised if Cocina::Models::*WithMetadata not provided.
@@ -51,7 +52,7 @@ module Dor
 
           raise_exception_based_on_response!(resp) unless resp.success?
 
-          build_cocina_from_response(resp)
+          build_cocina_from_response(resp, validate: validate)
         end
         # rubocop:enable Metrics/AbcSize
         # rubocop:enable Metrics/MethodLength

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

@@ -43,16 +43,17 @@ module Dor
         end
 
         # Retrieves the Cocina model
+        # @param [boolean] validate validate the response object
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
         # @return [Cocina::Models::DROWithMetadata,Cocina::Models::CollectionWithMetadata,Cocina::Models::AdminPolicyWithMetadata] the returned model
-        def find
+        def find(validate: false)
           resp = connection.get do |req|
             req.url object_path
           end
           raise_exception_based_on_response!(resp) unless resp.success?
 
-          build_cocina_from_response(resp)
+          build_cocina_from_response(resp, validate: validate)
         end
 
         # Get a list of the collections. (Similar to Valkyrie's find_inverse_references_by)

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

@@ -10,8 +10,9 @@ module Dor
         # Creates a new object in DOR
         # @param params [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAdminPolicy]
         # @param assign_doi [Boolean]
+        # @param [boolean] validate validate the response object
         # @return [Cocina::Models::DROWithMetadata,Cocina::Models::CollectionWithMetadata,Cocina::Models::AdminPolicyWithMetadata] the returned model
-        def register(params:, assign_doi: false)
+        def register(params:, assign_doi: false, validate: false)
           resp = connection.post do |req|
             req.url "#{api_version}/objects"
             req.headers['Content-Type'] = 'application/json'
@@ -23,7 +24,7 @@ module Dor
 
           raise_exception_based_on_response!(resp) unless resp.success?
 
-          build_cocina_from_response(resp)
+          build_cocina_from_response(resp, validate: validate)
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '10.2.0'
+      VERSION = '12.1.0'
     end
   end
 end

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

@@ -41,8 +41,8 @@ module Dor
                                     errors: data.fetch('errors', []))
         end
 
-        def build_cocina_from_response(response)
-          cocina_object = Cocina::Models.build(JSON.parse(response.body))
+        def build_cocina_from_response(response, validate: false)
+          cocina_object = Cocina::Models.build(JSON.parse(response.body), validate: validate)
           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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 10.2.0
+  version: 12.1.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-02 00:00:00.000000000 Z
+date: 2022-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: 0.80.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: 0.80.0
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -279,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: A client for dor-services-app