dor-workflow-service 2.10.2 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79fe69cfab22b4da4c0a0ffcff0b87260abe8135dfe4cddcf85b6a7ed1ab5340
-  data.tar.gz: 85d746ee5c055bd8ff1e9d8c49d6cc9698f546639bf5bb797319787e5fac4725
+  metadata.gz: d8f863086a378b50a1d61a7a2defaa0c33731683b53c7082108438725a7d7ec1
+  data.tar.gz: b398505b2babc4b039678f3b17e06ccd120df459ec8ef38784994690fc0dbf19
 SHA512:
-  metadata.gz: 5a944d65bbd908238f6a518d7c921f02bb1c53a6a342465a477239f96c6c6c9e31cb5ae6bc85c306ee7049fa3652f102213fa3a00df2edcb819b86fc5ab49674
-  data.tar.gz: 0f96ad970c71e26fc90428d352ce173ca3663df7d08a2f18d300083bec3b0390643f409ce8f530709b34b6f692d5ea50417ff7e778d36bf33e523851c6d131d9
+  metadata.gz: 3e0bbcea11e6b9ba2070ff50a47145f9cdc6a8e9b2d9b59d8da5961bcf7683c80767ad39928f426358ec7e627b402c1e89846c329988fda417ada8267223c21d
+  data.tar.gz: 9b9006a691d3e89917442e9040bb1c3907c1789c472da4e399b9e5214fd46737455b28822fa2958e53f6c0c791b4947ec9549e04cce2b018ddd9a90ea149e1fa

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-03-12 08:34:30 -0500 using RuboCop version 0.63.1.
+# on 2019-04-03 11:51:29 -0500 using RuboCop version 0.63.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
@@ -23,7 +23,7 @@ Metrics/AbcSize:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 257
+  Max: 305
 
 # Offense count: 3
 # Configuration parameters: CountComments, ExcludedMethods.
@@ -42,7 +42,7 @@ Naming/FileName:
   Exclude:
     - 'lib/dor-workflow-service.rb'
 
-# Offense count: 9
+# Offense count: 8
 Style/ClassVars:
   Exclude:
     - 'lib/dor/services/workflow_service.rb'

data/lib/dor/services/workflow_service.rb

@@ -94,8 +94,8 @@ 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
-      def get_workflow_status(repo, druid, workflow, process)
-        workflow_md = get_workflow_xml(repo, druid, workflow)
+      def workflow_status(repo, druid, workflow, process)
+        workflow_md = workflow_xml(repo, druid, workflow)
         doc = Nokogiri::XML(workflow_md)
         raise Dor::WorkflowException, "Unable to parse response:\n#{workflow_md}" if doc.root.nil?
 
@@ -104,16 +104,38 @@ module Dor
         process&.attr('status')
       end
 
+      def get_workflow_status(repo, druid, workflow, process)
+        Deprecation.warn(self, 'use workflow_status instead. This will be removed in dor-workflow-service version 3')
+        workflow_status(repo, druid, workflow, process)
+      end
+
       #
       # 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
-      def get_workflow_xml(repo, druid, workflow)
+      def workflow_xml(repo, druid, workflow)
+        unless workflow
+          Deprecation.warn(self, 'calling workflow_xml without a workflow is deprecated and will be removed in version 3. Use all_workflows_xml instead.')
+          return all_workflows_xml(druid)
+        end
         workflow_resource_method "#{repo}/objects/#{druid}/workflows/#{workflow}"
       end
 
+      def get_workflow_xml(repo, druid, workflow)
+        Deprecation.warn(self, 'use workflow_xml instead. This will be removed in dor-workflow-service version 3')
+        workflow_xml(repo, druid, workflow)
+      end
+
+      #
+      # Retrieves the raw XML for all the workflows for the the given object
+      # @param [String] druid The id of the object
+      # @return [String] XML of the workflow
+      def all_workflows_xml(druid)
+        workflow_resource_method "objects/#{druid}/workflows"
+      end
+
       # Get workflow names into an array for given PID
       # This method only works when this gem is used in a project that is configured to connect to DOR
       #
@@ -121,13 +143,18 @@ module Dor
       # @param [String] repo repository for the object
       # @return [Array<String>] list of worklows
       # @example
-      #   Dor::WorkflowService.get_workflows('druid:sr100hp0609')
+      #   Dor::WorkflowService.workflows('druid:sr100hp0609')
       #   => ["accessionWF", "assemblyWF", "disseminationWF"]
-      def get_workflows(pid, repo = 'dor')
-        xml_doc = Nokogiri::XML(get_workflow_xml(repo, pid, ''))
+      def workflows(pid, repo = 'dor')
+        xml_doc = Nokogiri::XML(workflow_xml(repo, pid, ''))
         xml_doc.xpath('//workflow').collect { |workflow| workflow['id'] }
       end
 
+      def get_workflows(pid, repo = 'dor')
+        Deprecation.warn(self, 'use workflows instead. This will be removed in dor-workflow-service version 3')
+        workflows(pid, repo)
+      end
+
       # Get active workflow names into an array for given PID
       # This method only works when this gem is used in a project that is configured to connect to DOR
       #
@@ -135,14 +162,16 @@ module Dor
       # @param [String] pid id of object
       # @return [Array<String>] list of active worklows.  Returns an empty Array if none are found
       # @example
-      #   Dor::WorkflowService.get_active_workflows('dor', 'druid:sr100hp0609')
+      #   Dor::WorkflowService.active_workflows('dor', 'druid:sr100hp0609')
       #   => ["accessionWF", "assemblyWF", "disseminationWF"]
-      def get_active_workflows(repo, pid)
+      def active_workflows(repo, pid)
         Deprecation.warn(self, 'get_active_workflows will be removed without replacement because the workflow server no longer archives processes')
         doc = Nokogiri::XML(get_workflow_xml(repo, pid, ''))
         doc.xpath(%(//workflow[not(process/@archived)]/@id )).map(&:value)
       end
 
+      alias get_active_workflows active_workflows
+
       # @param [String] repo repository of the object
       # @param [String] pid id of object
       # @param [String] workflow_name The name of the workflow
@@ -197,7 +226,7 @@ module Dor
       #     <milestone date="2010-04-29T10:12:51-0700">inprocess</milestone>
       #     <milestone date="2010-06-15T16:08:58-0700">released</milestone>
       #   </lifecycle>
-      def get_lifecycle(repo, druid, milestone)
+      def lifecycle(repo, druid, milestone)
         doc = query_lifecycle(repo, druid)
         milestone = doc.at_xpath("//lifecycle/milestone[text() = '#{milestone}']")
         return Time.parse(milestone['date']) if milestone
@@ -205,6 +234,11 @@ module Dor
         nil
       end
 
+      def get_lifecycle(repo, druid, milestone)
+        Deprecation.warn(self, 'use lifecycle instead. This will be removed in dor-workflow-service version 3')
+        lifecycle(repo, druid, milestone)
+      end
+
       # Returns the Date for a requested milestone ONLY FROM THE ACTIVE workflow table
       # @param [String] repo repository name
       # @param [String] druid object id
@@ -216,7 +250,7 @@ module Dor
       #     <milestone date="2010-04-29T10:12:51-0700">inprocess</milestone>
       #     <milestone date="2010-06-15T16:08:58-0700">released</milestone>
       #   </lifecycle>
-      def get_active_lifecycle(repo, druid, milestone)
+      def active_lifecycle(repo, druid, milestone)
         doc = query_lifecycle(repo, druid, true)
         milestone = doc.at_xpath("//lifecycle/milestone[text() = '#{milestone}']")
         return Time.parse(milestone['date']) if milestone
@@ -224,14 +258,24 @@ module Dor
         nil
       end
 
+      def get_active_lifecycle(repo, druid, milestone)
+        Deprecation.warn(self, 'use active_lifecycle instead. This will be removed in dor-workflow-service version 3')
+        active_lifecycle(repo, druid, milestone)
+      end
+
       # @return [Hash]
-      def get_milestones(repo, druid)
+      def milestones(repo, druid)
         doc = query_lifecycle(repo, druid)
         doc.xpath('//lifecycle/milestone').collect do |node|
           { milestone: node.text, at: Time.parse(node['date']), version: node['version'] }
         end
       end
 
+      def get_milestones(repo, druid)
+        Deprecation.warn(self, 'use milestones instead. This will be removed in dor-workflow-service version 3')
+        milestones(repo, druid)
+      end
+
       # Converts repo-workflow-step into repo:workflow:step
       # @param [String] default_repository
       # @param [String] default_workflow
@@ -260,7 +304,7 @@ module Dor
       # @return [Array<String>]  Array of druids
       #
       # @example
-      #     get_objects_for_workstep(...)
+      #     objects_for_workstep(...)
       #     => [
       #        "druid:py156ps0477",
       #        "druid:tt628cb6479",
@@ -268,19 +312,19 @@ module Dor
       #      ]
       #
       # @example
-      #     get_objects_for_workstep(..., "lane1")
+      #     objects_for_workstep(..., "lane1")
       #     => {
       #      "druid:py156ps0477",
       #      "druid:tt628cb6479",
       #     }
       #
       # @example
-      #     get_objects_for_workstep(..., "lane1", limit: 1)
+      #     objects_for_workstep(..., "lane1", limit: 1)
       #     => {
       #      "druid:py156ps0477",
       #     }
       #
-      def get_objects_for_workstep(completed, waiting, lane_id = 'default', options = {})
+      def objects_for_workstep(completed, waiting, lane_id = 'default', options = {})
         waiting_param = qualify_step(options[:default_repository], options[:default_workflow], waiting)
         uri_string = "workflow_queue?waiting=#{waiting_param}"
         if completed
@@ -308,6 +352,11 @@ module Dor
         result.map { |n| n[:id] }
       end
 
+      def get_objects_for_workstep(completed, waiting, lane_id = 'default', options = {})
+        Deprecation.warn(self, 'use objects_for_workstep instead. This will be removed in dor-workflow-service version 3')
+        objects_for_workstep(completed, waiting, lane_id, options)
+      end
+
       # Get a list of druids that have errored out in a particular workflow and step
       #
       # @param [String] workflow name
@@ -316,10 +365,10 @@ module Dor
       #
       # @return [Hash] hash of results, with key has a druid, and value as the error message
       # @example
-      #     Dor::WorkflowService.get_errored_objects_for_workstep('accessionWF','content-metadata')
+      #     Dor::WorkflowService.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 get_errored_objects_for_workstep(workflow, step, repository = 'dor')
+      def errored_objects_for_workstep(workflow, step, repository = 'dor')
         resp = workflow_resource_method "workflow_queue?repository=#{repository}&workflow=#{workflow}&error=#{step}"
         result = {}
         Nokogiri::XML(resp).xpath('//object').collect do |node|
@@ -328,6 +377,11 @@ module Dor
         result
       end
 
+      def get_errored_objects_for_workstep(workflow, step, repository = 'dor')
+        Deprecation.warn(self, 'use errored_objects_for_workstep instead. This will be removed in dor-workflow-service version 3')
+        errored_objects_for_workstep(workflow, step, repository)
+      end
+
       # Returns the number of objects that have a status of 'error' in a particular workflow and step
       #
       # @param [String] workflow name
@@ -356,6 +410,7 @@ module Dor
       # @param [String] repository -- optional, default=dor
       # @return [Integer] Number of objects with this repository:workflow that have been archived
       def count_archived_for_workflow(workflow, repository = 'dor')
+        Deprecation.warn(self, 'count_archived_for_workflow will be removed without replacement because the workflow server no longer archives processes')
         resp = workflow_resource_method "workflow_archive?repository=#{repository}&workflow=#{workflow}&count-only=true"
         extract_object_count(resp)
       end
@@ -369,11 +424,16 @@ module Dor
       # @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 get_stale_queued_workflows(repository, opts = {})
+      def stale_queued_workflows(repository, opts = {})
         uri_string = build_queued_uri(repository, opts)
         parse_queued_workflows_response workflow_resource_method(uri_string)
       end
 
+      def get_stale_queued_workflows(repository, opts = {})
+        Deprecation.warn(self, 'use stale_queued_workflows instead. This will be removed in dor-workflow-service version 3')
+        stale_queued_workflows(repository, opts)
+      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 [Hash] opts optional values for query
@@ -444,13 +504,18 @@ module Dor
       # @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 get_lane_ids(repo, workflow, process)
+      def lane_ids(repo, workflow, process)
         uri = "workflow_queue/lane_ids?step=#{repo}:#{workflow}:#{process}"
         doc = Nokogiri::XML(workflow_resource_method(uri))
         nodes = doc.xpath('/lanes/lane')
         nodes.map { |n| n['id'] }
       end
 
+      def get_lane_ids(repo, workflow, process)
+        Deprecation.warn(self, 'use lane_ids instead. This will be removed in dor-workflow-service version 3')
+        lane_ids(repo, workflow, process)
+      end
+
       ### MIMICKING ATTRIBUTE READER
       # @return [Faraday::Connection] the REST client resource created during configure()
       def workflow_resource

data/lib/dor/workflow_version.rb

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     module Service
-      VERSION = '2.10.2'
+      VERSION = '2.11.0'
     end
   end
 end

data/spec/workflow_service_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe Dor::WorkflowService do
+RSpec.describe Dor::WorkflowService do
   let(:wf_xml) do
     <<-EOXML
     <workflow id="etdSubmitWF">
@@ -41,7 +41,7 @@ describe Dor::WorkflowService do
     end
   end
 
-  before(:each) do
+  before do
     @repo  = 'dor'
     @druid = 'druid:123'
     @mock_logger = double('Logger')
@@ -49,13 +49,13 @@ describe Dor::WorkflowService do
     allow(@mock_logger).to receive(:info)  # silence log output
     allow(@mock_logger).to receive(:debug) # silence log output
     allow(@mock_logger).to receive(:warn) # silence log output
-    allow(Dor::WorkflowService).to receive(:default_logger).and_return(@mock_logger)
+    allow(described_class).to receive(:default_logger).and_return(@mock_logger)
 
-    Dor::WorkflowService.configure mock_http_connection
+    described_class.configure mock_http_connection
   end
 
   describe '#configure' do
-    let(:conn) { Dor::WorkflowService.configure 'http://externalhost/', timeout: 99 }
+    let(:conn) { described_class.configure 'http://externalhost/', timeout: 99 }
 
     it 'has a timeout' do
       expect(conn).to be_a(Faraday::Connection)
@@ -79,20 +79,20 @@ describe Dor::WorkflowService do
     end
 
     it 'should pass workflow xml to the DOR workflow service and return the URL to the workflow' do
-      Dor::WorkflowService.create_workflow(@repo, @druid, 'etdSubmitWF', wf_xml)
+      described_class.create_workflow(@repo, @druid, 'etdSubmitWF', wf_xml)
     end
 
     it 'should log an error and retry upon a targetted Faraday exception' do
       expect(@mock_logger).to receive(:warn).with(/\[Attempt 1\] Faraday::ClientError: the server responded with status 418/)
-      expect { Dor::WorkflowService.create_workflow(@repo, @druid, 'httpException', wf_xml) }.to raise_error Dor::WorkflowException
+      expect { described_class.create_workflow(@repo, @druid, 'httpException', wf_xml) }.to raise_error Dor::WorkflowException
     end
 
     it 'should raise on an unexpected Exception' do
-      expect { Dor::WorkflowService.create_workflow(@repo, @druid, 'raiseException', wf_xml) }.to raise_error(Exception, 'broken')
+      expect { described_class.create_workflow(@repo, @druid, 'raiseException', wf_xml) }.to raise_error(Exception, 'broken')
     end
 
     it 'sets the create-ds param to the value of the passed in options hash' do
-      Dor::WorkflowService.create_workflow(@repo, @druid, 'noCreateDsWF', wf_xml, create_ds: false)
+      described_class.create_workflow(@repo, @druid, 'noCreateDsWF', wf_xml, create_ds: false)
     end
 
     it 'adds lane_id attributes to all steps if passed in as an option' do
@@ -111,7 +111,7 @@ describe Dor::WorkflowService do
           <process name="start-accession" status="waiting" laneId="lane1"/>
         </workflow>
       XML
-      expect(Dor::WorkflowService.send(:add_lane_id_to_workflow_xml, 'lane1', wf_xml)).to be_equivalent_to(expected)
+      expect(described_class.send(:add_lane_id_to_workflow_xml, 'lane1', wf_xml)).to be_equivalent_to(expected)
     end
   end
 
@@ -134,21 +134,21 @@ describe Dor::WorkflowService do
     end
 
     it 'should update workflow status and return true if successful' do
-      expect(Dor::WorkflowService.update_workflow_status(@repo, @druid, 'etdSubmitWF', 'reader-approval', 'completed', version: 2, note: 'annotation', lane_id: 'lane2')).to be true
+      expect(described_class.update_workflow_status(@repo, @druid, 'etdSubmitWF', 'reader-approval', 'completed', version: 2, note: 'annotation', lane_id: 'lane2')).to be true
     end
 
     it 'should return false if the PUT to the DOR workflow service throws an exception' do
-      expect { Dor::WorkflowService.update_workflow_status(@repo, @druid, 'errorWF', 'reader-approval', 'completed') }.to raise_error(Dor::WorkflowException, /status 400/)
+      expect { described_class.update_workflow_status(@repo, @druid, 'errorWF', 'reader-approval', 'completed') }.to raise_error(Dor::WorkflowException, /status 400/)
     end
 
     it 'performs a conditional update when current-status is passed as a parameter' do
       expect(mock_http_connection).to receive(:put).with("#{@repo}/objects/#{@druid}/workflows/etdSubmitWF/reader-approval?current-status=queued").and_call_original
 
-      expect(Dor::WorkflowService.update_workflow_status(@repo, @druid, 'etdSubmitWF', 'reader-approval', 'completed', version: 2, note: 'annotation', lane_id: 'lane1', current_status: 'queued')).to be true
+      expect(described_class.update_workflow_status(@repo, @druid, 'etdSubmitWF', 'reader-approval', 'completed', version: 2, note: 'annotation', lane_id: 'lane1', current_status: 'queued')).to be true
     end
 
     it 'should throw exception if invalid status provided' do
-      expect { Dor::WorkflowService.update_workflow_status(@repo, @druid, 'accessionWF', 'publish', 'NOT_VALID_STATUS') }.to raise_error(ArgumentError)
+      expect { described_class.update_workflow_status(@repo, @druid, 'accessionWF', 'publish', 'NOT_VALID_STATUS') }.to raise_error(ArgumentError)
     end
   end
 
@@ -167,14 +167,29 @@ describe Dor::WorkflowService do
     end
 
     it 'should update workflow status to error and return true if successful' do
-      Dor::WorkflowService.update_workflow_error_status(@repo, @druid, 'etdSubmitWF', 'reader-approval', 'Some exception', error_text: 'The optional stacktrace')
+      described_class.update_workflow_error_status(@repo, @druid, 'etdSubmitWF', 'reader-approval', 'Some exception', error_text: 'The optional stacktrace')
     end
     it 'should return false if the PUT to the DOR workflow service throws an exception' do
-      expect { Dor::WorkflowService.update_workflow_status(@repo, @druid, 'errorWF', 'reader-approval', 'completed') }.to raise_error(Dor::WorkflowException, /status 400/)
+      expect { described_class.update_workflow_status(@repo, @druid, 'errorWF', 'reader-approval', 'completed') }.to raise_error(Dor::WorkflowException, /status 400/)
     end
   end
 
   describe '#get_workflow_status' do
+    subject(:get_workflow_status) { described_class.get_workflow_status(repo, druid, workflow_name, step_name) }
+
+    let(:step_name) { 'registrar-approval' }
+    let(:workflow_name) { 'etdSubmitWF' }
+    let(:repo) { 'dor' }
+    let(:druid) { 'druid:123' }
+
+    it 'calls workflow_status' do
+      expect(Deprecation).to receive(:warn)
+      expect(described_class).to receive(:workflow_status)
+      get_workflow_status
+    end
+  end
+
+  describe '#workflow_status' do
     let(:repo) { @repo }
     let(:druid) { @druid }
     let(:stubs) do
@@ -185,7 +200,7 @@ describe Dor::WorkflowService do
       end
     end
 
-    subject { Dor::WorkflowService.get_workflow_status(repo, druid, workflow_name, step_name) }
+    subject { described_class.workflow_status(repo, druid, workflow_name, step_name) }
     let(:step_name) { 'registrar-approval' }
     let(:workflow_name) { 'etdSubmitWF' }
     let(:status) { 200 }
@@ -246,21 +261,87 @@ describe Dor::WorkflowService do
   end
 
   describe '#get_workflow_xml' do
-    let(:xml) { '<workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>' }
+    subject(:get_workflow_xml) { described_class.get_workflow_xml(repo, druid, workflow_name) }
+
+    let(:workflow_name) { 'etdSubmitWF' }
+    let(:repo) { 'dor' }
+    let(:druid) { 'druid:123' }
+
+    it 'calls workflow_xml' do
+      expect(Deprecation).to receive(:warn)
+      expect(described_class).to receive(:workflow_xml)
+      get_workflow_xml
+    end
+  end
+
+  describe '#workflow_xml' do
+    subject(:workflow_xml) { described_class.workflow_xml('dor', 'druid:123', workflow) }
+
+    context 'when a workflow name is provided' do
+      let(:workflow) { 'etdSubmitWF' }
+      let(:xml) { '<workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>' }
+      let(:stubs) do
+        Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.get('dor/objects/druid:123/workflows/etdSubmitWF') do |_env|
+            [200, {}, xml]
+          end
+        end
+      end
+
+      it 'returns the xml for a given repository, druid, and workflow' do
+        expect(workflow_xml).to eq(xml)
+      end
+    end
+
+    context 'when no workflow name is provided' do
+      let(:workflow) { nil }
+
+      it 'calls all_workflows' do
+        expect(Deprecation).to receive(:warn)
+        expect(described_class).to receive(:all_workflows_xml).with('druid:123')
+        workflow_xml
+      end
+    end
+  end
+
+  describe '#get_workflows' do
+    subject(:get_workflows) { described_class.get_workflows(druid) }
+
+    let(:druid) { 'druid:123' }
+
+    it 'calls workflows' do
+      expect(Deprecation).to receive(:warn)
+      expect(described_class).to receive(:workflows)
+      get_workflows
+    end
+  end
+
+  describe '#all_workflows_xml' do
+    subject(:all_workflows_xml) { described_class.all_workflows_xml('druid:123') }
+
+    let(:workflow) { 'etdSubmitWF' }
+    let(:xml) do
+      <<~XML
+        <workflows>
+        <workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>
+        <workflow id="etdSubmitWF"><process name="registrar-approval" status="completed" /></workflow>
+        </workflows>
+      XML
+    end
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.get('dor/objects/druid:123/workflows/etdSubmitWF') do |_env|
+        stub.get('objects/druid:123/workflows') do |_env|
           [200, {}, xml]
         end
       end
     end
 
-    it 'returns the xml for a given repository, druid, and workflow' do
-      expect(Dor::WorkflowService.get_workflow_xml('dor', 'druid:123', 'etdSubmitWF')).to eq(xml)
+    it 'returns the xml for a given druid' do
+      expect(all_workflows_xml).to eq(xml)
     end
   end
 
-  describe '#get_workflows' do
+  describe '#workflows' do
     let(:xml) { '<workflow id="accessionWF"><process name="publish" status="completed" /></workflow>' }
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
@@ -271,11 +352,21 @@ describe Dor::WorkflowService do
     end
 
     it 'returns the workflows associated with druid' do
-      expect(Dor::WorkflowService.get_workflows(@druid)).to eq(['accessionWF'])
+      expect(described_class.workflows(@druid)).to eq(['accessionWF'])
     end
   end
 
   describe '#get_lifecycle' do
+    subject(:get_lifecycle) { described_class.get_lifecycle('dor', 'druid:123', 'released') }
+
+    it 'calls lifecycle' do
+      expect(Deprecation).to receive(:warn)
+      expect(described_class).to receive(:lifecycle)
+      get_lifecycle
+    end
+  end
+
+  describe '#lifecycle' do
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
         stub.get('dor/objects/druid:123/lifecycle') do |_env|
@@ -297,15 +388,25 @@ describe Dor::WorkflowService do
     end
 
     it 'returns a Time object reprenting when the milestone was reached' do
-      expect(Dor::WorkflowService.get_lifecycle('dor', 'druid:123', 'released').beginning_of_day).to eq(Time.parse('2010-06-15T16:08:58-0700').beginning_of_day)
+      expect(described_class.lifecycle('dor', 'druid:123', 'released').beginning_of_day).to eq(Time.parse('2010-06-15T16:08:58-0700').beginning_of_day)
     end
 
     it "returns nil if the milestone hasn't been reached yet" do
-      expect(Dor::WorkflowService.get_lifecycle('dor', 'druid:abc', 'inprocess')).to be_nil
+      expect(described_class.lifecycle('dor', 'druid:abc', 'inprocess')).to be_nil
     end
   end
 
   describe '#get_active_lifecycle' do
+    subject(:get_active_lifecycle) { described_class.get_active_lifecycle('dor', 'druid:123', 'released') }
+
+    it 'calls active_lifecycle' do
+      expect(Deprecation).to receive(:warn)
+      expect(described_class).to receive(:active_lifecycle)
+      get_active_lifecycle
+    end
+  end
+
+  describe '#active_lifecycle' do
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
         stub.get("dor/objects/#{@druid}/lifecycle") do |_env|
@@ -327,16 +428,26 @@ describe Dor::WorkflowService do
     end
 
     it 'parses out the active lifecycle' do
-      expect(Dor::WorkflowService.get_active_lifecycle('dor', @druid, 'released').beginning_of_day).to eq(Time.parse('2010-06-15T16:08:58-0700').beginning_of_day)
+      expect(described_class.active_lifecycle('dor', @druid, 'released').beginning_of_day).to eq(Time.parse('2010-06-15T16:08:58-0700').beginning_of_day)
     end
 
     it 'handles missing lifecycle' do
-      expect(Dor::WorkflowService.get_active_lifecycle('dor', @druid, 'NOT_FOUND')).to be_nil
+      expect(described_class.active_lifecycle('dor', @druid, 'NOT_FOUND')).to be_nil
+    end
+  end
+
+  describe '#get_objects_for_workstep' do
+    subject(:get_objects_for_workstep) { described_class.get_objects_for_workstep('google-download', 'process-content', 'default', default_repository: 'dor', default_workflow: 'googleScannedBookWF') }
+
+    it 'calls objects_for_workstep' do
+      expect(Deprecation).to receive(:warn)
+      expect(described_class).to receive(:objects_for_workstep)
+      get_objects_for_workstep
     end
   end
 
-  context '#get_objects_for_workstep' do
-    before :all do
+  context '#objects_for_workstep' do
+    before(:all) do
       @repository = 'dor'
       @workflow   = 'googleScannedBookWF'
       @completed  = 'google-download'
@@ -353,7 +464,7 @@ describe Dor::WorkflowService do
 
     describe 'a query with one step completed and one waiting' do
       it 'creates the URI string with only the one completed step' do
-        expect(Dor::WorkflowService.get_objects_for_workstep(@completed, @waiting, 'default', default_repository: @repository, default_workflow: @workflow)).to eq(['druid:ab123de4567', 'druid:ab123de9012'])
+        expect(described_class.objects_for_workstep(@completed, @waiting, 'default', default_repository: @repository, default_workflow: @workflow)).to eq(['druid:ab123de4567', 'druid:ab123de9012'])
       end
     end
 
@@ -362,7 +473,7 @@ describe Dor::WorkflowService do
         second_completed = 'google-convert'
         xml = %(<objects count="1"><object id="druid:ab123de4567"/><object id="druid:ab123de9012"/></objects>)
         allow(mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@repository}:#{@workflow}:#{@waiting}&completed=#{@repository}:#{@workflow}:#{@completed}&completed=#{@repository}:#{@workflow}:#{second_completed}&lane-id=default").and_return(double(Faraday::Response, body: xml))
-        expect(Dor::WorkflowService.get_objects_for_workstep([@completed, second_completed], @waiting, 'default', default_repository: @repository, default_workflow: @workflow)).to eq(['druid:ab123de4567', 'druid:ab123de9012'])
+        expect(described_class.objects_for_workstep([@completed, second_completed], @waiting, 'default', default_repository: @repository, default_workflow: @workflow)).to eq(['druid:ab123de4567', 'druid:ab123de9012'])
       end
     end
 
@@ -380,7 +491,7 @@ describe Dor::WorkflowService do
           allow(mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@qualified_waiting}&completed=#{@qualified_completed}&completed=#{qualified_completed2}&completed=#{qualified_completed3}&lane-id=#{laneid}").and_return(double(Faraday::Response, body: xml))
           args = [[@qualified_completed, qualified_completed2, qualified_completed3], @qualified_waiting]
           args << laneid if laneid != 'default'
-          expect(Dor::WorkflowService.get_objects_for_workstep(*args)).to eq(['druid:ab123de4567', 'druid:ab123de9012'])
+          expect(described_class.objects_for_workstep(*args)).to eq(['druid:ab123de4567', 'druid:ab123de9012'])
         end
       end
 
@@ -401,15 +512,15 @@ describe Dor::WorkflowService do
         end
         it 'with only one completed step passed in as a String' do
           allow(mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@qualified_waiting}&completed=#{@qualified_completed}&lane-id=default").and_return(double(Faraday::Response, body: @xml))
-          expect(Dor::WorkflowService.get_objects_for_workstep(@qualified_completed, @qualified_waiting)).to eq(['druid:ab123de4567'])
+          expect(described_class.objects_for_workstep(@qualified_completed, @qualified_waiting)).to eq(['druid:ab123de4567'])
         end
         it 'without any completed steps, only waiting' do
           allow(mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@qualified_waiting}&lane-id=default").and_return(double(Faraday::Response, body: @xml))
-          expect(Dor::WorkflowService.get_objects_for_workstep(nil, @qualified_waiting)).to eq(['druid:ab123de4567'])
+          expect(described_class.objects_for_workstep(nil, @qualified_waiting)).to eq(['druid:ab123de4567'])
         end
         it 'same but with lane_id' do
           allow(mock_http_connection).to receive(:get).with("workflow_queue?waiting=#{@qualified_waiting}&lane-id=lane1").and_return(double(Faraday::Response, body: @xml))
-          expect(Dor::WorkflowService.get_objects_for_workstep(nil, @qualified_waiting, 'lane1')).to eq(['druid:ab123de4567'])
+          expect(described_class.objects_for_workstep(nil, @qualified_waiting, 'lane1')).to eq(['druid:ab123de4567'])
         end
       end
     end
@@ -432,7 +543,7 @@ describe Dor::WorkflowService do
     end
 
     it 'returns an empty list if it encounters an empty workflow queue' do
-      expect(Dor::WorkflowService.get_objects_for_workstep(@completed, @waiting, 'default', default_repository: @repository, default_workflow: @workflow)).to eq([])
+      expect(described_class.objects_for_workstep(@completed, @waiting, 'default', default_repository: @repository, default_workflow: @workflow)).to eq([])
     end
   end
 
@@ -455,12 +566,26 @@ describe Dor::WorkflowService do
       end
     end
 
-    it 'returns error messages for errored objects' do
-      expect(Dor::WorkflowService.get_errored_objects_for_workstep(@workflow, @step, @repository)).to eq('druid:ab123cd4567' => 'This is an error message')
+    describe 'get_errored_objects_for_workstep' do
+      subject(:get_errored_objects_for_workstep) { described_class.get_errored_objects_for_workstep(@workflow, @step, @repository) }
+
+      it 'calls errored_objects_for_workstep' do
+        expect(Deprecation).to receive(:warn)
+        expect(described_class).to receive(:errored_objects_for_workstep)
+        get_errored_objects_for_workstep
+      end
     end
 
-    it 'counts how many steps are errored out' do
-      expect(Dor::WorkflowService.count_errored_for_workstep(@workflow, @step, @repository)).to eq(1)
+    describe 'errored_objects_for_workstep' do
+      it 'returns error messages for errored objects' do
+        expect(described_class.errored_objects_for_workstep(@workflow, @step, @repository)).to eq('druid:ab123cd4567' => 'This is an error message')
+      end
+    end
+
+    describe 'count_errored_for_workstep' do
+      it 'counts how many steps are errored out' do
+        expect(described_class.count_errored_for_workstep(@workflow, @step, @repository)).to eq(1)
+      end
     end
   end
 
@@ -484,7 +609,7 @@ describe Dor::WorkflowService do
     end
 
     it 'counts how many steps are errored out' do
-      expect(Dor::WorkflowService.count_queued_for_workstep(@workflow, @step, @repository)).to eq(1)
+      expect(described_class.count_queued_for_workstep(@workflow, @step, @repository)).to eq(1)
     end
   end
 
@@ -505,7 +630,8 @@ describe Dor::WorkflowService do
     end
 
     it 'counts how many workflows are archived' do
-      expect(Dor::WorkflowService.count_archived_for_workflow(@workflow, @repository)).to eq(20)
+      expect(Deprecation).to receive(:warn)
+      expect(described_class.count_archived_for_workflow(@workflow, @repository)).to eq(20)
     end
   end
 
@@ -530,7 +656,7 @@ describe Dor::WorkflowService do
     end
 
     it 'counts how many objects are at the type of step' do
-      expect(Dor::WorkflowService.count_objects_in_step(@workflow, @step, @type, @repository)).to eq(1)
+      expect(described_class.count_objects_in_step(@workflow, @step, @type, @repository)).to eq(1)
     end
   end
 
@@ -545,20 +671,31 @@ describe Dor::WorkflowService do
 
     it 'sends a delete request to the workflow service' do
       expect(mock_http_connection).to receive(:delete).with(url).and_call_original
-      Dor::WorkflowService.delete_workflow(@repo, @druid, 'accessionWF')
+      described_class.delete_workflow(@repo, @druid, 'accessionWF')
     end
   end
-  describe 'get_milestones' do
-    it 'should include the version in with the milestones' do
+
+  describe 'milestones' do
+    it 'includes the version in with the milestones' do
       xml = '<?xml version="1.0" encoding="UTF-8"?><lifecycle objectId="druid:gv054hp4128"><milestone date="2012-01-26T21:06:54-0800" version="2">published</milestone></lifecycle>'
       xml = Nokogiri::XML(xml)
-      allow(Dor::WorkflowService).to receive(:query_lifecycle).and_return(xml)
-      milestones = Dor::WorkflowService.get_milestones(@repo, @druid)
+      allow(described_class).to receive(:query_lifecycle).and_return(xml)
+      milestones = described_class.milestones(@repo, @druid)
       expect(milestones.first[:milestone]).to eq('published')
       expect(milestones.first[:version]).to eq('2')
     end
   end
 
+  describe 'get_milestones' do
+    subject(:get_milestones) { described_class.get_milestones('dor', 'abc:1233') }
+
+    it 'calls milestones' do
+      expect(Deprecation).to receive(:warn)
+      expect(described_class).to receive(:milestones)
+      get_milestones
+    end
+  end
+
   describe '.get_active_workflows' do
     it 'it returns an array of active workflows only' do
       xml = <<-XML
@@ -572,9 +709,9 @@ describe Dor::WorkflowService do
         </workflow>
       </workflows>
       XML
-      allow(Dor::WorkflowService).to receive(:get_workflow_xml) { xml }
+      allow(described_class).to receive(:get_workflow_xml) { xml }
       expect(Deprecation).to receive(:warn)
-      expect(Dor::WorkflowService.get_active_workflows('dor', 'druid:mw971zk1113')).to eq(['accessionWF'])
+      expect(described_class.get_active_workflows('dor', 'druid:mw971zk1113')).to eq(['accessionWF'])
     end
   end
 
@@ -587,11 +724,11 @@ describe Dor::WorkflowService do
       XML
     end
     before do
-      allow(Dor::WorkflowService).to receive(:get_workflow_xml) { xml }
+      allow(described_class).to receive(:get_workflow_xml) { xml }
     end
 
     it 'it returns a workflow' do
-      expect(Dor::WorkflowService.workflow(pid: 'druid:mw971zk1113', workflow_name: 'accessionWF')).to be_kind_of Dor::Workflow::Response::Workflow
+      expect(described_class.workflow(pid: 'druid:mw971zk1113', workflow_name: 'accessionWF')).to be_kind_of Dor::Workflow::Response::Workflow
     end
   end
 
@@ -610,16 +747,16 @@ describe Dor::WorkflowService do
 
     let(:url) { 'dor/objects/druid:123/versionClose' }
     it 'calls the versionClose endpoint with druid' do
-      Dor::WorkflowService.close_version(@repo, @druid)
+      described_class.close_version(@repo, @druid)
     end
 
     it 'optionally prevents creation of accessionWF' do
       expect(mock_http_connection).to receive(:post).with('dor/objects/druid:123/versionClose?create-accession=false').and_call_original
-      Dor::WorkflowService.close_version(@repo, @druid, false)
+      described_class.close_version(@repo, @druid, false)
     end
   end
 
-  describe '.get_stale_queued_workflows' do
+  describe '.stale_queued_workflows' do
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
         stub.get('workflow_queue/all_queued?repository=dor&hours-ago=24&limit=100') do |_env|
@@ -634,7 +771,7 @@ describe Dor::WorkflowService do
     end
 
     it 'returns an Array of Hashes containing each workflow step' do
-      ah = Dor::WorkflowService.get_stale_queued_workflows 'dor', hours_ago: 24, limit: 100
+      ah = described_class.stale_queued_workflows 'dor', hours_ago: 24, limit: 100
       expected = [
         { workflow: 'accessionWF', step: 'content-metadata', druid: 'dr:123', lane_id: 'lane1' },
         { workflow: 'assemblyWF',  step: 'jp2-create',       druid: 'dr:456', lane_id: 'lane2' }
@@ -643,6 +780,16 @@ describe Dor::WorkflowService do
     end
   end
 
+  describe '.get_stale_queued_workflows' do
+    subject(:get_stale_queued_workflows) { described_class.get_stale_queued_workflows('dor', hours_ago: 24, limit: 100) }
+
+    it 'calls stale_queued_workflows' do
+      expect(Deprecation).to receive(:warn)
+      expect(described_class).to receive(:stale_queued_workflows)
+      get_stale_queued_workflows
+    end
+  end
+
   describe '.count_stale_queued_workflows' do
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
@@ -653,11 +800,11 @@ describe Dor::WorkflowService do
     end
 
     it 'returns the number of queued workflow steps' do
-      expect(Dor::WorkflowService.count_stale_queued_workflows('dor', hours_ago: 48)).to eq(10)
+      expect(described_class.count_stale_queued_workflows('dor', hours_ago: 48)).to eq(10)
     end
   end
 
-  describe '.get_lane_ids' do
+  describe '.lane_ids' do
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
         stub.get('workflow_queue/lane_ids?lane_ids?step=dor:accessionWF:shelve') do |_env|
@@ -672,7 +819,17 @@ describe Dor::WorkflowService do
     end
 
     it 'returns the lane ids for a given workflow step' do
-      expect(Dor::WorkflowService.get_lane_ids('dor', 'accessionWF', 'shelve')).to eq(%w[lane1 lane2])
+      expect(described_class.lane_ids('dor', 'accessionWF', 'shelve')).to eq(%w[lane1 lane2])
+    end
+  end
+
+  describe '.get_lane_ids' do
+    subject(:get_lane_ids) { described_class.get_lane_ids('dor', 'accessionWF', 'shelve') }
+
+    it 'calls lane_ids' do
+      expect(Deprecation).to receive(:warn)
+      expect(described_class).to receive(:lane_ids)
+      get_lane_ids
     end
   end
 
@@ -686,7 +843,7 @@ describe Dor::WorkflowService do
     end
 
     it 'uses the flat params encoder' do
-      response = Dor::WorkflowService.send(:send_workflow_resource_request, 'x?complete=a&complete=b')
+      response = described_class.send(:send_workflow_resource_request, 'x?complete=a&complete=b')
 
       expect(response.body).to eq 'ab'
       expect(response.env.url.query).to eq 'complete=a&complete=b'
@@ -695,11 +852,11 @@ describe Dor::WorkflowService do
 
   describe '.workflow_resource' do
     before do
-      Dor::WorkflowService.configure 'http://example.com'
+      described_class.configure 'http://example.com'
     end
 
     it 'defaults to using the flat params encoder' do
-      expect(Dor::WorkflowService.workflow_resource.options.params_encoder).to eq Faraday::FlatParamsEncoder
+      expect(described_class.workflow_resource.options.params_encoder).to eq Faraday::FlatParamsEncoder
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-service
 version: !ruby/object:Gem::Version
-  version: 2.10.2
+  version: 2.11.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-01 00:00:00.000000000 Z
+date: 2019-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport