dor-workflow-client 3.15.0 → 3.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 999836d9819299630a505d4f09ec8e8fd9a054fe8a7718b09096a7e3aae3b4cb
-  data.tar.gz: 2aabfa8b7212d6b59a63b43c24b07d11d350ab25138b9888241a86d27a21282e
+  metadata.gz: 306ecf7474466434521965d8d0bf75496f019acb07802692967f49ee4eeb119b
+  data.tar.gz: 89f7a848c976cc332fa27b3cfdce8beb9819ead54f495f861e5155a03ac29263
 SHA512:
-  metadata.gz: e79fc455a8757224ebc51ad4fb2c28d59801d0be5c7283cc393011ae374cb21ffb762bc52e21838317c4abb71b17ec79269c028aac0fc0dfcc425ecaaf7a904e
-  data.tar.gz: ca91b5a46d08c5a2519d958d18ee55f0d201c13c6856b542a9ff0d5bef58ba80ff82e3c253fc5e323bbc3fac6ba866e99d7945b2392e682b92fb151d68d840d1
+  metadata.gz: 4969a4ada46d0bda079cd200d04e620cafcb7fcb03f3b847efb4ca342996518059eea623fd590270abdc97051e034881131193232ca980cc96262793d35b7900
+  data.tar.gz: e1d1a6b121d3511f21a56016fe641dbc31a5eee8f2e07617c5e7b3b04a36f419daaf0cf17500eabc1dff56b9f108666e339dee7f3d76fa81fde09afa725bc4b8

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

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     class Client
-      VERSION = '3.15.0'
+      VERSION = '3.15.1'
     end
   end
 end

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

@@ -37,11 +37,7 @@ module Dor
             raise ArgumentError, 'wrong number of arguments, must be 1-3'
           end
 
-          uri = "#{repo}/objects/#{druid}/versionClose"
-          uri += '?' if !create_accession_wf || version
-          uri += "version=#{version}" if version
-          uri += 'create-accession=false' unless create_accession_wf
-          requestor.request(uri, 'post', '')
+          requestor.request(construct_url(repo, druid, version, create_accession_wf), 'post', '')
           true
         end
         # rubocop:enable Metrics/MethodLength
@@ -49,6 +45,16 @@ module Dor
         private
 
         attr_reader :requestor
+
+        def construct_url(repo, druid, version, create_accession_wf)
+          url = "#{repo}/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

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

@@ -19,6 +19,12 @@ module Dor
           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

data/spec/models/response/workflows_spec.rb

@@ -36,4 +36,27 @@ RSpec.describe Dor::Workflow::Response::Workflows do
       expect(subject.map(&:workflow_name)).to eq %w[assemblyWF sdrPreservationWF]
     end
   end
+
+  describe '#errors_for' do
+    subject { instance.errors_for(version: 2) }
+
+    let(:xml) do
+      <<~XML
+        <workflows objectId="druid:mw971zk1113">
+          <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
+            <process version="1" status="error" errorMessage="err1" />
+            <process version="2" status="error" errorMessage="err2" />
+            <process version="2" status="complete" errorMessage="err3" />
+          </workflow>
+          <workflow repository="dor" objectId="druid:mw971zk1113" id="sdrPreservationWF">
+            <process version="1" status="error" errorMessage="err4" />
+            <process version="2" status="error" errorMessage="err5" />
+            <process version="2" status="complete" errorMessage="err6" />
+          </workflow>
+        </workflows>
+      XML
+    end
+
+    it { is_expected.to eq %w[err2 err5] }
+  end
 end

data/spec/workflow/client/version_routes_spec.rb

@@ -0,0 +1,59 @@
+# 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 positional arguments' do
+      before do
+        allow(Deprecation).to receive(:warn)
+      end
+
+      it 'calls the versionClose endpoint with druid' do
+        routes.close_version(repo, druid)
+        expect(Deprecation).to have_received(:warn)
+      end
+
+      it 'optionally prevents creation of accessionWF' do
+        routes.close_version(repo, druid, false)
+        expect(mock_requestor).to have_received(:request)
+          .with('dor/objects/druid:123/versionClose?create-accession=false', 'post', '')
+        expect(Deprecation).to have_received(:warn)
+      end
+    end
+
+    context 'with kwargs' do
+      it 'calls the versionClose endpoint' do
+        routes.close_version(repo: repo, druid: druid)
+        expect(mock_requestor).to have_received(:request)
+          .with('dor/objects/druid:123/versionClose', 'post', '')
+      end
+
+      it 'optionally prevents creation of accessionWF' do
+        routes.close_version(repo: repo, druid: druid, create_accession_wf: false)
+        expect(mock_requestor).to have_received(:request)
+          .with('dor/objects/druid:123/versionClose?create-accession=false', 'post', '')
+      end
+
+      it 'optionally passes version' do
+        routes.close_version(repo: repo, druid: druid, version: 3)
+        expect(mock_requestor).to have_received(:request)
+          .with('dor/objects/druid:123/versionClose?version=3', 'post', '')
+      end
+
+      it 'optionally prevents creation of accessionWF and passes version' do
+        routes.close_version(repo: repo, druid: druid, create_accession_wf: false, version: 3)
+        expect(mock_requestor).to have_received(:request)
+          .with('dor/objects/druid:123/versionClose?version=3&create-accession=false', 'post', '')
+      end
+    end
+  end
+end

data/spec/workflow/client_spec.rb

@@ -742,55 +742,6 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
-  describe '#close_version' do
-    let(:stubs) do
-      Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.post('dor/objects/druid:123/versionClose?create-accession=false') do |_env|
-          [202, {}, '']
-        end
-
-        stub.post('dor/objects/druid:123/versionClose') do |_env|
-          [202, {}, '']
-        end
-      end
-    end
-
-    let(:url) { 'dor/objects/druid:123/versionClose' }
-
-    context 'with positional arguments' do
-      before do
-        allow(Deprecation).to receive(:warn)
-      end
-
-      it 'calls the versionClose endpoint with druid' do
-        client.close_version(@repo, @druid)
-        expect(Deprecation).to have_received(:warn)
-      end
-
-      it 'optionally prevents creation of accessionWF' do
-        expect(mock_http_connection).to receive(:post).with('dor/objects/druid:123/versionClose?create-accession=false').and_call_original
-        client.close_version(@repo, @druid, false)
-        expect(Deprecation).to have_received(:warn)
-      end
-    end
-
-    context 'with kwargs' do
-      it 'calls the versionClose endpoint with druid' do
-        client.close_version(repo: @repo, druid: @druid)
-      end
-
-      it 'optionally prevents creation of accessionWF' do
-        expect(mock_http_connection).to receive(:post).with('dor/objects/druid:123/versionClose?create-accession=false').and_call_original
-        client.close_version(repo: @repo, druid: @druid, create_accession_wf: false)
-      end
-
-      it 'optionally passes version' do
-        expect(mock_http_connection).to receive(:post).with('dor/objects/druid:123/versionClose?version=3').and_call_original
-        client.close_version(repo: @repo, druid: @druid, version: 3)
-      end
-    end
-  end
-
   describe '.stale_queued_workflows' do
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-client
 version: !ruby/object:Gem::Version
-  version: 3.15.0
+  version: 3.15.1
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -231,6 +231,7 @@ files:
 - spec/workflow/client/connection_factory_spec.rb
 - spec/workflow/client/lifecycle_routes_spec.rb
 - spec/workflow/client/requestor_spec.rb
+- spec/workflow/client/version_routes_spec.rb
 - spec/workflow/client/workflow_routes_spec.rb
 - spec/workflow/client/workflow_template_spec.rb
 - spec/workflow/client_spec.rb
@@ -252,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Provides convenience methods to work with the DOR Workflow Service
@@ -264,6 +265,7 @@ test_files:
 - spec/workflow/client/connection_factory_spec.rb
 - spec/workflow/client/lifecycle_routes_spec.rb
 - spec/workflow/client/requestor_spec.rb
+- spec/workflow/client/version_routes_spec.rb
 - spec/workflow/client/workflow_routes_spec.rb
 - spec/workflow/client/workflow_template_spec.rb
 - spec/workflow/client_spec.rb