dor-workflow-client 5.1.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c58569c11d2c599671ecf4fef09158bdf37191c93c4193d96d2e6be614d9eeaa
-  data.tar.gz: ce8f53542aede57b9386ec769673fac4af7a92d9bb32b2c9a00ba9fe59ae6754
+  metadata.gz: b02179966ff3ccea0895b6f24e697893d1f6f86ca19f11e4f7e1bf1cd431d2d2
+  data.tar.gz: 34e3c8191e88642e1850fa346552a2f986a809289334193f6bee25273b20f81f
 SHA512:
-  metadata.gz: e09e2e40204d869c31ce832509ccf4582d98823cd767348966789a5961bfb2ae3b67b148a35a41f734fb782100bef10619e36a1f44e244a70685d3a1d6613f90
-  data.tar.gz: 2ddd5435a3f7738a48800182c46e1d243bf9bdaf457d367f7f26d0a7868c61005f853850a18aba61c97475c74bf297b08060fc7a51fdadd76161d90b4287cebc
+  metadata.gz: 100a4642fffa4640ad6f35cff6ec1e8e224919985c6f2852bbf840790350bdc9bd4fca81a9a343eb86eced7e69a489d0ed25fc32d0036c511fc581267efc5ce8
+  data.tar.gz: c3d5755642cff98de6adba80ea2e67dbe61195e38885dd7c4163409d3d978e49420a9ef1f55488133d49724affc985f0ad8463560fe58c5eae0c3ecabc616ec9

data/.circleci/config.yml

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

data/.rubocop.yml

@@ -1,17 +1,37 @@
 inherit_from: .rubocop_todo.yml
 
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 3.0
-# Configuration parameters: AllowURI, URISchemes.
+  # Configuration parameters: AllowURI, URISchemes.
+  Exclude:
+  - 'vendor/**/*'
+
+
 Layout/LineLength:
   Max: 300
 
+Lint/UnusedBlockArgument:
+  AllowUnusedKeywordArguments: true
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*_spec.rb
 
-Lint/UnusedBlockArgument:
-  AllowUnusedKeywordArguments: true
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4
 
 Gemspec/DeprecatedAttributeAssignment: # new in 1.10
   Enabled: true
@@ -143,4 +163,121 @@ Style/NestedFileDirname: # new in 1.26
 Style/ObjectThen: # new in 1.28
   Enabled: true
 Style/RedundantInitialize: # new in 1.27
-  Enabled: true
+  Enabled: true
+
+Lint/DuplicateMagicComment: # new in 1.37
+  Enabled: true
+Lint/DuplicateMatchPattern: # new in 1.50
+  Enabled: true
+Lint/UselessRescue: # new in 1.43
+  Enabled: true
+Metrics/CollectionLiteralLength: # new in 1.47
+  Enabled: true
+Style/ArrayIntersect: # new in 1.40
+  Enabled: true
+Style/ComparableClamp: # new in 1.44
+  Enabled: true
+Style/ConcatArrayLiterals: # new in 1.41
+  Enabled: true
+Style/DataInheritance: # new in 1.49
+  Enabled: true
+Style/DirEmpty: # new in 1.48
+  Enabled: true
+Style/ExactRegexpMatch: # new in 1.51
+  Enabled: true
+Style/FileEmpty: # new in 1.48
+  Enabled: true
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+Style/MapToSet: # new in 1.42
+  Enabled: true
+Style/MinMaxComparison: # new in 1.42
+  Enabled: true
+Style/OperatorMethodCall: # new in 1.37
+  Enabled: true
+Style/RedundantArrayConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantConstantBase: # new in 1.40
+  Enabled: true
+Style/RedundantDoubleSplatHashBraces: # new in 1.41
+  Enabled: true
+Style/RedundantEach: # new in 1.38
+  Enabled: true
+Style/RedundantFilterChain: # new in 1.52
+  Enabled: true
+Style/RedundantHeredocDelimiterQuotes: # new in 1.45
+  Enabled: true
+Style/RedundantLineContinuation: # new in 1.49
+  Enabled: true
+Style/RedundantRegexpConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantStringEscape: # new in 1.37
+  Enabled: true
+
+Capybara/MatchStyle: # new in 2.17
+  Enabled: true
+Capybara/NegationMatcher: # new in 2.14
+  Enabled: true
+Capybara/SpecificActions: # new in 2.14
+  Enabled: true
+Capybara/SpecificFinders: # new in 2.13
+  Enabled: true
+Capybara/SpecificMatcher: # new in 2.12
+  Enabled: true
+FactoryBot/AssociationStyle: # new in 2.23
+  Enabled: true
+FactoryBot/ConsistentParenthesesStyle: # new in 2.14
+  Enabled: true
+FactoryBot/FactoryAssociationWithStrategy: # new in 2.23
+  Enabled: true
+FactoryBot/FactoryNameStyle: # new in 2.16
+  Enabled: true
+FactoryBot/RedundantFactoryOption: # new in 2.23
+  Enabled: true
+FactoryBot/SyntaxMethods: # new in 2.7
+  Enabled: true
+RSpec/BeEmpty: # new in 2.20
+  Enabled: true
+RSpec/BeEq: # new in 2.9.0
+  Enabled: true
+RSpec/BeNil: # new in 2.9.0
+  Enabled: true
+RSpec/ChangeByZero: # new in 2.11
+  Enabled: true
+RSpec/ContainExactly: # new in 2.19
+  Enabled: true
+RSpec/DuplicatedMetadata: # new in 2.16
+  Enabled: true
+RSpec/ExcessiveDocstringSpacing: # new in 2.5
+  Enabled: true
+RSpec/IdenticalEqualityAssertion: # new in 2.4
+  Enabled: true
+RSpec/IndexedLet: # new in 2.20
+  Enabled: true
+RSpec/MatchArray: # new in 2.19
+  Enabled: true
+RSpec/NoExpectationExample: # new in 2.13
+  Enabled: true
+RSpec/PendingWithoutReason: # new in 2.16
+  Enabled: true
+RSpec/RedundantAround: # new in 2.19
+  Enabled: true
+RSpec/SkipBlockInsideExample: # new in 2.19
+  Enabled: true
+RSpec/SortMetadata: # new in 2.14
+  Enabled: true
+RSpec/SubjectDeclaration: # new in 2.5
+  Enabled: true
+RSpec/VerifiedDoubleReference: # new in 2.10.0
+  Enabled: true
+RSpec/Rails/AvoidSetupHook: # new in 2.4
+  Enabled: true
+RSpec/Rails/HaveHttpStatus: # new in 2.12
+  Enabled: true
+RSpec/Rails/InferredSpecType: # new in 2.14
+  Enabled: true
+RSpec/Rails/MinitestAssertions: # new in 2.17
+  Enabled: true
+RSpec/Rails/TravelAround: # new in 2.19
+  Enabled: true
+

