dor-services-client 15.2.0 → 15.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaec16bd6ab8deb272496997f7e8b3289652e81b01a8fd9b5cf3bbb7e19b04f8
-  data.tar.gz: 0fb8f67b2da1991cc2ae8439d49e1bb3ec526db4d762a17efdaa7612bdbe858f
+  metadata.gz: 7e74ca0ad7c415b3106f4877959eb84fd330a1d6165fde35061b9b8cf329ed2f
+  data.tar.gz: 467ca654ab6c53959a8cfa59f8379357129de3f531a236091712c798ec6d24eb
 SHA512:
-  metadata.gz: 7035e7003d3ac05987dd5ecdb902040ab3f5a5ac57c74fe245e7745e502b7a60ec4319fe0f9ac2f68713e062f46094493de01d3c748fdf93b6acb708a80240b2
-  data.tar.gz: 87950288c58bef7e0795d05908a2a5fb700c3651ff0b780c54289e8f3ec66b9ac6c1c25415e54a3d5f16837b46a3835f21406223db9d277979abf82f15e3cfdd
+  metadata.gz: bbbd6072449d6d5204e446c314ea3e5b334ab7678ad3e99e6c04332a1020f97c8c2d6db5621f68958d19aa899f0790b47d78ca0bda2bf43107c6f54113cb7724
+  data.tar.gz: 57c5d87ca0045680736832ba487417add78b9a0a85a7f78192a470dd311d189d27f0f13f6e4219cedc24c962b8abe2f19ff93a2c772111289d8aa32d8ab58728

data/.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2.1
 orbs:
-  ruby-rails: sul-dlss/ruby-rails@4.2.2
+  ruby-rails: sul-dlss/ruby-rails@4.2.3
 workflows:
   build:
     jobs:

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    dor-services-client (15.2.0)
-      activesupport (>= 4.2, < 8)
+    dor-services-client (15.3.0)
+      activesupport (>= 7.0.0)
       cocina-models (~> 0.99.0)
       deprecation
       faraday (~> 2.0)
@@ -12,8 +12,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.2.1.1)
+    activesupport (8.0.1)
       base64
+      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
@@ -23,15 +24,18 @@ GEM
       minitest (>= 5.1)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
     attr_extras (7.1.0)
     base64 (0.2.0)
-    bigdecimal (3.1.8)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
     byebug (11.1.3)
-    cocina-models (0.99.0)
+    cocina-models (0.99.2)
       activesupport
+      commonmarker (= 2.0.1)
       deprecation
       dry-struct (~> 1.0)
       dry-types (~> 1.1)
@@ -45,9 +49,9 @@ GEM
       super_diff
       thor
       zeitwerk (~> 2.1)
-    commonmarker (1.1.5-arm64-darwin)
-    commonmarker (1.1.5-x86_64-darwin)
-    commonmarker (1.1.5-x86_64-linux)
+    commonmarker (2.0.1-arm64-darwin)
+    commonmarker (2.0.1-x86_64-darwin)
+    commonmarker (2.0.1-x86_64-linux)
     concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     crack (1.0.0)
@@ -58,13 +62,15 @@ GEM
     diff-lcs (1.5.1)
     docile (1.4.1)
     drb (2.2.1)
-    dry-core (1.0.1)
+    dry-core (1.1.0)
       concurrent-ruby (~> 1.0)
+      logger
       zeitwerk (~> 2.6)
-    dry-inflector (1.1.0)
-    dry-logic (1.5.0)
+    dry-inflector (1.2.0)
+    dry-logic (1.6.0)
+      bigdecimal
       concurrent-ruby (~> 1.0)
-      dry-core (~> 1.0, < 2)
+      dry-core (~> 1.1)
       zeitwerk (~> 2.6)
     dry-struct (1.6.0)
       dry-core (~> 1.0, < 2)
@@ -78,43 +84,43 @@ GEM
       dry-inflector (~> 1.0)
       dry-logic (~> 1.4)
       zeitwerk (~> 2.6)
