dor-workflow-client 7.3.0 → 7.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f68410646d6db8f4544022b03aa0c1f4ed062c94482663d6076a2e08deefc0aa
-  data.tar.gz: 2fceb32ccab79dc19cf8449268965f3450d26fb1ab57d23ebff17b316f95c758
+  metadata.gz: 5b29586cf5f0f5d2fd768d99ae4533af1d29e1879daa96b1e5611e09ef8195ff
+  data.tar.gz: 74c7641b0e942528005d65318116702a5cba4171b6f833f2ec46aa3065619ac7
 SHA512:
-  metadata.gz: bec89343f7f847098e221235e4f8f76fe862e57a4af9f05f6da16bc7739e9db28777ae2df11860eba4630c88d5fe179571b6a18bf556477fcae838793e579960
-  data.tar.gz: b1a5e69406924bd48383e18cabd9416d95a77b90c8cbbdfaf2e395de50b2e95926f9a2b30958036f94fa77be2a05f9a0556f5de0c080e3b1881ed7c2351e956a
+  metadata.gz: 46e27f180e3df6018706a9f01051ff09e757795bdc76e013ff8e493a01ba45a639f054a0fefa55f340e3aa054c7458eb4fc82acc8233f2c28208a8476e17c5b3
+  data.tar.gz: 9597f00cc9074bac61867dd441b2d96150ce814763c2d5e25b84e3741b905a0233f5a96e1061f61ba0f43aef13a5aebb57f18f9911d12026c7e51acc78ffc832

data/.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2.1
 orbs:
-  ruby-rails: sul-dlss/ruby-rails@4.1.0
+  ruby-rails: sul-dlss/ruby-rails@4.2.0
 workflows:
   build:
     jobs:

data/.gitignore

@@ -15,5 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+workflow_service.log*
 .ruby-version
 .ruby-gemset

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dor-workflow-client (7.3.0)
+    dor-workflow-client (7.4.1)
       activesupport (>= 3.2.1, < 8)
       deprecation (>= 0.99.0)
       faraday (~> 2.0)
@@ -12,7 +12,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.2)
+    activesupport (7.1.3.3)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -26,7 +26,7 @@ GEM
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.7)
+    bigdecimal (3.1.8)
     byebug (11.1.3)
     concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
@@ -42,31 +42,32 @@ GEM
       faraday-net_http (>= 2.0, < 3.2)
     faraday-net_http (3.1.0)
       net-http
-    faraday-retry (2.2.0)
+    faraday-retry (2.2.1)
       faraday (~> 2.0)
     hashdiff (1.1.0)
-    i18n (1.14.4)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
-    mini_portile2 (2.8.5)
-    minitest (5.22.3)
+    mini_portile2 (2.8.6)
+    minitest (5.23.0)
     mutex_m (0.2.0)
     net-http (0.4.1)
       uri
-    nokogiri (1.16.3)
+    nokogiri (1.16.5)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     parallel (1.24.0)
-    parser (3.3.0.5)
+    parser (3.3.1.0)
       ast (~> 2.4.1)
       racc
     public_suffix (5.0.5)
-    racc (1.7.3)
+    racc (1.8.0)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
+    regexp_parser (2.9.2)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -76,13 +77,13 @@ GEM
     rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.63.0)
+    rubocop (1.63.5)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -93,20 +94,20 @@ GEM
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
     rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
     rubocop-factory_bot (2.25.1)
       rubocop (~> 1.41)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.29.1)
+    rubocop-rspec (2.29.2)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
       rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.28.2)
+    rubocop-rspec_rails (2.28.3)
       rubocop (~> 1.40)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
