dor-workflow-client 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa5a23b0984a3d7da51db957e5a2d7c6edce81362f78ff539ecacfc6b84d533c
-  data.tar.gz: 39414c933993e60ba993de7de54f4798b0d0afe5db787b4bf3891debc59f6fb9
+  metadata.gz: dc0e250229c8ecc7c2e6301ce8315580d3b00c722b3c433d2449f4f463e2ce8a
+  data.tar.gz: 589ae27fd6229f5f4484bedb4e17f519552e7c832ca0c9eaa8c483890c721546
 SHA512:
-  metadata.gz: 8dd823c38cf34f668096682bf54ec5727572fd3cf34c095dab6e7d88a4ede15a3003fe25248d36b81c72e77457a00f6a2615b4c0b2fbcd20afb5b03a4108ca7a
-  data.tar.gz: e6821dc36b1bd5c637b2c6f4aeb010e4f1e8f9e5ba2fce698ccf6a6bd8bd65d7e161e7bf59df57c89903bbaba718821fd51401b818d526ae1d6450a3bd49516a
+  metadata.gz: 0e94ca49bca7bc61552a167fec185994184b718a28b8143aca6a66091669b768868d111101103067a08313d86b40e5319009fdc4177f166736c333477c10177f
+  data.tar.gz: 7970103464337acdbc9fe721f1521d8192bb5ba14f055743d930e38984106160007fa574e5dd690c445507076566a2af39d58b5877eef0d3eaaa4ae5fb606773

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-04-06 08:08:20 -0500 using RuboCop version 0.63.1.
+# on 2019-09-13 10:43:44 -0500 using RuboCop version 0.63.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 2
 Metrics/AbcSize:
   Max: 23
 
@@ -15,7 +15,7 @@ Metrics/AbcSize:
 Metrics/MethodLength:
   Max: 13
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
-  Max: 6
+  Max: 8

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'faraday'
 require 'faraday_middleware'
 
 module Dor

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

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

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'deprecation'
-
 module Dor
   module Workflow
     class Client
@@ -49,6 +47,37 @@ module Dor
           true
         end
 
+        # Updates the status of one step in a workflow.
+        # 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] druid The id of the object
+        # @param [String] workflow The name of the workflow
+        # @param [String] process The name of the process step
+        # @param [String] status The status that you want to set -- using one of the values in VALID_STATUS
+        # @param [Float] :elapsed The number of seconds it took to complete this step. Can have a decimal.  Is set to 0 if not passed in.
+        # @param [String] :lifecycle Bookeeping label for this particular workflow step.  Examples are: 'registered', 'shelved'
+        # @param [String] :note Any kind of string annotation that you want to attach to the workflow
+        # @param [String] :current_status Setting this string tells the workflow service to compare the current status to this value.  If the current value does not match this value, the update is not performed
+        # @return [Boolean] always true
+        # Http Call
+        # ==
+        # The method does an HTTP PUT to the URL defined in `Dor::WF_URI`.  As an example:
+        #
+        #     PUT "/objects/pid:123/workflows/GoogleScannedWF/convert"
+        #     <process name=\"convert\" status=\"completed\" />"
+        def update_status(druid:, workflow:, process:, status:, elapsed: 0, lifecycle: nil, note: nil, current_status: nil)
+          raise ArgumentError, "Unknown status value #{status}" unless VALID_STATUS.include?(status)
+          raise ArgumentError, "Unknown current_status value #{current_status}" if current_status && !VALID_STATUS.include?(current_status)
+
+          xml = create_process_xml(name: process, status: status, elapsed: elapsed, lifecycle: lifecycle, note: note)
+          uri = "objects/#{druid}/workflows/#{workflow}/#{process}"
+          uri += "?current-status=#{current_status}" if current_status
+          response = requestor.request(uri, 'put', xml, content_type: 'application/xml')
+
+          Workflow::Response::Update.new(json: response)
+        end
+
         # Updates the status of one step in a workflow.
         # Returns true on success.  Caller must handle any exceptions
         #
@@ -80,9 +109,9 @@ module Dor
           uri = "#{repo}/objects/#{druid}/workflows/#{workflow}/#{process}"
           uri += "?current-status=#{current_status.downcase}" if current_status
           response = requestor.request(uri, 'put', xml, content_type: 'application/xml')
-
           Workflow::Response::Update.new(json: response)
         end
+        deprecation_deprecate update_workflow_status: 'use update_status instead.'
 
         #
         # Retrieves the process status of the given workflow for the given object identifier

data/lib/dor/workflow/client.rb

@@ -4,6 +4,8 @@ require 'active_support'
 require 'active_support/core_ext'
 require 'nokogiri'
 require 'zeitwerk'
+require 'faraday'
+require 'deprecation'
 
 loader = Zeitwerk::Loader.new
 # Zeitwerk::GemInflector wants to be instantiated with the main .rb entrypoint
@@ -39,7 +41,7 @@ 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, to: :workflow_routes
+               :workflow, :delete_workflow, :delete_all_workflows, :update_status, to: :workflow_routes
 
       delegate :lifecycle, :active_lifecycle, :milestones, to: :lifecycle_routes
 

data/spec/workflow/client/workflow_routes_spec.rb

@@ -25,6 +25,48 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
     end
   end
 
+  describe '#update_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_status(druid: druid, workflow: 'etdSubmitWF', process: 'registrar-approval', status: 'completed', note: 'annotation')).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=\"completed\" elapsed=\"0\" note=\"annotation\"/>\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_status(druid: druid, workflow: 'errorWF', process: 'registrar-approval', status: 'completed') }.to raise_error(Dor::WorkflowException, /status 400/)
+      end
+    end
+
+    context 'when current-status is passed as a parameter' do
+      it 'performs a conditional update' do
+        expect(routes.update_status(druid: druid, workflow: 'etdSubmitWF', process: 'registrar-approval', status: 'completed', note: 'annotation', current_status: 'queued')).to be_kind_of Dor::Workflow::Response::Update
+        expect(mock_requestor).to have_received(:request)
+          .with('objects/druid:mw971zk1113/workflows/etdSubmitWF/registrar-approval?current-status=queued',
+                'put',
+                "<?xml version=\"1.0\"?>\n<process name=\"registrar-approval\" status=\"completed\" elapsed=\"0\" note=\"annotation\"/>\n",
+                content_type: 'application/xml')
+      end
+    end
+
+    context 'when an invalid status is provided' do
+      it 'throws an exception' do
+        expect { routes.update_status(druid: druid, workflow: 'accessionWF', process: 'publish', status: 'NOT_VALID_STATUS') }.to raise_error(ArgumentError)
+      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

@@ -143,6 +143,9 @@ RSpec.describe Dor::Workflow::Client do
         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(@repo, @druid, 'etdSubmitWF', 'registrar-approval', 'completed', version: 2, note: 'annotation', lane_id: 'lane2')).to be_kind_of Dor::Workflow::Response::Update
@@ -181,7 +184,7 @@ RSpec.describe Dor::Workflow::Client do
       client.update_workflow_error_status(@repo, @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_status(@repo, @druid, 'errorWF', 'reader-approval', 'completed') }.to raise_error(Dor::WorkflowException, /status 400/)
+      expect { client.update_workflow_error_status(@repo, @druid, 'errorWF', 'reader-approval', 'completed') }.to raise_error(Dor::WorkflowException, /status 400/)
     end
   end
 

metadata

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