dor-services-client 14.13.0 → 14.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e11aa6b7c797bddc325923a41e2a2309b9acd7d2af271b72b0c88ea6bbdcd264
-  data.tar.gz: df84d64b8163f88ffe3bfd75e5e82535476822b59041a198b7597695c6fd44f2
+  metadata.gz: f2b55c7474fab7b39f9c192e3effa26056d8523e8d319a5915b205d242ae4edf
+  data.tar.gz: f15fdecc7e97287f58a6e386a4b94f8ba466f5db6d95e5f763ef773852ded901
 SHA512:
-  metadata.gz: 9d5e2f4971d7903f97547ad5a76178e4d6cd75bf5d8bb92fa6f895b17b52d1a3b68ed33637bacf6ec6df8eae1aa1967b714dba83cf9583aa997a86bacf9ff25f
-  data.tar.gz: 3af6f1d5eda5c2d80073931c5c6668baede8b3e9ea6fb632f2cbd9f44e6684b162f3166689f0bfd6b5b53ab0647b826ba5def700aba64d1da12bdad6748d0849
+  metadata.gz: 324c792ac506b0e4fdd0ff750c6348864bd116a0881dc02ebc657a0ca8ccceeed236c529a36cbf9bfdaedd0261363d5b69e9d5a9526fcfd3116ba29ad34486e1
+  data.tar.gz: 5aa5c984f0e3815bcb30b39b09292c9b7965113264e26c987d73cc0cbf3e8fe7e94906bb5d1395666da053d4bbde7ef48c3c8fd7611f41dd120e37438b008b1a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dor-services-client (14.13.0)
+    dor-services-client (14.15.0)
       activesupport (>= 4.2, < 8)
       cocina-models (~> 0.98.0)
       deprecation
@@ -22,14 +22,14 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
     attr_extras (7.1.0)
     base64 (0.2.0)
     bigdecimal (3.1.8)
     byebug (11.1.3)
-    cocina-models (0.98.0)
+    cocina-models (0.98.1)
       activesupport
       deprecation
       dry-struct (~> 1.0)
@@ -81,7 +81,7 @@ GEM
       activesupport (>= 3.0, < 8.0)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    faraday (2.9.1)
+    faraday (2.9.2)
       faraday-net_http (>= 2.0, < 3.2)
     faraday-net_http (3.1.0)
       net-http
@@ -95,33 +95,33 @@ GEM
     jsonpath (1.1.5)
       multi_json
     language_server-protocol (3.17.0.3)
-    minitest (5.23.1)
+    minitest (5.24.1)
     multi_json (1.15.0)
     mutex_m (0.2.0)
     net-http (0.4.1)
       uri
-    nokogiri (1.16.5-arm64-darwin)
+    nokogiri (1.16.6-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.5-x86_64-darwin)
+    nokogiri (1.16.6-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.5-x86_64-linux)
+    nokogiri (1.16.6-x86_64-linux)
       racc (~> 1.4)
     openapi3_parser (0.10.0)
       commonmarker (>= 1.0)
     openapi_parser (1.0.0)
     optimist (3.1.0)
     parallel (1.25.1)
-    parser (3.3.2.0)
+    parser (3.3.3.0)
       ast (~> 2.4.1)
       racc
     patience_diff (1.2.0)
       optimist (~> 3.0)
-    public_suffix (5.0.5)
+    public_suffix (6.0.0)
     racc (1.8.0)
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
-    rexml (3.2.9)
+    rexml (3.3.1)
       strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -129,7 +129,7 @@ GEM
       rspec-mocks (~> 3.13.0)
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-mocks (3.13.1)
@@ -151,15 +151,15 @@ GEM
       parser (>= 3.3.1.0)
     rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.26.0)
-      rubocop (~> 1.41)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
     rubocop-rspec (2.31.0)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
       rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.29.0)
-      rubocop (~> 1.40)
+    rubocop-rspec_rails (2.29.1)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -181,7 +181,7 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.15)
+    zeitwerk (2.6.16)
 
 PLATFORMS
   arm64-darwin-23

data/README.md

@@ -129,6 +129,13 @@ object_client.version.open(description: 'Changed title')
 # see dor-services-app openapi.yml for optional params
 object_client.version.close
 
+# Manage user versions
+object_client.user_version.inventory
+object_client.user_version.find(2)
+object_client.user_version.solr(2)
+object_client.user_version.create(object_version: 3)
+object_client.user_version.update(user_version: Dor::Services::Client::UserVersion::Version.new(version: 3, userVersion: 3, withdrawn: true))
+
 # Return the Cocina metadata
 object_client.find
 

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

@@ -5,7 +5,7 @@ module Dor
     class Client
       # API calls that are about user versions
       class UserVersion < VersionedService
-        Version = Struct.new(:version, :userVersion, keyword_init: true)
+        Version = Struct.new(:version, :userVersion, :withdrawn, keyword_init: true)
 
         # @param object_identifier [String] the pid for the object
         def initialize(connection:, version:, object_identifier:)
@@ -24,6 +24,64 @@ module Dor
           JSON.parse(resp.body).fetch('user_versions').map { |params| Version.new(**params.symbolize_keys!) }
         end
 
+        # @return [Cocina::Models::DROWithMetadata] the object metadata
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        def find(version)
+          resp = connection.get do |req|
+            req.url "#{base_path}/#{version}"
+          end
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          build_cocina_from_response(resp, validate: false)
+        end
+
+        # @return [Hash] the solr document for the user version
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        def solr(version)
+          resp = connection.get do |req|
+            req.url "#{base_path}/#{version}/solr"
+          end
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          JSON.parse(resp.body)
+        end
+
+        # Create a user version for an object
+        #
+        # @param [String] object_version the version of the object to create a user version for
+        # @return [Version]
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
+        def create(object_version:)
+          resp = connection.post do |req|
+            req.url "#{api_version}/objects/#{object_identifier}/user_versions"
+            req.headers['Content-Type'] = 'application/json'
+            req.body = { version: object_version }.to_json
+          end
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
+
+          Version.new(**JSON.parse(resp.body).symbolize_keys!)
+        end
+
+        # Updates a user version
+        #
+        # @param [Version] user_version the updated user version
+        # @return [Version]
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
+        # rubocop:disable Metrics/AbcSize
+        def update(user_version:)
+          resp = connection.patch do |req|
+            req.url "#{api_version}/objects/#{object_identifier}/user_versions/#{user_version.userVersion}"
+            req.headers['Content-Type'] = 'application/json'
+            req.body = user_version.to_h.except(:userVersion).compact.to_json
+          end
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
+
+          Version.new(**JSON.parse(resp.body).symbolize_keys!)
+        end
+        # rubocop:enable Metrics/AbcSize
+
         private
 
         attr_reader :object_identifier

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '14.13.0'
+      VERSION = '14.15.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 14.13.0
+  version: 14.15.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-13 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -280,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: A client for dor-services-app