dor-workflow-client 3.10.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 357ae42f561bd2a83ecd8250dc767b3426c0817d651fe38da5c81879d8bfbfc4
-  data.tar.gz: a6696a3639a6eaea0aa37b101d752f89a70104027f68473852e3a0f35432c1a5
+  metadata.gz: f99d2c878711b586b19b4493e6bfdfb97ccaa2d4633937aadf12527c275129be
+  data.tar.gz: 69101e12eb0cef2ee37e46983a7ca762e4d598f2794fcbc00923b0c4c07b30a7
 SHA512:
-  metadata.gz: cf907f6f4995caa88e19e06f0bf39e3a7ba54ce8515c106b69fc39c31f365d55de4de20afc673f9827f3264eeedb0dab8a804783853f6da3d9f025c0c9ac6bc4
-  data.tar.gz: e135d69b3ab60c5518f58524f1aee09a086d54277a02f7e344e8028e9b47d0ce79b015a94a852f4b3ee039770a3a57488511029239c0890942348613e3bdb56d
+  metadata.gz: 332dc12278f377747eaabeeacb2c728420c268e6664e6760b314353d38fb6e1443cfa515caee3c8c1df49209d514d526253345fd9bbd1a44d4f449c601c7782d
+  data.tar.gz: b6c26f3c28452ab4b566ec1ee0d60531a6776a215a71d1859695fe615c9b45dc9e5640edf2d158f010cb42c8d4ddcaa48edee0e826663a7e3cfe8768577660a7

data/README.md

@@ -19,27 +19,35 @@ client = Dor::Workflow::Client.new(url: 'https://test-server.edu/workflow/')
 Consumers of recent versions of the [dor-services](https://github.com/sul-dlss/dor-services) gem can access the configured `Dor::Workflow::Client` object via `Dor::Config`.
 
 ## API
+[Rubydoc](https://www.rubydoc.info/github/sul-dlss/dor-workflow-client/master)
 
+### Example usage
 Create a workflow
 ```
 client.create_workflow_by_name('druid:bc123df4567', 'etdSubmitWF')
 ```
 
 Update a workflow step's status
-```
+```ruby
 client.update_status(druid: 'druid:bc123df4567',
                      workflow: 'etdSubmitWF',
                      process: 'registrar-approval',
                      status: 'completed')
 ```
 
-List workflow templates
+Show "milestones" for an object
+```ruby
+client.milestones('dor', 'druid:gv054hp4128')
+#=> [{version: '1', milestone: 'published'}]
 ```
+
+List workflow templates
+```ruby
 client.workflow_templates
 ```
 
 Show a workflow template
-```
+```ruby
 client.workflow_template('etdSubmitWF')
 ```
 

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

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     class Client
-      VERSION = '3.10.0'
+      VERSION = '3.11.0'
     end
   end
 end

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

@@ -4,6 +4,7 @@ module Dor
   module Workflow
     class Client
       # Makes requests relating to a workflow
+      # rubocop:disable Metrics/ClassLength
       class WorkflowRoutes
         extend Deprecation
 
@@ -62,7 +63,7 @@ module Dor
         # @return [Boolean] always true
         # Http Call
         # ==
-        # The method does an HTTP PUT to the URL defined in `Dor::WF_URI`.  As an example:
+        # The method does an HTTP PUT to the base URL.  As an example:
         #
         #     PUT "/objects/pid:123/workflows/GoogleScannedWF/convert"
         #     <process name=\"convert\" status=\"completed\" />"
@@ -95,7 +96,7 @@ module Dor
         # @return [Boolean] always true
         # Http Call
         # ==
-        # The method does an HTTP PUT to the URL defined in `Dor::WF_URI`.  As an example:
+        # The method does an HTTP PUT to the base URL.  As an example:
         #
         #     PUT "/dor/objects/pid:123/workflows/GoogleScannedWF/convert"
         #     <process name=\"convert\" status=\"completed\" />"
@@ -120,8 +121,22 @@ module Dor
         # @param [String] workflow The name of the workflow
         # @param [String] process The name of the process step
         # @return [String] status for repo-workflow-process-druid
-        def workflow_status(repo, druid, workflow, process)
-          workflow_md = workflow_xml(repo, druid, workflow)
+        # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/AbcSize
+        def workflow_status(*args)
+          case args.length
+          when 4
+            Deprecation.warn(self, 'Calling workflow_status with positional args is deprecated, use kwargs instead')
+            (_repo, druid, workflow, process) = *args
+          when 1
+            opts = args.first
+            repo = opts[:repo]
+            Deprecation.warn(self, 'Passing `:repo` to workflow_status is deprecated and can be omitted') if repo
+            druid = opts[:druid]
+            workflow = opts[:workflow]
+            process = opts[:process]
+          end
+          workflow_md = workflow_xml(druid: druid, workflow: workflow)
           doc = Nokogiri::XML(workflow_md)
           raise Dor::WorkflowException, "Unable to parse response:\n#{workflow_md}" if doc.root.nil?
 
@@ -129,6 +144,8 @@ module Dor
           process = processes.max { |a, b| a.attr('version').to_i <=> b.attr('version').to_i }
           process&.attr('status')
         end
+        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/MethodLength
 
         #
         # Retrieves the raw XML for the given workflow
@@ -136,7 +153,18 @@ module Dor
         # @param [String] druid The id of the object
         # @param [String] workflow The name of the workflow
         # @return [String] XML of the workflow
-        def workflow_xml(repo, druid, workflow)
+        def workflow_xml(*args)
+          case args.length
+          when 3
+            Deprecation.warn(self, 'Calling workflow_xml with positional args is deprecated, use kwargs instead')
+            (repo, druid, workflow) = *args
+          when 1
+            opts = args.first
+            repo = opts[:repo]
+            Deprecation.warn(self, 'Passing `:repo` to workflow_xml is deprecated and can be omitted') if repo
+            druid = opts[:druid]
+            workflow = opts[:workflow]
+          end
           raise ArgumentError, 'missing workflow' unless workflow
 
           requestor.request "#{repo}/objects/#{druid}/workflows/#{workflow}"
@@ -156,7 +184,7 @@ module Dor
         #
         # Http Call
         # ==
-        # The method does an HTTP PUT to the URL defined in `Dor::WF_URI`.
+        # The method does an HTTP PUT to the base URL.
         #
         #     PUT "/objects/pid:123/workflows/GoogleScannedWF/convert"
         #     <process name=\"convert\" status=\"error\" />"
@@ -178,7 +206,7 @@ module Dor
         #
         # Http Call
         # ==
-        # The method does an HTTP PUT to the URL defined in `Dor::WF_URI`.
+        # The method does an HTTP PUT to the base URL.
         #
         #     PUT "/objects/pid:123/workflows/GoogleScannedWF/convert"
         #     <process name=\"convert\" status=\"error\" />"
@@ -213,8 +241,9 @@ module Dor
         # @example
         #   client.workflows('druid:sr100hp0609')
         #   => ["accessionWF", "assemblyWF", "disseminationWF"]
-        def workflows(pid, repo = 'dor')
-          xml_doc = Nokogiri::XML(workflow_xml(repo, pid, ''))
+        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.xpath('//workflow').collect { |workflow| workflow['id'] }
         end
 
@@ -222,8 +251,9 @@ module Dor
         # @param [String] pid id of object
         # @param [String] workflow_name The name of the workflow
         # @return [Workflow::Response::Workflow]
-        def workflow(repo: 'dor', pid:, workflow_name:)
-          xml = workflow_xml(repo, pid, workflow_name)
+        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)
           Workflow::Response::Workflow.new(xml: xml)
         end
 
@@ -260,6 +290,7 @@ module Dor
           builder.to_xml
         end
       end
+      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/spec/workflow/client_spec.rb

@@ -235,13 +235,13 @@ RSpec.describe Dor::Workflow::Client do
     let(:druid) { @druid }
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.get("#{repo}/objects/#{druid}/workflows/#{workflow_name}") do |_env|
+        stub.get("/objects/#{druid}/workflows/#{workflow_name}") do |_env|
           response
         end
       end
     end
 
-    subject { client.workflow_status(repo, druid, workflow_name, step_name) }
+    subject { client.workflow_status(druid: druid, workflow: workflow_name, process: step_name) }
     let(:step_name) { 'registrar-approval' }
     let(:workflow_name) { 'etdSubmitWF' }
     let(:status) { 200 }
@@ -250,6 +250,40 @@ RSpec.describe Dor::Workflow::Client do
     end
     let(:xml) { '' }
 
+    context 'when repo is provided' do
+      before do
+        allow(Deprecation).to receive(:warn)
+      end
+      subject { client.workflow_status(repo: repo, druid: druid, workflow: workflow_name, process: step_name) }
+
+      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')
+        end
+      end
+    end
+
+    context 'with positional arguments' do
+      before do
+        allow(Deprecation).to receive(:warn)
+      end
+      subject { client.workflow_status(repo, druid, workflow_name, step_name) }
+
+      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')
+        end
+      end
+    end
+
     context 'when a single result is returned' do
       let(:xml) do
         '<workflow><process name="registrar-approval" status="completed" /></workflow>'
@@ -302,29 +336,82 @@ RSpec.describe Dor::Workflow::Client do
   end
 
   describe '#workflow_xml' do
-    subject(:workflow_xml) { client.workflow_xml('dor', 'druid:123', workflow) }
-
-    context 'when a workflow name is provided' do
-      let(:workflow) { 'etdSubmitWF' }
-      let(:xml) { '<workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>' }
-      let(:stubs) do
-        Faraday::Adapter::Test::Stubs.new do |stub|
-          stub.get('dor/objects/druid:123/workflows/etdSubmitWF') do |_env|
-            [200, {}, xml]
+    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
+        let(:workflow) { 'etdSubmitWF' }
+        let(:xml) { '<workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>' }
+        let(:stubs) do
+          Faraday::Adapter::Test::Stubs.new do |stub|
+            stub.get('dor/objects/druid:123/workflows/etdSubmitWF') do |_env|
+              [200, {}, xml]
+            end
           end
         end
+
+        it 'returns the xml for a given repository, druid, and workflow' do
+          expect(workflow_xml).to eq(xml)
+        end
       end
 
-      it 'returns the xml for a given repository, druid, and workflow' do
-        expect(workflow_xml).to eq(xml)
+      context 'when no workflow name is provided' do
+        let(:workflow) { nil }
+
+        it 'raises an error' do
+          expect { workflow_xml }.to raise_error ArgumentError
+        end
       end
     end
+    context 'with keyword args' do
+      subject(:workflow_xml) { client.workflow_xml(druid: 'druid:123', workflow: workflow) }
 
-    context 'when no workflow name is provided' do
-      let(:workflow) { nil }
+      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>' }
+        let(:stubs) do
+          Faraday::Adapter::Test::Stubs.new do |stub|
+            stub.get('dor/objects/druid:123/workflows/etdSubmitWF') do |_env|
+              [200, {}, xml]
+            end
+          end
+        end
+
+        it 'returns the xml for a given repository, druid, and workflow' do
+          expect(workflow_xml).to eq(xml)
+        end
+      end
 
-      it 'raises an error' do
-        expect { workflow_xml }.to raise_error ArgumentError
+      context 'when a workflow name is provided' do
+        let(:workflow) { 'etdSubmitWF' }
+        let(:xml) { '<workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>' }
+        let(:stubs) do
+          Faraday::Adapter::Test::Stubs.new do |stub|
+            stub.get('/objects/druid:123/workflows/etdSubmitWF') do |_env|
+              [200, {}, xml]
+            end
+          end
+        end
+
+        it 'returns the xml for a given repository, druid, and workflow' do
+          expect(workflow_xml).to eq(xml)
+        end
+      end
+
+      context 'when no workflow name is provided' do
+        let(:workflow) { nil }
+
+        it 'raises an error' do
+          expect { workflow_xml }.to raise_error ArgumentError
+        end
       end
     end
   end
@@ -358,7 +445,7 @@ RSpec.describe Dor::Workflow::Client do
     let(:xml) { '<workflow id="accessionWF"><process name="publish" status="completed" /></workflow>' }
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.get("dor/objects/#{@druid}/workflows/") do |_env|
+        stub.get("/objects/#{@druid}/workflows/") do |_env|
           [200, {}, xml]
         end
       end

metadata

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