dor-workflow-client 3.13.0 → 3.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea39b8e90466517fda9d9c0c8a7d1e6bfe2fe09d38566e51db76031e2768eae0
-  data.tar.gz: d75001c1f99852c3cd0410ea5cb018abf713162c04fcc81cc43c58817bcae34a
+  metadata.gz: 5a00ebf82eddf3b2cce94a9e1eb3d4eeb77e78fb7280131b5f8cd475e611ff1c
+  data.tar.gz: fb8e8d16cebc1436e6747c5e601227c786ed007e54507f154dd3c248694f4fa0
 SHA512:
-  metadata.gz: 6e414f5936d21fed90a4690ada9cf3df8c6130734c043a9b0e4c178c8fbe17f5320547dc83c0982e17ee11fb660054b644f8d57cf873128ca91fd05aabe31dc7
-  data.tar.gz: cc096fad25055d2f31fb3344d9af42fddeeb36aa90a12795a620c6b6a14dbd1946fd3996902a6092ecb352bc49bd10f6ef51eab2fd585faf4e039796c6e8fdae
+  metadata.gz: 118a58574b972bd2c235103fcf71edc582a3e841c4641506a658881819a7a005ea356b3fef233d7733363cc83f35a3697a0c3ac783ef5d6d0d5e546a9336b29f
+  data.tar.gz: a4721adc49f0130683b82cad84cc487a5e33f206a814151381a6c75448661472b6bda149473d382908c7c8093e636ffb44382b44bfa1e66d5d1b7fd0248133bb

data/.rubocop_todo.yml

@@ -1,14 +1,18 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-09-13 10:43:44 -0500 using RuboCop version 0.63.1.
+# on 2020-01-06 12:37:25 -0600 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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
+# Offense count: 4
 Metrics/AbcSize:
-  Max: 23
+  Max: 26
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 9
 
 # Offense count: 1
 # Configuration parameters: CountComments, ExcludedMethods.

data/.travis.yml

@@ -5,7 +5,6 @@ rvm:
   - 2.5.3
 
 env:
-  - "RAILS_VERSION=4.2.11.1"
   - "RAILS_VERSION=5.2.3"
   - "RAILS_VERSION=6.0.0"
 

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

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     class Client
-      VERSION = '3.13.0'
+      VERSION = '3.14.0'
     end
   end
 end

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

@@ -17,12 +17,34 @@ module Dor
         # @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 [Boolean] create_accession_wf Option to create accessionWF when closing a version.  Defaults to true
-        def close_version(repo, druid, create_accession_wf = 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
+
           uri = "#{repo}/objects/#{druid}/versionClose"
-          uri += '?create-accession=false' unless create_accession_wf
+          uri += '?' if !create_accession_wf || version
+          uri += "version=#{version}" if version
+          uri += 'create-accession=false' unless create_accession_wf
           requestor.request(uri, 'post', '')
           true
         end
+        # rubocop:enable Metrics/MethodLength
 
         private
 

data/spec/workflow/client_spec.rb

@@ -756,13 +756,38 @@ RSpec.describe Dor::Workflow::Client do
     end
 
     let(:url) { 'dor/objects/druid:123/versionClose' }
-    it 'calls the versionClose endpoint with druid' do
-      client.close_version(@repo, @druid)
+
+    context 'with positional arguments' do
+      before do
+        allow(Deprecation).to receive(:warn)
+      end
+
+      it 'calls the versionClose endpoint with druid' do
+        client.close_version(@repo, @druid)
+        expect(Deprecation).to have_received(:warn)
+      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
+        client.close_version(@repo, @druid, false)
+        expect(Deprecation).to have_received(:warn)
+      end
     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
-      client.close_version(@repo, @druid, false)
+    context 'with kwargs' do
+      it 'calls the versionClose endpoint with druid' do
+        client.close_version(repo: @repo, druid: @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
+        client.close_version(repo: @repo, druid: @druid, create_accession_wf: false)
+      end
+
+      it 'optionally passes version' do
+        expect(mock_http_connection).to receive(:post).with('dor/objects/druid:123/versionClose?version=3').and_call_original
+        client.close_version(repo: @repo, druid: @druid, version: 3)
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-client
 version: !ruby/object:Gem::Version
-  version: 3.13.0
+  version: 3.14.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2020-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -252,8 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Provides convenience methods to work with the DOR Workflow Service