@@ -115,6 +116,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    strscan (3.1.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
@@ -124,7 +126,7 @@ GEM
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     yard (0.9.36)
-    zeitwerk (2.6.13)
+    zeitwerk (2.6.14)
 
 PLATFORMS
   ruby

data/README.md

@@ -19,15 +19,47 @@ 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`.
 
+## Console
+
+During development, you can test the gem locally on your laptop, hitting a local instance of workflow-server-rails via the console:
+
+```ruby
+bin/console
+
+client = Dor::Workflow::Client.new(url: 'http://localhost:3000')
+client.create_workflow_by_name('druid:bc123df4567', 'accessionWF', version: '1', context: { 'requireOCR' => true})
+
+client.workflows('druid:bc123df4567')
+ => ["accessionWF"]
+
+client.workflow(pid: 'druid:bc123df4567', workflow_name: 'accessionWF')
+=> #<Dor::Workflow::Response::Workflow:0x0000000105c8b440
+
+client.process(pid: 'druid:bc123df4567', workflow_name: 'accessionWF', process: 'start-accession').context
+ => {"requireOCR"=>true}
+
+client.all_workflows(pid: 'druid:bc123df4567')
+=> #<Dor::Workflow::Response::Workflows:0x00000001055d29a0>.....
+```
+
 ## API
 [Rubydoc](https://www.rubydoc.info/github/sul-dlss/dor-workflow-client/main)
 
+### Workflow Variables
+
+If a workflow or workflows for a particular object require data to be persisted and available between steps, workflow variables can be set.  These are per object/version pair and thus available to any step in any workflow for a given version of an object once set.  Pass in a context variable as a Hash as shown in the example below.  The context will be returned as a hash when fetching workflows data for an object.
+
 ### Example usage
 Create a workflow
 ```
 client.create_workflow_by_name('druid:bc123df4567', 'etdSubmitWF', version: '1')
 ```
 
+Create a workflow and send in context
+```
+client.create_workflow_by_name('druid:bc123df4567', 'etdSubmitWF', version: '1', context: { foo: 'bar'} )
+```
+
 Update a workflow step's status
 ```ruby
 client.update_status(druid: 'druid:bc123df4567',
@@ -36,6 +68,24 @@ client.update_status(druid: 'druid:bc123df4567',
                      status: 'completed')
 ```
 
+Fetch information about a workflow:
+```ruby
+client.workflow(pid: 'druid:bc123df4567', workflow_name: 'etdSubmitWF')
+ => #<Dor::Workflow::Response::Workflow:0x000000010cb28588
+```
+
+Fetch information about a workflow step:
+```ruby
+client.process(pid: 'druid:bc123df4567', workflow_name: 'etdSubmitWF', process: 'registrar-approval')
+ => #<Dor::Workflow::Response::Process:0x000000010c505098
+```
+
+Fetch version context about a workflow step:
+```ruby
+client.process(pid: 'druid:bc123df4567', workflow_name: 'etdSubmitWF', process: 'registrar-approval').context
+ => {"foo"=>"bar"}
+```
+
 Show "milestones" for an object
 ```ruby
 client.milestones(druid: 'druid:gv054hp4128')

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'dor/workflow/client'
+
+require 'irb'
+IRB.start(__FILE__)

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

@@ -11,7 +11,6 @@ module Dor
 
         # Returns the Date for a requested milestone from workflow lifecycle
         #
-        # @param [String] repo The repository the object resides in. This parameter is deprecated
         # @param [String] druid object id
         # @param [String] milestone_name the name of the milestone being queried for
         # @param [Number] version (nil) the version to query for

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

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     class Client
-      VERSION = '7.3.0'
+      VERSION = '7.4.1'
     end
   end
 end

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

@@ -14,7 +14,6 @@ module Dor
         # - completes the versioningWF:submit-version and versioningWF:start-accession steps
         # - initiates accesssionWF
         #
-        # @param [String] repo The repository the object resides in. This parameter is deprecated
         # @param [String] druid The id of the object to delete the workflow from
         # @param [Boolean] create_accession_wf Option to create accessionWF when closing a version.  Defaults to true
         def close_version(druid:, version:, create_accession_wf: true)

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

@@ -17,13 +17,15 @@ module Dor
         # @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 [String] lane_id adds laneId attribute to all process elements in the wf_xml workflow xml.  Defaults to a value of 'default'
+        # @param [Hash] context optional context to be included in the workflow (same for all processes for a given druid/version pair)
         # @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, version:, lane_id: 'default')
+        def create_workflow_by_name(druid, workflow_name, version:, lane_id: 'default', context: nil)
           params = { 'lane-id' => lane_id, 'version' => version }
-          requestor.request "objects/#{druid}/workflows/#{workflow_name}", 'post', '',
-                            content_type: 'application/xml',
+          body = context ? { 'context' => context }.to_json : ''
+          requestor.request "objects/#{druid}/workflows/#{workflow_name}", 'post', body,
+                            content_type: 'application/json',
                             params: params
           true
         end
@@ -31,7 +33,6 @@ module Dor
         # Updates the status of one step in a workflow.
         # Returns true on success.  Caller must handle any exceptions
         #
-        # @param [String] repo The repository the object resides in.  The service recoginzes "dor" and "sdr" at the moment
         # @param [String] druid The id of the object
         # @param [String] workflow The name of the workflow
         # @param [String] process The name of the process step
@@ -50,6 +51,7 @@ module Dor
         def update_status(druid:, workflow:, process:, status:, elapsed: 0, lifecycle: nil, note: nil, current_status: nil)
           raise ArgumentError, "Unknown status value #{status}" unless VALID_STATUS.include?(status)
           raise ArgumentError, "Unknown current_status value #{current_status}" if current_status && !VALID_STATUS.include?(current_status)
+          raise ArgumentError, "Do not set status to 'error', use update_error_status method" if status == 'error'
 
           xml = create_process_xml(name: process, status: status, elapsed: elapsed, lifecycle: lifecycle, note: note)
           uri = "objects/#{druid}/workflows/#{workflow}/#{process}"
@@ -61,7 +63,6 @@ module Dor
 
         #
         # Retrieves the process status of the given workflow for the given object identifier
-        # @param [String] repo The repository the object resides in.  Currently recoginzes "dor" and "sdr".
         # @param [String] druid The id of the object
         # @param [String] workflow The name of the workflow
         # @param [String] process The name of the process step

data/lib/dor/workflow/client.rb

@@ -24,7 +24,7 @@ module Dor
     #
     # Create and update workflows
     class Client
-      # From Workflow Service's admin/Process.java
+      # From workflow-server-rails' app/models/workflow_step.rb
       VALID_STATUS = %w[waiting completed error queued skipped started].freeze
 
       attr_accessor :requestor
@@ -40,7 +40,7 @@ module Dor
         @requestor = Requestor.new(connection: connection || ConnectionFactory.build_connection(url, timeout: timeout, logger: logger))
       end
 
-      delegate :create_workflow_by_name, :workflow_status, :workflows,
+      delegate :create_workflow_by_name, :workflow_status, :workflows, :all_workflows,
                :workflow, :process, :delete_workflow, :delete_all_workflows, :update_status, :update_error_status,
                to: :workflow_routes
 

data/lib/dor/workflow/response/process.rb

@@ -51,6 +51,13 @@ module Dor
           @attributes[:laneId].presence
         end
 
+        # @return [Hash] the context for the process (or empty hash if none present)
+        def context
+          return {} unless @attributes[:context].present?
+
+          JSON.parse(@attributes[:context])
+        end
+
         delegate :pid, :workflow_name, to: :parent
 
         private

data/spec/dor/workflow/client/workflow_routes_spec.rb

@@ -108,6 +108,12 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
         expect { routes.update_status(druid: druid, workflow: 'accessionWF', process: 'publish', status: 'NOT_VALID_STATUS') }.to raise_error(ArgumentError)
       end
     end
+
+    context 'when an error status is provided' do
+      it 'throws an exception' do
+        expect { routes.update_status(druid: druid, workflow: 'accessionWF', process: 'publish', status: 'error') }.to raise_error(ArgumentError)
+      end
+    end
   end
 
   describe '#update_error_status' do
@@ -169,8 +175,48 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
   end
 
   describe '#create_workflow_by_name' do
-    it 'need to write these specs', skip: 'need to write specs' do
-      # something
+    let(:mock_requestor) { instance_double(Dor::Workflow::Client::Requestor, request: nil) }
+
+    context 'with default lane_id and no context' do
+      subject(:create_workflow_by_name) do
+        routes.create_workflow_by_name('druid:mw971zk1113', 'accessionWF', version: '1')
+      end
+
+      it 'sends a create request with default lane_id and without any context param' do
+        create_workflow_by_name
+        expect(mock_requestor).to have_received(:request)
+          .with('objects/druid:mw971zk1113/workflows/accessionWF', 'post', '',
+                { content_type: 'application/json',
+                  params: { 'lane-id' => 'default', 'version' => '1' } })
+      end
+    end
+
+    context 'with a custom lane_id' do
+      subject(:create_workflow_by_name) do
+        routes.create_workflow_by_name('druid:mw971zk1113', 'accessionWF', version: '1', lane_id: 'hamburgers')
+      end
+
+      it 'sends a create request without any context param' do
+        create_workflow_by_name
+        expect(mock_requestor).to have_received(:request)
+          .with('objects/druid:mw971zk1113/workflows/accessionWF', 'post', '',
+                { content_type: 'application/json',
+                  params: { 'lane-id' => 'hamburgers', 'version' => '1' } })
+      end
+    end
+
+    context 'when context is sent' do
+      subject(:create_workflow_by_name) do
+        routes.create_workflow_by_name('druid:mw971zk1113', 'accessionWF', version: '1', lane_id: 'default', context: { foo: 'bar' })
+      end
+
+      it 'sends a create request with the context in the body' do
+        create_workflow_by_name
+        expect(mock_requestor).to have_received(:request)
+          .with('objects/druid:mw971zk1113/workflows/accessionWF', 'post', '{"context":{"foo":"bar"}}',
+                { content_type: 'application/json',
+                  params: { 'lane-id' => 'default', 'version' => '1' } })
+      end
     end
   end
 end

data/spec/dor/workflow/client_spec.rb

@@ -225,6 +225,29 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
+  describe '#all_workflows' do
+    let(:xml) do
+      <<~XML
+        <workflows objectId="druid:123">
+          <workflow repository="dor" objectId="druid:123" id="accessionWF">
+            <process laneId="default" lifecycle="submitted" elapsed="0.0" attempts="1" datetime="2013-02-18T15:08:10-0800" status="completed" name="start-accession"/>
+          </workflow>
+        </workflows>
+      XML
+    end
+    let(:stubs) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get("/objects/#{@druid}/workflows") do |_env|
+          [200, {}, xml]
+        end
+      end
+    end
+
+    it 'returns the workflow details associated with druid' do
+      expect(client.all_workflows(pid: @druid).xml).to eq(xml)
+    end
+  end
+
   describe '#lifecycle' do
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|

data/spec/dor/workflow/response/process_spec.rb

@@ -62,4 +62,32 @@ RSpec.describe Dor::Workflow::Response::Process do
 
     it { is_expected.to eq 'default' }
   end
+
+  describe '#context' do
+    subject { instance.context }
+
+    context 'when context exists' do
+      let(:xml) do
+        <<~XML
+          <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
+            <process name="start-assembly" laneId="default" context="{&quot;requireOCR&quot;:true}">
+          </workflow>
+        XML
+      end
+
+      it { is_expected.to eq({ 'requireOCR' => true }) }
+    end
+
+    context 'when no context exists' do
+      let(:xml) do
+        <<~XML
+          <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
+            <process name="start-assembly" laneId="default" context="">
+          </workflow>
+        XML
+      end
+
+      it { is_expected.to eq({}) }
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-client
 version: !ruby/object:Gem::Version
-  version: 7.3.0
+  version: 7.4.1
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-11 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -120,6 +120,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
 - dor-workflow-client.gemspec
 - lib/dor/missing_workflow_exception.rb
 - lib/dor/workflow/client.rb
@@ -168,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Provides convenience methods to work with the DOR Workflow Service