dor-services-client 6.28.0 → 6.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7deb2e9cf11e029ea63aa7bad9b918c09ccb0e8e556eff7e4fda128f8c6ad02e
-  data.tar.gz: 71e3ddd60c340352e76e1a2f97cca49238a900deaa15216507761abab2d3b51a
+  metadata.gz: fc73f1e0055882f5c80701e0c49eae8a6079553478799b4415676f651219ef4c
+  data.tar.gz: ebe6b6a76f73179da7e1835ddf242b50d355f61dc5e94f1b755536d2369e3235
 SHA512:
-  metadata.gz: 130bb091aac14a28ed07bfcae47cf610ae301195252b15a8a69b26e073eb6258e29f25ea1971000a5189dfa10a4c313b786566c9b934c1dc87bd85b0bf3555bf
-  data.tar.gz: c9c729fdbb5b8191e676467703a225f70678fc884d8e79abb01a940a7d3b55ff6f6850b7478af4c59d16e649e9a75ac751ca27272309994764e3a278138f1dbe
+  metadata.gz: a4cfe626ccfb4709f5f9c43d04ec228d3715df46fc252164e0ff57426d02a62d7e8be2d4fa7ba3525e5220ac504de632ef1c98e2d747dd6b3d7bd85137ca13ba
+  data.tar.gz: 45d554dedc4dc1c7236b294f780414bf39136544c83f4443b088522942f17cc0f47c892cd04aaad3cff7393386577ca113ad95819d4a5abf7ced176de2679001

data/README.md

@@ -117,6 +117,7 @@ object_client.apply_admin_policy_defaults
 object_client.notify_goobi
 
 # Manage versions
+object_client.version.inventory
 object_client.version.current
 object_client.version.openable?(**params)
 object_client.version.open(**params)

data/dor-services-client.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '~> 2.6'
 
   spec.add_dependency 'activesupport', '>= 4.2', '< 7'
-  spec.add_dependency 'cocina-models', '~> 0.55.0' # leave pinned to patch level until cocina-models hits 1.0
+  spec.add_dependency 'cocina-models', '~> 0.58.0' # leave pinned to patch level until cocina-models hits 1.0
   spec.add_dependency 'deprecation', '>= 0'
   spec.add_dependency 'faraday', '>= 0.15', '< 2'
   spec.add_dependency 'moab-versioning', '~> 4.0'

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

@@ -75,6 +75,33 @@ module Dor
           raise_exception_based_on_response!(resp, object_identifier)
         end
 
+        # rubocop:disable Lint/StructNewOverride
+        Datastream = Struct.new(:label, :dsid, :pid, :size, :mimeType, :versionId, keyword_init: true)
+        # rubocop:enable Lint/StructNewOverride
+
+        # @return [Array] the list of datastreams for the item
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        def datastreams
+          resp = connection.get do |req|
+            req.url "#{base_path}/datastreams"
+          end
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
+
+          JSON.parse(resp.body).map { |params| Datastream.new(**params.symbolize_keys!) }
+        end
+
+        # @param [String] dsid the identifier for the datastream
+        # @return [String] the contents of the specified datastream
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        def datastream(dsid)
+          resp = connection.get do |req|
+            req.url "#{base_path}/datastreams/#{dsid}"
+          end
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
+
+          resp.body
+        end
+
         private
 
         attr_reader :object_identifier

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

@@ -5,6 +5,8 @@ module Dor
     class Client
       # API calls that are about versions
       class ObjectVersion < VersionedService
+        Version = Struct.new(:versionId, :tag, :message, keyword_init: true)
+
         # @param object_identifier [String] the pid for the object
         def initialize(connection:, version:, object_identifier:)
           super(connection: connection, version: version)
@@ -17,7 +19,7 @@ module Dor
         # @return [String] the version identifier
         def current
           resp = connection.get do |req|
-            req.url "#{object_path}/versions/current"
+            req.url "#{base_path}/current"
           end
           return resp.body if resp.success?
 
@@ -32,7 +34,7 @@ module Dor
         # rubocop:disable Metrics/MethodLength
         def openable?(**params)
           resp = connection.get do |req|
-            req.url "#{object_path}/versions/openable"
+            req.url "#{base_path}/openable"
             req.params = params
           end
 
@@ -78,6 +80,17 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
+        # @return [Array] a list of the versions
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        def inventory
+          resp = connection.get do |req|
+            req.url base_path
+          end
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
+
+          JSON.parse(resp.body).fetch('versions').map { |params| Version.new(**params.symbolize_keys!) }
+        end
+
         private
 
         attr_reader :object_identifier
@@ -102,12 +115,14 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
-        def open_new_version_path
+        def base_path
           "#{object_path}/versions"
         end
 
+        alias open_new_version_path base_path
+
         def close_version_path
-          "#{object_path}/versions/current/close"
+          "#{base_path}/current/close"
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '6.28.0'
+      VERSION = '6.32.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 6.28.0
+  version: 6.32.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-17 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: 0.58.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: 0.58.0
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement