dor-services-client 9.1.0 → 10.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4b8ec2c059acbd588a6d64e931035f5552b16bacf9d0e6a1f0b8194fb371bb2
-  data.tar.gz: 750be3e2a2a234299c63ee1aeb6b40c4a0a87116785cf085bc359d80676465da
+  metadata.gz: 7d5e8a1919cb3cf3e1ad0ae59f1d29a0a30d181d330146ddb0cc8a580f5e37a8
+  data.tar.gz: abc969bfa3b1aae80c666d5ab244ca8ca3ebf2bbfe73fde20dabeffa8dfdefea
 SHA512:
-  metadata.gz: d0ffa417486e6136c276b2aa289d4f17e01a798ea288e727ce5b2955b722934ce7b992318ff3c88e3060a57a7cfd2a203b29d0302c6862d79cce80e6f4bab1d9
-  data.tar.gz: f707910e959af48ab45e29a4328217517b42c50f49314ff14e142afed33688d842b2ecfc9df8ea740e59914c31cbbd4d5b5dbff67cbb7b6e1b64e197a7aa1618
+  metadata.gz: 969b9fde995a8598ef1fa33c6aefb18e0fae6aa42fb38ff30ed1c8e6e939622e45921d5c26dbcf19668eb52930a81fd18e44e005345ee51a98da80dcde5f2fe9
+  data.tar.gz: edfe4f38b84cde8a1da06b527d16d1b8a46ccba945db6944809bc1d9748f56d328e449d3921668018e1bc966812a123a70a3508858331e9ac6892992e02f0391

data/.rubocop.yml

@@ -13,7 +13,7 @@ Metrics/BlockLength:
     - 'spec/**/*'
 
 RSpec/MultipleMemoizedHelpers:
-  Max: 10
+  Enabled: false
 
 RSpec/ExampleLength:
   Max: 10

data/README.md

@@ -123,9 +123,11 @@ object_client.notify_goobi
 # Manage versions
 object_client.version.inventory
 object_client.version.current
-object_client.version.openable?(**params)
-object_client.version.open(**params)
-object_client.version.close(description: 'Changed title', significance: 'minor')
+object_client.version.openable?
+# see dor-services-app openapi.yml for optional params
+object_client.version.open(description: 'Changed title', significance: 'minor')
+# see dor-services-app openapi.yml for optional params
+object_client.version.close
 
 # Get the Dublin Core XML representation
 object_client.metadata.dublin_core

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.75.0' # leave pinned to patch level until cocina-models hits 1.0
+  spec.add_dependency 'cocina-models', '~> 0.76.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

@@ -15,10 +15,10 @@ module Dor
 
         # Start accession on an object (start specified workflow, assemblyWF by default, and version if needed)
         # @param params [Hash<Symbol,String>] optional parameter hash
-        # @option params [String] :significance set significance (major/minor/patch) of version change
-        # @option params [String] :description set description of version change
-        # @option params [String] :opening_user_name add opening username to the events datastream
-        # @option params [String] :workflow the workflow to start (defaults to 'assemblyWF')
+        # @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] :workflow the workflow to start - defaults to 'assemblyWF'
         # @return [Boolean] true on success
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.

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

@@ -33,7 +33,10 @@ 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 ArgumentError, 'ETag not provided.' unless skip_lock || params.respond_to?(:lock)
 
@@ -42,7 +45,7 @@ module Dor
             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

@@ -27,15 +27,13 @@ module Dor
         end
 
         # Determines if a new version can be opened for a DOR object.
-        # @param params [Hash] optional params (see dor-services-app)
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
         # @return [Boolean] true if a new version can be opened
         # rubocop:disable Metrics/MethodLength
-        def openable?(**params)
+        def openable?
           resp = connection.get do |req|
             req.url "#{base_path}/openable"
-            req.params = params
           end
 
           raise_exception_based_on_response!(resp) unless resp.success?
@@ -52,20 +50,30 @@ module Dor
         # rubocop:enable Metrics/MethodLength
 
         # Open new version for an object
-        # @param params [Hash] optional params (see dor-services-app)
-        # @raise [MalformedResponse] when the response is not parseable.
+        # @param description [String] a description of the object version being opened - required
+        # @param significance [String] 'major' 'minor' or 'admin' - required
+        # @param opening_user_name [String] sunetid - defaults to nil
+        # @param assume_accessioned [Boolean] if true, does not check whether object has been accessioned; defaults to false
         # @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
-        # @param params [Hash] optional params (see dor-services-app)
+        # @param description [String] (optional) - a description of the object version being opened
+        # @param significance [String] (optional) - 'major' 'minor' or 'admin'
+        # @param user_name [String] (optional) - sunetid
+        # @param start_accession [Boolean] (optional) - whether to start accessioning workflow; defaults to true
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
         # @return [String] a message confirming successful closing
@@ -99,22 +107,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.1.0'
+      VERSION = '10.1.0'
     end
   end
 end

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

@@ -13,6 +13,8 @@ module Dor
           412 => PreconditionFailedResponse
         }.freeze
 
+        JSON_API_MIME_TYPE = 'application/vnd.api+json'
+
         def initialize(connection:, version:)
           @connection = connection
           @api_version = version
@@ -28,7 +30,7 @@ module Dor
         attr_reader :connection, :api_version
 
         def raise_exception_based_on_response!(response, object_identifier = nil)
-          data = if response.headers['content-type'] == 'application/json'
+          data = if response.headers.fetch('content-type', '').start_with?(JSON_API_MIME_TYPE)
                    JSON.parse(response.body)
                  else
                    {}

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 9.1.0
+  version: 10.1.0
 platform: ruby
 authors:
 - Justin Coyne
 - Michael Giarlo
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-04-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.75.0
+        version: 0.76.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.76.0
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -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.3.7
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: A client for dor-services-app
 test_files: []