dor-workflow-client 3.9.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 103d448136015a1fcfe0742a1804ac0d883106071ca53472ccf8e0671b158e11
-  data.tar.gz: b94093ac940a33c03dca26685ef808322d07f1430b61769414aabfbb6203587f
+  metadata.gz: 357ae42f561bd2a83ecd8250dc767b3426c0817d651fe38da5c81879d8bfbfc4
+  data.tar.gz: a6696a3639a6eaea0aa37b101d752f89a70104027f68473852e3a0f35432c1a5
 SHA512:
-  metadata.gz: 75b52575766b05e2645d800203e18e6f2ffe2929be1de46b00c31b36712246280ae35332102d4675e642e74dbc8076f675df9a2fdc7d9f547c599cad4ee50134
-  data.tar.gz: 55279fcdcb43e241a3f368290b2d86c896956a7962a2bb2506c8b01f02533c5b6690545a7de675865d1323d58a03d34e928dc758c61dd8733727c04e2d2b4ed0
+  metadata.gz: cf907f6f4995caa88e19e06f0bf39e3a7ba54ce8515c106b69fc39c31f365d55de4de20afc673f9827f3264eeedb0dab8a804783853f6da3d9f025c0c9ac6bc4
+  data.tar.gz: e135d69b3ab60c5518f58524f1aee09a086d54277a02f7e344e8028e9b47d0ce79b015a94a852f4b3ee039770a3a57488511029239c0890942348613e3bdb56d

data/README.md

@@ -13,11 +13,36 @@ https://consul.stanford.edu/display/DOR/DOR+services#DORservices-initializeworkf
 You should initialize a `Dor::Workflow::Client` object in your application configuration, i.e. in a bootup or startup method like:
 
 ```ruby
-wfs = Dor::Workflow::Client.new(url: 'https://test-server.edu/workflow/')
+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
+
+Create a workflow
+```
+client.create_workflow_by_name('druid:bc123df4567', 'etdSubmitWF')
+```
+
+Update a workflow step's status
+```
+client.update_status(druid: 'druid:bc123df4567',
+                     workflow: 'etdSubmitWF',
+                     process: 'registrar-approval',
+                     status: 'completed')
+```
+
+List workflow templates
+```
+client.workflow_templates
+```
+
+Show a workflow template
+```
+client.workflow_template('etdSubmitWF')
+```
+
 ## Underlying Clients
 
 This gem currently uses the [Faraday](https://github.com/lostisland/faraday) HTTP client to access the back-end service.  The clients be accessed directly from your `Dor::Workflow::Client` object:

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

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

data/lib/dor/workflow/client.rb

@@ -70,7 +70,15 @@ module Dor
       end
 
       def workflow_template(name)
-        WorkflowTemplate.new(requestor: requestor).retrieve(name)
+        templates.retrieve(name)
+      end
+
+      def workflow_templates
+        templates.all
+      end
+
+      def templates
+        WorkflowTemplate.new(requestor: requestor)
       end
 
       private

data/spec/workflow/client_spec.rb

@@ -207,6 +207,29 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
+  describe '#workflow_templates' do
+    subject(:workflow_templates) { client.workflow_templates }
+
+    let(:workflow_template_client) { instance_double Dor::Workflow::Client::WorkflowTemplate, all: 'data' }
+
+    before do
+      allow(Dor::Workflow::Client::WorkflowTemplate).to receive(:new).and_return(workflow_template_client)
+    end
+
+    it 'delegates to the client' do
+      expect(workflow_templates).to eq 'data'
+      expect(workflow_template_client).to have_received(:all)
+    end
+  end
+
+  describe '#templates' do
+    subject(:templates) { client.templates }
+
+    it 'returns the template client' do
+      expect(templates).to be_instance_of Dor::Workflow::Client::WorkflowTemplate
+    end
+  end
+
   describe '#workflow_status' do
     let(:repo) { @repo }
     let(:druid) { @druid }

metadata

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