dor-workflow-client 5.1.0 → 7.0.0

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

@@ -32,6 +32,8 @@ module Dor
           'opened' => 9
         }.freeze
 
+        attr_reader :status_code
+
         # @param [String] druid the object identifier
         # @param [String|Integer] version the version identifier
         # @param [LifecycleRoutes] lifecycle_routes the lifecycle client
@@ -39,40 +41,12 @@ module Dor
           @druid = druid
           @version = version.to_s
           @lifecycle_routes = lifecycle_routes
-        end
-
-        # @return [Hash{Symbol => Object}] including :status_code and :status_time
-        def info
-          @info ||= begin
-            # if we have an accessioned milestone, this is the last possible step and should be the status regardless of time stamp
-            accessioned_milestones = current_milestones.select { |m| m[:milestone] == 'accessioned' }
-            return { status_code: STEPS['accessioned'], status_time: accessioned_milestones.last[:at].utc.xmlschema } unless accessioned_milestones.empty?
-
-            status_code = 0
-            status_time = nil
-            # for each milestone in the current version, see if it comes at the same time or after the current 'last' step, if so, make it the last and record the date/time
-            current_milestones.each do |m|
-              m_name = m[:milestone]
-              m_time = m[:at].utc.xmlschema
-              next unless STEPS.key?(m_name) && (!status_time || m_time >= status_time)
-
-              status_code = STEPS[m_name]
-              status_time = m_time
-            end
-
-            { status_code: status_code, status_time: status_time }
-          end
-        end
-
-        def status_code
-          info.fetch(:status_code)
+          @status_code, @status_time = status_from_latest_current_milestone
         end
 
         # @param [Boolean] include_time
         # @return [String] single composed status from status_info
         def display(include_time: false)
-          status_time = info[:status_time]
-
           # use the translation table to get the appropriate verbage for the latest step
           result = "v#{version} #{STATUS_CODE_DISP_TXT[status_code]}"
           result += " #{format_date(status_time)}" if include_time
@@ -89,7 +63,19 @@ module Dor
 
         private
 
-        attr_reader :druid, :version, :lifecycle_routes
+        attr_reader :druid, :version, :lifecycle_routes, :status_time
+
+        def status_from_latest_current_milestone
+          # if we have an accessioned milestone, this is the last possible step and should be the status regardless of timestamp
+          return [STEPS['accessioned'], latest_accessioned_milestone[:at].utc.xmlschema] if currently_accessioned?
+
+          return [0, nil] if latest_current_milestone.nil?
+
+          [
+            STEPS.fetch(latest_current_milestone.fetch(:milestone), 0),
+            latest_current_milestone[:at].utc.xmlschema
+          ]
+        end
 
         # @return [String] text translation of the status code, minus any trailing parenthetical explanation
         # e.g. 'In accessioning (described)' and 'In accessioning (described, published)' both return 'In accessioning'
@@ -98,19 +84,33 @@ module Dor
         end
 
         def current_milestones
-          current = []
-          # only get steps that are part of accessioning and part of the current version. That can mean they were archived with the current version
-          # number, or they might be active (no version number).
-          milestones.each do |m|
-            if STEPS.key?(m[:milestone]) && (m[:version].nil? || m[:version] == version)
-              current << m unless m[:milestone] == 'registered' && version.to_i > 1
-            end
-          end
-          current
+          milestones
+            # milestone name must be in list of known steps
+            .select { |m| STEPS.key?(m[:milestone]) }
+            # registered milestone is only valid for v1
+            .reject { |m| m[:milestone] == 'registered' && version.to_i > 1 }
+            # Two possible ways the version can indicate the milestone is part of the current version:
+            # if m[:version] is nil, then the milestone is active (version 0 becoming version 1)
+            # if m[:version] is matches the current version, then the milestone is archived with the current version
+            .select { |m| m[:version].nil? || m[:version] == version }
+        end
+
+        def latest_current_milestone
+          current_milestones.max_by { |m| m[:at].utc.xmlschema }
+        end
+
+        def currently_accessioned?
+          current_milestones.any? { |m| m[:milestone] == 'accessioned' }
+        end
+
+        def latest_accessioned_milestone
+          current_milestones
+            .select { |m| m[:milestone] == 'accessioned' }
+            .max_by { |m| m[:at].utc.xmlschema }
         end
 
-        # handles formating utc date/time to human readable
-        # XXX: bad form to hardcode TZ here.
+        # handles formatting UTC date/time to human readable
+        # TODO: bad form to hardcode TZ here.
         def format_date(datetime)
           d =
             if datetime.is_a?(Time)

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

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     class Client
-      VERSION = '5.1.0'
+      VERSION = '7.0.0'
     end
   end
 end

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

@@ -98,19 +98,11 @@ module Dor
           Workflow::Response::Update.new(json: response)
         end
 
-        #
-        # Retrieves the raw XML for all the workflows for the the given object
-        # @param [String] druid The id of the object
-        # @return [String] XML of the workflow
-        def all_workflows_xml(druid)
-          requestor.request "objects/#{druid}/workflows"
-        end
-
         # Retrieves all workflows for the given object
         # @param [String] pid The id of the object
         # @return [Workflow::Response::Workflows]
         def all_workflows(pid:)
-          xml = all_workflows_xml(pid)
+          xml = requestor.request "objects/#{pid}/workflows"
           Workflow::Response::Workflows.new(xml: xml)
         end
 

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

@@ -21,15 +21,6 @@ module Dor
           JSON.parse(body)
         end
 
-        # Retrieves a list of workflow template name
-        #
-        # @return [Array<String>] the list of templates
-        #
-        def all
-          body = requestor.request 'workflow_templates'
-          JSON.parse(body)
-        end
-
         private
 
         attr_reader :requestor

data/lib/dor/workflow/client.rb

@@ -40,15 +40,13 @@ module Dor
         @requestor = Requestor.new(connection: connection || ConnectionFactory.build_connection(url, timeout: timeout, logger: logger))
       end
 
-      delegate :create_workflow_by_name, :workflow_status, :all_workflows_xml, :workflows,
+      delegate :create_workflow_by_name, :workflow_status, :workflows,
                :workflow, :process, :delete_workflow, :delete_all_workflows, :update_status, :update_error_status,
                to: :workflow_routes
 
       delegate :lifecycle, :active_lifecycle, :milestones, to: :lifecycle_routes
 
-      delegate :lane_ids, :stale_queued_workflows, :count_stale_queued_workflows,
-               :objects_for_workstep, :errored_objects_for_workstep, :count_objects_in_step,
-               :count_errored_for_workstep, :count_queued_for_workstep,
+      delegate :lane_ids, :objects_for_workstep,
                to: :queues
 
       delegate :close_version, to: :version_routes
@@ -73,10 +71,6 @@ module Dor
         templates.retrieve(name)
       end
 
-      def workflow_templates
-        templates.all
-      end
-
       def templates
         WorkflowTemplate.new(requestor: requestor)
       end

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

@@ -5,24 +5,26 @@ require 'spec_helper'
 # This test can take up to 15s to run because it does retries with exponential backoff
 RSpec.describe Dor::Workflow::Client::ConnectionFactory do
   let(:mock_logger) { double('Logger', info: true, debug: true, warn: true) }
+  let(:client) { Dor::Workflow::Client.new url: 'http://example.com', logger: mock_logger }
 
   let(:druid) { 'druid:123' }
   let(:request_url) { "http://example.com/objects/#{druid}/workflows/httpException?lane-id=default&version=1" }
+
   before do
     stub_request(:post, request_url)
       .to_return(status: 500, body: 'Internal error', headers: {})
+    allow(mock_logger).to receive(:warn)
   end
 
-  let(:client) { Dor::Workflow::Client.new url: 'http://example.com', logger: mock_logger }
-
   describe '#create_workflow_by_name' do
     subject(:request) { client.create_workflow_by_name(druid, 'httpException', version: '1') }
+
     it 'logs an error and retry upon a targeted Faraday exception' do
-      expect(mock_logger).to receive(:warn)
+      expect { request }.to raise_error Dor::WorkflowException
+      expect(mock_logger).to have_received(:warn)
         .with("retrying connection (1) to #{request_url}: (Faraday::RetriableResponse)  500")
-      expect(mock_logger).to receive(:warn)
+      expect(mock_logger).to have_received(:warn)
         .with("retrying connection (2) to #{request_url}: (Faraday::RetriableResponse)  500")
-      expect { request }.to raise_error Dor::WorkflowException
     end
   end
 end

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

@@ -6,6 +6,7 @@ RSpec.describe Dor::Workflow::Client::Status do
   subject(:instance) do
     described_class.new(druid: druid, version: version, lifecycle_routes: lifecycle_routes)
   end
+
   let(:druid) { 'druid:ab123cd4567' }
   let(:version) { '2' }
   let(:lifecycle_routes) { Dor::Workflow::Client::LifecycleRoutes.new(requestor: requestor) }
@@ -14,7 +15,7 @@ RSpec.describe Dor::Workflow::Client::Status do
   describe '#display' do
     subject(:status) { instance.display }
 
-    context 'for gv054hp4128' do
+    describe 'for gv054hp4128' do
       context 'when current version is published, but does not have a version attribute' do
         let(:xml) do
           '<?xml version="1.0" encoding="UTF-8"?>
@@ -51,7 +52,7 @@ RSpec.describe Dor::Workflow::Client::Status do
       end
     end
 
-    context 'for bd504dj1946' do
+    describe 'for bd504dj1946' do
       let(:xml) do
         '<?xml version="1.0"?>
         <lifecycle objectId="druid:bd504dj1946">
@@ -100,7 +101,9 @@ RSpec.describe Dor::Workflow::Client::Status do
       end
     end
 
-    context 'for an accessioned step with the exact same timestamp as the deposited step' do
+    context 'with an accessioned step with the exact same timestamp as the deposited step' do
+      subject(:status) { instance.display(include_time: true) }
+
       let(:xml) do
         '<?xml version="1.0"?>
         <lifecycle objectId="druid:bd504dj1946">
@@ -120,14 +123,14 @@ RSpec.describe Dor::Workflow::Client::Status do
         </lifecycle>'
       end
 
-      subject(:status) { instance.display(include_time: true) }
-
       it 'has the correct status of accessioned (v2) object' do
         expect(status).to eq('v2 Accessioned 2013-10-01 07:10PM')
       end
     end
 
-    context 'for an accessioned step with an ealier timestamp than the deposited step' do
+    context 'with an accessioned step with an ealier timestamp than the deposited step' do
+      subject(:status) { instance.display(include_time: true) }
+
       let(:xml) do
         '<?xml version="1.0"?>
         <lifecycle objectId="druid:bd504dj1946">
@@ -147,14 +150,14 @@ RSpec.describe Dor::Workflow::Client::Status do
         </lifecycle>'
       end
 
-      subject(:status) { instance.display(include_time: true) }
-
       it 'has the correct status of accessioned (v2) object' do
         expect(status).to eq('v2 Accessioned 2013-09-01 07:10PM')
       end
     end
 
-    context 'for a deposited step for a non-accessioned object' do
+    context 'with a deposited step for a non-accessioned object' do
+      subject(:status) { instance.display(include_time: true) }
+
       let(:xml) do
         '<?xml version="1.0"?>
         <lifecycle objectId="druid:bd504dj1946">
@@ -173,8 +176,6 @@ RSpec.describe Dor::Workflow::Client::Status do
         </lifecycle>'
       end
 
-      subject(:status) { instance.display(include_time: true) }
-
       it 'has the correct status of deposited (v2) object' do
         expect(status).to eq('v2 In accessioning (described, published, deposited) 2013-10-01 07:10PM')
       end
@@ -183,6 +184,7 @@ RSpec.describe Dor::Workflow::Client::Status do
 
   describe '#display_simplified' do
     subject(:status) { instance.display_simplified }
+
     let(:xml) do
       '<?xml version="1.0" encoding="UTF-8"?>
       <lifecycle objectId="druid:gv054hp4128">

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

@@ -86,6 +86,7 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
       before do
         allow(mock_requestor).to receive(:request).and_raise(Dor::WorkflowException, 'status 400')
       end
+
       it 'raises an exception' do
         expect { routes.update_status(druid: druid, workflow: 'errorWF', process: 'registrar-approval', status: 'completed') }.to raise_error(Dor::WorkflowException, /status 400/)
       end
@@ -128,6 +129,7 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
       before do
         allow(mock_requestor).to receive(:request).and_raise(Dor::WorkflowException, 'status 400')
       end
+
       it 'raises an exception' do
         expect { routes.update_error_status(druid: druid, workflow: 'errorWF', process: 'registrar-approval', error_msg: 'broken') }.to raise_error(Dor::WorkflowException, /status 400/)
       end
@@ -138,19 +140,7 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes 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 '#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
@@ -171,15 +161,16 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
       XML
     end
 
-    before do
-      allow(routes).to receive(:all_workflows_xml) { xml }
-    end
+    let(:mock_requestor) { instance_double(Dor::Workflow::Client::Requestor, request: xml) }
 
-    it 'it returns the workflows' do
+    it 'returns the workflows' do
       expect(routes.all_workflows(pid: 'druid:mw971zk1113')).to be_kind_of Dor::Workflow::Response::Workflows
     end
   end
 
   describe '#create_workflow_by_name' do
+    it 'need to write these specs', skip: 'need to write specs' do
+      # something
+    end
   end
 end

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

@@ -9,6 +9,7 @@ RSpec.describe Dor::Workflow::Client::WorkflowTemplate do
 
   describe '#retrieve' do
     subject(:workflow_template) { routes.retrieve('accessionWF') }
+
     let(:data) { '{"processes":[{"name":"start-assembly"},{"name":"content-metadata-create"}]}' }
 
     it 'returns a workflow template' do
@@ -17,14 +18,4 @@ RSpec.describe Dor::Workflow::Client::WorkflowTemplate do
       expect(mock_requestor).to have_received(:request).with('workflow_templates/accessionWF')
     end
   end
-
-  describe '#all' do
-    subject(:workflow_templates) { routes.all }
-    let(:data) { '["assemblyWF","registrationWF"]' }
-
-    it 'returns a list of templates' do
-      expect(workflow_templates).to eq %w[assemblyWF registrationWF]
-      expect(mock_requestor).to have_received(:request).with('workflow_templates')
-    end
-  end
 end