dor-services-client 15.12.0 → 15.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d25cb073f436c9dd92ecc738e8279216a84088e61d9452a4f7c81c9889e3138
-  data.tar.gz: 2d7db7153e6227ac47e93952ae44600fc0d7f1187127f96521bc4cdcbcd7b7a2
+  metadata.gz: bd62911db328e4acec57538baa18003ff2525c02929f2f96adbd9df74ba43e30
+  data.tar.gz: 9591c4c8977d9a81cffbf46a300e04778a60330c0ce9d9743232cc72bcca56e8
 SHA512:
-  metadata.gz: 59aee4af11f92713f68e2a114af9db4be1cb684fd2d06660463a57c3bf9762dccfffad527c441abfe4cf8ac6a607f010676765b1d01b2792c955216a62b23f12
-  data.tar.gz: 903bc3b83d1c664cd9b198e0a1985ad0e9727bb8fb50502e74faa265c7dbce3dd103e3fbc35e92a4af4617437dbcd2c70abf4dc8a6ff1248606e73a5388e70e9
+  metadata.gz: 8fa6acadd9432a53789fd3d33ab07bafca9d1078544536c80e2bfa661490921201a781c84e1b0a1898264c62e5d5a7d19ac95316409f894b074f88de917d91ea
+  data.tar.gz: 359df5ae75ca8e63aa4cc5d3fd56e13ce716e3ec67d3e74c4535906f573f4419c041683b1008cd563d098d0fbcf8750b698fe497ad85d825efd9d56528a6a379

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    dor-services-client (15.12.0)
+    dor-services-client (15.14.0)
       activesupport (>= 7.0.0)
-      cocina-models (~> 0.104.0)
+      cocina-models (~> 0.104.1)
       deprecation
       faraday (~> 2.0)
       faraday-retry
+      nokogiri
       zeitwerk (~> 2.1)
 
 GEM
@@ -33,7 +34,7 @@ GEM
     benchmark (0.4.1)
     bigdecimal (3.2.2)
     byebug (12.0.0)
-    cocina-models (0.104.0)
+    cocina-models (0.104.1)
       activesupport
       deprecation
       dry-struct (~> 1.0)

data/README.md

@@ -152,6 +152,25 @@ object_client.workspace.create(source: object_path_string)
 # Reindex
 object_client.reindex
 
+# List workflows
+object_client.workflows
+# Find workflow
+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')
+
+# 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
+# Get the date for a milestone
+object_client.milestones.date(milestone_name: 'published')
+
 # Search for administrative tags:
 Dor::Services::Client.administrative_tags.search(q: 'Project')
 

data/dor-services-client.gemspec

@@ -25,10 +25,11 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 3.0', '< 4'
 
   spec.add_dependency 'activesupport', '>= 7.0.0'
-  spec.add_dependency 'cocina-models', '~> 0.104.0'
+  spec.add_dependency 'cocina-models', '~> 0.104.1'
   spec.add_dependency 'deprecation', '>= 0'
   spec.add_dependency 'faraday', '~> 2.0'
   spec.add_dependency 'faraday-retry'
+  spec.add_dependency 'nokogiri'
   spec.add_dependency 'zeitwerk', '~> 2.1'
 
   spec.add_development_dependency 'bundler'

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls around milestones
+      class Milestones < VersionedService
+        # @param object_identifier [String] the druid for the object
+        def initialize(connection:, version:, object_identifier:)
+          super(connection: connection, version: version)
+          @object_identifier = object_identifier
+        end
+
+        # Returns the Date for a requested milestone from workflow lifecycle
+        #
+        # @param [String] druid object id
+        # @param [String] milestone_name the name of the milestone being queried for
+        # @param [Number] version (nil) the version to query for
+        # @param [Boolean] active_only (false) if true, return only lifecycle steps for versions that have all processes complete
+        # @return [Time] when the milestone was achieved.  Returns nil if the milestone does not exist
+        def date(milestone_name:, version: nil, active_only: false)
+          filter_milestone(query_lifecycle(version: version, active_only: active_only), milestone_name)
+        end
+
+        # @return [Array<Hash>]
+        def list
+          doc = query_lifecycle(active_only: false)
+          doc.xpath('//lifecycle/milestone').collect do |node|
+            { milestone: node.text, at: Time.parse(node['date']), version: node['version'] }
+          end
+        end
+
+        private
+
+        attr_reader :object_identifier
+
+        def filter_milestone(lifecycle_doc, milestone_name)
+          milestone = lifecycle_doc.at_xpath("//lifecycle/milestone[text() = '#{milestone_name}']")
+          return unless milestone
+
+          Time.parse(milestone['date'])
+        end
+
+        # @param [String] druid object id
+        # @param [Boolean] active_only (false) if true, return only lifecycle steps for versions that have all processes complete
+        # @param [Number] version the version to query for
+        # @return [Nokogiri::XML::Document]
+        # @example An example lifecycle xml from the workflow service.
+        #   <lifecycle objectId="druid:ct011cv6501">
+        #     <milestone date="2010-04-27T11:34:17-0700">registered</milestone>
+        #     <milestone date="2010-04-29T10:12:51-0700">inprocess</milestone>
+        #     <milestone date="2010-06-15T16:08:58-0700">released</milestone>
+        #   </lifecycle>
+        #
+        def query_lifecycle(active_only:, version: nil)
+          resp = connection.get do |req|
+            req.url "#{api_version}/objects/#{object_identifier}/lifecycles"
+            req.headers['Accept'] = 'application/xml'
+            req.params['version'] = version if version
+            req.params['active-only'] = 'true' if active_only
+          end
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          Nokogiri::XML(resp.body)
+        end
+      end
+    end
+  end
+end

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