data/.rubocop_todo.yml

@@ -1,58 +1,40 @@
 # This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2022-06-28 04:56:14 UTC using RuboCop version 1.31.0.
+# `rubocop --auto-gen-config --auto-gen-only-exclude`
+# on 2023-06-20 15:30:24 UTC using RuboCop version 1.52.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequiredRubyVersion:
-  Exclude:
-    - 'dor-workflow-client.gemspec'
-
-# Offense count: 1
-# Configuration parameters: AllowComments, AllowEmptyLambdas.
-Lint/EmptyBlock:
-  Exclude:
-    - 'spec/workflow/client/workflow_routes_spec.rb'
-
-# Offense count: 1
-Lint/NoReturnInBeginEndBlocks:
-  Exclude:
-    - 'lib/dor/workflow/client/status.rb'
-
-# Offense count: 5
-# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 23
-
 # Offense count: 2
-# Configuration parameters: IgnoredMethods.
-Metrics/CyclomaticComplexity:
-  Max: 8
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/dor/workflow/client/connection_factory.rb'
+    - 'lib/dor/workflow/client/queues.rb'
 
 # Offense count: 2
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# Configuration parameters: CountComments, Max, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 19
-
-# Offense count: 3
-# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
-Metrics/ParameterLists:
-  Max: 8
+  Exclude:
+    - 'lib/dor/workflow/client/connection_factory.rb'
+    - 'lib/dor/workflow/client/queues.rb'
 
 # Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/KeywordParametersOrder:
+# Configuration parameters: Max, CountKeywordArgs, MaxOptionalParameters.
+Metrics/ParameterLists:
   Exclude:
     - 'lib/dor/workflow/client/workflow_routes.rb'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowModifier.
-Style/SoleNestedConditional:
+# Offense count: 73
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/dor/workflow/client_spec.rb'
+
+# Offense count: 7
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
   Exclude:
-    - 'lib/dor/workflow/client/status.rb'
+    - 'spec/dor/workflow/client/connection_factory_spec.rb'
+    - 'spec/dor/workflow/client_spec.rb'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dor-workflow-client (5.1.0)
+    dor-workflow-client (6.0.0)
       activesupport (>= 3.2.1, < 8)
       deprecation (>= 0.99.0)
       faraday (~> 2.0)
@@ -12,96 +12,101 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3.1)
+    activesupport (7.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     byebug (11.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
     deprecation (1.1.0)
       activesupport
     diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (2.4.0)
-      faraday-net_http (~> 2.0)
+    faraday (2.7.6)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.1.0)
-    faraday-retry (2.0.0)
+    faraday-net_http (3.0.2)
+    faraday-retry (2.2.0)
       faraday (~> 2.0)
     hashdiff (1.0.1)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    json (2.6.2)
-    mini_portile2 (2.8.0)
-    minitest (5.16.2)
-    nokogiri (1.13.8)
-      mini_portile2 (~> 2.8.0)
+    json (2.6.3)
+    mini_portile2 (2.8.2)
+    minitest (5.18.1)
+    nokogiri (1.15.2)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.1.2.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    public_suffix (4.0.7)
-    racc (1.6.0)
+      racc
+    public_suffix (5.0.1)
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.5.0)
+    regexp_parser (2.8.1)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rspec_junit_formatter (0.5.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.33.0)
+    rubocop (1.52.1)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.19.1, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.19.1)
-      parser (>= 3.1.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.12.1)
-      rubocop (~> 1.31)
-    ruby-progressbar (1.11.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.2.0)
-    webmock (3.16.0)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-    zeitwerk (2.6.0)
+    yard (0.9.34)
+    zeitwerk (2.6.8)
 
 PLATFORMS
   ruby
@@ -120,4 +125,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.3.17
+   2.4.13

data/dor-workflow-client.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
 
   gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.require_paths = ['lib']
-  gem.required_ruby_version = '>= 2.7'
+  gem.required_ruby_version = '>= 3.0'
 
   gem.add_dependency 'activesupport', '>= 3.2.1', '< 8'
   gem.add_dependency 'deprecation', '>= 0.99.0'

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

@@ -32,6 +32,8 @@ module Dor
           'opened' => 9
         }.freeze
 
+        attr_reader :status_code
+
         # @param [String] druid the object identifier
         # @param [String|Integer] version the version identifier
         # @param [LifecycleRoutes] lifecycle_routes the lifecycle client
@@ -39,40 +41,12 @@ module Dor
           @druid = druid
           @version = version.to_s
           @lifecycle_routes = lifecycle_routes
-        end
-
-        # @return [Hash{Symbol => Object}] including :status_code and :status_time
-        def info
-          @info ||= begin
-            # if we have an accessioned milestone, this is the last possible step and should be the status regardless of time stamp
-            accessioned_milestones = current_milestones.select { |m| m[:milestone] == 'accessioned' }
-            return { status_code: STEPS['accessioned'], status_time: accessioned_milestones.last[:at].utc.xmlschema } unless accessioned_milestones.empty?
-
-            status_code = 0
-            status_time = nil
-            # for each milestone in the current version, see if it comes at the same time or after the current 'last' step, if so, make it the last and record the date/time
-            current_milestones.each do |m|
-              m_name = m[:milestone]
-              m_time = m[:at].utc.xmlschema
-              next unless STEPS.key?(m_name) && (!status_time || m_time >= status_time)
-
-              status_code = STEPS[m_name]
-              status_time = m_time
-            end
-
-            { status_code: status_code, status_time: status_time }
-          end
-        end
-
-        def status_code
-          info.fetch(:status_code)
+          @status_code, @status_time = status_from_latest_current_milestone
         end
 
         # @param [Boolean] include_time
         # @return [String] single composed status from status_info
         def display(include_time: false)
-          status_time = info[:status_time]
-
           # use the translation table to get the appropriate verbage for the latest step
           result = "v#{version} #{STATUS_CODE_DISP_TXT[status_code]}"
           result += " #{format_date(status_time)}" if include_time
@@ -89,7 +63,19 @@ module Dor
 
         private
 
-        attr_reader :druid, :version, :lifecycle_routes
+        attr_reader :druid, :version, :lifecycle_routes, :status_time
+
+        def status_from_latest_current_milestone
+          # if we have an accessioned milestone, this is the last possible step and should be the status regardless of timestamp
+          return [STEPS['accessioned'], latest_accessioned_milestone[:at].utc.xmlschema] if currently_accessioned?
+
+          return [0, nil] if latest_current_milestone.nil?
+
+          [
+            STEPS.fetch(latest_current_milestone.fetch(:milestone), 0),
+            latest_current_milestone[:at].utc.xmlschema
+          ]
+        end
 
         # @return [String] text translation of the status code, minus any trailing parenthetical explanation
         # e.g. 'In accessioning (described)' and 'In accessioning (described, published)' both return 'In accessioning'
@@ -98,19 +84,33 @@ module Dor
         end
 
         def current_milestones
