dor-workflow-client 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f379f2897210e36a67cf06fd7eed5ce8caa8b810b329a9c66dae0a03e03475d4
-  data.tar.gz: 309659963dca39f119c924d43be8599a3020d5154fb4dac3b4fc9923132542bf
+  metadata.gz: efd50cf41d262788cb42851599ce7e4556be25329de08a657cca03aa2e76ba23
+  data.tar.gz: 6a95df393c1110cfb0eb23d10673b7a057cb27c15f326a099d2ee970f7fc21ad
 SHA512:
-  metadata.gz: 3d0240474ec807050bf566fe9f4fe329cd7c5a471da6486966fcf9baa733169ef6a2dd87d5442634180847a245f8e07355f323886450474b401810eb0270a797
-  data.tar.gz: f057983eab36e17474eccaebfca7bb96666eb7f0ad103fdd2d1139291ef659023f4cdad56dc32ec1d11de2903d6716deb90d2c9cb3815353c8fe131e3497e3ab
+  metadata.gz: 0b438491d28534e0f80789ac107a5b882aa9d21310497105f50ebb42e22324a6c29a905f3da2cda8595febec2d65df6f2e6c3c0535727b4f534df64e8fbfb789
+  data.tar.gz: b16d230f7f4f86d0edae823233d99be2afd0a6bef875ffb4c2b6a29cd4cbde1f8e06319bd90434c1aa79591c87a429ee7c6bf8c47617f9ea20e2bbbeb2c3f0d1

data/README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/sul-dlss/dor-workflow-client.svg?branch=master)](https://travis-ci.org/sul-dlss/dor-workflow-client)
+[![Gem Version](https://badge.fury.io/rb/dor-workflow-client.svg)](https://badge.fury.io/rb/dor-workflow-client)
 
 # dor-workflow-client gem
 

data/dor-workflow-client.gemspec

@@ -18,16 +18,12 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   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'
   gem.add_dependency 'nokogiri', '~> 1.6'
 
-  gem.add_development_dependency 'equivalent-xml', '~> 0.5', '>= 0.5.1'
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'redcarpet'
   gem.add_development_dependency 'rspec', '~> 3.3'
   gem.add_development_dependency 'rubocop', '~> 0.63.1'
   gem.add_development_dependency 'simplecov'

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

@@ -12,39 +12,21 @@ module Dor
         # Returns the Date for a requested milestone from workflow lifecycle
         # @param [String] repo repository name
         # @param [String] druid object id
-        # @param [String] milestone name of the milestone being queried for
+        # @param [String] milestone_name the name of the milestone being queried for
         # @return [Time] when the milestone was achieved.  Returns nil if the milestone does not exist
-        # @example An example lifecycle xml from the workflow service.
-        #   <lifecycle objectId="druid:ct011cv6501">
-        #     <milestone date="2010-04-27T11:34:17-0700">registered</milestone>
-        #     <milestone date="2010-04-29T10:12:51-0700">inprocess</milestone>
-        #     <milestone date="2010-06-15T16:08:58-0700">released</milestone>
-        #   </lifecycle>
-        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
-
-          nil
+        #
+        def lifecycle(repo, druid, milestone_name)
+          filter_milestone(query_lifecycle(repo, druid), milestone_name)
         end
 
         # Returns the Date for a requested milestone ONLY FROM THE ACTIVE workflow table
         # @param [String] repo repository name
         # @param [String] druid object id
-        # @param [String] milestone name of the milestone being queried for
-        # @return [Time] when the milestone was achieved.  Returns nil if the milestone does not exist
-        # @example An example lifecycle xml from the workflow service.
-        #   <lifecycle objectId="druid:ct011cv6501">
-        #     <milestone date="2010-04-27T11:34:17-0700">registered</milestone>
-        #     <milestone date="2010-04-29T10:12:51-0700">inprocess</milestone>
-        #     <milestone date="2010-06-15T16:08:58-0700">released</milestone>
-        #   </lifecycle>
-        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
-
-          nil
+        # @param [String] milestone_name the name of the milestone being queried for
+        # @return [Time] when the milestone was achieved.  Returns nil if the milestone does not exis
+        #
+        def active_lifecycle(repo, druid, milestone_name)
+          filter_milestone(query_lifecycle(repo, druid, true), milestone_name)
         end
 
         # @return [Hash]
@@ -57,7 +39,21 @@ module Dor
 
         private
 
+        def filter_milestone(lifecycle_doc, milestone_name)
+          milestone = lifecycle_doc.at_xpath("//lifecycle/milestone[text() = '#{milestone_name}']")
+          return unless milestone
+
+          Time.parse(milestone['date'])
+        end
+
         # @return [Nokogiri::XML::Document]
+        # @example An example lifecycle xml from the workflow service.
+        #   <lifecycle objectId="druid:ct011cv6501">
+        #     <milestone date="2010-04-27T11:34:17-0700">registered</milestone>
+        #     <milestone date="2010-04-29T10:12:51-0700">inprocess</milestone>
+        #     <milestone date="2010-06-15T16:08:58-0700">released</milestone>
+        #   </lifecycle>
+        #
         def query_lifecycle(repo, druid, active_only = false)
           req = "#{repo}/objects/#{druid}/lifecycle"
           req += '?active-only=true' if active_only

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

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

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

@@ -20,12 +20,10 @@ module Dor
         # @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 [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 })
+        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'
@@ -40,12 +38,15 @@ module Dor
         # 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'
+        # @option opts [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, opts = { create_ds: true })
+        def create_workflow_by_name(druid, workflow_name, opts = {})
+          params = { 'lane-id' => opts.fetch(:lane_id, 'default') }
+          params['version'] = opts[:version] if opts[:version]
           requestor.request "objects/#{druid}/workflows/#{workflow_name}", 'post', '',
                             content_type: 'application/xml',
-                            params: { 'lane-id' => opts.fetch(:lane_id, 'default') }
+                            params: params
           true
         end
 

data/spec/spec_helper.rb

@@ -10,8 +10,6 @@ end
 
 require 'byebug'
 require 'dor/workflow/client'
-require 'equivalent-xml'
-require 'equivalent-xml/rspec_matchers'
 require 'webmock/rspec'
 
 # RSpec.configure do |conf|

data/spec/workflow/client_spec.rb

@@ -75,6 +75,7 @@ RSpec.describe Dor::Workflow::Client do
         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, {}, ''] }
+        stub.post("objects/#{@druid}/workflows/versionWF?version=2") { |_env| [201, {}, ''] }
       end
     end
 
@@ -104,6 +105,7 @@ RSpec.describe Dor::Workflow::Client do
         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, {}, ''] }
+        stub.post("objects/#{@druid}/workflows/versionWF?version=2") { |_env| [201, {}, ''] }
       end
     end
 
@@ -118,6 +120,10 @@ RSpec.describe Dor::Workflow::Client do
     it 'sets the lane_id param if provided in options hash' do
       client.create_workflow_by_name(@druid, 'laneIdWF', lane_id: 'foo_lane')
     end
+
+    it 'sets the version param if provided in options hash' do
+      client.create_workflow_by_name(@druid, 'versionWF', version: 2)
+    end
   end
 
   describe '#update_workflow_status' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-client
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-09 00:00:00.000000000 Z
+date: 2019-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,26 +31,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
-- !ruby/object:Gem::Dependency
-  name: confstruct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.7
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.7
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -99,26 +79,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: net-http-persistent
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.9.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 4.a
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.9.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 4.a
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -133,26 +93,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: equivalent-xml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -167,20 +107,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement