dor-services-client 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: add29434a7d092987f42745ab21360a8b07316240ef094b11b0c7efa798c1040
-  data.tar.gz: 81aab66662678c76b1c3e266df5d5d730f59760e9548521894de38ac60aa151f
+  metadata.gz: eb4e61bec082f3dec6a95359d667af8a162c7e3f8d6bd5c5a27fe1350ffb8cb0
+  data.tar.gz: dda521e88bbf4d133309efe559bf9e66677edcd047e7bb3416a8e13d0b234e8f
 SHA512:
-  metadata.gz: 27f4b988581fe4236e8fcf5c204ed70fdf50c02c8eacf3832b2529dab12123c671ea46075c53f1b40ad2b3ab303f78d1c0463e66daacc526bea55f0bc8def2b2
-  data.tar.gz: ada02ea8750cae5ac2979282f17a614a8f5569342506c14c8a617960a17c8d77d6a16165d37c354d91c6d8c8716fbf6c9963fedce6f91afc8c8bc5d840397bfd
+  metadata.gz: 9566af655ae58b4617e810afb0b324135a310b8d67371753c325852b7df514b2975979de1422f06d2d4380065719490a65253e67bbf2e589450ac1e9a0145689
+  data.tar.gz: 2a36b54ecc637e677ac84ba33ff68852392c23aefe2bc23551c9672ec322dcf71d8ffa7a7ea3d46454abfc03aeb6693db6c29a3ad0b7b6aad8ce8af546b71854

data/README.md

@@ -52,10 +52,15 @@ Note that the client may **not** be used without first having been configured, a
 Dor::Services:Client provides a number of methods to simplify connecting to the RESTful HTTP API of dor-services-app. In this section we list all of the available methods, reflecting how much of the API the client covers. For details see the [API docs](https://www.rubydoc.info/github/sul-dlss/dor-services-client/master/Dor/Services/Client)
 
 ```ruby
-# For registering a non-existent object
+# For performing operations on one or more objects
 objects_client = Dor::Services::Client.objects
+
+# For registering a non-existent object
 objects_client.register(params: {})
 
+# Create a batch of virtual objects
+objects_client.create_virtual_objects(parent_druid: '', child_druids: [''])
+
 # For performing operations on a known, registered object
 object_client = Dor::Services::Client.object(object_identifier)
 

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

@@ -103,6 +103,7 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
+        # TODO: Remove once Argo is using `VirtualObjects#create` instead.
         # Does a virtual-merge of the children into the parent
         # @param [Array<String>] child_druids the identifier of the children
         # @raise [NotFoundResponse] when the response is a 404 (object not found)

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '2.5.1'
+      VERSION = '2.6.0'
     end
   end
 end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls around "virtual objects" in DOR
+      class VirtualObjects < VersionedService
+        # Create a batch of virtual objects in DOR
+        # @param params [Hash] required hash params (see dor-services-app)
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        # @return [NilClass] nil if no errors
+        def create(params:)
+          resp = connection.post do |req|
+            req.url "#{api_version}/virtual_objects"
+            req.headers['Content-Type'] = 'application/json'
+            req.headers['Accept'] = 'application/json'
+            req.body = params.to_json
+          end
+          return if resp.success?
+
+          raise_exception_based_on_response!(resp)
+        end
+
+        private
+
+        def raise_exception_based_on_response!(response)
+          raise (response.status == 404 ? NotFoundResponse : UnexpectedResponse),
+                ResponseErrorFormatter.format(response: response)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-09 00:00:00.000000000 Z
+date: 2019-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -219,6 +219,7 @@ files:
 - lib/dor/services/client/sdr.rb
 - lib/dor/services/client/version.rb
 - lib/dor/services/client/versioned_service.rb
+- lib/dor/services/client/virtual_objects.rb
 - lib/dor/services/client/workspace.rb
 homepage: https://github.com/sul-dlss/dor-services-client
 licenses: []
@@ -239,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A client for dor-services-app