dor-workflow-client 5.1.0 → 7.0.0

data/spec/{workflow → dor/workflow}/client_spec.rb

@@ -14,6 +14,7 @@ RSpec.describe Dor::Workflow::Client do
     </workflow>
     EOXML
   end
+  let(:client) { described_class.new connection: mock_http_connection, logger: mock_logger }
 
   let(:wf_xml_label) do
     <<~EOXML
@@ -47,10 +48,9 @@ RSpec.describe Dor::Workflow::Client do
     @druid = 'druid:123'
   end
 
-  let(:client) { described_class.new connection: mock_http_connection, logger: mock_logger }
-
   describe '#connection' do
     subject(:conn) { client.requestor.connection }
+
     let(:client) { described_class.new url: 'http://example.com', timeout: 99, logger: mock_logger }
 
     it 'has a timeout' do
@@ -89,7 +89,8 @@ RSpec.describe Dor::Workflow::Client do
       end
 
       it 'sets the lane_id param' do
-        client.create_workflow_by_name(@druid, 'laneIdWF', lane_id: 'foo_lane', version: 1)
+        # if the stub isn't correct (params), it will raise an error
+        expect { client.create_workflow_by_name(@druid, 'laneIdWF', lane_id: 'foo_lane', version: 1) }.not_to raise_error
       end
     end
 
@@ -101,7 +102,8 @@ RSpec.describe Dor::Workflow::Client do
       end
 
       it 'sets the version param if provided in options hash' do
-        client.create_workflow_by_name(@druid, 'versionWF', version: 2)
+        # if the stub isn't correct (options hash), it will raise an error
+        expect { client.create_workflow_by_name(@druid, 'versionWF', version: 2) }.not_to raise_error
       end
     end
   end
@@ -121,21 +123,6 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
-  describe '#workflow_templates' do
-    subject(:workflow_templates) { client.workflow_templates }
-
-    let(:workflow_template_client) { instance_double Dor::Workflow::Client::WorkflowTemplate, all: 'data' }
-
-    before do
-      allow(Dor::Workflow::Client::WorkflowTemplate).to receive(:new).and_return(workflow_template_client)
-    end
-
-    it 'delegates to the client' do
-      expect(workflow_templates).to eq 'data'
-      expect(workflow_template_client).to have_received(:all)
-    end
-  end
-
   describe '#templates' do
     subject(:templates) { client.templates }
 
@@ -145,7 +132,16 @@ RSpec.describe Dor::Workflow::Client do
   end
 
   describe '#workflow_status' do
+    subject(:workflow_status) { client.workflow_status(druid: druid, workflow: workflow_name, process: step_name) }
+
     let(:repo) { nil }
+    let(:step_name) { 'registrar-approval' }
+    let(:workflow_name) { 'etdSubmitWF' }
+    let(:status) { 200 }
+    let(:response) do
+      [status, {}, xml]
+    end
+    let(:xml) { '' }
     let(:druid) { @druid }
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
@@ -155,22 +151,13 @@ RSpec.describe Dor::Workflow::Client do
       end
     end
 
-    subject { client.workflow_status(druid: druid, workflow: workflow_name, process: step_name) }
-    let(:step_name) { 'registrar-approval' }
-    let(:workflow_name) { 'etdSubmitWF' }
-    let(:status) { 200 }
-    let(:response) do
-      [status, {}, xml]
-    end
-    let(:xml) { '' }
-
     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')
+        expect(workflow_status).to eq('completed')
       end
     end
 
@@ -181,7 +168,7 @@ RSpec.describe Dor::Workflow::Client do
       end
 
       it 'returns the status for the highest version' do
-        expect(subject).to eq('waiting')
+        expect(workflow_status).to eq('waiting')
       end
     end
 
@@ -189,7 +176,7 @@ RSpec.describe Dor::Workflow::Client do
       let(:status) { 404 }
 
       it 'throws the missing workflow exception' do
-        expect { subject }.to raise_error Dor::MissingWorkflowException
+        expect { workflow_status }.to raise_error Dor::MissingWorkflowException
       end
     end
 
@@ -197,7 +184,7 @@ RSpec.describe Dor::Workflow::Client do
       let(:status) { 422 }
 
       it 'throws an exception' do
-        expect { subject }.to raise_error Dor::WorkflowException
+        expect { workflow_status }.to raise_error Dor::WorkflowException
       end
     end
 
@@ -207,7 +194,7 @@ RSpec.describe Dor::Workflow::Client do
       end
 
       it 'throws an exception' do
-        expect { subject }.to raise_error Dor::WorkflowException, "Unable to parse response:\nsomething not xml"
+        expect { workflow_status }.to raise_error Dor::WorkflowException, "Unable to parse response:\nsomething not xml"
       end
     end
 
@@ -218,36 +205,11 @@ RSpec.describe Dor::Workflow::Client do
       let(:step_name) { 'publish' }
 
       it 'returns nil' do
-        expect(subject).to be_nil
+        expect(workflow_status).to be_nil
       end
     end
   end
 
-  describe '#all_workflows_xml' do
-    subject(:all_workflows_xml) { client.all_workflows_xml('druid:123') }
-
-    let(:workflow) { 'etdSubmitWF' }
-    let(:xml) do
-      <<~XML
-        <workflows>
-        <workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>
-        <workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>
-        </workflows>
-      XML
-    end
-    let(:stubs) do
-      Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.get('objects/druid:123/workflows') do |_env|
-          [200, {}, xml]
-        end
-      end
-    end
-
-    it 'returns the xml for a given druid' do
-      expect(all_workflows_xml).to eq(xml)
-    end
-  end
-
   describe '#workflows' do
     let(:xml) { '<workflow id="accessionWF"><process name="publish" status="completed" /></workflow>' }
     let(:stubs) do
@@ -323,8 +285,8 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
-  context '#objects_for_workstep' do
-    before(:all) do
+  describe '#objects_for_workstep' do
+    before do
       @workflow   = 'googleScannedBookWF'
       @completed  = 'google-download'
       @waiting    = 'process-content'
@@ -353,8 +315,8 @@ RSpec.describe Dor::Workflow::Client do
       end
     end
 
-    context 'a query using qualified workflow names for completed and waiting' do
-      before :each do
+    context 'with a query using qualified workflow names for completed and waiting' do
+      before do
         @qualified_waiting   = "#{@workflow}:#{@waiting}"
         @qualified_completed = "#{@workflow}:#{@completed}"
       end
@@ -376,24 +338,28 @@ RSpec.describe Dor::Workflow::Client do
           let(:laneid) { 'default' }
         end
       end
+
       describe 'explicit lane_id' do
         it_behaves_like 'lane-aware' do
           let(:laneid) { 'lane1' }
         end
       end
 
-      context 'URI string creation' do
-        before :each do
+      context 'with URI string creation' do
+        before do
           @xml = %(<objects count="1"><object id="druid:ab123de4567"/></objects>)
         end
+
         it 'with only one completed step passed in as a String' do
           allow(mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@qualified_waiting}&completed=#{@qualified_completed}&lane-id=default").and_return(double(Faraday::Response, body: @xml))
           expect(client.objects_for_workstep(@qualified_completed, @qualified_waiting)).to eq(['druid:ab123de4567'])
         end
+
         it 'without any completed steps, only waiting' do
           allow(mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@qualified_waiting}&lane-id=default").and_return(double(Faraday::Response, body: @xml))
           expect(client.objects_for_workstep(nil, @qualified_waiting)).to eq(['druid:ab123de4567'])
         end
+
         it 'same but with lane_id' do
           allow(mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@qualified_waiting}&lane-id=lane1").and_return(double(Faraday::Response, body: @xml))
           expect(client.objects_for_workstep(nil, @qualified_waiting, 'lane1')).to eq(['druid:ab123de4567'])
@@ -402,8 +368,8 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
-  context 'get empty workflow queue' do
-    before(:all) do
+  context 'when empty workflow queue' do
+    before do
       @workflow   = 'googleScannedBookWF'
       @completed  = 'google-download'
       @waiting    = 'process-content'