-    edtf (3.1.1)
-      activesupport (>= 3.0, < 8.0)
+    edtf (3.2.0)
+      activesupport (>= 3.0, < 9.0)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    faraday (2.12.0)
-      faraday-net_http (>= 2.0, < 3.4)
+    faraday (2.12.2)
+      faraday-net_http (>= 2.0, < 3.5)
       json
       logger
-    faraday-net_http (3.3.0)
-      net-http
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
     faraday-retry (2.2.1)
       faraday (~> 2.0)
-    hashdiff (1.1.1)
+    hashdiff (1.1.2)
     i18n (1.14.6)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    json (2.7.2)
+    json (2.9.1)
     jsonpath (1.1.5)
       multi_json
     language_server-protocol (3.17.0.3)
-    logger (1.6.1)
-    minitest (5.25.1)
+    logger (1.6.4)
+    minitest (5.25.4)
     multi_json (1.15.0)
-    net-http (0.4.1)
+    net-http (0.6.0)
       uri
-    nokogiri (1.16.7-arm64-darwin)
+    nokogiri (1.18.1-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-darwin)
+    nokogiri (1.18.1-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-linux)
+    nokogiri (1.18.1-x86_64-linux-gnu)
       racc (~> 1.4)
     openapi3_parser (0.10.0)
       commonmarker (>= 1.0)
     openapi_parser (1.0.0)
-    optimist (3.1.0)
+    optimist (3.2.0)
     parallel (1.26.3)
-    parser (3.3.5.0)
+    parser (3.3.6.0)
       ast (~> 2.4.1)
       racc
     patience_diff (1.2.0)
@@ -123,8 +129,8 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.9.2)
-    rexml (3.3.8)
+    regexp_parser (2.10.0)
+    rexml (3.4.0)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -137,18 +143,18 @@ GEM
     rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.67.0)
+    rspec-support (3.13.2)
+    rubocop (1.69.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rubocop-ast (>= 1.32.2, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.3)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.37.0)
       parser (>= 3.3.1.0)
     rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
@@ -162,22 +168,24 @@ GEM
     rubocop-rspec_rails (2.29.1)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    securerandom (0.3.1)
