dor-workflow-client 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79af115a9f02f6d3de631dcf9dd88d6160b1fddc865cb19bf39e2f76077a7992
-  data.tar.gz: 41a3bb9cd2cfe4a7ae7eb74617c4bb54b0f351a266b3c56e13e1ce7962fdc9a9
+  metadata.gz: 103d448136015a1fcfe0742a1804ac0d883106071ca53472ccf8e0671b158e11
+  data.tar.gz: b94093ac940a33c03dca26685ef808322d07f1430b61769414aabfbb6203587f
 SHA512:
-  metadata.gz: 1e0e3579ec7be81ae999485c736d9314a71e4daf63116e19aaa7af92c86af59031795e61eca32114e5459c3c314fbe46f31d6640dde2fada2ec124abc1a1ff1c
-  data.tar.gz: 6ff468132eb597d1dc96e0901b828c4e4b9764832a4159ecbbb4920a3d9b705efc848586425eccd2fff195411a48e02a9a8e4e70c808e5ef350a98a636430c45
+  metadata.gz: 75b52575766b05e2645d800203e18e6f2ffe2929be1de46b00c31b36712246280ae35332102d4675e642e74dbc8076f675df9a2fdc7d9f547c599cad4ee50134
+  data.tar.gz: 55279fcdcb43e241a3f368290b2d86c896956a7962a2bb2506c8b01f02533c5b6690545a7de675865d1323d58a03d34e928dc758c61dd8733727c04e2d2b4ed0

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

@@ -14,10 +14,11 @@ module Dor
         # @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
+        # @param [Boolean] active_only (false) if true, return only lifecycle steps for versions that have all processes complete
         # @return [Time] when the milestone was achieved.  Returns nil if the milestone does not exist
         #
-        def lifecycle(repo, druid, milestone_name, version: nil)
-          filter_milestone(query_lifecycle(repo, druid, version: version), milestone_name)
+        def lifecycle(repo, druid, milestone_name, version: nil, active_only: false)
+          filter_milestone(query_lifecycle(repo, druid, version: version, active_only: active_only), milestone_name)
         end
 
         # Returns the Date for a requested milestone ONLY for the current version.
@@ -26,15 +27,16 @@ 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 exis
         #
-        def active_lifecycle(repo, druid, milestone_name)
-          filter_milestone(query_lifecycle(repo, druid, active_only: true), milestone_name)
+        def active_lifecycle(repo, druid, milestone_name, version: nil)
+          lifecycle(repo, druid, milestone_name, version: version, active_only: true)
         end
 
         # @return [Hash]
         def milestones(repo, druid)
-          doc = query_lifecycle(repo, druid)
+          doc = query_lifecycle(repo, druid, active_only: false)
           doc.xpath('//lifecycle/milestone').collect do |node|
             { milestone: node.text, at: Time.parse(node['date']), version: node['version'] }
           end
@@ -49,6 +51,10 @@ module Dor
           Time.parse(milestone['date'])
         end
 
+        # @param [String] repo repository name
+        # @param [String] druid object id
+        # @param [Boolean] active_only (false) if true, return only lifecycle steps for versions that have all processes complete
+        # @param [Number] version the version to query for
         # @return [Nokogiri::XML::Document]
         # @example An example lifecycle xml from the workflow service.
         #   <lifecycle objectId="druid:ct011cv6501">
@@ -57,15 +63,13 @@ module Dor
         #     <milestone date="2010-06-15T16:08:58-0700">released</milestone>
         #   </lifecycle>
         #
-        def query_lifecycle(repo, druid, active_only: false, version: nil)
+        def query_lifecycle(repo, druid, active_only:, version: nil)
           req = "#{repo}/objects/#{druid}/lifecycle"
-          req += if version
-                   "?version=#{version}"
-                 elsif active_only
-                   '?active-only=true'
-                 else
-                   ''
-                 end
+          params = []
+          params << "version=#{version}" if version
+          params << 'active-only=true' if active_only
+          req += "?#{params.join('&')}" unless params.empty?
+
           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.8.0'
+      VERSION = '3.9.0'
     end
   end
 end

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

@@ -21,6 +21,15 @@ 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/spec/workflow/client/lifecycle_routes_spec.rb

@@ -44,4 +44,24 @@ RSpec.describe Dor::Workflow::Client::LifecycleRoutes do
       end
     end
   end
+
+  describe '#active_lifecycle' do
+    context 'without version' do
+      subject(:active_lifecycle) { routes.active_lifecycle('dor', 'druid:gv054hp4128', 'submitted') }
+
+      it 'make the request' do
+        active_lifecycle
+        expect(requestor).to have_received(:request).with('dor/objects/druid:gv054hp4128/lifecycle?active-only=true')
+      end
+    end
+
+    context 'with version' do
+      subject(:active_lifecycle) { routes.active_lifecycle('dor', 'druid:gv054hp4128', 'submitted', version: 3) }
+
+      it 'makes the request with the version' do
+        active_lifecycle
+        expect(requestor).to have_received(:request).with('dor/objects/druid:gv054hp4128/lifecycle?version=3&active-only=true')
+      end
+    end
+  end
 end

data/spec/workflow/client/workflow_template_spec.rb

@@ -3,18 +3,28 @@
 require 'spec_helper'
 
 RSpec.describe Dor::Workflow::Client::WorkflowTemplate do
-  let(:data) { '{"processes":[{"name":"start-assembly"},{"name":"content-metadata-create"}]}' }
   let(:mock_requestor) { instance_double(Dor::Workflow::Client::Requestor, request: data) }
 
   let(:routes) { described_class.new(requestor: mock_requestor) }
 
   describe '#retrieve' do
     subject(:workflow_template) { routes.retrieve('accessionWF') }
+    let(:data) { '{"processes":[{"name":"start-assembly"},{"name":"content-metadata-create"}]}' }
 
-    it 'returns a workflow' do
+    it 'returns a workflow template' do
       expect(workflow_template['processes']).to eq [{ 'name' => 'start-assembly' },
                                                     { 'name' => 'content-metadata-create' }]
       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

metadata

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