dor-workflow-client 3.21.0 → 3.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa44370f3c08db522a5cfba8c511b44f096ea83cd6f3e55b209dc572a08b2922
-  data.tar.gz: 5d59452a5abf0f368f53ed48d78799726c8127795c724773e33d0a77f66ebaa9
+  metadata.gz: 906e80e65d5472f448be536ba072ad4bcf1f3c8e626571ca4a8afc0261eded96
+  data.tar.gz: e0bce8bb182c03ad0da4ceb174d98f8a265a56099c0ad171d9fd9d4d81614ac8
 SHA512:
-  metadata.gz: 1465b2aea82e56422aabb3193a0a9d70ae5d1cdd40d086d2369d73c67e477eb0cff7f6ffb92937d59dc5f123b0ad906e8c1ab5f95ff9ef3c9a41532e193797d1
-  data.tar.gz: '095ab0801c5fddda8c554d32f0a537b38bc04dca3c97e50ff1aa396770aee56f2140a9e97d0e1e584b9b5269535649357eeed8be4207d12d0087dced540a8f16'
+  metadata.gz: 82d97ffa31566dedc9d1c63b729751b83b0b0bc0212fd3e619dce05fa01d0ee285480984db1dabe0c49087e062a07e26603d2d59bbaa788972f7b8d9456b82f6
+  data.tar.gz: 382673d588f6b67e46bb3610d12d48cc51fd076872835d3326693705106fa18f67d1e8360593da7548330105249520eb7f02bc7e634a2ea8cadc18a2781d46e1

data/.github/pull_request_template.md

@@ -2,4 +2,11 @@
 
 
 
-## Was the usage documentation (e.g. wiki, README) updated?
+## How was this change tested?
+
+
+
+## Which documentation and/or configurations were updated?
+
+
+

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

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     class Client
-      VERSION = '3.21.0'
+      VERSION = '3.22.0'
     end
   end
 end

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

@@ -278,9 +278,16 @@ module Dor
         # @param [String] repo The repository the object resides in.  The service recoginzes "dor" and "sdr" at the moment
         # @param [String] druid The id of the object to delete the workflow from
         # @param [String] workflow The name of the workflow to be deleted
+        # @param [Integer] version The version of the workflow to delete
         # @return [Boolean] always true
-        def delete_workflow(repo, druid, workflow)
-          requestor.request "#{repo}/objects/#{druid}/workflows/#{workflow}", 'delete'
+        def delete_workflow(repo, druid, workflow, version: nil)
+          qs_args = if version
+                      "?version=#{version}"
+                    else
+                      Deprecation.warn(self, 'Calling delete_workflow without passing version is deprecated and will result in an error in dor-workflow-client 4.0')
+                      ''
+                    end
+          requestor.request "#{repo}/objects/#{druid}/workflows/#{workflow}#{qs_args}", 'delete'
           true
         end
 

data/spec/workflow/client_spec.rb

@@ -723,17 +723,29 @@ RSpec.describe Dor::Workflow::Client do
   end
 
   describe '#delete_workflow' do
-    let(:url) { "/objects/#{@druid}/workflows/accessionWF" }
-
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
         stub.delete(url) { |_env| [202, {}, ''] }
       end
     end
 
-    it 'sends a delete request to the workflow service' do
-      expect(mock_http_connection).to receive(:delete).with(url).and_call_original
-      client.delete_workflow(nil, @druid, 'accessionWF')
+    context 'without a version' do
+      let(:url) { "/objects/#{@druid}/workflows/accessionWF" }
+
+      it 'sends a delete request to the workflow service' do
+        expect(Deprecation).to receive(:warn)
+        expect(mock_http_connection).to receive(:delete).with(url).and_call_original
+        client.delete_workflow(nil, @druid, 'accessionWF')
+      end
+    end
+
+    context 'with a version' do
+      let(:url) { "/objects/#{@druid}/workflows/accessionWF?version=5" }
+
+      it 'sends a delete request to the workflow service' do
+        expect(mock_http_connection).to receive(:delete).with(url).and_call_original
+        client.delete_workflow(nil, @druid, 'accessionWF', version: 5)
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-client
 version: !ruby/object:Gem::Version
-  version: 3.21.0
+  version: 3.22.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -256,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Provides convenience methods to work with the DOR Workflow Service