dor-workflow-client 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc0e250229c8ecc7c2e6301ce8315580d3b00c722b3c433d2449f4f463e2ce8a
-  data.tar.gz: 589ae27fd6229f5f4484bedb4e17f519552e7c832ca0c9eaa8c483890c721546
+  metadata.gz: 79af115a9f02f6d3de631dcf9dd88d6160b1fddc865cb19bf39e2f76077a7992
+  data.tar.gz: 41a3bb9cd2cfe4a7ae7eb74617c4bb54b0f351a266b3c56e13e1ce7962fdc9a9
 SHA512:
-  metadata.gz: 0e94ca49bca7bc61552a167fec185994184b718a28b8143aca6a66091669b768868d111101103067a08313d86b40e5319009fdc4177f166736c333477c10177f
-  data.tar.gz: 7970103464337acdbc9fe721f1521d8192bb5ba14f055743d930e38984106160007fa574e5dd690c445507076566a2af39d58b5877eef0d3eaaa4ae5fb606773
+  metadata.gz: 1e0e3579ec7be81ae999485c736d9314a71e4daf63116e19aaa7af92c86af59031795e61eca32114e5459c3c314fbe46f31d6640dde2fada2ec124abc1a1ff1c
+  data.tar.gz: 6ff468132eb597d1dc96e0901b828c4e4b9764832a4159ecbbb4920a3d9b705efc848586425eccd2fff195411a48e02a9a8e4e70c808e5ef350a98a636430c45

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

@@ -13,20 +13,23 @@ module Dor
         # @param [String] repo repository name
         # @param [String] druid object id
         # @param [String] milestone_name the name of the milestone being queried for
+        # @param [Number] version the version to query for
         # @return [Time] when the milestone was achieved.  Returns nil if the milestone does not exist
         #
-        def lifecycle(repo, druid, milestone_name)
-          filter_milestone(query_lifecycle(repo, druid), milestone_name)
+        def lifecycle(repo, druid, milestone_name, version: nil)
+          filter_milestone(query_lifecycle(repo, druid, version: version), milestone_name)
         end
 
-        # Returns the Date for a requested milestone ONLY FROM THE ACTIVE workflow table
+        # Returns the Date for a requested milestone ONLY for the current version.
+        # This is slow as the workflow server will query dor-services-app for the version.
+        # A better approach is #lifecycle with the version tag.
         # @param [String] repo repository name
         # @param [String] druid object id
         # @param [String] milestone_name the name of the milestone being queried for
         # @return [Time] when the milestone was achieved.  Returns nil if the milestone does not exis
         #
         def active_lifecycle(repo, druid, milestone_name)
-          filter_milestone(query_lifecycle(repo, druid, true), milestone_name)
+          filter_milestone(query_lifecycle(repo, druid, active_only: true), milestone_name)
         end
 
         # @return [Hash]
@@ -54,9 +57,15 @@ module Dor
         #     <milestone date="2010-06-15T16:08:58-0700">released</milestone>
         #   </lifecycle>
         #
-        def query_lifecycle(repo, druid, active_only = false)
+        def query_lifecycle(repo, druid, active_only: false, version: nil)
           req = "#{repo}/objects/#{druid}/lifecycle"
-          req += '?active-only=true' if active_only
+          req += if version
+                   "?version=#{version}"
+                 elsif active_only
+                   '?active-only=true'
+                 else
+                   ''
+                 end
           Nokogiri::XML(requestor.request(req))
         end
 

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

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     class Client
-      VERSION = '3.7.0'
+      VERSION = '3.8.0'
     end
   end
 end

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

@@ -145,9 +145,10 @@ module Dor
         # Updates the status of one step in a workflow to error.
         # Returns true on success.  Caller must handle any exceptions
         #
-        # @param [String] repo The repository the object resides in.  The service recoginzes "dor" and "sdr" at the moment
+        # @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
         # @param [String] workflow The name of the workflow
+        # @param [String] process The name of the workflow step
         # @param [String] error_msg The error message.  Ideally, this is a brief message describing the error
         # @param [Hash] opts optional values for the workflow step
         # @option opts [String] :error_text A slot to hold more information about the error, like a full stacktrace
@@ -157,14 +158,35 @@ module Dor
         # ==
         # The method does an HTTP PUT to the URL defined in `Dor::WF_URI`.
         #
-        #     PUT "/dor/objects/pid:123/workflows/GoogleScannedWF/convert"
+        #     PUT "/objects/pid:123/workflows/GoogleScannedWF/convert"
         #     <process name=\"convert\" status=\"error\" />"
-        def update_workflow_error_status(repo, druid, workflow, process, error_msg, opts = {})
-          opts = { error_text: nil }.merge!(opts)
-          xml = create_process_xml({ name: process, status: 'error', errorMessage: error_msg }.merge!(opts))
-          requestor.request "#{repo}/objects/#{druid}/workflows/#{workflow}/#{process}", 'put', xml, content_type: 'application/xml'
+        def update_workflow_error_status(_repo, druid, workflow, process, error_msg, opts = {})
+          update_error_status(druid: druid, workflow: workflow, process: process, error_msg: error_msg, error_text: opts[:error_text])
           true
         end
+        deprecation_deprecate update_workflow_error_status: 'use update_error_status instead.'
+
+        # Updates the status of one step in a workflow to error.
+        # Returns true on success.  Caller must handle any exceptions
+        #
+        # @param [String] druid The id of the object
+        # @param [String] workflow The name of the workflow
+        # @param [String] process The name of the workflow step
+        # @param [String] error_msg The error message.  Ideally, this is a brief message describing the error
+        # @param [String] error_text A slot to hold more information about the error, like a full stacktrace
+        # @return [Workflow::Response::Update]
+        #
+        # Http Call
+        # ==
+        # The method does an HTTP PUT to the URL defined in `Dor::WF_URI`.
+        #
+        #     PUT "/objects/pid:123/workflows/GoogleScannedWF/convert"
+        #     <process name=\"convert\" status=\"error\" />"
+        def update_error_status(druid:, workflow:, process:, error_msg:, error_text: nil)
+          xml = create_process_xml(name: process, status: 'error', errorMessage: error_msg, error_text: error_text)
+          response = requestor.request "objects/#{druid}/workflows/#{workflow}/#{process}", 'put', xml, content_type: 'application/xml'
+          Workflow::Response::Update.new(json: response)
+        end
 
         #
         # Retrieves the raw XML for all the workflows for the the given object

data/lib/dor/workflow/client.rb

@@ -41,7 +41,8 @@ module Dor
 
       delegate :create_workflow, :create_workflow_by_name, :update_workflow_status, :workflow_status,
                :workflow_xml, :update_workflow_error_status, :all_workflows_xml, :workflows,
-               :workflow, :delete_workflow, :delete_all_workflows, :update_status, to: :workflow_routes
+               :workflow, :delete_workflow, :delete_all_workflows, :update_status, :update_error_status,
+               to: :workflow_routes
 
       delegate :lifecycle, :active_lifecycle, :milestones, to: :lifecycle_routes
 

data/spec/workflow/client/lifecycle_routes_spec.rb

@@ -3,9 +3,9 @@
 require 'spec_helper'
 
 RSpec.describe Dor::Workflow::Client::LifecycleRoutes do
-  let(:mock_requestor) { instance_double(Dor::Workflow::Client::Requestor) }
-
-  let(:routes) { described_class.new(requestor: mock_requestor) }
+  let(:requestor) { instance_double(Dor::Workflow::Client::Requestor, request: response) }
+  let(:response) { '<xml />' }
+  let(:routes) { described_class.new(requestor: requestor) }
 
   describe '#milestones' do
     let(:ng_xml) { Nokogiri::XML(xml) }
@@ -24,4 +24,24 @@ RSpec.describe Dor::Workflow::Client::LifecycleRoutes do
       expect(milestones.first[:version]).to eq('2')
     end
   end
+
+  describe '#lifecycle' do
+    context 'without version' do
+      subject(:lifecycle) { routes.lifecycle('dor', 'druid:gv054hp4128', 'submitted') }
+
+      it 'make the request' do
+        lifecycle
+        expect(requestor).to have_received(:request).with('dor/objects/druid:gv054hp4128/lifecycle')
+      end
+    end
+
+    context 'with version' do
+      subject(:lifecycle) { routes.lifecycle('dor', 'druid:gv054hp4128', 'submitted', version: 3) }
+
+      it 'makes the request with the version' do
+        lifecycle
+        expect(requestor).to have_received(:request).with('dor/objects/druid:gv054hp4128/lifecycle?version=3')
+      end
+    end
+  end
 end

data/spec/workflow/client/workflow_routes_spec.rb

@@ -67,6 +67,31 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
     end
   end
 
+  describe '#update_error_status' do
+    let(:mock_requestor) { instance_double(Dor::Workflow::Client::Requestor, request: '{"next_steps":["submit-marc"]}') }
+    let(:druid) { 'druid:mw971zk1113' }
+
+    context 'when the request is successful' do
+      it 'updates workflow status and return true if successful' do
+        expect(routes.update_error_status(druid: druid, workflow: 'etdSubmitWF', process: 'registrar-approval', error_msg: 'broken')).to be_kind_of Dor::Workflow::Response::Update
+        expect(mock_requestor).to have_received(:request)
+          .with('objects/druid:mw971zk1113/workflows/etdSubmitWF/registrar-approval',
+                'put',
+                "<?xml version=\"1.0\"?>\n<process name=\"registrar-approval\" status=\"error\" errorMessage=\"broken\"/>\n",
+                content_type: 'application/xml')
+      end
+    end
+
+    context 'when the PUT to the DOR workflow service throws an exception' 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
+    end
+  end
+
   describe '#delete_all_workflows' do
     subject(:delete_all_workflows) do
       routes.delete_all_workflows(pid: 'druid:mw971zk1113')

data/spec/workflow/client_spec.rb

@@ -169,17 +169,21 @@ RSpec.describe Dor::Workflow::Client do
   describe '#update_workflow_error_status' do
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.put("#{@repo}/objects/#{@druid}/workflows/etdSubmitWF/reader-approval") do |env|
+        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, {}, '']
+          [201, {}, '{"next_steps":["submit-marc"]}']
         end
 
-        stub.put("#{@repo}/objects/#{@druid}/workflows/errorWF/reader-approval") do |_env|
+        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(@repo, @druid, 'etdSubmitWF', 'reader-approval', 'Some exception', error_text: 'The optional stacktrace')
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-client
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2019-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport