dor-services-client 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9f6133621d9f6fa4fe27dff918c99d375ac77229e5eda67b61e3d80e6ba7002
-  data.tar.gz: 1f4ed1a368590418755e6e208342cce5d7616f4509588fa23e50088220689436
+  metadata.gz: '05129b08c176476bd2e3ced8d6f3dfff99ddc118988170c11c6df428897fd5bd'
+  data.tar.gz: 4da1003e323c07a7ba9e530a2ebe46c58c5e4f200aa879dd78942fb91a9f1d0a
 SHA512:
-  metadata.gz: efd9ef1aa9e06a623dea5a3d922da027adc52389240bb6209ecd2ef8cdad38b967f9e86ceb7bd0d204de80eafc5be65bc4eba36c0a3afc6ccfff4431d5891b5d
-  data.tar.gz: 56fb94a307efb61cbf013d2bd43c6dfc577c7cf13dd979e2bde15a153478dc01a11074b31d591f5a39a575bc8d9525fb2853110f3eea8c2953454ae5a2c64d74
+  metadata.gz: 2e90d10bcee7498339bcb684e67da2612f6d4ad9fbef24b2de270c0d3ea1c508f63bae430b14d6bebc602f60286c712eb2c59eb54a33405cf5caf82928f1a657
+  data.tar.gz: fa54d821c6e50fc56ca824f54d89d74c0a9455c41809176c5f1f41068ca8a3f5171e27dae950477c3df7f662aab00e2b0264c8f60250723a828cb8a0661a1cb7

data/README.md

@@ -72,9 +72,12 @@ background_jobs_client.show(job_id: 123)
 # For performing operations on a known, registered object
 object_client = Dor::Services::Client.object(object_identifier)
 
-# Publish an object
+# Publish an object (push to PURL)
 object_client.publish
 
+# Shelve an object (push to Stacks)
+object_client.shelve
+
 # Update the MARC record
 object_client.update_marc_record
 
@@ -110,9 +113,11 @@ object_client.sdr.content_diff(current_content: existing_content)
 object_client.sdr.metadata(datastream: dsid)
 object_client.sdr.signature_catalog
 
-# Create and remove workspaces
+# Create, remove, and reset workspaces
 object_client.workspace.create(source: object_path_string)
 object_client.workspace.cleanup
+object_client.workspace.reset
+
 
 # Update embargo
 object_client.embargo.update(embargo_date: date_string, requesting_user: username_string)

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

@@ -64,7 +64,7 @@ module Dor
           Collections.new(parent_params).collections
         end
 
-        # Publish a new object
+        # Publish an object (send to PURL)
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
         # @return [boolean] true on success
@@ -77,6 +77,19 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
+        # Shelve an object (send to Stacks)
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [boolean] true on success
+        def shelve
+          resp = connection.post do |req|
+            req.url "#{object_path}/shelve"
+          end
+          return true if resp.success?
+
+          raise_exception_based_on_response!(resp)
+        end
+
         # Update the marc record for the given object
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '3.1.1'
+      VERSION = '3.2.0'
     end
   end
 end

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

@@ -33,6 +33,17 @@ module Dor
           raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp) unless resp.success?
         end
 
+        # After an object has been copied to preservation the workspace can be
+        # reset. This is called by the reset-workspace step of the accessionWF
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
+        # @return nil
+        def reset
+          resp = connection.post do |req|
+            req.url "#{workspace_path}/reset"
+          end
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp) unless resp.success?
+        end
+
         private
 
         def workspace_path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-01 00:00:00.000000000 Z
+date: 2019-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -255,8 +255,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: A client for dor-services-app