@@ -46,6 +46,18 @@ module Dor
           @accession ||= Accession.new(**parent_params.merge(params))
         end
 
+        def milestones
+          @milestones ||= Milestones.new(**parent_params)
+        end
+
+        def workflows
+          @workflows ||= ObjectWorkflows.new(**parent_params).list
+        end
+
+        def workflow(workflow_name)
+          @workflow ||= ObjectWorkflow.new(**parent_params.merge({ workflow_name: workflow_name }))
+        end
+
         # Retrieves the Cocina model
         # @param [boolean] validate validate the response object
         # @raise [NotFoundResponse] when the response is a 404 (object not found)

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls around workflow for an object.
+      class ObjectWorkflow < VersionedService
+        # @param object_identifier [String] the druid for the object
+        # @param [String] workflow_name The name of the workflow
+        def initialize(connection:, version:, object_identifier:, workflow_name:)
+          super(connection: connection, version: version)
+          @object_identifier = object_identifier
+          @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)
+        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))
+        end
+
+        # Creates a workflow for a given object in the repository.  If this particular workflow for this objects exists,
+        # it will replace the old workflow.
+        # @param [Integer] version
+        # @param [String] lane_id adds laneId attribute to all process elements in the wf_xml workflow xml.  Defaults to a value of 'default'
+        # @param [Hash] context optional context to be included in the workflow (same for all processes for a given druid/version pair)
+        def create(version:, lane_id: 'default', context: nil) # rubocop:disable Metrics/AbcSize
+          resp = connection.post do |req|
+            req.url "#{api_version}/objects/#{object_identifier}/workflows/#{workflow_name}"
+            req.params['version'] = version
+            req.params['lane-id'] = lane_id
+            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
+
+        private
+
+        attr_reader :object_identifier, :workflow_name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls around workflows for an object.
+      class ObjectWorkflows < VersionedService
+        # @param object_identifier [String] the druid for the object
+        def initialize(connection:, version:, object_identifier:)
+          super(connection: connection, version: version)
+          @object_identifier = object_identifier
+        end
+
+        # Retrieves all workflows for the given object
+        # @return [Dor::Services::Response::Workflows]
+        def list
+          resp = connection.get do |req|
+            req.url "#{api_version}/objects/#{object_identifier}/workflows"
+            req.headers['Accept'] = 'application/xml'
+          end
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          Dor::Services::Response::Workflows.new(xml: Nokogiri::XML(resp.body))
+        end
+
+        private
+
+        attr_reader :object_identifier
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# 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:)
+          super(connection: connection, version: version)
+          @object_identifier = object_identifier
+          @workflow_name = workflow_name
+          @process = process
+        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)
+          # 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))
+        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
+
+        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.12.0'
+      VERSION = '15.14.0'
     end
   end
 end

data/lib/dor/services/client.rb

@@ -10,6 +10,7 @@ require 'active_support/json'
 require 'cocina/models'
 require 'faraday'
 require 'faraday/retry'
+require 'nokogiri'
 require 'singleton'
 require 'zeitwerk'
 

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    module Response
+      # Represents the status of an object doing a workflow process
+      class Process
+        # @params [Workflow] parent
+        # @params [Hash] attributes
+        def initialize(parent:, **attributes)
+          @parent = parent
+          @attributes = attributes
+        end
+
+        def name
+          @attributes[:name].presence
+        end
+
+        def status
+          @attributes[:status].presence
+        end
+
+        def datetime
+          @attributes[:datetime].presence
+        end
+
+        def elapsed
+          @attributes[:elapsed].presence
+        end
+
+        def attempts
+          @attributes[:attempts].presence
+        end
+
+        def lifecycle
+          @attributes[:lifecycle].presence
+        end
+
+        def note
+          @attributes[:note].presence
+        end
+
+        def error_message
+          @attributes[:errorMessage].presence
+        end
+
+        def lane_id
+          @attributes[:laneId].presence
+        end
+
+        # @return [Hash] the context for the process (or empty hash if none present)
+        def context
+          return {} unless @attributes[:context].present?
+
+          JSON.parse(@attributes[:context])
+        end
+
+        delegate :pid, :workflow_name, to: :parent
+
+        private
+
+        attr_reader :parent
+      end
+    end
+  end
+end

data/lib/dor/services/response/workflow.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    module Response
+      # The response from asking the server about a workflow for an item
+      class Workflow
+        def initialize(xml:)
+          @xml = xml
+        end
+
+        def pid
+          workflow['objectId']
+        end
+
+        def workflow_name
+          workflow['id']
+        end
+
+        # Check if there are any processes for the provided version.
+        # @param [Integer] version the version we are checking for.
+        def active_for?(version:)
+          result = ng_xml.at_xpath("/workflow/process[@version=#{version}]")
+          result ? true : false
+        end
+
+        # Returns the process, for the most recent version that matches the given name:
+        def process_for_recent_version(name:)
+          nodes = process_nodes_for(name: name)
+          node = nodes.max { |a, b| a.attr('version').to_i <=> b.attr('version').to_i }
+          to_process(node)
+        end
+
+        def empty?
+          ng_xml.xpath('/workflow/process').empty?
+        end
+
+        # Check if all processes are skipped or complete for the provided version.
+        # @param [Integer] version the version we are checking for.
+        def complete_for?(version:)
+          # ng_xml.xpath("/workflow/process[@version=#{version}]/@status").map(&:value).all? { |p| %w[skipped completed].include?(p) }
+          incomplete_processes_for(version: version).empty?
+        end
+
+        def complete?
+          complete_for?(version: version)
+        end
+
+        def incomplete_processes_for(version:)
+          process_nodes = ng_xml.xpath("/workflow/process[@version=#{version}]")
+          incomplete_process_nodes = process_nodes.reject { |process_node| %w[skipped completed].include?(process_node.attr('status')) }
+          incomplete_process_nodes.map { |process_node| to_process(process_node) }
+        end
+
+        def incomplete_processes
+          incomplete_processes_for(version: version)
+        end
+
+        attr_reader :xml
+
+        private
+
+        # Return the max version in this workflow document
+        def version
+          ng_xml.xpath('/workflow/process/@version').map { |attr| attr.value.to_i }.max
+        end
+
+        def workflow
+          ng_xml.at_xpath('workflow')
+        end
+
+        def process_nodes_for(name:)
+          ng_xml.xpath("/workflow/process[@name = '#{name}']")
+        end
+
+        def ng_xml
+          @ng_xml ||= Nokogiri::XML(@xml)
+        end
+
+        def to_process(node)
+          attributes = node ? node.attributes.to_h { |k, v| [k.to_sym, v.value] } : {}
+          Process.new(parent: self, **attributes)
+        end
+      end
+    end
+  end
+end

data/lib/dor/services/response/workflows.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    module Response
+      # The response from asking the server about all workflows for an item
+      class Workflows
+        def initialize(xml:)
+          @xml = xml
+        end
+
+        def pid
+          ng_xml.at_xpath('/workflows/@objectId').text
+        end
+
+        def workflows
+          @workflows ||= ng_xml.xpath('/workflows/workflow').map do |node|
+            Workflow.new(xml: node.to_xml)
+          end
+        end
+
+        # @return [Array<String>] returns a list of errors for any process for the current version
+        def errors_for(version:)
+          ng_xml.xpath("//workflow/process[@version='#{version}' and @status='error']/@errorMessage")
+                .map(&:text)
+        end
+
+        attr_reader :xml
+
+        private
+
+        def ng_xml
+          @ng_xml ||= Nokogiri::XML(@xml)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 15.12.0
+  version: 15.14.0
 platform: ruby
 authors:
 - Justin Coyne
 - Michael Giarlo
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-24 00:00:00.000000000 Z
+date: 2025-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.104.0
+        version: 0.104.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.104.0
+        version: 0.104.1
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +81,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +221,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+description:
 email:
 - jcoyne@justincoyne.com
 - leftwing@alumni.rutgers.edu
@@ -237,10 +253,14 @@ files:
 - lib/dor/services/client/error_faraday_middleware.rb
 - lib/dor/services/client/events.rb
 - lib/dor/services/client/members.rb
+- lib/dor/services/client/milestones.rb
 - lib/dor/services/client/mutate.rb
 - lib/dor/services/client/object.rb
 - lib/dor/services/client/object_version.rb
+- 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
@@ -250,10 +270,14 @@ files:
 - lib/dor/services/client/virtual_objects.rb
 - lib/dor/services/client/workflows.rb
 - lib/dor/services/client/workspace.rb
+- lib/dor/services/response/process.rb
+- lib/dor/services/response/workflow.rb
+- lib/dor/services/response/workflows.rb
 homepage: https://github.com/sul-dlss/dor-services-client
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -271,7 +295,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: A client for dor-services-app
 test_files: []