dor-workflow-client 3.24.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fcd257c721798580d9e953614f3b8b29bb71cff18359984f5f12355e43032e2
-  data.tar.gz: 000a4e4b96f31fafd144a5a02825b4d6a6fe5bab7e2c925d47874db0873dfaae
+  metadata.gz: ebdb5efb62a6eaede5600c160ced195692290cc059666345c4ea7e21b9ffee33
+  data.tar.gz: da11701acceca8acc9ed30719e034bfe5eb9350394f90d10b9babdad92600c46
 SHA512:
-  metadata.gz: 539d6b2915c4d5a031227f73b00065674d401be19610925e0ba4fc2954348b713ca6a093246bdc73fc321705315a94bf082cde53b10cf1196ec75611027c4da0
-  data.tar.gz: 2be1999274099fa74ee6ba3c69303421af076866ef1a8aba673ef7a1b5b09c4a19306af0f43aa59af0a458aced85b0a8f567ab499f35fcb0f0b353eab7265dbf
+  metadata.gz: 027c3795481fb428df972a4cd420a281e39226acffb2bf067769de10580fa42d7c64f826c168c1a009f0cef825acb34f027202b95d19ba9098f92333232fcb46
+  data.tar.gz: 82cc4205238d2fbe04c75903dd99ad214579becf8326f6ca46dc459e3a962ca05d38fca587cb42b1c5ea4fe030ff1a61b95f5983828081f24d9fae123123b07d

data/.circleci/config.yml

@@ -1,35 +1,10 @@
 version: 2.1
-
-jobs:
+orbs:
+  ruby-rails: sul-dlss/ruby-rails@2.0.0
+workflows:
   build:
-    docker:
-      - image: circleci/ruby:2.7.1
-        environment:
-          CC_TEST_REPORTER_ID: 3853bc688a88a4de1a5568eaa8163d20db8637fe988540a935aff028190cff6a
-          RAILS_ENV: test
-    steps:
-      - checkout
-      - run:
-          name: Install Bundler
-          command: gem install bundler
-      - run:
-          name: Which bundler?
-          command: bundle -v
-      - run:
-          name: Bundle Install
-          command: bundle check || bundle install
-      - run:
-          name: Lint using rubocop
-          command: bundle exec rubocop
-      - run:
-          name: Setup Code Climate test-reporter
-          command: |
-            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-            chmod +x ./cc-test-reporter
-            ./cc-test-reporter before-build
-      - run:
-          name: rspec
-          command: bundle exec rspec
-      - run:
-          name: upload test coverage report to Code Climate
-          command: ./cc-test-reporter after-build --coverage-input-type simplecov --exit-code $?
+    jobs:
+      - ruby-rails/lint:
+          name: lint
+      - ruby-rails/test-gem:
+          name: test

data/.rubocop.yml

@@ -1,11 +1,114 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 3.0
 # Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
+Layout/LineLength:
   Max: 300
 
 Metrics/BlockLength:
   Exclude:
     - spec/**/*_spec.rb
+
+Gemspec/DateAssignment: # new in 1.10
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true

data/.rubocop_todo.yml

@@ -1,25 +1,64 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-01-06 12:37:25 -0600 using RuboCop version 0.63.1.
+# on 2022-01-14 04:19:32 UTC using RuboCop version 1.24.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: 4
+# 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: 26
+  Max: 24
 
 # Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Max: 26
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 9
+  Max: 8
 
 # Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 13
 
 # Offense count: 3
-# Configuration parameters: CountKeywordArgs.
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 8
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/KeywordParametersOrder:
+  Exclude:
+    - 'lib/dor/workflow/client/workflow_routes.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowModifier.
+Style/SoleNestedConditional:
+  Exclude:
+    - 'lib/dor/workflow/client/status.rb'

data/Gemfile

@@ -9,4 +9,5 @@ gem 'activesupport', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
 
 group :development, :test do
   gem 'byebug'
+  gem 'rspec_junit_formatter' # For CircleCI
 end

data/README.md

@@ -11,7 +11,7 @@ https://consul.stanford.edu/display/DOR/DOR+services#DORservices-initializeworkf
 
 ## Usage
 
