dor-services-client 14.4.0 → 14.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd7841c236c50b58fae7790f830fe16ccdf406046be4739d758bba74dd0155aa
-  data.tar.gz: 7e6f87de10e9112ce4301ead05ca56115ecc7c956d347f3447856f7afe29882f
+  metadata.gz: f174f312d81c83f4eb16c9d833623fb69b8a010f4afbca1b57018a38819c10f2
+  data.tar.gz: 7230f8d8093bc586cb5a083b7b292c12d47fbba648e1999f3c697bcb7d56a216
 SHA512:
-  metadata.gz: ea9ca5c81c500d8782f89b7ec7a8efc615116e4c98d306ee6c8d16d3fd144d6b36b1a162a266adf681c2a91aa48f5bc842dbccbcfe6e334b38641b45d7524240
-  data.tar.gz: 20ae566854c4f8eb4f95a6861f6c89d0d4594d3590d979fda9774f2a06d7c8dc1b8be5ddaa016479e54759091bba5c14da761abb48e7c01d6246990d9d395837
+  metadata.gz: d7d5cffdeb8ce04d90055bce6a9e5a751dcf7eaef4483e7f206eb10a68eecd3c3519d2295b470e006b88d1d2b2bbc8ae47fdaae8ab45e28d403bdc9b68615c28
+  data.tar.gz: dbcf6972c5b6dacd76407eb6a8573377ea0372a0447f9c834a5a1803b6a9cc6d0d2d25f83b90cec6ec02e9f7ddd6648e51d4175ad7e62ef4bc48fead47f7daa6

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    dor-services-client (14.4.0)
+    dor-services-client (14.6.0)
       activesupport (>= 4.2, < 8)
-      cocina-models (~> 0.95.1)
+      cocina-models (~> 0.96.0)
       deprecation
       faraday (~> 2.0)
       faraday-retry
@@ -29,7 +29,7 @@ GEM
     base64 (0.2.0)
     bigdecimal (3.1.7)
     byebug (11.1.3)
-    cocina-models (0.95.1)
+    cocina-models (0.96.0)
       activesupport
       deprecation
       dry-struct (~> 1.0)
@@ -151,10 +151,13 @@ GEM
       rubocop (~> 1.41)
     rubocop-factory_bot (2.25.1)
       rubocop (~> 1.41)
-    rubocop-rspec (2.27.1)
+    rubocop-rspec (2.28.0)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.2)
+      rubocop (~> 1.40)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)

data/README.md

@@ -120,9 +120,12 @@ object_client.notify_goobi
 # Manage versions
 object_client.version.inventory
 object_client.version.current
+# Returns a struct containing the status.
+# Status includes whether the object is open, assembling, accessioning, or closeable.
+object_client.version.status
 object_client.version.openable?
 # see dor-services-app openapi.yml for optional params
-object_client.version.open(description: 'Changed title', significance: 'minor')
+object_client.version.open(description: 'Changed title')
 # see dor-services-app openapi.yml for optional params
 object_client.version.close
 

data/dor-services-client.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 3.0', '< 4'
 
   spec.add_dependency 'activesupport', '>= 4.2', '< 8'
-  spec.add_dependency 'cocina-models', '~> 0.95.1'
+  spec.add_dependency 'cocina-models', '~> 0.96.0'
   spec.add_dependency 'deprecation', '>= 0'
   spec.add_dependency 'faraday', '~> 2.0'
   spec.add_dependency 'faraday-retry'

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

@@ -15,7 +15,6 @@ module Dor
 
         # Start accession on an object (start specified workflow, assemblyWF by default, and version if needed)
         # @param params [Hash<Symbol,String>] optional parameter hash
-        # @option params [String] :significance set significance (major/minor/patch) of version change - required
         # @option params [String] :description set description of version change - required
         # @option params [String] :opening_user_name add opening username to the event - optional
         # @option params [String] :workflow the workflow to start - defaults to 'assemblyWF'

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

@@ -6,6 +6,31 @@ module Dor
       # API calls that are about versions
       class ObjectVersion < VersionedService
         Version = Struct.new(:versionId, :tag, :message, keyword_init: true)
+        VersionStatus = Struct.new(:versionId, :open, :openable, :assembling, :accessioning, :closeable, keyword_init: true) do
+          def open?
+            open
+          end
+
+          def openable?
+            openable
+          end
+
+          def assembling?
+            assembling
+          end
+
+          def accessioning?
+            accessioning
+          end
+
+          def closed?
+            !open
+          end
+
+          def closeable?
+            closeable
+          end
+        end
 
         # @param object_identifier [String] the pid for the object
         def initialize(connection:, version:, object_identifier:)
@@ -51,7 +76,6 @@ module Dor
 
         # Open new version for an object
         # @param description [String] a description of the object version being opened - required
-        # @param significance [String] 'major' 'minor' or 'admin' - required
         # @param opening_user_name [String] sunetid - defaults to nil
         # @param assume_accessioned [Boolean] if true, does not check whether object has been accessioned; defaults to false
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
@@ -70,7 +94,6 @@ module Dor
 
         # Close current version for an object
         # @param description [String] (optional) - a description of the object version being opened
-        # @param significance [String] (optional) - 'major' 'minor' or 'admin'
         # @param user_name [String] (optional) - sunetid
         # @param start_accession [Boolean] (optional) - whether to start accessioning workflow; defaults to true
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
@@ -97,6 +120,17 @@ module Dor
           JSON.parse(resp.body).fetch('versions').map { |params| Version.new(**params.symbolize_keys!) }
         end
 
+        # @return [VersionStatus] status of the version
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        def status
+          resp = connection.get do |req|
+            req.url "#{base_path}/status"
+          end
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
+
+          VersionStatus.new(JSON.parse(resp.body).symbolize_keys!)
+        end
+
         private
 
         attr_reader :object_identifier

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '14.4.0'
+      VERSION = '14.6.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 14.4.0
+  version: 14.6.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-25 00:00:00.000000000 Z
+date: 2024-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.95.1
+        version: 0.96.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.95.1
+        version: 0.96.0
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -278,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
 summary: A client for dor-services-app