dor-services-client 15.13.0 → 15.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 565b25455d31d878a49e800e34b6b3b096322762300a7042ae677ed650ff21a5
-  data.tar.gz: 8c9f6acc0a76f4ac7da4b3190a3e1d4e5e349ccc9678d487f23fa3ee237e3d65
+  metadata.gz: 0cddd625cce276c478e27e4c996690f8a8edcab5115981f84af0fb916cf5e81d
+  data.tar.gz: 9e81af88e194dfb37e55f75b94a24d3ecb33cccdac6571c09cc931e0ebccf171
 SHA512:
-  metadata.gz: 94e719800898ca73d2028dd144a184e7ca98b5958b421846a8380bd176b7f5eef64e921e0cc3f973ed62b7607e29e801dfa64fc771d19d995cb7d00dec01f84a
-  data.tar.gz: 337a076d2a17c2eb7201fc7f038f53018582f26c22fdbbfd61caf05268e382e8911e6aafaa8f20aaa9c64aafcf3681fc84ce0efbb2dc31174b89c9c5ad10ec23
+  metadata.gz: d010eed7fdfc3cae2d84c87686a52333822ecb204d772f44c30ecff51d0522b59ec09334ab3a2aaddc434cc2fda9d61beabd8a82aa4e5fb9a20455c4854b7822
+  data.tar.gz: 2781234795ae013152b0cfd5c13d95757db81e4468f45fddb703fd801c17a7b765cf7348a35b34368aa8f2294c49e4b51745b144248647ff6c98fab89bc51443

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dor-services-client (15.13.0)
+    dor-services-client (15.15.0)
       activesupport (>= 7.0.0)
       cocina-models (~> 0.104.1)
       deprecation

data/README.md

@@ -158,6 +158,15 @@ object_client.workflows
 object_client.workflow('accessionWF').find
 # Create workflow
 object_client.workflow('etdSubmitWF').create(version: 2)
+# Skip all workflow steps
+object_client.workflow('accessionWF').skip_all(note: 'Cleaning up')
+
+# Get the status of a workflow process
+object_client.workflow('accessionWF').process('shelve').status
+=> 'completed'
+# Update workflow processes
+object_client.workflow('accessionWF').process('shelve').update(status: 'completed')
+object_client.workflow('accessionWF').process('shelve').update_error(error_msg: 'Something went wrong', error_text: 'Detailed error message')
 
 # List milestones
 object_client.milestones.list

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

@@ -13,12 +13,19 @@ module Dor
           @workflow_name = workflow_name
         end
 
+        # @return [Dor::Services::Client::Process]
+        def process(process)
+          @process ||= Process.new(connection: connection, version: api_version, object_identifier: object_identifier,
+                                   workflow_name: workflow_name, process: process, object_workflow_client: self)
+        end
+
         # @return [Workflow::Response::Workflow]
         def find
           resp = connection.get do |req|
             req.url "#{api_version}/objects/#{object_identifier}/workflows/#{workflow_name}"
             req.headers['Accept'] = 'application/xml'
           end
+
           raise_exception_based_on_response!(resp) unless resp.success?
 
           Dor::Services::Response::Workflow.new(xml: Nokogiri::XML(resp.body))
@@ -37,6 +44,18 @@ module Dor
             req.headers['Content-Type'] = 'application/json'
             req.body = { context: context }.to_json if context
           end
+
+          raise_exception_based_on_response!(resp) unless resp.success?
+        end
+
+        # Skips all steps in a workflow.
+        # @param note [String] a note to be added to the skipped steps
+        def skip_all(note:)
+          resp = connection.post do |req|
+            req.url "#{api_version}/objects/#{object_identifier}/workflows/#{workflow_name}/skip_all"
+            req.params['note'] = note
+          end
+
           raise_exception_based_on_response!(resp) unless resp.success?
         end
 

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls around workflow process for an object.
+      class Process < VersionedService
+        # @param object_identifier [String] the druid for the object
+        # @param [String] workflow_name The name of the workflow
+        # @param [String] process The name of the workflow step
+        def initialize(connection:, version:, object_identifier:, workflow_name:, process:, object_workflow_client:) # rubocop:disable Metrics/ParameterLists
+          super(connection: connection, version: version)
+          @object_identifier = object_identifier
+          @workflow_name = workflow_name
+          @process = process
+          @object_workflow_client = object_workflow_client
+        end
+
+        # Retrieves the process status of the given workflow for the given object identifier
+        # @return [String,nil] status
+        def status
+          doc = object_workflow_client.find.xml
+
+          processes = doc.root.xpath("//process[@name='#{process}']")
+          process = processes.max { |a, b| a.attr('version').to_i <=> b.attr('version').to_i }
+          process&.attr('status')
+        end
+
+        # Updates the status of one step in a workflow.
+        # @param [String] status The status of the process.
+        # @param [Float] elapsed The number of seconds it took to complete this step. Can have a decimal.  Is set to 0 if not passed in.
+        # @param [String] lifecycle Bookeeping label for this particular workflow step.  Examples are: 'registered', 'shelved'
+        # @param [String] note Any kind of string annotation that you want to attach to the workflow
+        # @param [String] current_status Setting this string tells the workflow service to compare the current status to this value.
+        # @raise [Dor::Services::Client::ConflictResponse] if the current status does not match the value passed in current_status.
+        def update(status:, elapsed: 0, lifecycle: nil, note: nil, current_status: nil)
+          perform_update(status: status, elapsed: elapsed, lifecycle: lifecycle, note: note, current_status: current_status)
+        end
+
+        # Updates the status of one step in a workflow to error.
+        # @param [String] error_msg The error message.  Ideally, this is a brief message describing the error
+        # @param [String] error_text A slot to hold more information about the error, like a full stacktrace
+        def update_error(error_msg:, error_text: nil)
+          perform_update(status: 'error', error_msg: error_msg, error_text: error_text)
+        end
+
+        private
+
+        attr_reader :object_identifier, :workflow_name, :process, :object_workflow_client
+
+        def perform_update(**payload)
+          resp = connection.put do |req|
+            req.url "#{api_version}/objects/#{object_identifier}/workflows/#{workflow_name}/processes/#{process}"
+            req.headers['Content-Type'] = 'application/json'
+            req.body = payload.compact.to_json
+          end
+
+          raise_exception_based_on_response!(resp) unless resp.success?
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '15.13.0'
+      VERSION = '15.15.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 15.13.0
+  version: 15.15.0
 platform: ruby
 authors:
 - Justin Coyne
 - Michael Giarlo
 bindir: exe
 cert_chain: []
-date: 2025-06-26 00:00:00.000000000 Z
+date: 2025-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -258,6 +258,7 @@ files:
 - lib/dor/services/client/object_workflow.rb
 - lib/dor/services/client/object_workflows.rb
 - lib/dor/services/client/objects.rb
+- lib/dor/services/client/process.rb
 - lib/dor/services/client/release_tag.rb
 - lib/dor/services/client/release_tags.rb
 - lib/dor/services/client/response_error_formatter.rb