+    securerandom (0.4.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    super_diff (0.13.0)
+    super_diff (0.14.0)
       attr_extras (>= 6.2.4)
       diff-lcs
       patience_diff
     thor (1.3.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.6.0)
-    uri (0.13.1)
+    unicode-display_width (3.1.3)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.2)
     webmock (3.24.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -186,6 +194,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-23
+  arm64-darwin-24
   x86_64-darwin-19
   x86_64-darwin-20
   x86_64-darwin-21

data/README.md

@@ -66,6 +66,9 @@ objects_client.register(params: {}, assign_doi: true)
 # Find object by source ID
 objects_client.find(source_id: 'sul:abc123')
 
+# Get status for a batch of objects
+objects_client.statuses(object_ids: ['druid:bc123df4567', 'druid:bc987gh6543'])
+
 # Interact with virtual objects
 virtual_objects_client = Dor::Services::Client.virtual_objects
 
@@ -87,39 +90,23 @@ object_client.update(params: dro)
 # Publish an object (push to PURL)
 object_client.publish(workflow: 'releaseWF', lane_id: 'low')
 
-# Shelve an object (push to Stacks)
-object_client.shelve(lane_id: 'low')
-
 # Start accessioning an object (initialize assemblyWF or specified workflow, and version object if needed)
 object_client.accession.start(**versioning_params)
 
-# Preserve an object (push to SDR)
-object_client.preserve(lane_id: 'low')
-
-# Update the MARC record (used in the releaseWF)
-object_client.update_marc_record
-
-# Update the DOI metadata (used by robot)
-object_client.update_doi_metadata
-
-# Update the Orcid work (used by robot)
-object_client.update_orcid_work
-
 # Copy metadata from Symphony into descMetadata
 object_client.refresh_descriptive_metadata_from_ils
 
 # Apply defaults from the item's AdminPolicy to the item itself
 object_client.apply_admin_policy_defaults
 
-# Send a notification to goobi
-object_client.notify_goobi
-
 # Manage versions
 object_client.version.inventory
 object_client.version.current
 # Returns a struct containing the status.
 # Status includes whether the object is open, assembling, accessioning, or closeable.
+# See also objects_client.statuses for getting statuses in batch.
 object_client.version.status
+
 # see dor-services-app openapi.yml for optional params
 object_client.version.open(description: 'Changed title')
 # see dor-services-app openapi.yml for optional params
@@ -160,9 +147,8 @@ object_client.release_tags.list(public: true) # only public release tags (i.e. l
 object_client.events.create(type: type, data: data)
 object_client.events.list
 
-# Create and reset workspaces
+# Create workspaces
 object_client.workspace.create(source: object_path_string)
-object_client.workspace.cleanup
 
 # Reindex
 object_client.reindex

data/dor-services-client.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 3.0', '< 4'
 
-  spec.add_dependency 'activesupport', '>= 4.2', '< 8'
+  spec.add_dependency 'activesupport', '>= 7.0.0'
   spec.add_dependency 'cocina-models', '~> 0.99.0'
   spec.add_dependency 'deprecation', '>= 0'
   spec.add_dependency 'faraday', '~> 2.0'

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

@@ -107,8 +107,6 @@ module Dor
           Transfer.new(**parent_params)
         end
 
-        delegate :publish, :preserve, :shelve, to: :transfer
-
         def mutate
           Mutate.new(**parent_params)
         end
@@ -118,68 +116,41 @@ module Dor
         alias refresh_metadata refresh_descriptive_metadata_from_ils
         deprecation_deprecate refresh_metadata: 'Use refresh_descriptive_metadata_from_ils instead'
 
-        # Update the marc record for the given object
+        # Reindex the object in Solr.
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
         # @return [boolean] true on success
-        def update_marc_record
-          resp = connection.post do |req|
-            req.url "#{object_path}/update_marc_record"
-          end
-          return true if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
-        # Update the DOI metadata at DataCite
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @return [boolean] true on success
-        def update_doi_metadata
-          resp = connection.post do |req|
-            req.url "#{object_path}/update_doi_metadata"
-          end
-          return true if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
-        # Update the ORCID Work
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @return [Boolean] true on success
-        def update_orcid_work
+        def reindex
           resp = connection.post do |req|
-            req.url "#{object_path}/update_orcid_work"
+            req.url "#{object_path}/reindex"
           end
           return true if resp.success?
 
           raise_exception_based_on_response!(resp)
         end
 
-        # Notify the external Goobi system for a new object that was registered in DOR
+        # Publish an object (send to PURL)
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [boolean] true on success
-        def notify_goobi
-          resp = connection.post do |req|
-            req.url "#{object_path}/notify_goobi"
+        # @param [String] workflow (nil) which workflow to callback to.
+        # @param [String] lane_id for prioritization (default or low)
+        # @return [String] the URL of the background job on dor-service-app
+        # rubocop:disable Metrics/MethodLength
+        def publish(workflow: nil, lane_id: nil)
+          query_params = [].tap do |params|
+            params << "workflow=#{workflow}" if workflow
+            params << "lane-id=#{lane_id}" if lane_id
           end
-          return true if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
-        # Reindex the object in Solr.
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [boolean] true on success
-        def reindex
+          query_string = query_params.any? ? "?#{query_params.join('&')}" : ''
+          publish_path = "#{object_path}/publish#{query_string}"
           resp = connection.post do |req|
-            req.url "#{object_path}/reindex"
+            req.url publish_path
           end
-          return true if resp.success?
+          return resp.headers['Location'] if resp.success?
 
           raise_exception_based_on_response!(resp)
         end
+        # rubocop:enable Metrics/MethodLength
 
         private
 

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

@@ -41,6 +41,22 @@ module Dor
           build_cocina_from_response(resp, validate: validate)
         end
 
+        # Retrieves the version statuses for a batch of objects
+        # @param [Array<String>] object_ids the druids to get statuses for
+        # @return [Hash<String,VersionStatus>] Map of druids to statuses
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        def statuses(object_ids:)
+          resp = connection.post do |req|
+            req.url "#{objects_path}/versions/status"
+            req.headers['Content-Type'] = 'application/json'
+            req.body = { externalIdentifiers: object_ids }.to_json
+          end
+
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          JSON.parse(resp.body).transform_values { |status| ObjectVersion::VersionStatus.new(status.symbolize_keys!) }
+        end
+
         private
 
         def objects_path

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '15.2.0'
+      VERSION = '15.3.0'
     end
   end
 end

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

@@ -31,24 +31,6 @@ module Dor
         end
         # rubocop:enable Metrics/AbcSize
 
-        # Cleans up and resets the workspace
-        # After an object has been copied to preservation the workspace can be
-        # reset. This is called by the reset-workspace step of the accessionWF
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @param [String] lane_id for prioritization (default or low)
-        # @return [String] the URL of the background job on dor-service-app
-        def cleanup(lane_id: nil)
-          cleanup_workspace_path = workspace_path
-          cleanup_workspace_path += "?lane-id=#{lane_id}" if lane_id
-          resp = connection.delete do |req|
-            req.url cleanup_workspace_path
-          end
-          return resp.headers['Location'] if resp.success?
-
-          raise_exception_based_on_response!(resp, object_identifier)
-        end
-
         private
 
         def workspace_path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 15.2.0
+  version: 15.3.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-28 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,20 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: cocina-models
   requirement: !ruby/object:Gem::Requirement
@@ -252,7 +246,6 @@ files:
 - lib/dor/services/client/release_tag.rb
 - lib/dor/services/client/release_tags.rb
 - lib/dor/services/client/response_error_formatter.rb
-- lib/dor/services/client/transfer.rb
 - lib/dor/services/client/user_version.rb
 - lib/dor/services/client/version.rb
 - lib/dor/services/client/versioned_service.rb

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

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Services
-    class Client
-      # API calls that move data around.
-      class Transfer < VersionedService
-        # @param object_identifier [String] the pid for the object
-        def initialize(connection:, version:, object_identifier:)
-          super(connection: connection, version: version)
-          @object_identifier = object_identifier
-        end
-
-        # Publish an object (send to PURL)
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @param [String] workflow (nil) which workflow to callback to.
-        # @param [String] lane_id for prioritization (default or low)
-        # @return [String] the URL of the background job on dor-service-app
-        def publish(workflow: nil, lane_id: nil)
-          query_params = [].tap do |params|
-            params << "workflow=#{workflow}" if workflow
-            params << "lane-id=#{lane_id}" if lane_id
-          end
-          query_string = query_params.any? ? "?#{query_params.join('&')}" : ''
-          publish_path = "#{object_path}/publish#{query_string}"
-          resp = connection.post do |req|
-            req.url publish_path
-          end
-          return resp.headers['Location'] if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
-        # Preserve an object (send to SDR)
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @param [String] lane_id for prioritization (default or low)
-        # @return [String] URL from Location response header if no errors
-        def preserve(lane_id: nil)
-          query_string = lane_id ? "?lane-id=#{lane_id}" : ''
-          resp = connection.post do |req|
-            req.url "#{object_path}/preserve#{query_string}"
-          end
-          return resp.headers['Location'] if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
-        # Shelve an object (send to Stacks)
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @param [String] lane_id for prioritization (default or low)
-        # @return [boolean] true on success
-        def shelve(lane_id: nil)
-          query_string = lane_id ? "?lane-id=#{lane_id}" : ''
-          resp = connection.post do |req|
-            req.url "#{object_path}/shelve#{query_string}"
-          end
-          return resp.headers['Location'] if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
-        private
-
-        def object_path
-          "#{api_version}/objects/#{object_identifier}"
-        end
-
-        attr_reader :object_identifier
-      end
-    end
-  end
-end