dor-services-client 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2af95c20ad77c9b950660a02df65827f08e9ebf7cb2d0217367fbf665338405
-  data.tar.gz: f0bbb4b7e7f0152febb7d2e9d51928bacb744c8ed24959da15302538f5db470e
+  metadata.gz: 9eed92163307c689ed61735f07b910d9dd37821a8f77b744ffc5c1ff37956284
+  data.tar.gz: 7f7be3de30b2c121f0fd8fbdf7103d8aadff50d89a2c3cf30f0e741c98d2d6c9
 SHA512:
-  metadata.gz: dcd5376ca4a422498692db568d0bd7c7a7e909cd06453e13c7979f7cf4fa0d106eedbf51abc0972a02448e5a30d747bfe378bc3a47c0eb1f342a6fd7408e9c3f
-  data.tar.gz: 81395050e0396da033e723195d2a37408710ea8a1f18525241895029d8774a3f59b5a33763f65de74fd360d48b1de83f632f37f248952d74773429d926968470
+  metadata.gz: 47b70505a9c21255bdfcfb4ac6c523e33ef39cbec3838f794242b1704c607f209e3b572586bb790cf07f4a6f22dc729f8adfb4265fdaac0c9ccd872a7d76ef74
+  data.tar.gz: c3fcb06b5fba157bee9a5e7692b377f64d289fb3a5d4f476342783aec5e84f66bd583a5c2d78d9d8ecf7fe6a2b5d387abc8204d83329fcb3882d874ce28aab2c

data/.rubocop.yml

@@ -1,3 +1,3 @@
 inherit_from: .rubocop_todo.yml
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.3

data/.rubocop_todo.yml

@@ -10,7 +10,7 @@
 # Configuration parameters: CountComments, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 104
+  Max: 151
 
 # Offense count: 1
 Style/Documentation:

data/lib/dor/services/client/object.rb

@@ -50,6 +50,33 @@ module Dor
           resp.body
         end
 
+        # Open new version for an object
+        # @param params [Hash] optional params (see dor-services-app)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @raise [MalformedResponse] when the response is not parseable.
+        # @return [String] the current version
+        def open_new_version(**params)
+          version = open_new_version_response(**params)
+          raise MalformedResponse, "Version of #{object} is empty" if version.empty?
+
+          version
+        end
+
+        # Close current version for an object
+        # @param params [Hash] optional params (see dor-services-app)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [String] a message confirming successful closing
+        def close_version(**params)
+          resp = connection.post do |req|
+            req.url close_version_path
+            req.headers['Content-Type'] = 'application/json'
+            req.body = params.to_json if params.any?
+          end
+          return resp.body if resp.success?
+
+          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body}) for #{object}"
+        end
+
         private
 
         attr_reader :object
@@ -57,6 +84,29 @@ module Dor
         def object_path
           "#{api_version}/objects/#{object}"
         end
+
+        # Make request to server to open a new version
+        # @param params [Hash] optional params (see dor-services-app)
+        # @raises [UnexpectedResponse] on an unsuccessful response from the server
+        # @returns [String] the plain text from the server
+        def open_new_version_response(**params)
+          resp = connection.post do |req|
+            req.url open_new_version_path
+            req.headers['Content-Type'] = 'application/json'
+            req.body = params.to_json if params.any?
+          end
+          return resp.body if resp.success?
+
+          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body}) for #{object}"
+        end
+
+        def open_new_version_path
+          "#{object_path}/versions"
+        end
+
+        def close_version_path
+          "#{object_path}/versions/current/close"
+        end
       end
     end
   end

data/lib/dor/services/client/objects.rb

@@ -23,7 +23,7 @@ module Dor
         def publish(object:)
           Object.new(connection: connection, version: api_version, object: object).publish
         end
-        deprecation_deprecate publish: 'Use Dor::Client.object(obj).publish instead'
+        deprecation_deprecate publish: 'Use Dor::Services::Client.object(obj).publish instead'
 
         # Notify the external Goobi system for a new object that was registered in DOR
         # @param object [String] the pid for the object
@@ -32,7 +32,7 @@ module Dor
         def notify_goobi(object:)
           Object.new(connection: connection, version: api_version, object: object).notify_goobi
         end
-        deprecation_deprecate notify_goobi: 'Use Dor::Client.object(obj).notify_goobi instead'
+        deprecation_deprecate notify_goobi: 'Use Dor::Services::Client.object(obj).notify_goobi instead'
 
         # Gets the current version number for the object
         # @param object [String] the pid for the object
@@ -42,11 +42,12 @@ module Dor
         def current_version(object:)
           SDR.new(connection: connection, version: api_version).current_version(object: object)
         end
-        deprecation_deprecate current_version: 'Use Dor::Client.sdr.current_version instead'
+        deprecation_deprecate current_version: 'Use Dor::Services::Client.sdr.current_version(object: obj) instead'
 
         private
 
         # make the registration request to the server
+        # @param params [Hash] optional params (see dor-services-app)
         # @raises [UnexpectedResponse] on an unsuccessful response from the server
         # @returns [String] the raw JSON from the server
         def register_response(params:)

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '0.9.0'
+      VERSION = '0.10.0'
     end
   end
 end

data/lib/dor/services/client.rb

@@ -127,6 +127,25 @@ module Dor
           release_tags.create(object: object, release: release, what: what, to: to, who: who)
         end
 
+        # Open new version for an object
+        # @param object [String] object identifier
+        # @param params [Hash] optional params (see dor-services-app)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @raise [MalformedResponse] when the response is not parseable.
+        # @return [String] the current version
+        def open_new_version(object:, **params)
+          object(object).open_new_version(**params)
+        end
+
+        # Close current version for an object
+        # @param object [String] object identifier
+        # @param params [Hash] optional params (see dor-services-app)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [String] a message confirming successful closing
+        def close_version(object:, **params)
+          object(object).close_version(**params)
+        end
+
         # Publish a new object
         # @param object [String] the pid for the object
         # @raise [UnexpectedResponse] when the response is not successful.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -191,8 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: A client for dor-services-app