dor-workflow-client 3.20.0 → 3.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eef64675c5a37fb89ea5f7a522c85dfa8a6e426418f4af515f73719a6812a28
-  data.tar.gz: 32162d0b34a328cc2d42414bac647db71f5e14425c223cf0c22b9dc37b2a71a4
+  metadata.gz: 2db7637402c0dd629a9d7ced145e20558b24717e56f7bc3fcd3adabbfca4d162
+  data.tar.gz: 7d4b3a6e7903ebb67a7786d1e10e7210020dee185674028507570e3ca271b796
 SHA512:
-  metadata.gz: 804ed21db035008f7ce28ec81491fcc3d2f8d72c7c06f4874ffe74431d8b5b59ffc3f860a31847456644b428a57c1b0352681c7046b622ff9e72bfab8d02125e
-  data.tar.gz: d76a0c12b6570130d4adf11980fd1cbd80df8336c9d00b960b03d4ff0c75b46812a8a18e1527cd8df82b55a63ab12bbb6564e5b2156332b50dbc7daa4f1bcb64
+  metadata.gz: 14374bf91330e5b7280984ffec6a9547731b8a65a9dbe251d2496ed6c94e732efdddfaeab342ae077658e26b4db24af0c3f7fc59ca8c77ddf7fb3143e6c26453
+  data.tar.gz: ded3fd3fb5f3cbd7a3a3accbfa010e96cfd30df3773c799176a5645aede13fc5cbdf8171445b1bf60805980292014dd83c4255ad62fe83fb9a0440c78c5b5338

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+
+jobs:
+  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 $?

data/.github/pull_request_template.md

@@ -0,0 +1,12 @@
+## Why was this change made?
+
+
+
+## How was this change tested?
+
+
+
+## Which documentation and/or configurations were updated?
+
+
+

data/README.md

@@ -1,6 +1,7 @@
-[![Build Status](https://travis-ci.org/sul-dlss/dor-workflow-client.svg?branch=master)](https://travis-ci.org/sul-dlss/dor-workflow-client)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/fba77ff479c468f8510f/test_coverage)](https://codeclimate.com/github/sul-dlss/dor-services-client/test_coverage)
-[![Maintainability](https://api.codeclimate.com/v1/badges/fba77ff479c468f8510f/maintainability)](https://codeclimate.com/github/sul-dlss/dor-services-client/maintainability)
+[![CircleCI](https://circleci.com/gh/sul-dlss/dor-workflow-client.svg?style=svg)](https://circleci.com/gh/sul-dlss/dor-workflow-client)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/ff9d01af29a7a357645c/test_coverage)](https://codeclimate.com/github/sul-dlss/dor-workflow-client/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ff9d01af29a7a357645c/maintainability)](https://codeclimate.com/github/sul-dlss/dor-workflow-client/maintainability)
+
 [![Gem Version](https://badge.fury.io/rb/dor-workflow-client.svg)](https://badge.fury.io/rb/dor-workflow-client)
 
 # dor-workflow-client gem
@@ -19,7 +20,7 @@ client = Dor::Workflow::Client.new(url: 'https://test-server.edu/workflow/')
 Consumers of recent versions of the [dor-services](https://github.com/sul-dlss/dor-services) gem can access the configured `Dor::Workflow::Client` object via `Dor::Config`.
 
 ## API
-[Rubydoc](https://www.rubydoc.info/github/sul-dlss/dor-workflow-client/master)
+[Rubydoc](https://www.rubydoc.info/github/sul-dlss/dor-workflow-client/main)
 
 ### Example usage
 Create a workflow
@@ -37,7 +38,7 @@ client.update_status(druid: 'druid:bc123df4567',
 
 Show "milestones" for an object
 ```ruby
-client.milestones('dor', 'druid:gv054hp4128')
+client.milestones(druid: 'druid:gv054hp4128')
 #=> [{version: '1', milestone: 'published'}]
 ```
 

data/dor-workflow-client.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |gem|
   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'
+  gem.add_development_dependency 'simplecov', '~> 0.17.0' # CodeClimate cannot use SimpleCov >= 0.18.0 for generating test coverage
   gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'yard'
 end

data/lib/dor/workflow/client.rb

@@ -82,7 +82,7 @@ module Dor
       end
 
       def status(druid:, version:)
-        @status ||= Status.new(druid: druid, version: version, lifecycle_routes: lifecycle_routes)
+        Status.new(druid: druid, version: version, lifecycle_routes: lifecycle_routes)
       end
 
       private

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

@@ -10,37 +10,102 @@ module Dor
         end
 
         # Returns the Date for a requested milestone from workflow lifecycle
-        # @param [String] repo repository name
+        #
+        # @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 [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
         #
-        def lifecycle(repo, druid, milestone_name, version: nil, active_only: false)
-          filter_milestone(query_lifecycle(repo, druid, version: version, active_only: active_only), milestone_name)
+        # 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
+
+          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.
         # A better approach is #lifecycle with the version tag.
-        # @param [String] repo repository name
         # @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
         # @return [Time] when the milestone was achieved.  Returns nil if the milestone does not exis
         #
-        def active_lifecycle(repo, druid, milestone_name, version: nil)
-          lifecycle(repo, druid, milestone_name, version: version, active_only: true)
+        # 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
+
+          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
 
-        # @return [Hash]
-        def milestones(repo, druid)
-          doc = query_lifecycle(repo, druid, active_only: false)
+          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
 
@@ -51,7 +116,6 @@ module Dor
           Time.parse(milestone['date'])
         end
 
-        # @param [String] repo repository name
         # @param [String] druid object id
         # @param [Boolean] active_only (false) if true, return only lifecycle steps for versions that have all processes complete
         # @param [Number] version the version to query for
@@ -63,8 +127,8 @@ module Dor
         #     <milestone date="2010-06-15T16:08:58-0700">released</milestone>
         #   </lifecycle>
         #
-        def query_lifecycle(repo, druid, active_only:, version: nil)
-          req = "#{repo}/objects/#{druid}/lifecycle"
+        def query_lifecycle(druid, active_only:, version: nil)
+          req = "objects/#{druid}/lifecycle"
           params = []
           params << "version=#{version}" if version
           params << 'active-only=true' if active_only

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

@@ -11,39 +11,59 @@ module Dor
 
         # Returns all the distinct laneIds for a given workflow step
         #
-        # @param [String] repo The repository the object resides in.  The service recoginzes "dor" and "sdr" at the moment
+        # @param [String] repo -- deprecated, ignored by workflow service
         # @param [String] workflow name
         # @param [String] process name
         # @return [Array<String>] all of the distinct laneIds.  Array will be empty if no lane ids were found
-        def lane_ids(repo, workflow, process)
-          uri = "workflow_queue/lane_ids?step=#{repo}:#{workflow}:#{process}"
+        def lane_ids(*args)
+          if args.count == 3
+            Deprecation.warn(
+              self,
+              '`#lane_ids` only takes two args: workflow name, & process/step name. This will raise an exception in Dor::Workflow::Client 4.0.0'
+            )
+            args.shift # ditch the `repo` argument
+          end
+          uri = "workflow_queue/lane_ids?step=#{args.first}:#{args.second}"
           doc = Nokogiri::XML(requestor.request(uri))
-          nodes = doc.xpath('/lanes/lane')
-          nodes.map { |n| n['id'] }
+          doc.xpath('/lanes/lane').map { |n| n['id'] }
         end
 
         # Gets all of the workflow steps that have a status of 'queued' that have a last-updated timestamp older than the number of hours passed in
         #   This will enable re-queueing of jobs that have been lost by the job manager
-        # @param [String] repository name of the repository you want to query, like 'dor' or 'sdr'
+        # @param [String] repository -- deprecated, ignored by workflow service
         # @param [Hash] opts optional values for query
         # @option opts [Integer] :hours_ago steps older than this value will be returned by the query.  If not passed in, the service defaults to 0 hours,
         #   meaning you will get all queued workflows
         # @option opts [Integer] :limit sets the maximum number of workflow steps that can be returned.  Defaults to no limit
         # @return [Array[Hash]] each Hash represents a workflow step.  It will have the following keys:
         #  :workflow, :step, :druid, :lane_id
-        def stale_queued_workflows(repository, opts = {})
-          uri_string = build_queued_uri(repository, opts)
+        def stale_queued_workflows(*args)
+          if args.count == 2
+            Deprecation.warn(
+              self,
+              '`#stale_queued_workflows` only takes one arg: a hash. This will raise an exception in Dor::Workflow::Client 4.0.0'
+            )
+            args.shift # ditch the `repo` argument
+          end
+          uri_string = build_queued_uri(args.first)
           parse_queued_workflows_response requestor.request(uri_string)
         end
 
         # Returns a count of workflow steps that have a status of 'queued' that have a last-updated timestamp older than the number of hours passed in
-        # @param [String] repository name of the repository you want to query, like 'dor' or 'sdr'
+        # @param [String] repository -- deprecated, ignored by workflow service
         # @param [Hash] opts optional values for query
         # @option opts [Integer] :hours_ago steps older than this value will be returned by the query.  If not passed in, the service defaults to 0 hours,
         #   meaning you will get all queued workflows
         # @return [Integer] number of stale, queued steps if the :count_only option was set to true
-        def count_stale_queued_workflows(repository, opts = {})
-          uri_string = build_queued_uri(repository, opts) + '&count-only=true'
+        def count_stale_queued_workflows(*args)
+          if args.count == 2
+            Deprecation.warn(
+              self,
+              '`#count_stale_queued_workflows` only takes one arg: a hash. This will raise an exception in Dor::Workflow::Client 4.0.0'
+            )
+            args.shift # ditch the `repo` argument
+          end
+          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
@@ -51,13 +71,11 @@ module Dor
         # Returns a list of druids from the workflow service that meet the criteria
         # of the passed in completed and waiting params
         #
-        # @param [Array<String>, String] completed An array or single String of the completed steps, should use the qualified format: `repository:workflow:step-name`
+        # @param [Array<String>, String] completed An array or single String of the completed steps, should use the qualified format: `workflow:step-name`
         # @param [String] waiting name of the waiting step
-        # @param [String] repository default repository to use if it isn't passed in the qualified-step-name
         # @param [String] workflow default workflow to use if it isn't passed in the qualified-step-name
         # @param [String] lane_id issue a query for a specific lane_id for the waiting step
         # @param [Hash] options
-        # @param options  [String]  :default_repository repository to query for if not using the qualified format
         # @param options  [String]  :default_workflow workflow to query for if not using the qualified format
         # @option options [Integer] :limit maximum number of druids to return (nil for no limit)
         # @return [Array<String>]  Array of druids
@@ -84,11 +102,12 @@ module Dor
         #     }
         #
         def objects_for_workstep(completed, waiting, lane_id = 'default', options = {})
-          waiting_param = qualify_step(options[:default_repository], options[:default_workflow], waiting)
+          Deprecation.warn(self, 'the `:default_repository` option in `#objects_for_workstep` is unused and will go away in Dor::Workflow::Client 4.0.0. omit argument to silence.') if options[:default_repository]
+          waiting_param = qualify_step(options[:default_workflow], waiting)
           uri_string = "workflow_queue?waiting=#{waiting_param}"
           if completed
             Array(completed).each do |step|
-              completed_param = qualify_step(options[:default_repository], options[:default_workflow], step)
+              completed_param = qualify_step(options[:default_workflow], step)
               uri_string += "&completed=#{completed_param}"
             end
           end
@@ -107,33 +126,39 @@ module Dor
           # convert into:
           #   ['druid:ab123de4567', 'druid:ab123de9012']
           #
-          result = Nokogiri::XML(resp).xpath('//object[@id]')
-          result.map { |n| n[:id] }
+          Nokogiri::XML(resp).xpath('//object[@id]').map { |n| n[:id] }
         end
 
         # Get a list of druids that have errored out in a particular workflow and step
         #
         # @param [String] workflow name
         # @param [String] step name
-        # @param [String] repository -- optional, default=dor
+        # @param [String] repository -- deprecated, ignored by workflow service
         #
         # @return [Hash] hash of results, with key has a druid, and value as the error message
         # @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>"}
-        def errored_objects_for_workstep(workflow, step, repository = 'dor')
-          resp = requestor.request "workflow_queue?repository=#{repository}&workflow=#{workflow}&error=#{step}"
-          result = {}
-          Nokogiri::XML(resp).xpath('//object').collect do |node|
-            result.merge!(node['id'] => node['errorMessage'])
-          end
-          result
+        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|
+            [node['id'], node['errorMessage']]
+          end.to_h
         end
 
         # Used by preservation robots stats reporter
-        def count_objects_in_step(workflow, step, type, repo)
-          resp = requestor.request "workflow_queue?repository=#{repo}&workflow=#{workflow}&#{type}=#{step}"
+        #
+        # @param [String] workflow name
+        # @param [String] step name
+        # @param [String] type
+        # @param [String] repo -- deprecated, ignored by workflow service
+        #
+        # @return [Hash] hash of results, with key has a druid, and value as the error message
+        def count_objects_in_step(workflow, step, type, repo = nil)
+          Deprecation.warn(self, 'the fourth argument to `#count_objects_in_step` is unused and will go away in Dor::Workflow::Client 4.0.0. omit argument to silence.') unless repo.nil?
+          resp = requestor.request "workflow_queue?workflow=#{workflow}&#{type}=#{step}"
           extract_object_count(resp)
         end
 
@@ -141,52 +166,50 @@ module Dor
         #
         # @param [String] workflow name
         # @param [String] step name
-        # @param [String] repository -- optional, default=dor
+        # @param [String] repository -- deprecated, ignored by workflow service
         #
         # @return [Integer] Number of objects with this repository:workflow:step that have a status of 'error'
-        def count_errored_for_workstep(workflow, step, repository = 'dor')
-          count_objects_in_step(workflow, step, 'error', repository)
+        def count_errored_for_workstep(workflow, step, repository = nil)
+          Deprecation.warn(self, 'the third argument to `#count_errored_for_workstep` is unused and will go away in Dor::Workflow::Client 4.0.0. omit argument to silence.') unless repository.nil?
+          count_objects_in_step(workflow, step, 'error')
         end
 
         # Returns the number of objects that have a status of 'queued' in a particular workflow and step
         #
         # @param [String] workflow name
         # @param [String] step name
-        # @param [String] repository -- optional, default=dor
+        # @param [String] repository -- deprecated, ignored by workflow service
         #
         # @return [Integer] Number of objects with this repository:workflow:step that have a status of 'queued'
-        def count_queued_for_workstep(workflow, step, repository = 'dor')
-          count_objects_in_step(workflow, step, 'queued', repository)
+        def count_queued_for_workstep(workflow, step, repository = nil)
+          Deprecation.warn(self, 'the third argument to `#count_queued_for_workstep` is unused and will go away in Dor::Workflow::Client 4.0.0. omit argument to silence.') unless repository.nil?
+          count_objects_in_step(workflow, step, 'queued')
         end
 
         private
 
         attr_reader :requestor
 
-        def build_queued_uri(repository, opts = {})
-          uri_string = "workflow_queue/all_queued?repository=#{repository}"
-          uri_string += "&hours-ago=#{opts[:hours_ago]}" if opts[:hours_ago]
-          uri_string += "&limit=#{opts[:limit]}"         if opts[:limit]
-          uri_string
+        def build_queued_uri(opts = {})
+          query_hash = opts.slice(:hours_ago, :limit).transform_keys { |key| key.to_s.tr('_', '-') }
+          query_string = URI.encode_www_form(query_hash)
+          "workflow_queue/all_queued?#{query_string}"
         end
 
-        # Converts repo-workflow-step into repo:workflow:step
-        # @param [String] default_repository
+        # Converts workflow-step into workflow:step
         # @param [String] default_workflow
         # @param [String] step if contains colon :, then the value for workflow and/or workflow/repository. For example: 'jp2-create', 'assemblyWF:jp2-create' or 'dor:assemblyWF:jp2-create'
-        # @return [String] repo:workflow:step
+        # @return [String] workflow:step
         # @example
-        #   dor:assemblyWF:jp2-create
-        def qualify_step(default_repository, default_workflow, step)
-          current = step.split(/:/, 3)
-          current.unshift(default_workflow)   if current.length < 3
-          current.unshift(default_repository) if current.length < 3
+        #   assemblyWF:jp2-create
+        def qualify_step(default_workflow, step)
+          current = step.split(':').last(2)
+          current.unshift(default_workflow) if current.length < 2
           current.join(':')
         end
 
         def parse_queued_workflows_response(xml)
-          doc = Nokogiri::XML(xml)
-          doc.xpath('/workflows/workflow').collect do |wf_node|
+          Nokogiri::XML(xml).xpath('/workflows/workflow').collect do |wf_node|
             {
               workflow: wf_node['name'],
               step: wf_node['process'],