-          current = []
-          # only get steps that are part of accessioning and part of the current version. That can mean they were archived with the current version
-          # number, or they might be active (no version number).
-          milestones.each do |m|
-            if STEPS.key?(m[:milestone]) && (m[:version].nil? || m[:version] == version)
-              current << m unless m[:milestone] == 'registered' && version.to_i > 1
-            end
-          end
-          current
+          milestones
+            # milestone name must be in list of known steps
+            .select { |m| STEPS.key?(m[:milestone]) }
+            # registered milestone is only valid for v1
+            .reject { |m| m[:milestone] == 'registered' && version.to_i > 1 }
+            # Two possible ways the version can indicate the milestone is part of the current version:
+            # if m[:version] is nil, then the milestone is active (version 0 becoming version 1)
+            # if m[:version] is matches the current version, then the milestone is archived with the current version
+            .select { |m| m[:version].nil? || m[:version] == version }
+        end
+
+        def latest_current_milestone
+          current_milestones.max_by { |m| m[:at].utc.xmlschema }
+        end
+
+        def currently_accessioned?
+          current_milestones.any? { |m| m[:milestone] == 'accessioned' }
+        end
+
+        def latest_accessioned_milestone
+          current_milestones
+            .select { |m| m[:milestone] == 'accessioned' }
+            .max_by { |m| m[:at].utc.xmlschema }
         end
 
-        # handles formating utc date/time to human readable
-        # XXX: bad form to hardcode TZ here.
+        # handles formatting UTC date/time to human readable
+        # TODO: bad form to hardcode TZ here.
         def format_date(datetime)
           d =
             if datetime.is_a?(Time)

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

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     class Client
-      VERSION = '5.1.0'
+      VERSION = '6.0.0'
     end
   end
 end

data/spec/{workflow → dor/workflow}/client/connection_factory_spec.rb

@@ -5,24 +5,26 @@ require 'spec_helper'
 # This test can take up to 15s to run because it does retries with exponential backoff
 RSpec.describe Dor::Workflow::Client::ConnectionFactory do
   let(:mock_logger) { double('Logger', info: true, debug: true, warn: true) }
+  let(:client) { Dor::Workflow::Client.new url: 'http://example.com', logger: mock_logger }
 
   let(:druid) { 'druid:123' }
   let(:request_url) { "http://example.com/objects/#{druid}/workflows/httpException?lane-id=default&version=1" }
+
   before do
     stub_request(:post, request_url)
       .to_return(status: 500, body: 'Internal error', headers: {})
+    allow(mock_logger).to receive(:warn)
   end
 
-  let(:client) { Dor::Workflow::Client.new url: 'http://example.com', logger: mock_logger }
-
   describe '#create_workflow_by_name' do
     subject(:request) { client.create_workflow_by_name(druid, 'httpException', version: '1') }
+
     it 'logs an error and retry upon a targeted Faraday exception' do
-      expect(mock_logger).to receive(:warn)
+      expect { request }.to raise_error Dor::WorkflowException
+      expect(mock_logger).to have_received(:warn)
         .with("retrying connection (1) to #{request_url}: (Faraday::RetriableResponse)  500")
-      expect(mock_logger).to receive(:warn)
+      expect(mock_logger).to have_received(:warn)
         .with("retrying connection (2) to #{request_url}: (Faraday::RetriableResponse)  500")
-      expect { request }.to raise_error Dor::WorkflowException
     end
   end
 end

data/spec/{workflow → dor/workflow}/client/status_spec.rb

@@ -6,6 +6,7 @@ RSpec.describe Dor::Workflow::Client::Status do
   subject(:instance) do
     described_class.new(druid: druid, version: version, lifecycle_routes: lifecycle_routes)
   end
+
   let(:druid) { 'druid:ab123cd4567' }
   let(:version) { '2' }
   let(:lifecycle_routes) { Dor::Workflow::Client::LifecycleRoutes.new(requestor: requestor) }
@@ -14,7 +15,7 @@ RSpec.describe Dor::Workflow::Client::Status do
   describe '#display' do
     subject(:status) { instance.display }
 
-    context 'for gv054hp4128' do
+    describe 'for gv054hp4128' do
       context 'when current version is published, but does not have a version attribute' do
         let(:xml) do
           '<?xml version="1.0" encoding="UTF-8"?>
@@ -51,7 +52,7 @@ RSpec.describe Dor::Workflow::Client::Status do
       end
     end
 
-    context 'for bd504dj1946' do
+    describe 'for bd504dj1946' do
       let(:xml) do
         '<?xml version="1.0"?>
         <lifecycle objectId="druid:bd504dj1946">
@@ -100,7 +101,9 @@ RSpec.describe Dor::Workflow::Client::Status do
       end
     end
 
-    context 'for an accessioned step with the exact same timestamp as the deposited step' do
+    context 'with an accessioned step with the exact same timestamp as the deposited step' do
+      subject(:status) { instance.display(include_time: true) }
+
       let(:xml) do
         '<?xml version="1.0"?>
         <lifecycle objectId="druid:bd504dj1946">
@@ -120,14 +123,14 @@ RSpec.describe Dor::Workflow::Client::Status do
         </lifecycle>'
       end
 
-      subject(:status) { instance.display(include_time: true) }
-
       it 'has the correct status of accessioned (v2) object' do
         expect(status).to eq('v2 Accessioned 2013-10-01 07:10PM')
       end
     end
 