@@ -422,134 +388,21 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
-  context 'get errored workflow steps' do
-    before(:all) do
-      @workflow   = 'accessionWF'
-      @step       = 'publish'
-    end
-
-    let(:stubs) do
-      Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.get("/workflow_queue?error=#{@step}&workflow=#{@workflow}") do |_env|
-          [200, {}, <<-EOXML]
-            <objects count="1">
-               <object id="druid:ab123cd4567" errorMessage="This is an error message"/>
-             </objects>
-          EOXML
-        end
-      end
-    end
-
-    describe 'errored_objects_for_workstep' do
-      it 'returns error messages for errored objects' do
-        expect(client.errored_objects_for_workstep(@workflow, @step)).to eq('druid:ab123cd4567' => 'This is an error message')
-      end
-    end
-
-    describe 'count_errored_for_workstep' do
-      it 'counts how many steps are errored out' do
-        expect(client.count_errored_for_workstep(@workflow, @step)).to eq(1)
-      end
-    end
-  end
-
-  describe '#count_queued_for_workstep' do
-    before(:all) do
-      @workflow   = 'accessionWF'
-      @step       = 'publish'
-    end
-
-    let(:stubs) do
-      Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.get("/workflow_queue?queued=#{@step}&workflow=#{@workflow}") do |_env|
-          [200, {}, <<-EOXML]
-            <objects count="1">
-               <object id="druid:ab123cd4567"/>
-             </objects>
-          EOXML
-        end
-      end
-    end
-
-    it 'counts how many steps are errored out' do
-      expect(client.count_queued_for_workstep(@workflow, @step)).to eq(1)
-    end
-  end
-
-  describe '#count_objects_in_step' do
-    before(:all) do
-      @workflow   = 'sdrIngestWF'
-      @step       = 'start-ingest'
-      @type       = 'waiting'
-    end
-
-    let(:stubs) do
-      Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.get("/workflow_queue?workflow=#{@workflow}&#{@type}=#{@step}") do |_env|
-          [200, {}, <<-EOXML]
-            <objects count="1">
-              <object id="druid:oo000ra0001" url="null/fedora/objects/druid:oo000ra0001"/>
-            </objects>
-          EOXML
-        end
-      end
-    end
-
-    it 'counts how many objects are at the type of step' do
-      expect(client.count_objects_in_step(@workflow, @step, @type)).to eq(1)
-    end
-  end
-
   describe '#delete_workflow' do
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
         stub.delete(url) { |_env| [202, {}, ''] }
       end
     end
-
     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(druid: @druid, workflow: 'accessionWF', version: 5)
-    end
-  end
-
-  describe '.stale_queued_workflows' do
-    let(:stubs) do
-      Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.get('workflow_queue/all_queued?hours-ago=24&limit=100') do |_env|
-          [200, {}, <<-XML]
-          <workflows>
-              <workflow laneId="lane1" note="annotation" lifecycle="in-process" errorText="stacktrace" errorMessage="NullPointerException" elapsed="1.173" repository="dor" attempts="0" datetime="2008-11-15T13:30:00-0800" status="waiting" process="content-metadata" name="accessionWF" druid="dr:123"/>
-              <workflow laneId="lane2" note="annotation" lifecycle="in-process" errorText="stacktrace" errorMessage="NullPointerException" elapsed="1.173" repository="dor" attempts="0" datetime="2008-11-15T13:30:00-0800" status="waiting" process="jp2-create" name="assemblyWF" druid="dr:456"/>
-          </workflows>
-          XML
-        end
-      end
-    end
-
-    it 'returns an Array of Hashes containing each workflow step' do
-      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' }
-      ]
-      expect(ah).to eql(expected)
-    end
-  end
-
-  describe '.count_stale_queued_workflows' do
-    let(:stubs) do
-      Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.get('workflow_queue/all_queued?hours-ago=48&count-only=true') do |_env|
-          [200, {}, '<objects count="10"/>']
-        end
-      end
+    before do
+      allow(mock_http_connection).to receive(:delete).with(url).and_call_original
     end
 
-    it 'returns the number of queued workflow steps' do
-      expect(client.count_stale_queued_workflows(hours_ago: 48)).to eq(10)
+    it 'sends a delete request to the workflow service' do
+      client.delete_workflow(druid: @druid, workflow: 'accessionWF', version: 5)
+      expect(mock_http_connection).to have_received(:delete).with(url)
     end
   end
 

data/spec/{models → dor/workflow}/response/process_spec.rb

@@ -3,9 +3,10 @@
 require 'spec_helper'
 
 RSpec.describe Dor::Workflow::Response::Process do
-  let(:parent) { Dor::Workflow::Response::Workflow.new(xml: xml) }
   subject(:instance) { parent.process_for_recent_version(name: 'start-assembly') }
 
+  let(:parent) { Dor::Workflow::Response::Workflow.new(xml: xml) }
+
   describe '#pid' do
     subject { instance.pid }
 
@@ -16,6 +17,7 @@ RSpec.describe Dor::Workflow::Response::Process do
         </workflow>
       XML
     end
+
     it { is_expected.to eq 'druid:mw971zk1113' }
   end
 
@@ -29,6 +31,7 @@ RSpec.describe Dor::Workflow::Response::Process do
         </workflow>
       XML
     end
+
     it { is_expected.to eq 'assemblyWF' }
   end
 
@@ -42,6 +45,7 @@ RSpec.describe Dor::Workflow::Response::Process do
         </workflow>
       XML
     end
+
     it { is_expected.to eq 'start-assembly' }
   end
 
