dor-workflow-client 7.6.1 → 7.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e00d33007a67fe3e607553f3fb0f51744cafc3bcda21d2d7bd07526d1821f199
-  data.tar.gz: eba26125adda3619e00f5e8ec081dc2c861cf45b39993a70c011a79bea53ac48
+  metadata.gz: 12fc3722da54e3e3e25ef9bae87ac0fa5e492076fb88a532450fef9adebe5e52
+  data.tar.gz: 91113259c02396333c21190914fd79cdcfd66415dcf1b14e9859f2fe8e272084
 SHA512:
-  metadata.gz: 4e1e7964e9432f5aa2d0af7a1729812ef0a5401501a89f9e73ad32a78f7dbc920d3d52ed28a3e583fb61d455f9e0cc21439cb55b2680d174843544d9e0e8441f
-  data.tar.gz: 509627aa57a083d796534df08b9a39761a0615394ff34a6c730da357b9e59e6c55bdd525884d673b2e6b79ca308b7bac9076d8b3f9a07c4b397a9b5e827b6300
+  metadata.gz: 3521c9c4b2e0156f1ee8a559a7a61786ec441da04695da184be35a261349c895e8f11132a4687d1ca7db7b98993251ac1475cd95da12cfbbf2f2762ed3a447f7
+  data.tar.gz: ae4250842e3664aa3978f2ee405b8a217cd149aa5356b74c9a9b2dd0c164643505323271c07891b390f7358295ddc787fdfccc5beb7b361dff343a4573ffb748

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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dor-workflow-client (7.6.1)
+    dor-workflow-client (7.7.0)
       activesupport (>= 7.0.0)
       deprecation (>= 0.99.0)
       faraday (~> 2.0)
@@ -42,25 +42,25 @@ GEM
     diff-lcs (1.5.1)
     docile (1.4.1)
     drb (2.2.1)
-    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)
-    json (2.8.1)
+    json (2.9.0)
     language_server-protocol (3.17.0.3)
-    logger (1.6.1)
-    mini_portile2 (2.8.7)
-    minitest (5.25.1)
-    net-http (0.5.0)
+    logger (1.6.2)
+    mini_portile2 (2.8.8)
+    minitest (5.25.4)
+    net-http (0.6.0)
       uri
-    nokogiri (1.16.7)
+    nokogiri (1.17.0)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     parallel (1.26.3)
@@ -71,7 +71,7 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.9.2)
+    regexp_parser (2.9.3)
     rexml (3.3.9)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -85,20 +85,20 @@ GEM
     rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
+    rspec-support (3.13.2)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.68.0)
+    rubocop (1.69.1)
       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.34.1)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.36.2)
       parser (>= 3.3.1.0)
     rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
@@ -114,7 +114,7 @@ GEM
     rubocop-rspec_rails (2.29.1)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    securerandom (0.3.2)
+    securerandom (0.4.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -123,8 +123,10 @@ GEM
     simplecov_json_formatter (0.1.4)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.6.0)
-    uri (1.0.1)
+    unicode-display_width (3.1.2)
+      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)

data/lib/dor/workflow/client/queues.rb

@@ -80,6 +80,25 @@ module Dor
           Nokogiri::XML(resp).xpath('//object[@id]').map { |n| n[:id] }
         end
 
+        # Returns a list of druids from the workflow service that meet the criteria
+        # of the passed in error param
+        #
+        # @see `#objects_for_workstep`
+        #
+        # @param [String] error name of the error step
+        # @param [Hash] options
+        # @param options  [String]  :default_workflow workflow to query for if not using the qualified format
+        # @option options [Integer] :limit maximum number of druids to return (nil for no limit)
+        # @return [Array<String>]  Array of druids
+        def objects_erroring_at_workstep(error, options = {})
+          uri_string = "workflow_queue?error=#{error}"
+          uri_string += "&limit=#{options[:limit].to_i}" if options[:limit]&.to_i&.positive?
+
+          resp = requestor.request uri_string
+
+          Nokogiri::XML(resp).xpath('//object[@id]').map { |n| n[:id] }
+        end
+
         private
 
         attr_reader :requestor

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

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     class Client
-      VERSION = '7.6.1'
+      VERSION = '7.7.0'
     end
   end
 end

data/lib/dor/workflow/client.rb

@@ -46,8 +46,7 @@ module Dor
 
       delegate :lifecycle, :active_lifecycle, :milestones, to: :lifecycle_routes
 
-      delegate :lane_ids, :objects_for_workstep,
-               to: :queues
+      delegate :lane_ids, :objects_for_workstep, :objects_erroring_at_workstep, to: :queues
 
       def queues
         @queues ||= Queues.new(requestor: requestor)

data/spec/dor/workflow/client_spec.rb

@@ -391,6 +391,38 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
+  describe '#objects_erroring_at_workstep' do
+    before do
+      @workflow = 'googleScannedBookWF'
+      @error = 'process-content'
+    end
+
+    let(:stubs) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get("workflow_queue?error=#{@workflow}:#{@error}") do |_env|
+          [200, {}, '<objects count="1"><object id="druid:ab123de4567"/><object id="druid:ab123de9012"/></objects>']
+        end
+      end
+    end
+
+    context 'with a query using qualified workflow name for error' do
+      before do
+        @qualified_error = "#{@workflow}:#{@error}"
+      end
+
+      context 'with URI string creation' do
+        before do
+          @xml = %(<objects count="1"><object id="druid:ab123de4567"/></objects>)
+        end
+
+        it 'with lane ID' do
+          allow(mock_http_connection).to receive(:get).with("workflow_queue?error=#{@qualified_error}").and_return(double(Faraday::Response, body: @xml))
+          expect(client.objects_erroring_at_workstep(@qualified_error)).to eq(['druid:ab123de4567'])
+        end
+      end
+    end
+  end
+
   context 'when empty workflow queue' do
     before do
       @workflow   = 'googleScannedBookWF'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-client
 version: !ruby/object:Gem::Version
-  version: 7.6.1
+  version: 7.7.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-11 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -161,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Provides convenience methods to work with the DOR Workflow Service