-You should initialize a `Dor::Workflow::Client` object in your application configuration, i.e. in a bootup or startup method like:
+Initialize a `Dor::Workflow::Client` object in your application configuration, i.e. in a bootup or startup method like:
 
 ```ruby
 client = Dor::Workflow::Client.new(url: 'https://test-server.edu/workflow/')

data/dor-workflow-client.gemspec

@@ -16,18 +16,23 @@ Gem::Specification.new do |gem|
   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', '>= 0.9.2', '< 2.0'
-  gem.add_dependency 'faraday_middleware'
+  gem.add_dependency 'faraday', '~> 2.0'
+  gem.add_dependency 'faraday-retry'
+
   gem.add_dependency 'nokogiri', '~> 1.6'
   gem.add_dependency 'zeitwerk', '~> 2.1'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 3.3'
-  gem.add_development_dependency 'rubocop', '~> 0.63.1'
-  gem.add_development_dependency 'simplecov', '~> 0.17.0' # CodeClimate cannot use SimpleCov >= 0.18.0 for generating test coverage
+  gem.add_development_dependency 'rubocop', '~> 1.24'
+  gem.add_development_dependency 'rubocop-rake'
+  gem.add_development_dependency 'rubocop-rspec', '~> 2.1'
+  gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'yard'
+  gem.metadata['rubygems_mfa_required'] = 'true'
 end

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'faraday_middleware'
-
 module Dor
   module Workflow
     class Client
@@ -21,7 +19,6 @@ module Dor
         def build_connection
           Faraday.new(url: url) do |faraday|
             faraday.use Faraday::Response::RaiseError # raise exceptions on 40x, 50x responses
-            faraday.use FaradayMiddleware::FollowRedirects, limit: 3
             faraday.options.params_encoder = Faraday::FlatParamsEncoder
             if timeout
               faraday.options.timeout = timeout
@@ -51,17 +48,17 @@ module Dor
         attr_reader :logger, :timeout, :url
 
         def retriable_methods
-          Faraday::Request::Retry::IDEMPOTENT_METHODS + [:post]
+          Faraday::Retry::Middleware::IDEMPOTENT_METHODS + [:post]
         end
 
         def retriable_exceptions
-          Faraday::Request::Retry::DEFAULT_EXCEPTIONS + [Faraday::ConnectionFailed]
+          Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Faraday::ConnectionFailed]
         end
 
         def retry_block
           lambda do |env, _opts, retries, exception|
             logger.warn "retrying connection (#{retries} remaining) to #{env.url}: (#{exception.class}) " \
-              "#{exception.message} #{env.status}"
+                        "#{exception.message} #{env.status}"
           end
         end
 

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

@@ -63,7 +63,7 @@ module Dor
             )
             args.shift # ditch the `repo` argument
           end
-          uri_string = build_queued_uri(args.first) + '&count-only=true'
+          uri_string = "#{build_queued_uri(args.first)}&count-only=true"
           doc = Nokogiri::XML(requestor.request(uri_string))
           doc.at_xpath('/objects/@count').value.to_i
         end
@@ -143,9 +143,9 @@ module Dor
         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}"
-          Nokogiri::XML(resp).xpath('//object').map do |node|
+          Nokogiri::XML(resp).xpath('//object').to_h do |node|
             [node['id'], node['errorMessage']]
-          end.to_h
+          end
         end
 
         # Used by preservation robots stats reporter

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

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

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

@@ -23,7 +23,7 @@ module Dor
         # @return [Boolean] always true
         #
         def create_workflow(_repo, druid, workflow_name, _wf_xml, opts = {})
-          create_workflow_by_name(druid, workflow_name, opts)
+          create_workflow_by_name(druid, workflow_name, **opts)
         end
         deprecation_deprecate create_workflow: 'use create_workflow_by_name instead'
 
@@ -313,8 +313,8 @@ module Dor
         # @return [String]
         def create_process_xml(params)
           builder = Nokogiri::XML::Builder.new do |xml|
-            attrs = params.reject { |_k, v| v.nil? }
-            attrs = Hash[attrs.map { |k, v| [k.to_s.camelize(:lower), v] }] # camelize all the keys in the attrs hash
+            attrs = params.compact
+            attrs = attrs.transform_keys { |k| k.to_s.camelize(:lower) } # camelize all the keys in the attrs hash
             xml.process(attrs)
           end
           builder.to_xml

data/lib/dor/workflow/client.rb

@@ -5,6 +5,7 @@ require 'active_support/core_ext'
 require 'nokogiri'
 require 'zeitwerk'
 require 'faraday'
+require 'faraday/retry'
 require 'deprecation'
 
 loader = Zeitwerk::Loader.new

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

@@ -35,7 +35,7 @@ module Dor
         def process_for_recent_version(name:)
           nodes = process_nodes_for(name: name)
           node = nodes.max { |a, b| a.attr('version').to_i <=> b.attr('version').to_i }
-          attributes = node ? Hash[node.attributes.collect { |k, v| [k.to_sym, v.value] }] : {}
+          attributes = node ? node.attributes.to_h { |k, v| [k.to_sym, v.value] } : {}
           Process.new(parent: self, **attributes)
         end
 

data/spec/models/response/workflow_spec.rb

@@ -72,7 +72,7 @@ RSpec.describe Dor::Workflow::Response::Workflow do
     end
   end
 
-  describe '#active?' do
+  describe '#active_for?' do
     subject { instance.active_for?(version: 2) }
 
     context 'when the workflow has not been instantiated for the given version' do

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-client
 version: !ruby/object:Gem::Version
-  version: 3.24.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Willy Mene
 - Darren Hardy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -49,24 +49,18 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -141,28 +135,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.1
+        version: '1.24'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.1
+        version: '1.24'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -240,8 +262,9 @@ files:
 - spec/workflow/client_spec.rb
 homepage: https://consul.stanford.edu/display/DOR/DOR+services#DORservices-initializeworkflow
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -249,15 +272,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Provides convenience methods to work with the DOR Workflow Service
 test_files: