dor-services-client 15.15.2 → 15.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 664c758fdb6930cfa0c0756f6282d6268b0174ed59a23266006cc4ca75e366a1
-  data.tar.gz: e723073e8376db61491580fe0e02d3a8d3affd146387743f24ffdff2c8d42521
+  metadata.gz: '08d442e83ffd620ca6ce507912bfad7ece5ce2e303c05dbfa09753828b348f17'
+  data.tar.gz: 7da84b625648e7dfaef778ece349cea18d5e25b5ebd49163e33aa223920d81ba
 SHA512:
-  metadata.gz: efc9dfa6cef3526a8a9af187b851c2344fb2508880364ee1825c3df74a1812317a70e1073d50732ad25829796c12726e2c6a8bfff5988c6d7b7698e7df366d69
-  data.tar.gz: f7de64fac118e5cfaaca0b73449baa6f72f1431ca9cd220ba7edf1cd154233a5e9da16824c00e8ad0b75ad0e7280ddd71e64fa5f993cdfa3f49ca6be8e9c6eaa
+  metadata.gz: 957c36d544c0708e407885b10f5eb2d5c82dff88a4635800d90ad1d3371563d6b63147f2674c9678d2d6049d3289046632c631d337eab04e3b6e427e4b381f53
+  data.tar.gz: ba46d21dda5de8a2a614c014fc26ad7287e6de283c5285ffbec4661090c529c3df9cb4333ba22e7ae5188b9360b2d68f5255f1d50524ce9e62019bab5a6800b1

data/Gemfile.lock

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

data/README.md

@@ -178,6 +178,8 @@ Dor::Services::Client.administrative_tags.search(q: 'Project')
 
 # Get a list of workflow templates
 Dor::Services::Client.workflows.templates
+# Show a workflow template (e.g., to view its list of steps)
+Dor::Services::Client.workflows.template('accessionWF')
 ```
 
 ## Asynchronous results

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '15.15.2'
+      VERSION = '15.17.0'
     end
   end
 end

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

@@ -8,9 +8,20 @@ module Dor
         # Retrieves a list of workflow template name
         # @return [Array<String>] the list of templates
         def templates
-          resp = connection.post do |req|
+          resp = connection.get do |req|
             req.url "#{api_version}/workflow_templates"
-            req.headers['Content-Type'] = 'application/json'
+            req.headers['Accept'] = 'application/json'
+          end
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          JSON.parse(resp.body)
+        end
+
+        # Retrieves a workflow template given a workflow name
+        # @return [Hash] the set of processes within a template
+        def template(workflow_name)
+          resp = connection.get do |req|
+            req.url "#{api_version}/workflow_templates/#{workflow_name}"
             req.headers['Accept'] = 'application/json'
           end
           raise_exception_based_on_response!(resp) unless resp.success?

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

@@ -24,7 +24,12 @@ module Dor
           result ? true : false
         end
 
-        # Returns the process, for the most recent version that matches the given name:
+        def error_count
+          process_names.map { |process_name| process_for_recent_version(name: process_name) }
+                       .count { |process| process.status == 'error' }
+        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 }
@@ -38,12 +43,11 @@ module Dor
         # 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)
+          complete_for?(version: latest_version)
         end
 
         def incomplete_processes_for(version:)
@@ -53,15 +57,15 @@ module Dor
         end
 
         def incomplete_processes
-          incomplete_processes_for(version: version)
+          incomplete_processes_for(version: latest_version)
         end
 
         attr_reader :xml
 
         private
 
-        # Return the max version in this workflow document
-        def version
+        # Return the latest version in this workflow document
+        def latest_version
           ng_xml.xpath('/workflow/process/@version').map { |attr| attr.value.to_i }.max
         end
 
@@ -81,6 +85,10 @@ module Dor
           attributes = node ? node.attributes.to_h { |k, v| [k.to_sym, v.value] } : {}
           Process.new(parent: self, **attributes)
         end
+
+        def process_names(version: latest_version)
+          ng_xml.xpath("/workflow/process[@version=#{version}]").map { |process| process['name'] }
+        end
       end
     end
   end

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

@@ -5,32 +5,26 @@ module Dor
     module Response
       # The response from asking the server about all workflows for an item
       class Workflows
+        attr_reader :xml
+
+        # @param [Nokogiri::XML] xml Nokogiri XML document showing all workflows
         def initialize(xml:)
           @xml = xml
         end
 
         def pid
-          ng_xml.at_xpath('/workflows/@objectId').text
+          xml.at_xpath('/workflows/@objectId').text
         end
 
         def workflows
-          @workflows ||= ng_xml.xpath('/workflows/workflow').map do |node|
+          @workflows ||= 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
+        # @return [Array<String>] returns a list of errors for any process for the specified 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)
+          xml.xpath("//workflow/process[@version='#{version}' and @status='error']/@errorMessage").map(&:text)
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 15.15.2
+  version: 15.17.0
 platform: ruby
 authors:
 - Justin Coyne