dor-workflow-client 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebdb5efb62a6eaede5600c160ced195692290cc059666345c4ea7e21b9ffee33
-  data.tar.gz: da11701acceca8acc9ed30719e034bfe5eb9350394f90d10b9babdad92600c46
+  metadata.gz: 77fd46c14ada1f0509732073801d7ea699624a79a41ca1cb7c8c47ba6acb7f55
+  data.tar.gz: fe4871b54d1df828b1cca4740aeafefdb1d1eee5af55f2040d23a0762a0cc56a
 SHA512:
-  metadata.gz: 027c3795481fb428df972a4cd420a281e39226acffb2bf067769de10580fa42d7c64f826c168c1a009f0cef825acb34f027202b95d19ba9098f92333232fcb46
-  data.tar.gz: 82cc4205238d2fbe04c75903dd99ad214579becf8326f6ca46dc459e3a962ca05d38fca587cb42b1c5ea4fe030ff1a61b95f5983828081f24d9fae123123b07d
+  metadata.gz: e9404ff0f029c86849316f780d3e16cc2af0838313adf9034c7e4e78a779848a7c3cf7e3d7a773376907cde6bcbcecc894115de7386035240ec83294112405d7
+  data.tar.gz: 88b7444740059ecc1124793b69a1744ae0cf0518e0b5ac06f31690c1b569cc695cc6a322c2916ba1a382586b57a3c0a5ffdd2888893fdd077202bd98f6096f7a

data/.github/pull_request_template.md

@@ -1,12 +1,10 @@
-## Why was this change made?
+## Why was this change made? 🤔
 
 
 
-## How was this change tested?
+## How was this change tested? 🤨
 
