dor-workflow-service 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 247315ca28af42d73ab1947353b8ae71f459d75b
-  data.tar.gz: 0204c4ba989f633559264556415dfbc85db0a16e
+SHA256:
+  metadata.gz: ffae9b6a6c8ad9f6b160c80230c85f97387d9cd96c64ee3954c9c28c5f6d83b8
+  data.tar.gz: b682177ac31b9658cf850721ebcab413fb59ff5d9ab396540e22831330f02eec
 SHA512:
-  metadata.gz: '09781481dd5d29f0fe06a16e015587a0b8296cc3ab27b36e67f4ce5f0451eb27f477dea6a3af5621ca5bf3449e62fca5017354a4e8268c4eb9693bd41a6f68e3'
-  data.tar.gz: 5d08832b83c3e2996996e691664f89bbbce47e521ec36e7b4dbb2482345a3cc83395d9592d77116f9ec3b57bef85ac7ce2e2675d2a75bd4865ad18ea0d009d72
+  metadata.gz: f1c55e5f176a70ba9201e69211a732a7447a1484374df55b9bbcb1113215da2f5c4936fbe966ec08f83f58e7ad34b4a4b9e97fc0b24bdee3cfdde15fc9152896
+  data.tar.gz: 903f5def9d9c11e753600bec6fbe40cfe31396887739cfc4ee1b8a8bf65b1eddfe74ca47f5930d6a8f39de060841c801cc1a333eb6e41adb8f5df0aaf6bf2a34

data/.travis.yml

@@ -1,17 +1,10 @@
 language: ruby
-sudo: false
 notifications:
   email: false
 
 rvm:
-  - 2.2.5
-  - 2.3.1
-  
-matrix:
-  include:
-    - rvm: 2.1.2
-      env: RAILS_VERSION=4.2.7.1
+  - 2.5.3
 
 env:
-  - "RAILS_VERSION=4.2.7.1"
+  - "RAILS_VERSION=4.2.10"
   - "RAILS_VERSION=5.0.0.1"

data/README.md