@@ -55,6 +59,7 @@ RSpec.describe Dor::Workflow::Response::Process do
         </workflow>
       XML
     end
+
     it { is_expected.to eq 'default' }
   end
 end

data/spec/{models → dor/workflow}/response/workflow_spec.rb

@@ -14,6 +14,7 @@ RSpec.describe Dor::Workflow::Response::Workflow do
         </workflow>
       XML
     end
+
     it { is_expected.to eq 'druid:mw971zk1113' }
   end
 
@@ -26,11 +27,13 @@ RSpec.describe Dor::Workflow::Response::Workflow do
         </workflow>
       XML
     end
+
     it { is_expected.to eq 'assemblyWF' }
   end
 
   describe '#complete?' do
     subject { instance.complete? }
+
     context 'when all steps are complete' do
       let(:xml) do
         <<~XML
@@ -40,6 +43,7 @@ RSpec.describe Dor::Workflow::Response::Workflow do
           </workflow>
         XML
       end
+
       it { is_expected.to be true }
     end
 
@@ -52,6 +56,7 @@ RSpec.describe Dor::Workflow::Response::Workflow do
           </workflow>
         XML
       end
+
       it { is_expected.to be false }
     end
   end
@@ -68,6 +73,7 @@ RSpec.describe Dor::Workflow::Response::Workflow do
           </workflow>
         XML
       end
+
       it { is_expected.to be false }
     end
 
@@ -81,6 +87,7 @@ RSpec.describe Dor::Workflow::Response::Workflow do
           </workflow>
         XML
       end
+
       it { is_expected.to be true }
     end
   end

data/spec/{models → dor/workflow}/response/workflows_spec.rb

@@ -14,11 +14,12 @@ RSpec.describe Dor::Workflow::Response::Workflows do
         </workflows>
       XML
     end
+
     it { is_expected.to eq 'druid:mw971zk1113' }
   end
 
   describe '#workflows' do
-    subject { instance.workflows }
+    subject(:workflows) { instance.workflows }
 
     let(:xml) do
       <<~XML
@@ -32,8 +33,8 @@ RSpec.describe Dor::Workflow::Response::Workflows do
     end
 
     it 'has children' do
-      expect(subject).to all(be_kind_of Dor::Workflow::Response::Workflow)
-      expect(subject.map(&:workflow_name)).to eq %w[assemblyWF sdrPreservationWF]
+      expect(workflows).to all(be_kind_of Dor::Workflow::Response::Workflow)
+      expect(workflows.map(&:workflow_name)).to eq %w[assemblyWF sdrPreservationWF]
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-client
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-05 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -101,118 +101,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.24'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.24'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Enables Ruby manipulation of the DOR Workflow Service via its REST API
 email:
 - wmene@stanford.edu
@@ -249,18 +137,18 @@ files:
 - lib/dor/workflow/response/workflow.rb
 - lib/dor/workflow/response/workflows.rb
 - lib/dor/workflow_exception.rb
-- spec/models/response/process_spec.rb
-- spec/models/response/workflow_spec.rb
-- spec/models/response/workflows_spec.rb
+- spec/dor/workflow/client/connection_factory_spec.rb
+- 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
+- spec/dor/workflow/response/process_spec.rb
+- spec/dor/workflow/response/workflow_spec.rb
+- spec/dor/workflow/response/workflows_spec.rb
 - spec/spec_helper.rb
-- spec/workflow/client/connection_factory_spec.rb
-- spec/workflow/client/lifecycle_routes_spec.rb
-- spec/workflow/client/requestor_spec.rb
-- spec/workflow/client/status_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
 homepage: https://consul.stanford.edu/display/DOR/DOR+services#DORservices-initializeworkflow
 licenses: []
 metadata:
@@ -273,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/spec/{workflow → dor/workflow}/client/lifecycle_routes_spec.rb

@@ -10,6 +10,8 @@ RSpec.describe Dor::Workflow::Client::LifecycleRoutes do
   let(:druid) { 'druid:gv054hp4128' }
 
   describe '#milestones' do
+    subject(:milestones) { routes.milestones(druid: druid) }
+
     let(:ng_xml) { Nokogiri::XML(xml) }
     let(:xml) do
       '<?xml version="1.0" encoding="UTF-8"?><lifecycle objectId="druid:gv054hp4128"><milestone date="2012-01-26T21:06:54-0800" version="2">published</milestone></lifecycle>'
@@ -19,8 +21,6 @@ RSpec.describe Dor::Workflow::Client::LifecycleRoutes do
       allow(routes).to receive(:query_lifecycle).and_return(ng_xml)
     end
 
-    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')