dor-workflow-client 3.11.1 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9befc325f9a9f7f39fb51bfe1ec663ac1e47f4b873a8d86853849ab71842b14d
-  data.tar.gz: 57cdb8cc8896292bf406298bcfd779cca36cc68fdcdc5d5c352f2a8b63590b58
+  metadata.gz: 5cbb16ceddf569a9b82c822b1b885ebba29b592cd012ae340cb76882c61cc3d8
+  data.tar.gz: 4f1a7c2f940898abb328618ba1a8e09628fcf5a232e146b5546811a2bd3c223f
 SHA512:
-  metadata.gz: 5130e4c0418579681766938f1c53ddeba5ea84ef8aec72e4f1b87877d4120ecc718bd1b8e64c90f7eb515e0383080d73de4eecd6ffdbc6809ab459f2c1136f3b
-  data.tar.gz: dc7b9d86a50b2dc1bc2f7e706294c212df2e3e1c03c9693ea91d0ce4fe419354b8c8cb05d45716752e9d0ce98fe204351de64ab3b8ca3112d3e60e67943acfa7
+  metadata.gz: 228c451516708789a413be980b76fe25cb1efa7cf12865763291350ff86b2bdb63adfae2390ad02c3ef5fe33a213e68213a5a8dfb35a99531bded86fe396e21b
+  data.tar.gz: 42646cbdf62345f5128f7cc7c3391f245a387d6255734ddd498c71f38d82e6f6ec6ddbd2d3ad33c553abc09a9fee6525276343f7e6802cda1ed156aa8d55f643

data/Gemfile

@@ -2,7 +2,7 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in dor-workflow-service.gemspec
+# Specify your gem's dependencies in dor-workflow-client.gemspec
 gemspec
 
 gem 'activesupport', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']

data/README.md

@@ -24,7 +24,7 @@ Consumers of recent versions of the [dor-services](https://github.com/sul-dlss/d
 ### Example usage
 Create a workflow
 ```
-client.create_workflow_by_name('druid:bc123df4567', 'etdSubmitWF')
+client.create_workflow_by_name('druid:bc123df4567', 'etdSubmitWF', version: '1')
 ```
 
 Update a workflow step's status

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

@@ -43,7 +43,7 @@ module Dor
         # rubocop:enable Metrics/MethodLength
 
         def user_agent
-          "dor-workflow-service #{VERSION}"
+          "dor-workflow-client #{VERSION}"
         end
 
         private

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

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     class Client
-      VERSION = '3.11.1'
+      VERSION = '3.12.0'
     end
   end
 end

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

@@ -34,14 +34,17 @@ module Dor
         # @param [String] druid The id of the object
         # @param [String] workflow_name The name of the workflow you want to create. This must correspond with a workflow
         # name that is known by the workflow service.
-        # @param [Hash] opts optional params
-        # @option opts [String] :lane_id adds laneId attribute to all process elements in the wf_xml workflow xml.  Defaults to a value of 'default'
-        # @option opts [Integer] :version specifies the version so that workflow service doesn't need to query dor-services.
+        # @param [String] lane_id adds laneId attribute to all process elements in the wf_xml workflow xml.  Defaults to a value of 'default'
+        # @param [Integer] version specifies the version so that workflow service doesn't need to query dor-services.
         # @return [Boolean] always true
         #
-        def create_workflow_by_name(druid, workflow_name, opts = {})
-          params = { 'lane-id' => opts.fetch(:lane_id, 'default') }
-          params['version'] = opts[:version] if opts[:version]
+        def create_workflow_by_name(druid, workflow_name, version: nil, lane_id: 'default')
+          params = { 'lane-id' => lane_id }
+          if version
+            params['version'] = version
+          else
+            Deprecation.warn(self, 'Calling create_workflow_by_name without passing version is deprecated and will result in an error in dor-workflow-client 4.0')
+          end
           requestor.request "objects/#{druid}/workflows/#{workflow_name}", 'post', '',
                             content_type: 'application/xml',
                             params: params
@@ -136,7 +139,7 @@ module Dor
             workflow = opts[:workflow]
             process = opts[:process]
           end
-          workflow_md = workflow_xml(druid: druid, workflow: workflow)
+          workflow_md = fetch_workflow(druid: druid, workflow: workflow)
           doc = Nokogiri::XML(workflow_md)
           raise Dor::WorkflowException, "Unable to parse response:\n#{workflow_md}" if doc.root.nil?
 
@@ -166,11 +169,14 @@ module Dor
             druid = opts[:druid]
             workflow = opts[:workflow]
           end
+
           raise ArgumentError, 'missing workflow' unless workflow
           return requestor.request "#{repo}/objects/#{druid}/workflows/#{workflow}" if repo
 
-          requestor.request "objects/#{druid}/workflows/#{workflow}"
+          fetch_workflow(druid: druid, workflow: workflow)
         end
+        deprecation_deprecate workflow_xml: 'workflow_xml will not be replaced'
+
         # rubocop:enable Metrics/MethodLength
 
         # Updates the status of one step in a workflow to error.
@@ -246,7 +252,7 @@ module Dor
         #   => ["accessionWF", "assemblyWF", "disseminationWF"]
         def workflows(pid, repo = nil)
           Deprecation.warn(self, 'Passing the second argument (repo) to workflows is deprecated and can be omitted') if repo
-          xml_doc = Nokogiri::XML(workflow_xml(druid: pid, workflow: ''))
+          xml_doc = Nokogiri::XML(fetch_workflow(druid: pid, workflow: ''))
           xml_doc.xpath('//workflow').collect { |workflow| workflow['id'] }
         end
 
@@ -256,7 +262,7 @@ module Dor
         # @return [Workflow::Response::Workflow]
         def workflow(repo: nil, pid:, workflow_name:)
           Deprecation.warn(self, 'passing the repo parameter is deprecated and will be removed in the next major versions') if repo
-          xml = workflow_xml(druid: pid, workflow: workflow_name)
+          xml = fetch_workflow(druid: pid, workflow: workflow_name)
           Workflow::Response::Workflow.new(xml: xml)
         end
 
@@ -282,6 +288,12 @@ module Dor
 
         attr_reader :requestor
 
+        def fetch_workflow(druid:, workflow:)
+          raise ArgumentError, 'missing workflow' unless workflow
+
+          requestor.request "objects/#{druid}/workflows/#{workflow}"
+        end
+
         # @param [Hash] params
         # @return [String]
         def create_process_xml(params)

data/spec/workflow/client/connection_factory_spec.rb

@@ -7,18 +7,22 @@ RSpec.describe Dor::Workflow::Client::ConnectionFactory do
   let(:mock_logger) { double('Logger', info: true, debug: true, warn: true) }
 
   let(:druid) { 'druid:123' }
+  let(:request_url) { "http://example.com/objects/#{druid}/workflows/httpException?lane-id=default&version=1" }
   before do
-    stub_request(:post, "http://example.com/objects/#{druid}/workflows/httpException?lane-id=default")
+    stub_request(:post, request_url)
       .to_return(status: 500, body: 'Internal error', headers: {})
   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).with('retrying connection (1 remaining) to http://example.com/objects/druid:123/workflows/httpException?lane-id=default: (Faraday::RetriableResponse)  500')
-      expect(mock_logger).to receive(:warn).with('retrying connection (0 remaining) to http://example.com/objects/druid:123/workflows/httpException?lane-id=default: (Faraday::RetriableResponse)  500')
-      expect { client.create_workflow_by_name(druid, 'httpException') }.to raise_error Dor::WorkflowException
+      expect(mock_logger).to receive(:warn)
+        .with("retrying connection (1 remaining) to #{request_url}: (Faraday::RetriableResponse)  500")
+      expect(mock_logger).to receive(:warn)
+        .with("retrying connection (0 remaining) to #{request_url}: (Faraday::RetriableResponse)  500")
+      expect { request }.to raise_error Dor::WorkflowException
     end
   end
 end

data/spec/workflow/client/workflow_routes_spec.rb

@@ -7,6 +7,30 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
 
   let(:routes) { described_class.new(requestor: mock_requestor) }
 
+  describe '#fetch_workflow' do
+    subject(:fetch_workflow) { routes.send(:fetch_workflow, druid: 'druid:mw971zk1113', workflow: workflow) }
+
+    context 'when a workflow name is provided' do
+      let(:workflow) { 'etdSubmitWF' }
+      let(:mock_requestor) { instance_double(Dor::Workflow::Client::Requestor, request: xml) }
+      let(:xml) { '<workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>' }
+
+      it 'returns the xml for a given repository, druid, and workflow' do
+        expect(fetch_workflow).to eq(xml)
+        expect(mock_requestor).to have_received(:request)
+          .with('objects/druid:mw971zk1113/workflows/etdSubmitWF')
+      end
+    end
+
+    context 'when no workflow name is provided' do
+      let(:workflow) { nil }
+
+      it 'raises an error' do
+        expect { fetch_workflow }.to raise_error ArgumentError
+      end
+    end
+  end
+
   describe '#workflow' do
     let(:xml) do
       <<~XML
@@ -17,7 +41,7 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
     end
 
     before do
-      allow(routes).to receive(:workflow_xml) { xml }
+      allow(routes).to receive(:fetch_workflow) { xml }
     end
 
     it 'returns a workflow' do

data/spec/workflow/client_spec.rb

@@ -61,7 +61,7 @@ RSpec.describe Dor::Workflow::Client do
     end
 
     it 'has a user_agent' do
-      expect(conn.headers).to include('User-Agent' => /dor-workflow-service \d+\.\d+\.\d+/)
+      expect(conn.headers).to include('User-Agent' => /dor-workflow-client \d+\.\d+\.\d+/)
     end
 
     it 'defaults to using the flat params encoder' do
@@ -83,46 +83,70 @@ RSpec.describe Dor::Workflow::Client do
       allow(Deprecation).to receive(:warn)
     end
 
-    it 'should request the workflow by name and return the URL to the workflow' do
+    it 'requests the workflow by name and return the URL to the workflow' do
       client.create_workflow(@repo, @druid, 'etdSubmitWF', wf_xml)
-      expect(Deprecation).to have_received(:warn)
+      expect(Deprecation).to have_received(:warn).twice
     end
 
-    it 'should raise on an unexpected Exception' do
+    it 'raises on an unexpected Exception' do
       expect { client.create_workflow(@repo, @druid, 'raiseException', wf_xml) }.to raise_error(Exception, 'broken')
-      expect(Deprecation).to have_received(:warn)
+      expect(Deprecation).to have_received(:warn).twice
     end
 
     it 'sets the lane_id param if provided in options hash' do
       client.create_workflow(@repo, @druid, 'laneIdWF', wf_xml, lane_id: 'foo_lane')
-      expect(Deprecation).to have_received(:warn)
+      expect(Deprecation).to have_received(:warn).twice
     end
   end
 
   describe '#create_workflow_by_name' 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, {}, ''] }
+    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
-    end
 
-    it 'should request the workflow by name and return the URL to the workflow' do
-      client.create_workflow_by_name(@druid, 'etdSubmitWF')
+      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
 
-    it 'should raise on an unexpected Exception' do
-      expect { client.create_workflow_by_name(@druid, 'raiseException') }.to raise_error(Exception, 'broken')
+    context 'when an unexpected exception is raised' do
+      let(:stubs) do
+        Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.post("objects/#{@druid}/workflows/raiseException") { |_env| raise 'broken' }
+        end
+      end
+
+      it 'raises the error' do
+        expect { client.create_workflow_by_name(@druid, 'raiseException', version: '1') }.to raise_error(Exception, 'broken')
+      end
     end
 
-    it 'sets the lane_id param if provided in options hash' do
-      client.create_workflow_by_name(@druid, 'laneIdWF', lane_id: 'foo_lane')
+    context 'when lane_id is provided' do
+      let(:stubs) do
+        Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.post("objects/#{@druid}/workflows/laneIdWF?lane-id=foo_lane&version=1") { |_env| [201, {}, ''] }
+        end
+      end
+
+      it 'sets the lane_id param' do
+        client.create_workflow_by_name(@druid, 'laneIdWF', lane_id: 'foo_lane', version: 1)
+      end
     end
 
-    it 'sets the version param if provided in options hash' do
-      client.create_workflow_by_name(@druid, 'versionWF', version: 2)
+    context 'when lane_id is not provided' do
+      let(:stubs) do
+        Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.post("objects/#{@druid}/workflows/versionWF?version=2") { |_env| [201, {}, ''] }
+        end
+      end
+
+      it 'sets the version param if provided in options hash' do
+        client.create_workflow_by_name(@druid, 'versionWF', version: 2)
+      end
     end
   end
 
@@ -336,10 +360,10 @@ RSpec.describe Dor::Workflow::Client do
   end
 
   describe '#workflow_xml' do
+    before do
+      allow(Deprecation).to receive(:warn)
+    end
     context 'with positional args' do
-      before do
-        allow(Deprecation).to receive(:warn)
-      end
       subject(:workflow_xml) { client.workflow_xml('dor', 'druid:123', workflow) }
 
       context 'when a workflow name is provided' do
@@ -371,9 +395,6 @@ RSpec.describe Dor::Workflow::Client do
 
       context 'when a repo is provided' do
         subject(:workflow_xml) { client.workflow_xml(repo: 'dor', druid: 'druid:123', workflow: workflow) }
-        before do
-          allow(Deprecation).to receive(:warn)
-        end
 
         let(:workflow) { 'etdSubmitWF' }
         let(:xml) { '<workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>' }

metadata

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