dor-workflow-client 3.24.0 → 5.0.0

data/spec/workflow/client/lifecycle_routes_spec.rb

@@ -17,177 +17,43 @@ RSpec.describe Dor::Workflow::Client::LifecycleRoutes do
 
     before do
       allow(routes).to receive(:query_lifecycle).and_return(ng_xml)
-      allow(Deprecation).to receive(:warn)
     end
 
-    context 'with positional arguments' do
-      subject(:milestones) { routes.milestones(repo, druid) }
+    subject(:milestones) { routes.milestones(druid: druid) }
 
-      it 'includes the version in with the milestones' do
-        expect(milestones.first[:milestone]).to eq('published')
-        expect(milestones.first[:version]).to eq('2')
-        expect(Deprecation).to have_received(:warn).twice
-      end
-    end
-
-    context 'with kwargs' do
-      subject(:milestones) { routes.milestones(druid: druid) }
-
-      it 'includes the version in with the milestones' do
-        expect(milestones.first[:milestone]).to eq('published')
-        expect(milestones.first[:version]).to eq('2')
-      end
+    it 'includes the version in with the milestones' do
+      expect(milestones.first[:milestone]).to eq('published')
+      expect(milestones.first[:version]).to eq('2')
     end
   end
 
   describe '#lifecycle' do
-    context 'with positional arguments' do
-      before do
-        allow(Deprecation).to receive(:warn)
-      end
-
-      context 'without version' do
-        subject(:lifecycle) { routes.lifecycle(repo, druid, 'submitted') }
-
-        it 'make the request' do
-          lifecycle
-          expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle')
-          expect(Deprecation).to have_received(:warn).twice
-        end
-      end
-
-      context 'with version' do
-        subject(:lifecycle) { routes.lifecycle(repo, druid, 'submitted', version: 3) }
+    context 'without version' do
+      subject(:lifecycle) { routes.lifecycle(druid: druid, milestone_name: 'submitted') }
 
-        it 'makes the request with the version' do
-          lifecycle
-          expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle?version=3')
-          expect(Deprecation).to have_received(:warn).twice
-        end
+      it 'make the request' do
+        lifecycle
+        expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle')
       end
     end
 
-    context 'with kwargs' do
-      before do
-        allow(Deprecation).to receive(:warn)
-      end
-
-      context 'with deprecated repo arg' do
-        context 'without version' do
-          subject(:lifecycle) { routes.lifecycle(repo: repo, druid: druid, milestone_name: 'submitted') }
-
-          it 'make the request' do
-            lifecycle
-            expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle')
-            expect(Deprecation).to have_received(:warn)
-          end
-        end
-
-        context 'with version' do
-          subject(:lifecycle) { routes.lifecycle(repo: repo, druid: druid, milestone_name: 'submitted', version: 3) }
+    context 'with version' do
+      subject(:lifecycle) { routes.lifecycle(druid: druid, milestone_name: 'submitted', version: 3) }
 
-          it 'makes the request with the version' do
-            lifecycle
-            expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle?version=3')
-            expect(Deprecation).to have_received(:warn)
-          end
-        end
-      end
-
-      context 'without version' do
-        subject(:lifecycle) { routes.lifecycle(druid: druid, milestone_name: 'submitted') }
-
-        it 'make the request' do
-          lifecycle
-          expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle')
-          expect(Deprecation).not_to have_received(:warn)
-        end
-      end
-
-      context 'with version' do
-        subject(:lifecycle) { routes.lifecycle(druid: druid, milestone_name: 'submitted', version: 3) }
-
-        it 'makes the request with the version' do
-          lifecycle
-          expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle?version=3')
-          expect(Deprecation).not_to have_received(:warn)
-        end
+      it 'makes the request with the version' do
+        lifecycle
+        expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle?version=3')
       end
     end
   end
 
   describe '#active_lifecycle' do
-    context 'with positional arguments' do
-      before do
-        allow(Deprecation).to receive(:warn)
-      end
-
-      context 'without version' do
-        subject(:active_lifecycle) { routes.active_lifecycle(repo, druid, 'submitted') }
-
-        it 'make the request' do
-          active_lifecycle
-          expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle?active-only=true')
-          expect(Deprecation).to have_received(:warn).twice
-        end
-      end
-
-      context 'with version' do
-        subject(:active_lifecycle) { routes.active_lifecycle(repo, druid, 'submitted', version: 3) }
-
-        it 'makes the request with the version' do
-          active_lifecycle
-          expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle?version=3&active-only=true')
-          expect(Deprecation).to have_received(:warn).twice
-        end
-      end
-    end
-
     context 'with kwargs' do
-      before do
-        allow(Deprecation).to receive(:warn)
-      end
-
-      context 'with deprecated repo arg' do
-        context 'without version' do
-          subject(:active_lifecycle) { routes.active_lifecycle(repo: repo, druid: druid, milestone_name: 'submitted') }
-
-          it 'make the request' do
-            active_lifecycle
-            expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle?active-only=true')
-            expect(Deprecation).to have_received(:warn)
-          end
-        end
-
-        context 'with version' do
-          subject(:active_lifecycle) { routes.active_lifecycle(repo: repo, druid: druid, milestone_name: 'submitted', version: 3) }
-
-          it 'makes the request with the version' do
-            active_lifecycle
-            expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle?version=3&active-only=true')
-            expect(Deprecation).to have_received(:warn)
-          end
-        end
-      end
-
-      context 'without version' do
-        subject(:active_lifecycle) { routes.active_lifecycle(druid: druid, milestone_name: 'submitted') }
-
-        it 'make the request' do
-          active_lifecycle
-          expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle?active-only=true')
-          expect(Deprecation).not_to have_received(:warn)
-        end
-      end
-
-      context 'with version' do
-        subject(:active_lifecycle) { routes.active_lifecycle(druid: druid, milestone_name: 'submitted', version: 3) }
+      subject(:active_lifecycle) { routes.active_lifecycle(druid: druid, milestone_name: 'submitted', version: 3) }
 
-        it 'makes the request with the version' do
-          active_lifecycle
-          expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle?version=3&active-only=true')
-          expect(Deprecation).not_to have_received(:warn)
-        end
+      it 'makes the request with the version' do
+        active_lifecycle
+        expect(requestor).to have_received(:request).with('objects/druid:gv054hp4128/lifecycle?version=3&active-only=true')
       end
     end
   end

data/spec/workflow/client/version_routes_spec.rb

@@ -12,51 +12,8 @@ RSpec.describe Dor::Workflow::Client::VersionRoutes do
   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).twice
-      end
-
-      it 'optionally prevents creation of accessionWF' do
-        routes.close_version(repo, druid, false)
-        expect(mock_requestor).to have_received(:request)
-          .with('objects/druid:123/versionClose?create-accession=false', 'post', '')
-        expect(Deprecation).to have_received(:warn).twice
-      end
-    end
-
     context 'with kwargs' do
-      it 'calls the versionClose endpoint' do
-        routes.close_version(druid: druid)
-        expect(mock_requestor).to have_received(:request)
-          .with('objects/druid:123/versionClose', 'post', '')
-      end
-
-      context 'with deprecated repo arg' do
-        before do
-          allow(Deprecation).to receive(:warn)
-        end
-
-        it 'calls the versionClose endpoint' do
-          routes.close_version(repo: repo, druid: druid)
-          expect(mock_requestor).to have_received(:request)
-            .with('objects/druid:123/versionClose', 'post', '')
-          expect(Deprecation).to have_received(:warn)
-        end
-      end
-
-      it 'optionally prevents creation of accessionWF' do
-        routes.close_version(druid: druid, create_accession_wf: false)
-        expect(mock_requestor).to have_received(:request)
-          .with('objects/druid:123/versionClose?create-accession=false', 'post', '')
-      end
-
-      it 'optionally passes version' 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', '')

data/spec/workflow/client/workflow_routes_spec.rb

@@ -147,6 +147,19 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
     end
   end
 
+  describe '#delete_all_workflows' do
+    subject(:delete_all_workflows) do
+      routes.delete_all_workflows(pid: 'druid:mw971zk1113')
+    end
+    let(:mock_requestor) { instance_double(Dor::Workflow::Client::Requestor, request: nil) }
+
+    it 'sends a delete request' do
+      delete_all_workflows
+      expect(mock_requestor).to have_received(:request)
+        .with('objects/druid:mw971zk1113/workflows', 'delete')
+    end
+  end
+
   describe '#all_workflows' do
     let(:xml) do
       <<~XML

data/spec/workflow/client_spec.rb

@@ -68,50 +68,7 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
-  describe '#create_workflow' do
-    let(:stubs) do
-      Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.post("objects/#{@druid}/workflows/etdSubmitWF") { |_env| [201, {}, ''] }
-        stub.post("objects/#{@druid}/workflows/raiseException") { |_env| raise 'broken' }
-        stub.post("objects/#{@druid}/workflows/laneIdWF?lane-id=foo_lane") { |_env| [201, {}, ''] }
-        stub.post("objects/#{@druid}/workflows/versionWF?version=2") { |_env| [201, {}, ''] }
-      end
-    end
-
-    before do
-      allow(Deprecation).to receive(:warn)
-    end
-
-    it 'requests the workflow by name and return the URL to the workflow' do
-      client.create_workflow(nil, @druid, 'etdSubmitWF', wf_xml)
-      expect(Deprecation).to have_received(:warn).twice
-    end
-
-    it 'raises on an unexpected Exception' do
-      expect { client.create_workflow(nil, @druid, 'raiseException', wf_xml) }.to raise_error(Exception, 'broken')
-      expect(Deprecation).to have_received(:warn).twice
-    end
-
-    it 'sets the lane_id param if provided in options hash' do
-      client.create_workflow(nil, @druid, 'laneIdWF', wf_xml, lane_id: 'foo_lane')
-      expect(Deprecation).to have_received(:warn).twice
-    end
-  end
-
   describe '#create_workflow_by_name' do
-    context 'with no args' do
-      let(:stubs) do
-        Faraday::Adapter::Test::Stubs.new do |stub|
-          stub.post("objects/#{@druid}/workflows/etdSubmitWF") { |_env| [201, {}, ''] }
-        end
-      end
-
-      it 'requests the workflow by name and return the URL to the workflow' do
-        expect(Deprecation).to receive(:warn)
-        client.create_workflow_by_name(@druid, 'etdSubmitWF')
-      end
-    end
-
     context 'when an unexpected exception is raised' do
       let(:stubs) do
         Faraday::Adapter::Test::Stubs.new do |stub|
@@ -149,72 +106,6 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
-  describe '#update_workflow_status' do
-    let(:stubs) do
-      Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.put("objects/#{@druid}/workflows/etdSubmitWF/registrar-approval?current-status=queued") do |_env|
-          [201, {}, '{"next_steps":["submit-marc"]}']
-        end
-
-        stub.put("objects/#{@druid}/workflows/etdSubmitWF/registrar-approval") do |env|
-          expect(env.body).to eq "<?xml version=\"1.0\"?>\n<process name=\"registrar-approval\" status=\"completed\" elapsed=\"0\" note=\"annotation\" version=\"2\" laneId=\"lane2\"/>\n"
-          [201, {}, '{"next_steps":["submit-marc"]}']
-        end
-
-        stub.put("objects/#{@druid}/workflows/errorWF/registrar-approval") do |_env|
-          [400, {}, '']
-        end
-      end
-    end
-    before do
-      allow(Deprecation).to receive(:warn)
-    end
-
-    it 'should update workflow status and return true if successful' do
-      expect(client.update_workflow_status(nil, @druid, 'etdSubmitWF', 'registrar-approval', 'completed', version: 2, note: 'annotation', lane_id: 'lane2')).to be_kind_of Dor::Workflow::Response::Update
-    end
-
-    it 'should return false if the PUT to the DOR workflow service throws an exception' do
-      expect { client.update_workflow_status(nil, @druid, 'errorWF', 'registrar-approval', 'completed') }.to raise_error(Dor::WorkflowException, /status 400/)
-    end
-
-    it 'performs a conditional update when current-status is passed as a parameter' do
-      expect(mock_http_connection).to receive(:put).with("/objects/#{@druid}/workflows/etdSubmitWF/registrar-approval?current-status=queued").and_call_original
-
-      expect(client.update_workflow_status(nil, @druid, 'etdSubmitWF', 'registrar-approval', 'completed', version: 2, note: 'annotation', lane_id: 'lane1', current_status: 'queued')).to be_kind_of Dor::Workflow::Response::Update
-    end
-
-    it 'should throw exception if invalid status provided' do
-      expect { client.update_workflow_status(nil, @druid, 'accessionWF', 'publish', 'NOT_VALID_STATUS') }.to raise_error(ArgumentError)
-    end
-  end
-
-  describe '#update_workflow_error_status' do
-    let(:stubs) do
-      Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.put("objects/#{@druid}/workflows/etdSubmitWF/reader-approval") do |env|
-          expect(env.body).to match(/status="error" errorMessage="Some exception" errorText="The optional stacktrace"/)
-          [201, {}, '{"next_steps":["submit-marc"]}']
-        end
-
-        stub.put("objects/#{@druid}/workflows/errorWF/reader-approval") do |_env|
-          [400, {}, '']
-        end
-      end
-    end
-
-    before do
-      allow(Deprecation).to receive(:warn)
-    end
-
-    it 'should update workflow status to error and return true if successful' do
-      client.update_workflow_error_status(nil, @druid, 'etdSubmitWF', 'reader-approval', 'Some exception', error_text: 'The optional stacktrace')
-    end
-    it 'should return false if the PUT to the DOR workflow service throws an exception' do
-      expect { client.update_workflow_error_status(nil, @druid, 'errorWF', 'reader-approval', 'completed') }.to raise_error(Dor::WorkflowException, /status 400/)
-    end
-  end
-
   describe '#workflow_template' do
     subject(:workflow_template) { client.workflow_template('etdSubmitWF') }
 
