dor-workflow-client 3.24.0 → 5.0.0

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

@@ -11,59 +11,35 @@ module Dor
 
         # Returns all the distinct laneIds for a given workflow step
         #
-        # @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(*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}"
+        def lane_ids(workflow, process)
+          uri = "workflow_queue/lane_ids?step=#{workflow}:#{process}"
           doc = Nokogiri::XML(requestor.request(uri))
           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 -- 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(*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)
+        def stale_queued_workflows(opts)
+          uri_string = build_queued_uri(opts)
           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 -- 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(*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'
+        def count_stale_queued_workflows(opts)
+          uri_string = "#{build_queued_uri(opts)}&count-only=true"
           doc = Nokogiri::XML(requestor.request(uri_string))
           doc.at_xpath('/objects/@count').value.to_i
         end
@@ -102,7 +78,6 @@ module Dor
         #     }
         #
         def objects_for_workstep(completed, waiting, lane_id = 'default', options = {})
-          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
@@ -133,19 +108,17 @@ module Dor
         #
         # @param [String] workflow name
         # @param [String] step name
-        # @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 = 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?
+        #        blah blah. See logger for details>"}
+        def errored_objects_for_workstep(workflow, step)
           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
@@ -153,11 +126,9 @@ module Dor
         # @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?
+        def count_objects_in_step(workflow, step, type)
           resp = requestor.request "workflow_queue?workflow=#{workflow}&#{type}=#{step}"
           extract_object_count(resp)
         end
@@ -166,11 +137,9 @@ module Dor
         #
         # @param [String] workflow name
         # @param [String] step name
-        # @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 = 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?
+        def count_errored_for_workstep(workflow, step)
           count_objects_in_step(workflow, step, 'error')
         end
 
@@ -178,11 +147,9 @@ module Dor
         #
         # @param [String] workflow name
         # @param [String] step name
-        # @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 = 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?
+        def count_queued_for_workstep(workflow, step)
           count_objects_in_step(workflow, step, 'queued')
         end
 

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 = '3.24.0'
+      VERSION = '5.0.0'
     end
   end
 end

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

@@ -17,32 +17,10 @@ module Dor
         # @param [String] repo The repository the object resides in. This parameter is deprecated
         # @param [String] druid The id of the object to delete the workflow from
         # @param [Boolean] create_accession_wf Option to create accessionWF when closing a version.  Defaults to true
-        # rubocop:disable Metrics/MethodLength
-        def close_version(*args)
-          case args.size
-          when 3
-            Deprecation.warn(self, 'you provided 3 args, but close_version now takes kwargs')
-            (repo, druid, create_accession_wf) = args
-          when 2
-            Deprecation.warn(self, 'you provided 2 args, but close_version now takes kwargs')
-            (repo, druid) = args
-            create_accession_wf = true
-          when 1
-            opts = args.first
-            repo = opts[:repo]
-            druid = opts[:druid]
-            version = opts[:version]
-            create_accession_wf = opts.key?(:create_accession_wf) ? opts[:create_accession_wf] : true
-          else
-            raise ArgumentError, 'wrong number of arguments, must be 1-3'
-          end
-
-          Deprecation.warn(self, 'passing the repo parameter to close_version is no longer necessary. This will raise an error in dor-workflow-client version 4') if repo
-
+        def close_version(druid:, version:, create_accession_wf: true)
           requestor.request(construct_url(druid, version, create_accession_wf), 'post', '')
           true
         end
-        # rubocop:enable Metrics/MethodLength
 
         private
 

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

@@ -4,31 +4,13 @@ module Dor
   module Workflow
     class Client
       # Makes requests relating to a workflow
-      # rubocop:disable Metrics/ClassLength
       class WorkflowRoutes
-        extend Deprecation
-
         def initialize(requestor:)
           @requestor = requestor
         end
 
-        # This method is deprecated and calls create_workflow_by_name.
-        #
-        # @param [String] repo Ignored
-        # @param [String] druid The id of the object
-        # @param [String] workflow_name The name of the workflow you want to create
-        # @param [String] wf_xml Ignored
-        # @param [Hash] opts optional params
-        # @option opts [String] :lane_id adds laneId attribute to all process elements in the wf_xml workflow xml.  Defaults to a value of 'default'
-        # @return [Boolean] always true
-        #
-        def create_workflow(_repo, druid, workflow_name, _wf_xml, opts = {})
-          create_workflow_by_name(druid, workflow_name, opts)
-        end
-        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
@@ -38,13 +20,8 @@ module Dor
         # @param [Integer] version specifies the version so that workflow service doesn't need to query dor-services.
         # @return [Boolean] always true
         #
-        def create_workflow_by_name(druid, workflow_name, version: nil, lane_id: 'default')
-          params = { 'lane-id' => lane_id }
-          if version
-            params['version'] = version
-          else
-            Deprecation.warn(self, 'Calling create_workflow_by_name without passing version is deprecated and will result in an error in dor-workflow-client 4.0')
-          end
+        def create_workflow_by_name(druid, workflow_name, version:, lane_id: 'default')
+          params = { 'lane-id' => lane_id, 'version' => version }
           requestor.request "objects/#{druid}/workflows/#{workflow_name}", 'post', '',
                             content_type: 'application/xml',
                             params: params
@@ -82,41 +59,6 @@ module Dor
           Workflow::Response::Update.new(json: response)
         end
 
-        # Updates the status of one step in a workflow.
-        # Returns true on success.  Caller must handle any exceptions
-        #
-        # @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
-        # @param [String] workflow The name of the workflow
-        # @param [String] process The name of the process step
-        # @param [String] status The status that you want to set -- using one of the values in VALID_STATUS
-        # @param [Hash] opts optional values for the workflow step
-        # @option opts [Float] :elapsed The number of seconds it took to complete this step. Can have a decimal.  Is set to 0 if not passed in.
-        # @option opts [String] :lifecycle Bookeeping label for this particular workflow step.  Examples are: 'registered', 'shelved'
-        # @option opts [String] :note Any kind of string annotation that you want to attach to the workflow
-        # @option opts [String] :lane_id Id of processing lane used by the job manager.  Can convey priority or name of an applicaiton specific processing lane (e.g. 'high', 'critical', 'hydrus')
-        # @option opts [String] :current_status Setting this string tells the workflow service to compare the current status to this value.  If the current value does not match this value, the update is not performed
-        # @return [Boolean] always true
-        # Http Call
-        # ==
-        # The method does an HTTP PUT to the base URL.  As an example:
-        #
-        #     PUT "/dor/objects/pid:123/workflows/GoogleScannedWF/convert"
-        #     <process name=\"convert\" status=\"completed\" />"
-        def update_workflow_status(repo, druid, workflow, process, status, opts = {})
-          raise ArgumentError, "Unknown status value #{status}" unless VALID_STATUS.include?(status.downcase)
-
-          opts = { elapsed: 0, lifecycle: nil, note: nil }.merge!(opts)
-          opts[:elapsed] = opts[:elapsed].to_s
-          current_status = opts.delete(:current_status)
-          xml = create_process_xml({ name: process, status: status.downcase }.merge!(opts))
-          uri = "#{repo}/objects/#{druid}/workflows/#{workflow}/#{process}"
-          uri += "?current-status=#{current_status.downcase}" if current_status
-          response = requestor.request(uri, 'put', xml, content_type: 'application/xml')
-          Workflow::Response::Update.new(json: response)
-        end
-        deprecation_deprecate update_workflow_status: 'use update_status instead.'
-
         #
         # Retrieves the process status of the given workflow for the given object identifier
         # @param [String] repo The repository the object resides in.  Currently recoginzes "dor" and "sdr".
@@ -124,21 +66,7 @@ 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
-          when 4
-            Deprecation.warn(self, 'Calling workflow_status with positional args is deprecated, use kwargs instead')
-            (_repo, druid, workflow, process) = *args
-          when 1
-            opts = args.first
-            repo = opts[:repo]
-            Deprecation.warn(self, 'Passing `:repo` to workflow_status is deprecated and can be omitted') if repo
-            druid = opts[:druid]
-            workflow = opts[:workflow]
-            process = opts[:process]
-          end
+        def workflow_status(druid:, workflow:, process:)
           workflow_md = fetch_workflow(druid: druid, workflow: workflow)
           doc = Nokogiri::XML(workflow_md)
           raise Dor::WorkflowException, "Unable to parse response:\n#{workflow_md}" if doc.root.nil?
@@ -147,61 +75,6 @@ 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
-
-        #
-        # 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
-            Deprecation.warn(self, 'Calling workflow_xml with positional args is deprecated, use kwargs instead')
-            (repo, druid, workflow) = *args
-          when 1
-            opts = args.first
-            repo = opts[:repo]
-            Deprecation.warn(self, 'Passing `:repo` to workflow_xml is deprecated and can be omitted') if repo
-            druid = opts[:druid]
-            workflow = opts[:workflow]
-          end
-
-          raise ArgumentError, 'missing workflow' unless workflow
-          return requestor.request "#{repo}/objects/#{druid}/workflows/#{workflow}" if repo
-
-          fetch_workflow(druid: druid, workflow: workflow)
-        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
-        #
-        # @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
-        # @param [String] workflow The name of the workflow
-        # @param [String] process The name of the workflow step
-        # @param [String] error_msg The error message.  Ideally, this is a brief message describing the error
-        # @param [Hash] opts optional values for the workflow step
-        # @option opts [String] :error_text A slot to hold more information about the error, like a full stacktrace
-        # @return [Boolean] always true
-        #
-        # Http Call
-        # ==
-        # The method does an HTTP PUT to the base URL.
-        #
-        #     PUT "/objects/pid:123/workflows/GoogleScannedWF/convert"
-        #     <process name=\"convert\" status=\"error\" />"
-        def update_workflow_error_status(_repo, druid, workflow, process, error_msg, opts = {})
-          update_error_status(druid: druid, workflow: workflow, process: process, error_msg: error_msg, error_text: opts[:error_text])
-          true
-        end
-        deprecation_deprecate update_workflow_error_status: 'use update_error_status instead.'
 
         # Updates the status of one step in a workflow to error.
         # Returns true on success.  Caller must handle any exceptions
@@ -245,23 +118,19 @@ module Dor
         # This method only works when this gem is used in a project that is configured to connect to DOR
         #
         # @param [String] pid of druid
-        # @param [String] repo repository for the object
         # @return [Array<String>] list of worklows
         # @example
         #   client.workflows('druid:sr100hp0609')
         #   => ["accessionWF", "assemblyWF", "disseminationWF"]
-        def workflows(pid, repo = nil)
-          Deprecation.warn(self, 'Passing the second argument (repo) to workflows is deprecated and can be omitted') if repo
+        def workflows(pid)
           xml_doc = Nokogiri::XML(fetch_workflow(druid: pid, workflow: ''))
           xml_doc.xpath('//workflow').collect { |workflow| workflow['id'] }
         end
 
-        # @param [String] repo repository of the object
         # @param [String] pid id of object
         # @param [String] workflow_name The name of the workflow
         # @return [Workflow::Response::Workflow]
-        def workflow(repo: nil, pid:, workflow_name:)
-          Deprecation.warn(self, 'passing the repo parameter is deprecated and will be removed in the next major versions') if repo
+        def workflow(pid:, workflow_name:)
           xml = fetch_workflow(druid: pid, workflow: workflow_name)
           Workflow::Response::Workflow.new(xml: xml)
         end
@@ -275,19 +144,13 @@ 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)
-          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'
+        def delete_workflow(druid:, workflow:, version:)
+          qs_args = "?version=#{version}"
+          requestor.request "/objects/#{druid}/workflows/#{workflow}#{qs_args}", 'delete'
           true
         end
 
@@ -313,14 +176,13 @@ 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
         end
       end
-      # rubocop:enable Metrics/ClassLength
     end
   end
 end

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
@@ -39,8 +40,7 @@ module Dor
         @requestor = Requestor.new(connection: connection || ConnectionFactory.build_connection(url, timeout: timeout, logger: logger))
       end
 
-      delegate :create_workflow, :create_workflow_by_name, :update_workflow_status, :workflow_status,
-               :workflow_xml, :update_workflow_error_status, :all_workflows_xml, :workflows,
+      delegate :create_workflow_by_name, :workflow_status, :all_workflows_xml, :workflows,
                :workflow, :process, :delete_workflow, :delete_all_workflows, :update_status, :update_error_status,
                to: :workflow_routes
 

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

@@ -51,8 +51,7 @@ module Dor
           @attributes[:laneId].presence
         end
 
-        delegate :pid, :workflow_name, :repository, to: :parent
-        deprecation_deprecate :repository
+        delegate :pid, :workflow_name, to: :parent
 
         private
 

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

@@ -5,9 +5,6 @@ module Dor
     module Response
       # The response from asking the server about a workflow for an item
       class Workflow
-        extend Deprecation
-        self.deprecation_horizon = '4.x'
-
         def initialize(xml:)
           @xml = xml
         end
@@ -20,11 +17,6 @@ module Dor
           workflow['id']
         end
 
-        def repository
-          workflow['repository']
-        end
-        deprecation_deprecate :repository
-
         # @param [Integer] version the version we are checking for.
         def active_for?(version:)
           result = ng_xml.at_xpath("/workflow/process[@version=#{version}]")
@@ -35,7 +27,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/process_spec.rb

@@ -32,23 +32,6 @@ RSpec.describe Dor::Workflow::Response::Process do
     it { is_expected.to eq 'assemblyWF' }
   end
 
-  describe '#repository' do
-    before do
-      allow(Deprecation).to receive(:warn)
-    end
-
-    subject { instance.repository }
-
-    let(:xml) do
-      <<~XML
-        <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
-          <process name="start-assembly">
-        </workflow>
-      XML
-    end
-    it { is_expected.to eq 'dor' }
-  end
-
   describe '#name' do
     subject { instance.name }
 

data/spec/models/response/workflow_spec.rb

@@ -29,22 +29,6 @@ RSpec.describe Dor::Workflow::Response::Workflow do
     it { is_expected.to eq 'assemblyWF' }
   end
 
-  describe '#repository' do
-    subject { instance.repository }
-
-    before do
-      allow(Deprecation).to receive(:warn)
-    end
-
-    let(:xml) do
-      <<~XML
-        <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
-        </workflow>
-      XML
-    end
-    it { is_expected.to eq 'dor' }
-  end
-
   describe '#complete?' do
     subject { instance.complete? }
     context 'when all steps are complete' do
@@ -72,7 +56,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