@@ -1,9 +1,8 @@
 [![Build Status](https://travis-ci.org/sul-dlss/dor-workflow-service.svg?branch=master)](https://travis-ci.org/sul-dlss/dor-workflow-service)
-[![Dependency Status](https://gemnasium.com/sul-dlss/dor-workflow-service.svg)](https://gemnasium.com/sul-dlss/dor-workflow-service)
 
 # dor-workflow-service gem
 
-Provides Ruby convenience methods to work with the DOR Workflow REST Service. The REST API is defined here:
+A Ruby client to work with the DOR Workflow REST Service. The REST API is defined here:
 https://consul.stanford.edu/display/DOR/DOR+services#DORservices-initializeworkflow
 
 ## Usage

data/lib/dor/services/workflow_service.rb

@@ -96,9 +96,9 @@ module Dor
         workflow_md = get_workflow_xml(repo, druid, workflow)
         doc = Nokogiri::XML(workflow_md)
         raise Dor::WorkflowException.new("Unable to parse response:\n#{workflow_md}") if doc.root.nil?
-        status = doc.root.at_xpath("//process[@name='#{process}']/@status")
-        status = status.content if status
-        status
+        processes = doc.root.xpath("//process[@name='#{process}']")
+        process = processes.max { |a, b| a.attr('version').to_i <=> b.attr('version').to_i }
+        process&.attr('status')
       end
 
       #
@@ -555,7 +555,7 @@ module Dor
           response.body
         end
       rescue *workflow_service_exceptions_to_catch => e
-        msg = "Failed to retrieve resource: #{meth} #{base_url}/#{uri_string}"
+        msg = "Failed to retrieve resource: #{meth} #{base_url}#{uri_string}"
         msg += " (HTTP status #{e.response[:status]})" if e.respond_to?(:response) && e.response
         raise Dor::WorkflowException, msg
       end

data/lib/dor/workflow_version.rb

@@ -1,7 +1,7 @@
 module Dor
   module Workflow
     module Service
-      VERSION = '2.3.0'
+      VERSION = '2.4.0'
     end
   end
 end

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ SimpleCov.start do
   add_filter 'spec'
 end
 
+require 'byebug'
 require 'dor-workflow-service'
 require 'equivalent-xml'
 require 'equivalent-xml/rspec_matchers'

data/spec/workflow_service_spec.rb

@@ -166,37 +166,73 @@ describe Dor::WorkflowService do
   end
 
   describe '#get_workflow_status' do
+    let(:repo) { @repo }
+    let(:druid) { @druid }
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.get("#{@repo}/objects/#{@druid}/workflows/etdSubmitWF") do |env|
-          [200, {}, '<process name="registrar-approval" status="completed" />']
+        stub.get("#{repo}/objects/#{druid}/workflows/#{workflow_name}") do |env|
+          response
         end
+      end
+    end
 
-        stub.get("#{@repo}/objects/#{@druid}/workflows/missingWF") do |env|
-          [404, {}, '']
-        end
+    subject { Dor::WorkflowService.get_workflow_status(repo, druid, workflow_name, step_name) }
+    let(:step_name) { 'registrar-approval' }
+    let(:workflow_name) { 'etdSubmitWF' }
+    let(:status) { 200 }
+    let(:response) do
+      [status, {}, xml]
+    end
+    let(:xml) { '' }
 
-        stub.get("#{@repo}/objects/#{@druid}/workflows/errorWF") do |env|
-          [200, {}, 'something not xml']
-        end
+    context 'when a single result is returned' do
+      let(:xml) do
+        '<workflow><process name="registrar-approval" status="completed" /></workflow>'
+      end
 
-        stub.get("#{@repo}/objects/#{@druid}/workflows/accessionWF") do |env|
-          [200, {}, '<process name="registrar-approval" status="completed" />']
-        end
+      it 'returns status as a string' do
+        expect(subject).to eq('completed')
       end
     end
 
-    it 'parses workflow xml and returns status as a string' do
-      expect(Dor::WorkflowService.get_workflow_status('dor', 'druid:123', 'etdSubmitWF', 'registrar-approval')).to eq('completed')
+    context 'when a multiple versions are returned' do
+      let(:xml) do
+        '<workflow><process name="registrar-approval" version="1" status="completed" />
+          <process name="registrar-approval" version="2" status="waiting" /></workflow>'
+      end
+
+      it 'returns the status for the highest version' do
+        expect(subject).to eq('waiting')
+      end
     end
-    it 'should throw an exception if it fails for any reason' do
-      expect{ Dor::WorkflowService.get_workflow_status('dor', 'druid:123', 'missingWF', 'registrar-approval') }.to raise_error Dor::WorkflowException
+
+    context 'when it fails for any reason' do
+      let(:status) { 404 }
+
+      it 'throws an exception' do
+        expect{ subject }.to raise_error Dor::WorkflowException
+      end
     end
-    it 'should throw an exception if it cannot parse the response' do
-      expect{ Dor::WorkflowService.get_workflow_status('dor', 'druid:123', 'errorWF', 'registrar-approval') }.to raise_error(Dor::WorkflowException, "Unable to parse response:\nsomething not xml")
+
+    context 'when it cannot parse the response' do
+      let(:xml) do
+        'something not xml'
+      end
+
+      it 'throws an exception' do
+        expect{ subject }.to raise_error Dor::WorkflowException, "Unable to parse response:\nsomething not xml"
+      end
     end
-    it 'should return nil if the workflow/process combination doesnt exist' do
-      expect(Dor::WorkflowService.get_workflow_status('dor', 'druid:123', 'accessionWF', 'publish')).to be_nil
+
+    context 'when the workflow/process combination doesnt exist' do
+      let(:xml) do
+        '<workflow><process name="registrar-approval" status="completed" /></workflow>'
+      end
+      let(:step_name) { 'publish' }
+
+      it 'returns nil' do
+        expect(subject).to be_nil
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-service
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-13 00:00:00.000000000 Z
+date: 2019-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -255,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Provides convenience methods to work with the DOR Workflow Service