dor-workflow-client 3.24.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fcd257c721798580d9e953614f3b8b29bb71cff18359984f5f12355e43032e2
-  data.tar.gz: 000a4e4b96f31fafd144a5a02825b4d6a6fe5bab7e2c925d47874db0873dfaae
+  metadata.gz: 660ca959342689ef767c9b7d6ce72f90ec5d568227e1acab968c7cf5b2e9bb95
+  data.tar.gz: e5c19e4cf9c2f79edc1cefaa0b9dbe4954866c2f29357fd58425d173662422ad
 SHA512:
-  metadata.gz: 539d6b2915c4d5a031227f73b00065674d401be19610925e0ba4fc2954348b713ca6a093246bdc73fc321705315a94bf082cde53b10cf1196ec75611027c4da0
-  data.tar.gz: 2be1999274099fa74ee6ba3c69303421af076866ef1a8aba673ef7a1b5b09c4a19306af0f43aa59af0a458aced85b0a8f567ab499f35fcb0f0b353eab7265dbf
+  metadata.gz: d7f985246d0238a872a26f9fcab9a65f7d2795be9b7946dffa4fba5cb2557203184de1ec1e1b4a758405a397c34dc991ef74290e8d5d5d28691b69984c18ddfd
+  data.tar.gz: c458009469d0684198722475fbe01a1dce917272298b18494979ed63957e399ea76830f1c22036ae0e21b46fb7ac31481b1e37e5f715916ee217648cb62526cc

data/.circleci/config.yml

@@ -1,35 +1,10 @@
 version: 2.1
-
-jobs:
+orbs:
+  ruby-rails: sul-dlss/ruby-rails@3.1.2
+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/.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

@@ -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/DeprecatedAttributeAssignment: # 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,58 @@
 # 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-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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 4
-Metrics/AbcSize:
-  Max: 26
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'dor-workflow-client.gemspec'
 
 # Offense count: 1
-Metrics/CyclomaticComplexity:
-  Max: 9
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/workflow/client/workflow_routes_spec.rb'
 
 # Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
+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
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 13
+  Max: 19
 
 # Offense count: 3
-# Configuration parameters: CountKeywordArgs.
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 8
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/KeywordParametersOrder:
+  Exclude:
+    - 'lib/dor/workflow/client/workflow_routes.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# 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/Gemfile.lock

@@ -0,0 +1,122 @@
+PATH
+  remote: .
+  specs:
+    dor-workflow-client (5.0.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.1)
+      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.4.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.1.0)
+    faraday-retry (1.0.3)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      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)
+      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.32.0)
+      json (~> 2.3)
+      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.19.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    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.5)
+      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.3.17

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

@@ -14,20 +14,24 @@ 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', '>= 0.9.2', '< 2.0'
-  gem.add_dependency 'faraday_middleware'
+  gem.add_dependency 'faraday', '~> 2.0'
+  gem.add_dependency 'faraday-retry', '~> 1.0'
+
   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
@@ -17,11 +15,9 @@ 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
-            faraday.use FaradayMiddleware::FollowRedirects, limit: 3
             faraday.options.params_encoder = Faraday::FlatParamsEncoder
             if timeout
               faraday.options.timeout = timeout
@@ -40,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}"
@@ -51,17 +46,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/lifecycle_routes.rb

@@ -14,39 +14,12 @@ module Dor
         # @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 the version to query for
+        # @param [Number] version (nil) the version to query for
         # @param [Boolean] active_only (false) if true, return only lifecycle steps for versions that have all processes complete
         # @return [Time] when the milestone was achieved.  Returns nil if the milestone does not exist
-        #
-        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        def lifecycle(*args)
-          case args.size
-          when 4
-            Deprecation.warn(self, 'you provided 4 args, but lifecycle now takes kwargs')
-            (repo, druid, milestone_name) = args[0..2]
-            version = args[3][:version]
-            active_only = args[3][:active_only] || false
-          when 3
-            Deprecation.warn(self, 'you provided 3 args, but lifecycle now takes kwargs')
-            (repo, druid, milestone_name) = args
-            version = nil
-            active_only = false
-          when 1
-            opts = args.first
-            repo = opts[:repo]
-            druid = opts[:druid]
-            milestone_name = opts[:milestone_name]
-            version = opts[:version]
-            active_only = opts[:active_only] || false
-          else
-            raise ArgumentError, 'wrong number of arguments, must be 1, or 3-5'
-          end
-
-          Deprecation.warn(self, 'passing the repo parameter to lifecycle is no longer necessary. This will raise an error in dor-workflow-client version 4') if repo
-
+        def lifecycle(druid:, milestone_name:, version: nil, active_only: false)
           filter_milestone(query_lifecycle(druid, version: version, active_only: active_only), milestone_name)
         end
-        # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
         # Returns the Date for a requested milestone ONLY for the current version.
         # This is slow as the workflow server will query dor-services-app for the version.
@@ -55,57 +28,17 @@ module Dor
         # @param [String] milestone_name the name of the milestone being queried for
         # @param [Number] version the version to query for
         # @return [Time] when the milestone was achieved.  Returns nil if the milestone does not exis
-        #
-        # rubocop:disable Metrics/MethodLength
-        def active_lifecycle(*args)
-          case args.size
-          when 4
-            Deprecation.warn(self, 'you provided 4 args, but active_lifecycle now takes kwargs')
-            (repo, druid, milestone_name) = args[0..2]
-            version = args[3][:version]
-          when 3
-            Deprecation.warn(self, 'you provided 3 args, but active_lifecycle now takes kwargs')
-            (repo, druid, milestone_name) = args
-            version = nil
-          when 1
-            opts = args.first
-            repo = opts[:repo]
-            druid = opts[:druid]
-            milestone_name = opts[:milestone_name]
-            version = opts[:version]
-          else
-            raise ArgumentError, 'wrong number of arguments, must be 1, 3, or 4'
-          end
-
-          Deprecation.warn(self, 'passing the repo parameter to active_lifecycle is no longer necessary. This will raise an error in dor-workflow-client version 4') if repo
-
+        def active_lifecycle(druid:, milestone_name:, version:)
           lifecycle(druid: druid, milestone_name: milestone_name, version: version, active_only: true)
         end
-        # rubocop:enable Metrics/MethodLength
 
         # @return [Array<Hash>]
-        # rubocop:disable Metrics/MethodLength
-        def milestones(*args)
-          case args.size
-          when 2
-            Deprecation.warn(self, 'you provided 2 args, but active_lifecycle now takes kwargs')
-            (repo, druid) = args
-          when 1
-            opts = args.first
-            repo = opts[:repo]
-            druid = opts.fetch(:druid)
-          else
-            raise ArgumentError, 'wrong number of arguments, must be 1-2'
-          end
-
-          Deprecation.warn(self, 'passing the repo parameter to active_lifecycle is no longer necessary. This will raise an error in dor-workflow-client version 4') if repo
-
+        def milestones(druid:)
           doc = query_lifecycle(druid, active_only: false)
           doc.xpath('//lifecycle/milestone').collect do |node|
             { milestone: node.text, at: Time.parse(node['date']), version: node['version'] }
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         private