-    context 'for an accessioned step with an ealier timestamp than the deposited step' do
+    context 'with an accessioned step with an ealier timestamp than the deposited step' do
+      subject(:status) { instance.display(include_time: true) }
+
       let(:xml) do
         '<?xml version="1.0"?>
         <lifecycle objectId="druid:bd504dj1946">
@@ -147,14 +150,14 @@ RSpec.describe Dor::Workflow::Client::Status do
         </lifecycle>'
       end
 
-      subject(:status) { instance.display(include_time: true) }
-
       it 'has the correct status of accessioned (v2) object' do
         expect(status).to eq('v2 Accessioned 2013-09-01 07:10PM')
       end
     end
 
-    context 'for a deposited step for a non-accessioned object' do
+    context 'with a deposited step for a non-accessioned object' do
+      subject(:status) { instance.display(include_time: true) }
+
       let(:xml) do
         '<?xml version="1.0"?>
         <lifecycle objectId="druid:bd504dj1946">
@@ -173,8 +176,6 @@ RSpec.describe Dor::Workflow::Client::Status do
         </lifecycle>'
       end
 
-      subject(:status) { instance.display(include_time: true) }
-
       it 'has the correct status of deposited (v2) object' do
         expect(status).to eq('v2 In accessioning (described, published, deposited) 2013-10-01 07:10PM')
       end
@@ -183,6 +184,7 @@ RSpec.describe Dor::Workflow::Client::Status do
 
   describe '#display_simplified' do
     subject(:status) { instance.display_simplified }
+
     let(:xml) do
       '<?xml version="1.0" encoding="UTF-8"?>
       <lifecycle objectId="druid:gv054hp4128">

data/spec/{workflow → dor/workflow}/client/workflow_routes_spec.rb

@@ -86,6 +86,7 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
       before do
         allow(mock_requestor).to receive(:request).and_raise(Dor::WorkflowException, 'status 400')
       end
+
       it 'raises an exception' do
         expect { routes.update_status(druid: druid, workflow: 'errorWF', process: 'registrar-approval', status: 'completed') }.to raise_error(Dor::WorkflowException, /status 400/)
       end
@@ -128,6 +129,7 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
       before do
         allow(mock_requestor).to receive(:request).and_raise(Dor::WorkflowException, 'status 400')
       end
+
       it 'raises an exception' do
         expect { routes.update_error_status(druid: druid, workflow: 'errorWF', process: 'registrar-approval', error_msg: 'broken') }.to raise_error(Dor::WorkflowException, /status 400/)
       end
@@ -138,19 +140,7 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
     subject(:delete_all_workflows) do
       routes.delete_all_workflows(pid: 'druid:mw971zk1113')
     end
-    let(:mock_requestor) { instance_double(Dor::Workflow::Client::Requestor, request: nil) }
 
-    it 'sends a delete request' do
-      delete_all_workflows
-      expect(mock_requestor).to have_received(:request)
-        .with('objects/druid:mw971zk1113/workflows', 'delete')
-    end
-  end
-
-  describe '#delete_all_workflows' do
-    subject(:delete_all_workflows) do
-      routes.delete_all_workflows(pid: 'druid:mw971zk1113')
-    end
     let(:mock_requestor) { instance_double(Dor::Workflow::Client::Requestor, request: nil) }
 
     it 'sends a delete request' do
@@ -175,11 +165,14 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
       allow(routes).to receive(:all_workflows_xml) { xml }
     end
 
-    it 'it returns the workflows' do
+    it 'returns the workflows' do
       expect(routes.all_workflows(pid: 'druid:mw971zk1113')).to be_kind_of Dor::Workflow::Response::Workflows
     end
   end
 
   describe '#create_workflow_by_name' do
+    it 'need to write these specs', skip: 'need to write specs' do
+      # something
+    end
   end
 end

data/spec/{workflow → dor/workflow}/client/workflow_template_spec.rb

@@ -9,6 +9,7 @@ RSpec.describe Dor::Workflow::Client::WorkflowTemplate do
 
   describe '#retrieve' do
     subject(:workflow_template) { routes.retrieve('accessionWF') }
+
     let(:data) { '{"processes":[{"name":"start-assembly"},{"name":"content-metadata-create"}]}' }
 
     it 'returns a workflow template' do
@@ -20,6 +21,7 @@ RSpec.describe Dor::Workflow::Client::WorkflowTemplate do
 
   describe '#all' do
     subject(:workflow_templates) { routes.all }
+
     let(:data) { '["assemblyWF","registrationWF"]' }
 
     it 'returns a list of templates' do

data/spec/{workflow → dor/workflow}/client_spec.rb

@@ -14,6 +14,7 @@ RSpec.describe Dor::Workflow::Client do
     </workflow>
     EOXML
   end
+  let(:client) { described_class.new connection: mock_http_connection, logger: mock_logger }
 
   let(:wf_xml_label) do
     <<~EOXML
@@ -47,10 +48,9 @@ RSpec.describe Dor::Workflow::Client do
     @druid = 'druid:123'
   end
 
-  let(:client) { described_class.new connection: mock_http_connection, logger: mock_logger }
-
   describe '#connection' do
     subject(:conn) { client.requestor.connection }
+
     let(:client) { described_class.new url: 'http://example.com', timeout: 99, logger: mock_logger }
 
     it 'has a timeout' do
@@ -89,7 +89,8 @@ RSpec.describe Dor::Workflow::Client do
       end
 
       it 'sets the lane_id param' do
-        client.create_workflow_by_name(@druid, 'laneIdWF', lane_id: 'foo_lane', version: 1)
+        # if the stub isn't correct (params), it will raise an error
+        expect { client.create_workflow_by_name(@druid, 'laneIdWF', lane_id: 'foo_lane', version: 1) }.not_to raise_error
       end
     end
 
@@ -101,7 +102,8 @@ RSpec.describe Dor::Workflow::Client do
       end
 
       it 'sets the version param if provided in options hash' do
-        client.create_workflow_by_name(@druid, 'versionWF', version: 2)
+        # if the stub isn't correct (options hash), it will raise an error
+        expect { client.create_workflow_by_name(@druid, 'versionWF', version: 2) }.not_to raise_error
       end
     end
   end
@@ -145,7 +147,16 @@ RSpec.describe Dor::Workflow::Client do
   end
 
   describe '#workflow_status' do
+    subject(:workflow_status) { client.workflow_status(druid: druid, workflow: workflow_name, process: step_name) }
+
     let(:repo) { nil }
+    let(:step_name) { 'registrar-approval' }
+    let(:workflow_name) { 'etdSubmitWF' }
+    let(:status) { 200 }
+    let(:response) do
+      [status, {}, xml]
+    end
+    let(:xml) { '' }
     let(:druid) { @druid }
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
@@ -155,22 +166,13 @@ RSpec.describe Dor::Workflow::Client do
       end
     end
 
-    subject { client.workflow_status(druid: druid, workflow: workflow_name, process: step_name) }
-    let(:step_name) { 'registrar-approval' }
-    let(:workflow_name) { 'etdSubmitWF' }
-    let(:status) { 200 }
-    let(:response) do
-      [status, {}, xml]
-    end
-    let(:xml) { '' }
-
     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')
+        expect(workflow_status).to eq('completed')
       end
     end
 
@@ -181,7 +183,7 @@ RSpec.describe Dor::Workflow::Client do
       end
 
       it 'returns the status for the highest version' do
-        expect(subject).to eq('waiting')
+        expect(workflow_status).to eq('waiting')
       end
     end
 
@@ -189,7 +191,7 @@ RSpec.describe Dor::Workflow::Client do
       let(:status) { 404 }
 
       it 'throws the missing workflow exception' do
-        expect { subject }.to raise_error Dor::MissingWorkflowException
+        expect { workflow_status }.to raise_error Dor::MissingWorkflowException
       end
     end
 
@@ -197,7 +199,7 @@ RSpec.describe Dor::Workflow::Client do
       let(:status) { 422 }
 
       it 'throws an exception' do
-        expect { subject }.to raise_error Dor::WorkflowException
+        expect { workflow_status }.to raise_error Dor::WorkflowException
       end
     end
 
@@ -207,7 +209,7 @@ RSpec.describe Dor::Workflow::Client do
       end
 
       it 'throws an exception' do
-        expect { subject }.to raise_error Dor::WorkflowException, "Unable to parse response:\nsomething not xml"
+        expect { workflow_status }.to raise_error Dor::WorkflowException, "Unable to parse response:\nsomething not xml"
       end
     end
 
@@ -218,7 +220,7 @@ RSpec.describe Dor::Workflow::Client do
       let(:step_name) { 'publish' }
 
       it 'returns nil' do
-        expect(subject).to be_nil
+        expect(workflow_status).to be_nil
       end
     end
   end
@@ -323,8 +325,8 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
-  context '#objects_for_workstep' do
-    before(:all) do
+  describe '#objects_for_workstep' do
+    before do
       @workflow   = 'googleScannedBookWF'
       @completed  = 'google-download'
       @waiting    = 'process-content'
@@ -353,8 +355,8 @@ RSpec.describe Dor::Workflow::Client do
       end
     end
 
-    context 'a query using qualified workflow names for completed and waiting' do
-      before :each do
+    context 'with a query using qualified workflow names for completed and waiting' do
+      before do
         @qualified_waiting   = "#{@workflow}:#{@waiting}"
         @qualified_completed = "#{@workflow}:#{@completed}"
       end
