dor-workflow-client 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a466510ea74b36c454ae742892e3f100db970d93f3e584edcb984ba9bff87b30
-  data.tar.gz: ed836d1b6e9180f9195b407501f0040584c901100b40416e0405a983665b8fbf
+  metadata.gz: f379f2897210e36a67cf06fd7eed5ce8caa8b810b329a9c66dae0a03e03475d4
+  data.tar.gz: 309659963dca39f119c924d43be8599a3020d5154fb4dac3b4fc9923132542bf
 SHA512:
-  metadata.gz: 33f86334702e1e4bdd32ab861bb871bd015781527f1896508897c09b9fe1432482fc1cee2a361e89c79be84b892e9c9ee708ed1c7b848f064b27780d3d3ca61c
-  data.tar.gz: c597974072d997829af32e0ec449b7c9c69dab90229d0e662acac637fdee85bf26d5b95f780f9bcfbd99f97ce20035f5bcd4958b92626e4a236378c12cb4ff23
+  metadata.gz: 3d0240474ec807050bf566fe9f4fe329cd7c5a471da6486966fcf9baa733169ef6a2dd87d5442634180847a245f8e07355f323886450474b401810eb0270a797
+  data.tar.gz: f057983eab36e17474eccaebfca7bb96666eb7f0ad103fdd2d1139291ef659023f4cdad56dc32ec1d11de2903d6716deb90d2c9cb3815353c8fe131e3497e3ab

data/dor-workflow-client.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'activesupport', '>= 3.2.1', '< 6'
   gem.add_dependency 'confstruct', '>= 0.2.7', '< 2'
+  gem.add_dependency 'deprecation', '~> 0'
   gem.add_dependency 'faraday', '~> 0.9', '>= 0.9.2'
   gem.add_dependency 'faraday_middleware'
   gem.add_dependency 'net-http-persistent', '>= 2.9.4', '< 4.a'

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

@@ -5,7 +5,7 @@ require 'dor/models/response/process'
 module Dor
   module Workflow
     module Response
-      # The response form asking the server about a workflow for an item
+      # The response from asking the server about a workflow for an item
       class Workflow
         def initialize(xml:)
           @xml = xml

data/lib/dor/models/response/workflows.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'dor/models/response/workflow'
+
+module Dor
+  module Workflow
+    module Response
+      # The response from asking the server about all workflows for an item
+      class Workflows
+        def initialize(xml:)
+          @xml = xml
+        end
+
+        def pid
+          ng_xml.at_xpath('/workflows/@objectId').text
+        end
+
+        def workflows
+          @workflows ||= ng_xml.xpath('/workflows/workflow').map do |node|
+            Workflow.new(xml: node.to_xml)
+          end
+        end
+
+        attr_reader :xml
+
+        private
+
+        def ng_xml
+          @ng_xml ||= Nokogiri::XML(@xml)
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     class Client
-      VERSION = '3.0.0'
+      VERSION = '3.1.0'
     end
   end
 end

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

@@ -1,34 +1,51 @@
 # frozen_string_literal: true
 
+require 'deprecation'
+
 module Dor
   module Workflow
     class Client
       # Makes requests relating to a workflow
       class WorkflowRoutes
+        extend Deprecation
+
         def initialize(requestor:)
           @requestor = requestor
         end
 
-        # Creates a workflow for a given object in the repository.  If this particular workflow for this objects exists,
-        # it will replace the old workflow with wf_xml passed to this method.  You have the option of creating a datastream or not.
-        # Returns true on success.  Caller must handle any exceptions
+        # This method is deprecated and calls create_workflow_by_name.
         #
-        # @param [String] repo The repository the object resides in.  The service recoginzes "dor" and "sdr" at the moment
+        # @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 The xml that represents the workflow
+        # @param [String] wf_xml Ignored
         # @param [Hash] opts optional params
         # @option opts [Boolean] :create_ds if true, a workflow datastream will be created in Fedora.  Set to false if you do not want a datastream to be created
         #   If you do not pass in an <b>opts</b> Hash, then :create_ds is set to true by default
         # @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_ds: true })
-          lane_id = opts.fetch(:lane_id, 'default')
-          xml = add_lane_id_to_workflow_xml(lane_id, wf_xml)
-          _status = requestor.request "#{repo}/objects/#{druid}/workflows/#{workflow_name}", 'put', xml,
-                                      content_type: 'application/xml',
-                                      params: { 'create-ds' => opts[:create_ds] }
+        def create_workflow(_repo, druid, workflow_name, _wf_xml, opts = { create_ds: true })
+          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.
+        # 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_name The name of the workflow you want to create. This must correspond with a workflow
+        # name that is known by the workflow service.
+        # @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_by_name(druid, workflow_name, opts = { create_ds: true })
+          requestor.request "objects/#{druid}/workflows/#{workflow_name}", 'post', '',
+                            content_type: 'application/xml',
+                            params: { 'lane-id' => opts.fetch(:lane_id, 'default') }
           true
         end
 
@@ -128,6 +145,14 @@ module Dor
           requestor.request "objects/#{druid}/workflows"
         end
 
+        # Retrieves all workflows for the given object
+        # @param [String] pid The id of the object
+        # @return [Workflow::Response::Workflows]
+        def all_workflows(pid:)
+          xml = all_workflows_xml(pid)
+          Workflow::Response::Workflows.new(xml: xml)
+        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
         #
@@ -165,17 +190,6 @@ module Dor
 
         attr_reader :requestor
 
-        # Adds laneId attributes to each process of workflow xml
-        #
-        # @param [String] lane_id to add to each process element
-        # @param [String] wf_xml the workflow xml
-        # @return [String] wf_xml with lane_id attributes
-        def add_lane_id_to_workflow_xml(lane_id, wf_xml)
-          doc = Nokogiri::XML(wf_xml)
-          doc.xpath('/workflow/process').each { |proc| proc['laneId'] = lane_id }
-          doc.to_xml
-        end
-
         # @param [Hash] params
         # @return [String]
         def create_process_xml(params)

data/lib/dor/workflow/client.rb

@@ -4,6 +4,7 @@ require 'active_support'
 require 'active_support/core_ext'
 require 'nokogiri'
 require 'dor/workflow_exception'
+require 'dor/models/response/workflows'
 require 'dor/models/response/workflow'
 require 'dor/models/response/update'
 
@@ -36,8 +37,8 @@ module Dor
         @requestor = Requestor.new(connection: connection || ConnectionFactory.build_connection(url, timeout: timeout, logger: logger))
       end
 
-      delegate :create_workflow, :update_workflow_status, :workflow_status, :workflow_xml,
-               :update_workflow_error_status, :all_workflows_xml, :workflows,
+      delegate :create_workflow, :create_workflow_by_name, :update_workflow_status, :workflow_status,
+               :workflow_xml, :update_workflow_error_status, :all_workflows_xml, :workflows,
                :workflow, :delete_workflow, to: :workflow_routes
 
       delegate :lifecycle, :active_lifecycle, :milestones, to: :lifecycle_routes

data/spec/models/response/workflows_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Dor::Workflow::Response::Workflows do
+  subject(:instance) { described_class.new(xml: xml) }
+
+  describe '#pid' do
+    subject { instance.pid }
+
+    let(:xml) do
+      <<~XML
+        <workflows objectId="druid:mw971zk1113">
+        </workflows>
+      XML
+    end
+    it { is_expected.to eq 'druid:mw971zk1113' }
+  end
+
+  describe '#workflows' do
+    subject { instance.workflows }
+
+    let(:xml) do
+      <<~XML
+        <workflows objectId="druid:mw971zk1113">
+          <workflow repository="dor" objectId="druid:mw971zk1113" id="assemblyWF">
+          </workflow>
+          <workflow repository="dor" objectId="druid:mw971zk1113" id="sdrPreservationWF">
+          </workflow>
+        </workflows>
+      XML
+    end
+
+    it 'has children' do
+      expect(subject).to all(be_kind_of Dor::Workflow::Response::Workflow)
+      expect(subject.map(&:workflow_name)).to eq %w[assemblyWF sdrPreservationWF]
+    end
+  end
+end

data/spec/workflow/client/connection_factory_spec.rb

@@ -6,20 +6,19 @@ require 'spec_helper'
 RSpec.describe Dor::Workflow::Client::ConnectionFactory do
   let(:mock_logger) { double('Logger', info: true, debug: true, warn: true) }
 
-  let(:repo) { 'dor' }
   let(:druid) { 'druid:123' }
   before do
-    stub_request(:put, "http://example.com/#{repo}/objects/#{druid}/workflows/httpException?create-ds=true")
+    stub_request(:post, "http://example.com/objects/#{druid}/workflows/httpException?lane-id=default")
       .to_return(status: 500, body: 'Internal error', headers: {})
   end
 
   let(:client) { Dor::Workflow::Client.new url: 'http://example.com', logger: mock_logger }
 
-  describe '#create_workflow' do
+  describe '#create_workflow_by_name' do
     it 'logs an error and retry upon a targeted Faraday exception' do
-      expect(mock_logger).to receive(:warn).with('retrying connection (1 remaining) to http://example.com/dor/objects/druid:123/workflows/httpException?create-ds=true: (Faraday::RetriableResponse)  500')
-      expect(mock_logger).to receive(:warn).with('retrying connection (0 remaining) to http://example.com/dor/objects/druid:123/workflows/httpException?create-ds=true: (Faraday::RetriableResponse)  500')
-      expect { client.create_workflow(repo, druid, 'httpException', '<xml>') }.to raise_error Dor::WorkflowException
+      expect(mock_logger).to receive(:warn).with('retrying connection (1 remaining) to http://example.com/objects/druid:123/workflows/httpException?lane-id=default: (Faraday::RetriableResponse)  500')
+      expect(mock_logger).to receive(:warn).with('retrying connection (0 remaining) to http://example.com/objects/druid:123/workflows/httpException?lane-id=default: (Faraday::RetriableResponse)  500')
+      expect { client.create_workflow_by_name(druid, 'httpException') }.to raise_error Dor::WorkflowException
     end
   end
 end

data/spec/workflow/client/workflow_routes_spec.rb

@@ -7,33 +7,6 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
 
   let(:routes) { described_class.new(requestor: mock_requestor) }
 
-  let(:wf_xml) do
-    <<-EOXML
-    <workflow id="etdSubmitWF">
-         <process name="register-object" status="completed" attempts="1" />
-         <process name="submit" status="waiting" />
-         <process name="reader-approval" status="waiting" />
-         <process name="registrar-approval" status="waiting" />
-         <process name="start-accession" status="waiting" />
-    </workflow>
-    EOXML
-  end
-
-  describe '#add_lane_id_to_workflow_xml' do
-    it 'adds laneId attributes to all process elements' do
-      expected = <<-XML
-        <workflow id="etdSubmitWF">
-          <process name="register-object" status="completed" attempts="1" laneId="lane1"/>
-          <process name="submit" status="waiting" laneId="lane1"/>
-          <process name="reader-approval" status="waiting" laneId="lane1"/>
-          <process name="registrar-approval" status="waiting" laneId="lane1"/>
-          <process name="start-accession" status="waiting" laneId="lane1"/>
-        </workflow>
-      XML
-      expect(routes.send(:add_lane_id_to_workflow_xml, 'lane1', wf_xml)).to be_equivalent_to(expected)
-    end
-  end
-
   describe '#workflow' do
     let(:xml) do
       <<~XML
@@ -42,6 +15,7 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
         </workflow>
       XML
     end
+
     before do
       allow(routes).to receive(:workflow_xml) { xml }
     end
@@ -50,4 +24,27 @@ RSpec.describe Dor::Workflow::Client::WorkflowRoutes do
       expect(routes.workflow(pid: 'druid:mw971zk1113', workflow_name: 'accessionWF')).to be_kind_of Dor::Workflow::Response::Workflow
     end
   end
+
+  describe '#all_workflows' do
+    let(:xml) do
+      <<~XML
+        <workflows objectId="druid:mw971zk1113">
+          <workflow repository="dor" objectId="druid:mw971zk1113" id="accessionWF">
+            <process laneId="default" lifecycle="submitted" elapsed="0.0" attempts="1" datetime="2013-02-18T15:08:10-0800" status="completed" name="start-accession"/>
+          </workflow>
+        </workflows>
+      XML
+    end
+
+    before do
+      allow(routes).to receive(:all_workflows_xml) { xml }
+    end
+
+    it 'it returns the workflows' do
+      expect(routes.all_workflows(pid: 'druid:mw971zk1113')).to be_kind_of Dor::Workflow::Response::Workflows
+    end
+  end
+
+  describe '#create_workflow_by_name' do
+  end
 end

data/spec/workflow/client_spec.rb

@@ -72,26 +72,51 @@ RSpec.describe Dor::Workflow::Client do
   describe '#create_workflow' do
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.put("#{@repo}/objects/#{@druid}/workflows/etdSubmitWF") { |_env| [201, {}, ''] }
-        stub.put("#{@repo}/objects/#{@druid}/workflows/noCreateDsWF?create-ds=false") { |_env| [201, {}, ''] }
-        stub.put("#{@repo}/objects/#{@druid}/workflows/raiseException") { |_env| raise 'broken' }
+        stub.post("objects/#{@druid}/workflows/etdSubmitWF") { |_env| [201, {}, ''] }
+        stub.post("objects/#{@druid}/workflows/raiseException") { |_env| raise 'broken' }
+        stub.post("objects/#{@druid}/workflows/laneIdWF?lane-id=foo_lane") { |_env| [201, {}, ''] }
       end
     end
 
-    it 'should pass workflow xml to the DOR workflow service and return the URL to the workflow' do
+    before do
+      allow(Deprecation).to receive(:warn)
+    end
+
+    it 'should request the workflow by name and return the URL to the workflow' do
       client.create_workflow(@repo, @druid, 'etdSubmitWF', wf_xml)
+      expect(Deprecation).to have_received(:warn)
     end
 
     it 'should raise on an unexpected Exception' do
       expect { client.create_workflow(@repo, @druid, 'raiseException', wf_xml) }.to raise_error(Exception, 'broken')
+      expect(Deprecation).to have_received(:warn)
     end
 
-    it 'sets the create-ds param to the value of the passed in options hash' do
-      client.create_workflow(@repo, @druid, 'noCreateDsWF', wf_xml, create_ds: false)
+    it 'sets the lane_id param if provided in options hash' do
+      client.create_workflow(@repo, @druid, 'laneIdWF', wf_xml, lane_id: 'foo_lane')
+      expect(Deprecation).to have_received(:warn)
+    end
+  end
+
+  describe '#create_workflow_by_name' do
+    let(:stubs) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.post("objects/#{@druid}/workflows/etdSubmitWF") { |_env| [201, {}, ''] }
+        stub.post("objects/#{@druid}/workflows/raiseException") { |_env| raise 'broken' }
+        stub.post("objects/#{@druid}/workflows/laneIdWF?lane-id=foo_lane") { |_env| [201, {}, ''] }
+      end
+    end
+
+    it 'should request the workflow by name and return the URL to the workflow' do
+      client.create_workflow_by_name(@druid, 'etdSubmitWF')
+    end
+
+    it 'should raise on an unexpected Exception' do
+      expect { client.create_workflow_by_name(@druid, 'raiseException') }.to raise_error(Exception, 'broken')
     end
 
-    it 'adds lane_id attributes to all steps if passed in as an option' do
-      skip 'test not implemented'
+    it 'sets the lane_id param if provided in options hash' do
+      client.create_workflow_by_name(@druid, 'laneIdWF', lane_id: 'foo_lane')
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-client
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-23 00:00:00.000000000 Z
+date: 2019-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -51,6 +51,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: deprecation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -258,6 +272,7 @@ files:
 - lib/dor/models/response/process.rb
 - lib/dor/models/response/update.rb
 - lib/dor/models/response/workflow.rb
+- lib/dor/models/response/workflows.rb
 - lib/dor/workflow/client.rb
 - lib/dor/workflow/client/connection_factory.rb
 - lib/dor/workflow/client/lifecycle_routes.rb
@@ -268,6 +283,7 @@ files:
 - lib/dor/workflow/client/workflow_routes.rb
 - lib/dor/workflow_exception.rb
 - spec/models/response/workflow_spec.rb
+- spec/models/response/workflows_spec.rb
 - spec/spec_helper.rb
 - spec/workflow/client/connection_factory_spec.rb
 - spec/workflow/client/lifecycle_routes_spec.rb
@@ -299,6 +315,7 @@ specification_version: 4
 summary: Provides convenience methods to work with the DOR Workflow Service
 test_files:
 - spec/models/response/workflow_spec.rb
+- spec/models/response/workflows_spec.rb
 - spec/spec_helper.rb
 - spec/workflow/client/connection_factory_spec.rb
 - spec/workflow/client/lifecycle_routes_spec.rb