@@ -273,40 +164,6 @@ RSpec.describe Dor::Workflow::Client do
     end
     let(:xml) { '' }
 
-    context 'when repo is provided' do
-      before do
-        allow(Deprecation).to receive(:warn)
-      end
-      subject { client.workflow_status(repo: repo, druid: druid, workflow: workflow_name, process: step_name) }
-
-      context 'when a single result is returned' do
-        let(:xml) do
-          '<workflow><process name="registrar-approval" status="completed" /></workflow>'
-        end
-
-        it 'returns status as a string' do
-          expect(subject).to eq('completed')
-        end
-      end
-    end
-
-    context 'with positional arguments' do
-      before do
-        allow(Deprecation).to receive(:warn)
-      end
-      subject { client.workflow_status(repo, druid, workflow_name, step_name) }
-
-      context 'when a single result is returned' do
-        let(:xml) do
-          '<workflow><process name="registrar-approval" status="completed" /></workflow>'
-        end
-
-        it 'returns status as a string' do
-          expect(subject).to eq('completed')
-        end
-      end
-    end
-
     context 'when a single result is returned' do
       let(:xml) do
         '<workflow><process name="registrar-approval" status="completed" /></workflow>'
@@ -366,85 +223,6 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
-  describe '#workflow_xml' do
-    before do
-      allow(Deprecation).to receive(:warn)
-    end
-    context 'with positional args' do
-      subject(:workflow_xml) { client.workflow_xml('dor', 'druid:123', workflow) }
-
-      context 'when a workflow name is provided' do
-        let(:workflow) { 'etdSubmitWF' }
-        let(:xml) { '<workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>' }
-        let(:stubs) do
-          Faraday::Adapter::Test::Stubs.new do |stub|
-            stub.get('dor/objects/druid:123/workflows/etdSubmitWF') do |_env|
-              [200, {}, xml]
-            end
-          end
-        end
-
-        it 'returns the xml for a given repository, druid, and workflow' do
-          expect(workflow_xml).to eq(xml)
-        end
-      end
-
-      context 'when no workflow name is provided' do
-        let(:workflow) { nil }
-
-        it 'raises an error' do
-          expect { workflow_xml }.to raise_error ArgumentError
-        end
-      end
-    end
-    context 'with keyword args' do
-      subject(:workflow_xml) { client.workflow_xml(druid: 'druid:123', workflow: workflow) }
-
-      # TODO: Remove this `context` block altogether when repos are wiped out for good
-      context 'when a repo is provided' do
-        subject(:workflow_xml) { client.workflow_xml(repo: 'dor', druid: 'druid:123', workflow: workflow) }
-
-        let(:workflow) { 'etdSubmitWF' }
-        let(:xml) { '<workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>' }
-        let(:stubs) do
-          Faraday::Adapter::Test::Stubs.new do |stub|
-            stub.get('dor/objects/druid:123/workflows/etdSubmitWF') do |_env|
-              [200, {}, xml]
-            end
-          end
-        end
-
-        it 'returns the xml for a given repository, druid, and workflow' do
-          expect(workflow_xml).to eq(xml)
-        end
-      end
-
-      context 'when a workflow name is provided' do
-        let(:workflow) { 'etdSubmitWF' }
-        let(:xml) { '<workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>' }
-        let(:stubs) do
-          Faraday::Adapter::Test::Stubs.new do |stub|
-            stub.get('/objects/druid:123/workflows/etdSubmitWF') do |_env|
-              [200, {}, xml]
-            end
-          end
-        end
-
-        it 'returns the xml for a given repository, druid, and workflow' do
-          expect(workflow_xml).to eq(xml)
-        end
-      end
-
-      context 'when no workflow name is provided' do
-        let(:workflow) { nil }
-
-        it 'raises an error' do
-          expect { workflow_xml }.to raise_error ArgumentError
-        end
-      end
-    end
-  end
-
   describe '#all_workflows_xml' do
     subject(:all_workflows_xml) { client.all_workflows_xml('druid:123') }
 
@@ -537,11 +315,11 @@ RSpec.describe Dor::Workflow::Client do
     end
 
     it 'parses out the active lifecycle' do
-      expect(client.active_lifecycle(druid: @druid, milestone_name: 'released').beginning_of_day).to eq(Time.parse('2010-06-15T16:08:58-0700').beginning_of_day)
+      expect(client.active_lifecycle(druid: @druid, milestone_name: 'released', version: '1').beginning_of_day).to eq(Time.parse('2010-06-15T16:08:58-0700').beginning_of_day)
     end
 
     it 'handles missing lifecycle' do
-      expect(client.active_lifecycle(druid: @druid, milestone_name: 'NOT_FOUND')).to be_nil
+      expect(client.active_lifecycle(druid: @druid, milestone_name: 'NOT_FOUND', version: '1')).to be_nil
     end
   end
 
@@ -729,31 +507,15 @@ RSpec.describe Dor::Workflow::Client do
       end
     end
 
-    context 'without a version' do
-      let(:url) { "/objects/#{@druid}/workflows/accessionWF" }
+    let(:url) { "/objects/#{@druid}/workflows/accessionWF?version=5" }
 
-      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
+    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(druid: @druid, workflow: 'accessionWF', version: 5)
     end
   end
 
   describe '.stale_queued_workflows' do
-    before do
-      allow(Deprecation).to receive(:warn)
-    end
-
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
         stub.get('workflow_queue/all_queued?hours-ago=24&limit=100') do |_env|
@@ -768,8 +530,7 @@ RSpec.describe Dor::Workflow::Client do
     end
 
     it 'returns an Array of Hashes containing each workflow step' do
-      ah = client.stale_queued_workflows 'dor', hours_ago: 24, limit: 100
-      expect(Deprecation).to have_received(:warn).once
+      ah = client.stale_queued_workflows hours_ago: 24, limit: 100
       expected = [
         { workflow: 'accessionWF', step: 'content-metadata', druid: 'dr:123', lane_id: 'lane1' },
         { workflow: 'assemblyWF',  step: 'jp2-create',       druid: 'dr:456', lane_id: 'lane2' }
@@ -779,10 +540,6 @@ RSpec.describe Dor::Workflow::Client do
   end
 
   describe '.count_stale_queued_workflows' do
-    before do
-      allow(Deprecation).to receive(:warn)
-    end
-
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
         stub.get('workflow_queue/all_queued?hours-ago=48&count-only=true') do |_env|
@@ -792,16 +549,11 @@ RSpec.describe Dor::Workflow::Client do
     end
 
     it 'returns the number of queued workflow steps' do
-      expect(client.count_stale_queued_workflows('dor', hours_ago: 48)).to eq(10)
-      expect(Deprecation).to have_received(:warn).once
+      expect(client.count_stale_queued_workflows(hours_ago: 48)).to eq(10)
     end
   end
 
   describe '.lane_ids' do
-    before do
-      allow(Deprecation).to receive(:warn)
-    end
-
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
         stub.get('workflow_queue/lane_ids?step=accessionWF:shelve') do |_env|
@@ -816,8 +568,7 @@ RSpec.describe Dor::Workflow::Client do
     end
 
     it 'returns the lane ids for a given workflow step' do
-      expect(client.lane_ids('dor', 'accessionWF', 'shelve')).to eq(%w[lane1 lane2])
-      expect(Deprecation).to have_received(:warn).once
+      expect(client.lane_ids('accessionWF', 'shelve')).to eq(%w[lane1 lane2])
     end
   end
 end