-
-
-## Which documentation and/or configurations were updated?
+⚡ ⚠ If this change affects the API or other fundamentals of this service, ***run [integration tests](https://github.com/sul-dlss/infrastructure-integration-test)*** that exercise this service and/or test in [stage|qa] environment, in addition to specs. ⚡
 
 
 

data/.gitignore

@@ -4,7 +4,6 @@
 .config
 .yardoc
 .rvmrc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
@@ -18,4 +17,3 @@ test/version_tmp
 tmp
 .ruby-version
 .ruby-gemset
-

data/.rubocop.yml

@@ -10,7 +10,7 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/*_spec.rb
 
-Gemspec/DateAssignment: # new in 1.10
+Gemspec/DeprecatedAttributeAssignment: # new in 1.10
   Enabled: true
 Gemspec/RequireMFA: # new in 1.23
   Enabled: true

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-01-14 04:19:32 UTC using RuboCop version 1.24.1.
+# on 2022-06-28 04:56:14 UTC using RuboCop version 1.31.0.
 # 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
@@ -27,23 +27,17 @@ Lint/NoReturnInBeginEndBlocks:
 # Offense count: 5
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 24
-
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
-# IgnoredMethods: refine
-Metrics/BlockLength:
-  Max: 26
+  Max: 23
 
 # Offense count: 2
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
   Max: 8
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 13
+  Max: 19
 
 # Offense count: 3
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
@@ -51,13 +45,13 @@ Metrics/ParameterLists:
   Max: 8
 
 # Offense count: 1
-# Cop supports --auto-correct.
+# This cop supports safe autocorrection (--autocorrect).
 Style/KeywordParametersOrder:
   Exclude:
     - 'lib/dor/workflow/client/workflow_routes.rb'
 
 # Offense count: 1
-# Cop supports --auto-correct.
+# This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowModifier.
 Style/SoleNestedConditional:
   Exclude:

data/Gemfile.lock

@@ -0,0 +1,118 @@
+PATH
+  remote: .
+  specs:
+    dor-workflow-client (4.1.0)
+      activesupport (>= 3.2.1, < 8)
+      deprecation (>= 0.99.0)
+      faraday (~> 2.0)
+      faraday-retry (~> 1.0)
+      nokogiri (~> 1.6)
+      zeitwerk (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3)
+      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)
+    ast (2.4.2)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    deprecation (1.1.0)
+      activesupport
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.3)
+    faraday-retry (1.0.3)
+    hashdiff (1.0.1)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.16.1)
+    nokogiri (1.13.6-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.7)
+    racc (1.6.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rspec_junit_formatter (0.5.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.31.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      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.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    webmock (3.14.0)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  dor-workflow-client!
+  rake
+  rspec (~> 3.3)
+  rspec_junit_formatter
+  rubocop (~> 1.24)
+  rubocop-rake
+  rubocop-rspec (~> 2.1)
+  simplecov
+  webmock
+  yard
+
+BUNDLED WITH
+   2.2.32

data/dor-workflow-client.gemspec

@@ -14,14 +14,13 @@ Gem::Specification.new do |gem|
   gem.homepage      = 'https://consul.stanford.edu/display/DOR/DOR+services#DORservices-initializeworkflow'
 
   gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  gem.test_files    = gem.files.grep(%r{^(spec)/})
   gem.require_paths = ['lib']
   gem.required_ruby_version = '>= 2.7'
 
   gem.add_dependency 'activesupport', '>= 3.2.1', '< 8'
   gem.add_dependency 'deprecation', '>= 0.99.0'
   gem.add_dependency 'faraday', '~> 2.0'
-  gem.add_dependency 'faraday-retry'
+  gem.add_dependency 'faraday-retry', '~> 1.0'
 
   gem.add_dependency 'nokogiri', '~> 1.6'
   gem.add_dependency 'zeitwerk', '~> 2.1'

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

@@ -15,7 +15,6 @@ module Dor
           @logger = logger
         end
 
-        # rubocop:disable Metrics/MethodLength
         def build_connection
           Faraday.new(url: url) do |faraday|
             faraday.use Faraday::Response::RaiseError # raise exceptions on 40x, 50x responses
@@ -37,7 +36,6 @@ module Dor
             faraday.adapter Faraday.default_adapter # Last middleware must be the adapter
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         def user_agent
           "dor-workflow-client #{VERSION}"

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

@@ -84,7 +84,6 @@ module Dor
         # rubocop:enable Metrics/MethodLength
 
         # @return [Array<Hash>]
-        # rubocop:disable Metrics/MethodLength
         def milestones(*args)
           case args.size
           when 2
@@ -105,7 +104,6 @@ module Dor
             { milestone: node.text, at: Time.parse(node['date']), version: node['version'] }
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         private
 

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

@@ -139,7 +139,7 @@ module Dor
         # @example
         #     client.errored_objects_for_workstep('accessionWF','content-metadata')
         #     => {"druid:qd556jq0580"=>"druid:qd556jq0580 - Item error; caused by
-        #        #<Rubydora::FedoraInvalidRequest: Error modifying datastream contentMetadata for druid:qd556jq0580. See logger for details>"}
+        #        blah blah. See logger for details>"}
         def errored_objects_for_workstep(workflow, step, repository = nil)
           Deprecation.warn(self, 'the third argument to `#errored_objects_for_workstep` is unused and will go away in Dor::Workflow::Client 4.0.0. omit argument to silence.') unless repository.nil?
           resp = requestor.request "workflow_queue?workflow=#{workflow}&error=#{step}"

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

@@ -42,7 +42,6 @@ module Dor
         end
 
         # @return [Hash{Symbol => Object}] including :status_code and :status_time
-        # rubocop:disable Metrics/MethodLength
         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
@@ -64,7 +63,6 @@ module Dor
             { status_code: status_code, status_time: status_time }
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         def status_code
           info.fetch(:status_code)

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

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     class Client
-      VERSION = '4.0.0'
+      VERSION = '4.1.0'
     end
   end
 end

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

@@ -28,7 +28,7 @@ module Dor
         deprecation_deprecate create_workflow: 'use create_workflow_by_name instead'
 
         # Creates a workflow for a given object in the repository.  If this particular workflow for this objects exists,
-        # it will replace the old workflow.  You have the option of creating a datastream or not.
+        # it will replace the old workflow.
         # Returns true on success.  Caller must handle any exceptions.
         #
         # @param [String] druid The id of the object
@@ -124,7 +124,6 @@ module Dor
         # @param [String] workflow The name of the workflow
         # @param [String] process The name of the process step
         # @return [String] status for repo-workflow-process-druid
-        # rubocop:disable Metrics/MethodLength
         # rubocop:disable Metrics/AbcSize
         def workflow_status(*args)
           case args.length
@@ -147,16 +146,14 @@ module Dor
           process = processes.max { |a, b| a.attr('version').to_i <=> b.attr('version').to_i }
           process&.attr('status')
         end
-        # rubocop:enable Metrics/AbcSize
-        # rubocop:enable Metrics/MethodLength
 
+        # rubocop:enable Metrics/AbcSize
         #
         # Retrieves the raw XML for the given workflow
         # @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
         # @return [String] XML of the workflow
-        # rubocop:disable Metrics/MethodLength
         def workflow_xml(*args)
           case args.length
           when 3
@@ -177,8 +174,6 @@ module Dor
         end
         deprecation_deprecate workflow_xml: 'workflow_xml will not be replaced'
 
-        # rubocop:enable Metrics/MethodLength
-
         # Updates the status of one step in a workflow to error.
         # Returns true on success.  Caller must handle any exceptions
         #
@@ -275,19 +270,29 @@ module Dor
         end
 
         # Deletes a workflow from a particular repository and druid. This is only used by Hydrus.
-        # @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 to delete the workflow from
         # @param [String] workflow The name of the workflow to be deleted
         # @param [Integer] version The version of the workflow to delete
         # @return [Boolean] always true
-        def delete_workflow(repo, druid, workflow, version: nil)
+        def delete_workflow(*args)
+          case args.length
+          when 3..4
+            Deprecation.warn(self, 'Calling delete_workflow with positional args is deprecated, use kwargs instead')
+            (_repo, druid, workflow, version_hash) = *args
+            version = version_hash && version_hash[:version]
+          when 1
+            opts = args.first
+            druid = opts[:druid]
+            workflow = opts[:workflow]
+            version = opts[:version]
+          end
           qs_args = if version
                       "?version=#{version}"
                     else
                       Deprecation.warn(self, 'Calling delete_workflow without passing version is deprecated and will result in an error in dor-workflow-client 4.0')
                       ''
                     end
-          requestor.request "#{repo}/objects/#{druid}/workflows/#{workflow}#{qs_args}", 'delete'
+          requestor.request "/objects/#{druid}/workflows/#{workflow}#{qs_args}", 'delete'
           true
         end
 

data/spec/workflow/client/workflow_routes_spec.rb

@@ -147,6 +147,19 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
     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
+      delete_all_workflows
+      expect(mock_requestor).to have_received(:request)
+        .with('objects/druid:mw971zk1113/workflows', 'delete')
+    end
+  end
+
   describe '#all_workflows' do
     let(:xml) do
       <<~XML

data/spec/workflow/client_spec.rb

@@ -729,22 +729,34 @@ RSpec.describe Dor::Workflow::Client do
       end
     end
 
-    context 'without a version' do
-      let(:url) { "/objects/#{@druid}/workflows/accessionWF" }
+    context 'with positional args' do
+      context 'without a version' do
+        let(:url) { "/objects/#{@druid}/workflows/accessionWF" }
 
-      it 'sends a delete request to the workflow service' do
-        expect(Deprecation).to receive(:warn)
-        expect(mock_http_connection).to receive(:delete).with(url).and_call_original
-        client.delete_workflow(nil, @druid, 'accessionWF')
+        it 'sends a delete request to the workflow service' do
+          expect(Deprecation).to receive(:warn).twice
+          expect(mock_http_connection).to receive(:delete).with(url).and_call_original
+          client.delete_workflow(nil, @druid, 'accessionWF')
+        end
+      end
+
+      context 'with a version' do
+        let(:url) { "/objects/#{@druid}/workflows/accessionWF?version=5" }
+
+        it 'sends a delete request to the workflow service' do
+          expect(Deprecation).to receive(:warn)
+          expect(mock_http_connection).to receive(:delete).with(url).and_call_original
+          client.delete_workflow(nil, @druid, 'accessionWF', version: 5)
+        end
       end
     end
 
-    context 'with a version' do
+    context 'with kwargs' do
       let(:url) { "/objects/#{@druid}/workflows/accessionWF?version=5" }
 
       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(nil, @druid, 'accessionWF', version: 5)
+        client.delete_workflow(druid: @druid, workflow: 'accessionWF', version: 5)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-client
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -63,16 +63,16 @@ dependencies:
   name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -228,6 +228,7 @@ files:
 - ".rubocop_todo.yml"
 - ".yardopts"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -283,16 +284,4 @@ rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Provides convenience methods to work with the DOR Workflow Service
-test_files:
-- spec/models/response/process_spec.rb
-- spec/models/response/workflow_spec.rb
-- spec/models/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
+test_files: []