@@ -376,24 +378,28 @@ RSpec.describe Dor::Workflow::Client do
           let(:laneid) { 'default' }
         end
       end
+
       describe 'explicit lane_id' do
         it_behaves_like 'lane-aware' do
           let(:laneid) { 'lane1' }
         end
       end
 
-      context 'URI string creation' do
-        before :each do
+      context 'with URI string creation' do
+        before do
           @xml = %(<objects count="1"><object id="druid:ab123de4567"/></objects>)
         end
+
         it 'with only one completed step passed in as a String' do
           allow(mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@qualified_waiting}&completed=#{@qualified_completed}&lane-id=default").and_return(double(Faraday::Response, body: @xml))
           expect(client.objects_for_workstep(@qualified_completed, @qualified_waiting)).to eq(['druid:ab123de4567'])
         end
+
         it 'without any completed steps, only waiting' do
           allow(mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@qualified_waiting}&lane-id=default").and_return(double(Faraday::Response, body: @xml))
           expect(client.objects_for_workstep(nil, @qualified_waiting)).to eq(['druid:ab123de4567'])
         end
+
         it 'same but with lane_id' do
           allow(mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@qualified_waiting}&lane-id=lane1").and_return(double(Faraday::Response, body: @xml))
           expect(client.objects_for_workstep(nil, @qualified_waiting, 'lane1')).to eq(['druid:ab123de4567'])
@@ -402,8 +408,8 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
-  context 'get empty workflow queue' do
-    before(:all) do
+  context 'when empty workflow queue' do
+    before do
       @workflow   = 'googleScannedBookWF'
       @completed  = 'google-download'
       @waiting    = 'process-content'
@@ -422,8 +428,8 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
-  context 'get errored workflow steps' do
-    before(:all) do
+  context 'when errored workflow steps' do
+    before do
       @workflow   = 'accessionWF'
       @step       = 'publish'
     end
@@ -454,7 +460,7 @@ RSpec.describe Dor::Workflow::Client do
   end
 
   describe '#count_queued_for_workstep' do
-    before(:all) do
+    before do
       @workflow   = 'accessionWF'
       @step       = 'publish'
     end
@@ -477,7 +483,7 @@ RSpec.describe Dor::Workflow::Client do
   end
 
   describe '#count_objects_in_step' do
-    before(:all) do
+    before do
       @workflow   = 'sdrIngestWF'
       @step       = 'start-ingest'
       @type       = 'waiting'
@@ -506,12 +512,15 @@ RSpec.describe Dor::Workflow::Client do
         stub.delete(url) { |_env| [202, {}, ''] }
       end
     end
-
     let(:url) { "/objects/#{@druid}/workflows/accessionWF?version=5" }
 
+    before do
+      allow(mock_http_connection).to receive(:delete).with(url).and_call_original
+    end
+
     it 'sends a delete request to the workflow service' do
-      expect(mock_http_connection).to receive(:delete).with(url).and_call_original
       client.delete_workflow(druid: @druid, workflow: 'accessionWF', version: 5)
+      expect(mock_http_connection).to have_received(:delete).with(url)
     end
   end
 

data/spec/{models → dor/workflow}/response/process_spec.rb

@@ -3,9 +3,10 @@
 require 'spec_helper'
 
 RSpec.describe Dor::Workflow::Response::Process do
-  let(:parent) { Dor::Workflow::Response::Workflow.new(xml: xml) }
   subject(:instance) { parent.process_for_recent_version(name: 'start-assembly') }
 
+  let(:parent) { Dor::Workflow::Response::Workflow.new(xml: xml) }
+
   describe '#pid' do
     subject { instance.pid }
 
@@ -16,6 +17,7 @@ RSpec.describe Dor::Workflow::Response::Process do
         </workflow>
       XML
     end
+
     it { is_expected.to eq 'druid:mw971zk1113' }
   end
 
@@ -29,6 +31,7 @@ RSpec.describe Dor::Workflow::Response::Process do
         </workflow>
       XML
     end
+
     it { is_expected.to eq 'assemblyWF' }
   end
 
@@ -42,6 +45,7 @@ RSpec.describe Dor::Workflow::Response::Process do
         </workflow>
       XML
     end
+
     it { is_expected.to eq 'start-assembly' }
   end
 
@@ -55,6 +59,7 @@ RSpec.describe Dor::Workflow::Response::Process do
         </workflow>
       XML
     end
+
     it { is_expected.to eq 'default' }
   end
 end

data/spec/{models → dor/workflow}/response/workflow_spec.rb

@@ -14,6 +14,7 @@ RSpec.describe Dor::Workflow::Response::Workflow do
         </workflow>
       XML
     end
+
     it { is_expected.to eq 'druid:mw971zk1113' }
   end
 
@@ -26,11 +27,13 @@ RSpec.describe Dor::Workflow::Response::Workflow do
         </workflow>
       XML
     end
+
     it { is_expected.to eq 'assemblyWF' }
   end
 
   describe '#complete?' do
     subject { instance.complete? }
+
     context 'when all steps are complete' do
       let(:xml) do
         <<~XML
@@ -40,6 +43,7 @@ RSpec.describe Dor::Workflow::Response::Workflow do
           </workflow>
         XML
       end
+
       it { is_expected.to be true }
     end
 
@@ -52,6 +56,7 @@ RSpec.describe Dor::Workflow::Response::Workflow do
           </workflow>
         XML
       end
+
       it { is_expected.to be false }
     end
   end
@@ -68,6 +73,7 @@ RSpec.describe Dor::Workflow::Response::Workflow do
           </workflow>
         XML
       end
+
       it { is_expected.to be false }
     end
 
@@ -81,6 +87,7 @@ RSpec.describe Dor::Workflow::Response::Workflow do
           </workflow>
         XML
       end
+
       it { is_expected.to be true }
     end
   end

data/spec/{models → dor/workflow}/response/workflows_spec.rb

@@ -14,11 +14,12 @@ RSpec.describe Dor::Workflow::Response::Workflows do
         </workflows>
       XML
     end
+
     it { is_expected.to eq 'druid:mw971zk1113' }
   end
 
   describe '#workflows' do
-    subject { instance.workflows }
+    subject(:workflows) { instance.workflows }
 
     let(:xml) do
       <<~XML
@@ -32,8 +33,8 @@ RSpec.describe Dor::Workflow::Response::Workflows do
     end
 
     it 'has children' do
-      expect(subject).to all(be_kind_of Dor::Workflow::Response::Workflow)
-      expect(subject.map(&:workflow_name)).to eq %w[assemblyWF sdrPreservationWF]
+      expect(workflows).to all(be_kind_of Dor::Workflow::Response::Workflow)
+      expect(workflows.map(&:workflow_name)).to eq %w[assemblyWF sdrPreservationWF]
     end
   end
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-client
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Willy Mene
 - Darren Hardy
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-05 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -249,23 +249,23 @@ files:
 - lib/dor/workflow/response/workflow.rb
 - lib/dor/workflow/response/workflows.rb
 - lib/dor/workflow_exception.rb
-- spec/models/response/process_spec.rb
-- spec/models/response/workflow_spec.rb
-- spec/models/response/workflows_spec.rb
+- spec/dor/workflow/client/connection_factory_spec.rb
+- spec/dor/workflow/client/lifecycle_routes_spec.rb
+- spec/dor/workflow/client/requestor_spec.rb
+- spec/dor/workflow/client/status_spec.rb
+- spec/dor/workflow/client/version_routes_spec.rb
+- spec/dor/workflow/client/workflow_routes_spec.rb
+- spec/dor/workflow/client/workflow_template_spec.rb
+- spec/dor/workflow/client_spec.rb
+- spec/dor/workflow/response/process_spec.rb
+- spec/dor/workflow/response/workflow_spec.rb
+- spec/dor/workflow/response/workflows_spec.rb
 - spec/spec_helper.rb
-- spec/workflow/client/connection_factory_spec.rb
-- spec/workflow/client/lifecycle_routes_spec.rb
-- spec/workflow/client/requestor_spec.rb
-- spec/workflow/client/status_spec.rb
-- spec/workflow/client/version_routes_spec.rb
-- spec/workflow/client/workflow_routes_spec.rb
-- spec/workflow/client/workflow_template_spec.rb
-- spec/workflow/client_spec.rb
 homepage: https://consul.stanford.edu/display/DOR/DOR+services#DORservices-initializeworkflow
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -273,15 +273,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: Provides convenience methods to work with the DOR Workflow Service
 test_files: []

data/spec/{workflow → dor/workflow}/client/lifecycle_routes_spec.rb

@@ -10,6 +10,8 @@ RSpec.describe Dor::Workflow::Client::LifecycleRoutes do
   let(:druid) { 'druid:gv054hp4128' }
 
   describe '#milestones' do
+    subject(:milestones) { routes.milestones(druid: druid) }
+
     let(:ng_xml) { Nokogiri::XML(xml) }
     let(:xml) do
       '<?xml version="1.0" encoding="UTF-8"?><lifecycle objectId="druid:gv054hp4128"><milestone date="2012-01-26T21:06:54-0800" version="2">published</milestone></lifecycle>'
@@ -19,8 +21,6 @@ RSpec.describe Dor::Workflow::Client::LifecycleRoutes do
       allow(routes).to receive(:query_lifecycle).and_return(ng_xml)
     end
 
-    subject(:milestones) { routes.milestones(druid: druid) }
-
     it 'includes the version in with the milestones' do
       expect(milestones.first[:milestone]).to eq('published')
       expect(milestones.first[:version]).to eq('2')