dor-workflow-client 7.4.1 → 7.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b29586cf5f0f5d2fd768d99ae4533af1d29e1879daa96b1e5611e09ef8195ff
-  data.tar.gz: 74c7641b0e942528005d65318116702a5cba4171b6f833f2ec46aa3065619ac7
+  metadata.gz: f09cfcba6518009d57900ff9c069be55dab613542f38cb948d503c8bd2754ba6
+  data.tar.gz: e446798dbeedc9a88784622598ff21b22ae2246a70cb392b2a7842afe08889a3
 SHA512:
-  metadata.gz: 46e27f180e3df6018706a9f01051ff09e757795bdc76e013ff8e493a01ba45a639f054a0fefa55f340e3aa054c7458eb4fc82acc8233f2c28208a8476e17c5b3
-  data.tar.gz: 9597f00cc9074bac61867dd441b2d96150ce814763c2d5e25b84e3741b905a0233f5a96e1061f61ba0f43aef13a5aebb57f18f9911d12026c7e51acc78ffc832
+  metadata.gz: a45a0cea334788ad551560bc29250e3e37ad2dc17eca40305804e181178815632537ba6ff1ea99147fb292c154605fd0a68dc53a8fadcc06240bb73d4526b4cd
+  data.tar.gz: 7b4319b9e0bdafc9c08033de8dec348c5bc5204a0798038516415371d819ba6dec4563b07b1497142764f0d6740a28ebb84245947e43391aa0a7b7d98215650b

data/.circleci/config.yml

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dor-workflow-client (7.4.1)
+    dor-workflow-client (7.6.0)
       activesupport (>= 3.2.1, < 8)
       deprecation (>= 0.99.0)
       faraday (~> 2.0)
@@ -12,23 +12,26 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.3)
+    activesupport (7.2.2)
       base64
+      benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
     base64 (0.2.0)
+    benchmark (0.3.0)
     bigdecimal (3.1.8)
     byebug (11.1.3)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     crack (1.0.0)
       bigdecimal
@@ -36,97 +39,97 @@ GEM
     deprecation (1.1.0)
       activesupport
     diff-lcs (1.5.1)
-    docile (1.4.0)
+    docile (1.4.1)
     drb (2.2.1)
-    faraday (2.9.0)
-      faraday-net_http (>= 2.0, < 3.2)
-    faraday-net_http (3.1.0)
+    faraday (2.12.0)
+      faraday-net_http (>= 2.0, < 3.4)
+      json
+      logger
+    faraday-net_http (3.3.0)
       net-http
     faraday-retry (2.2.1)
       faraday (~> 2.0)
-    hashdiff (1.1.0)
-    i18n (1.14.5)
+    hashdiff (1.1.1)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
-    json (2.7.2)
+    json (2.7.5)
     language_server-protocol (3.17.0.3)
-    mini_portile2 (2.8.6)
-    minitest (5.23.0)
-    mutex_m (0.2.0)
+    logger (1.6.1)
+    mini_portile2 (2.8.7)
+    minitest (5.25.1)
     net-http (0.4.1)
       uri
-    nokogiri (1.16.5)
+    nokogiri (1.16.7)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    parallel (1.24.0)
-    parser (3.3.1.0)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
-    public_suffix (5.0.5)
-    racc (1.8.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
+    rexml (3.3.9)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.2)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.63.5)
+    rubocop (1.68.0)
       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 (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
+    rubocop-ast (1.33.0)
       parser (>= 3.3.1.0)
-    rubocop-capybara (2.20.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
+    rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.29.2)
+    rubocop-rspec (2.31.0)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
       rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.28.3)
-      rubocop (~> 1.40)
+    rubocop-rspec_rails (2.29.1)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
+    securerandom (0.3.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    strscan (3.1.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
-    uri (0.13.0)
-    webmock (3.23.0)
+    unicode-display_width (2.6.0)
+    uri (0.13.1)
+    webmock (3.24.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.36)
-    zeitwerk (2.6.14)
+    yard (0.9.37)
+    zeitwerk (2.7.1)
 
 PLATFORMS
   ruby

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

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     class Client
-      VERSION = '7.4.1'
+      VERSION = '7.6.0'
     end
   end
 end

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

@@ -107,6 +107,13 @@ module Dor
           Workflow::Response::Workflows.new(xml: xml)
         end
 
+        # Skips all steps in a WF
+        def skip_all(druid:, workflow:, note:)
+          xml = create_process_xml(name: 'skip-all', status: 'skipped', note: note)
+          response = requestor.request "objects/#{druid}/workflows/#{workflow}/skip-all", 'post', xml, content_type: 'application/xml'
+          Workflow::Response::Workflows.new(xml: response)
+        end
+
         # Get workflow names into an array for given PID
         # This method only works when this gem is used in a project that is configured to connect to DOR
         #

data/lib/dor/workflow/client.rb

@@ -25,7 +25,7 @@ module Dor
     # Create and update workflows
     class Client
       # From workflow-server-rails' app/models/workflow_step.rb
-      VALID_STATUS = %w[waiting completed error queued skipped started].freeze
+      VALID_STATUS = %w[waiting completed error queued skipped started retrying].freeze
 
       attr_accessor :requestor
 
@@ -40,7 +40,7 @@ module Dor
         @requestor = Requestor.new(connection: connection || ConnectionFactory.build_connection(url, timeout: timeout, logger: logger))
       end
 
-      delegate :create_workflow_by_name, :workflow_status, :workflows, :all_workflows,
+      delegate :create_workflow_by_name, :workflow_status, :workflows, :all_workflows, :skip_all,
                :workflow, :process, :delete_workflow, :delete_all_workflows, :update_status, :update_error_status,
                to: :workflow_routes
 
@@ -49,8 +49,6 @@ module Dor
       delegate :lane_ids, :objects_for_workstep,
                to: :queues
 
-      delegate :close_version, to: :version_routes
-
       def queues
         @queues ||= Queues.new(requestor: requestor)
       end
@@ -63,10 +61,6 @@ module Dor
         @lifecycle_routes ||= LifecycleRoutes.new(requestor: requestor)
       end
 
-      def version_routes
-        @version_routes ||= VersionRoutes.new(requestor: requestor)
-      end
-
       def workflow_template(name)
         templates.retrieve(name)
       end

data/spec/dor/workflow/client/workflow_routes_spec.rb

@@ -156,6 +156,22 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
     end
   end
 
+  describe '#skip_all' do
+    subject(:skip_all) do
+      routes.skip_all(druid: 'druid:mw971zk1113', note: 'test note', workflow: 'ocrWF')
+    end
+
+    let(:mock_requestor) { instance_double(Dor::Workflow::Client::Requestor, request: nil) }
+
+    it 'sends a skip all request' do
+      skip_all
+      expect(mock_requestor).to have_received(:request)
+        .with('objects/druid:mw971zk1113/workflows/ocrWF/skip-all', 'post',
+              "<?xml version=\"1.0\"?>\n<process name=\"skip-all\" status=\"skipped\" note=\"test note\"/>\n",
+              { content_type: 'application/xml' })
+    end
+  end
+
   describe '#all_workflows' do
     let(:xml) do
       <<~XML

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-client
 version: !ruby/object:Gem::Version
-  version: 7.4.1
+  version: 7.6.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-23 00:00:00.000000000 Z
+date: 2024-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -130,7 +130,6 @@ files:
 - lib/dor/workflow/client/requestor.rb
 - lib/dor/workflow/client/status.rb
 - lib/dor/workflow/client/version.rb
-- lib/dor/workflow/client/version_routes.rb
 - lib/dor/workflow/client/workflow_routes.rb
 - lib/dor/workflow/client/workflow_template.rb
 - lib/dor/workflow/response/process.rb
@@ -142,7 +141,6 @@ files:
 - spec/dor/workflow/client/lifecycle_routes_spec.rb
 - spec/dor/workflow/client/requestor_spec.rb
 - spec/dor/workflow/client/status_spec.rb
-- spec/dor/workflow/client/version_routes_spec.rb
 - spec/dor/workflow/client/workflow_routes_spec.rb
 - spec/dor/workflow/client/workflow_template_spec.rb
 - spec/dor/workflow/client_spec.rb
@@ -169,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Provides convenience methods to work with the DOR Workflow Service

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

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Workflow
-    class Client
-      # Makes requests relating to versions
-      class VersionRoutes
-        def initialize(requestor:)
-          @requestor = requestor
-        end
-
-        # Calls the versionClose endpoint of the workflow service:
-        #
-        # - completes the versioningWF:submit-version and versioningWF:start-accession steps
-        # - initiates accesssionWF
-        #
-        # @param [String] druid The id of the object to delete the workflow from
-        # @param [Boolean] create_accession_wf Option to create accessionWF when closing a version.  Defaults to true
-        def close_version(druid:, version:, create_accession_wf: true)
-          requestor.request(construct_url(druid, version, create_accession_wf), 'post', '')
-          true
-        end
-
-        private
-
-        attr_reader :requestor
-
-        def construct_url(druid, version, create_accession_wf)
-          url = "objects/#{druid}/versionClose"
-
-          qs_args = []
-          qs_args << "version=#{version}" if version
-          qs_args << 'create-accession=false' unless create_accession_wf
-          url += "?#{qs_args.join('&')}" unless qs_args.empty?
-          url
-        end
-      end
-    end
-  end
-end

data/spec/dor/workflow/client/version_routes_spec.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe Dor::Workflow::Client::VersionRoutes do
-  let(:mock_requestor) { instance_double(Dor::Workflow::Client::Requestor, request: nil) }
-
-  let(:routes) { described_class.new(requestor: mock_requestor) }
-
-  let(:repo) { 'dor' }
-
-  let(:druid) { 'druid:123' }
-
-  describe '#close_version' do
-    context 'with kwargs' do
-      it 'passes version' do
-        routes.close_version(druid: druid, version: 3)
-        expect(mock_requestor).to have_received(:request)
-          .with('objects/druid:123/versionClose?version=3', 'post', '')
-      end
-
-      it 'optionally prevents creation of accessionWF and passes version' do
-        routes.close_version(druid: druid, create_accession_wf: false, version: 3)
-        expect(mock_requestor).to have_received(:request)
-          .with('objects/druid:123/versionClose?version=3&create-accession=false', 'post', '')
-      end
-    end
-  end
-end