dor-services-client 15.1.0 → 15.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d7ec32221ccf11fa986b36536aa4a298ac724a0686411ee7246e897e92c2bed
-  data.tar.gz: 9aadc355af7981afee4a2c82ba27c924d3693e905c07663237dbab2800f130b7
+  metadata.gz: 17084d47db10602abff0c9d6bc50840dfac58ac14e2efa96a2a2f38f0dd8b779
+  data.tar.gz: 9fa643be94ed39a305199becf67b996759084fbf2ebecbd139cfc2e03b50c6ae
 SHA512:
-  metadata.gz: a9575501c47cae7331a1761873c2f380ed6c50a4c9d64e13adf530188a6abc20b5b5be55216d9d0e4950544c8092ee47046b4097e11749f5fa8498c573c5665c
-  data.tar.gz: b7da6ff18817b7fd1b84757d2c701b73d6b989e6de0afa24ff1f57ccdb73331d6f7b79900b3d283dd2f17cc6230368cf1440973ceb0c483e79bb781823265340
+  metadata.gz: fedc3d9668ecc6be0e9139b983ce5ee4469572250c3e354b7152047f27f88c52d2c90f2147aadf72de3b63402a0e23db4b8555f60f8693380e37a72301e01686
+  data.tar.gz: 47af1f97d1969b053b64ad9b7a634192e0efaf103e5add43d949cc6c1c7a4f45a41caf9f72ad09d207c5ac193f918acd28a0375153d249050d1c8e0d4b8028b0

data/.rubocop.yml

@@ -12,15 +12,15 @@ Metrics/BlockLength:
     - 'dor-services-client.gemspec'
     - 'spec/**/*'
 
+RSpec/ExampleLength:
+  Enabled: false
+
 RSpec/MultipleExpectations:
   Enabled: false
 
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
 
-RSpec/ExampleLength:
-  Max: 10
-
 Gemspec/DeprecatedAttributeAssignment: # (new in 1.10)
   Enabled: true
 Layout/SpaceBeforeBrackets: # (new in 1.7)
@@ -135,7 +135,7 @@ RSpec/SubjectDeclaration: # new in 2.5
   Enabled: true
 FactoryBot/SyntaxMethods: # new in 2.7
   Enabled: true
-RSpec/Rails/AvoidSetupHook: # new in 2.4
+RSpecRails/AvoidSetupHook: # new in 2.4
   Enabled: true
 
 Lint/RefinementImportMethods: # new in 1.27
@@ -179,7 +179,7 @@ RSpec/ChangeByZero: # new in 2.11.0
   Enabled: true
 Capybara/SpecificMatcher: # new in 2.12
   Enabled: false
-RSpec/Rails/HaveHttpStatus: # new in 2.12
+RSpecRails/HaveHttpStatus: # new in 2.12
   Enabled: false
 
 RSpec/ClassCheck: # new in 2.13
@@ -271,11 +271,11 @@ RSpec/SkipBlockInsideExample: # new in 2.19
   Enabled: true
 RSpec/SortMetadata: # new in 2.14
   Enabled: true
-RSpec/Rails/InferredSpecType: # new in 2.14
+RSpecRails/InferredSpecType: # new in 2.14
   Enabled: true
-RSpec/Rails/MinitestAssertions: # new in 2.17
+RSpecRails/MinitestAssertions: # new in 2.17
   Enabled: true
-RSpec/Rails/TravelAround: # new in 2.19
+RSpecRails/TravelAround: # new in 2.19
   Enabled: true
 
 Lint/MixedCaseRange: # new in 1.53
@@ -292,5 +292,64 @@ Style/YAMLFileRead: # new in 1.53
   Enabled: true
 RSpec/ReceiveMessages: # new in 2.23
   Enabled: true
-RSpec/Rails/NegationBeValid: # new in 2.23
+RSpecRails/NegationBeValid: # new in 2.23
+  Enabled: true
+
+Gemspec/AddRuntimeDependency: # new in 1.65
+  Enabled: true
+Lint/DuplicateSetElement: # new in 1.67
+  Enabled: true
+Lint/ItWithoutArgumentsInBlock: # new in 1.59
+  Enabled: true
+Lint/LiteralAssignmentInCondition: # new in 1.58
+  Enabled: true
+Lint/UselessNumericOperation: # new in 1.66
+  Enabled: true
+Style/MapIntoArray: # new in 1.63
+  Enabled: true
+Style/RedundantInterpolationUnfreeze: # new in 1.66
+  Enabled: true
+Style/SendWithLiteralMethodName: # new in 1.64
+  Enabled: true
+Style/SingleLineDoEndBlock: # new in 1.57
+  Enabled: true
+Style/SuperArguments: # new in 1.64
+  Enabled: true
+Style/SuperWithArgsParentheses: # new in 1.58
+  Enabled: true
+Capybara/ClickLinkOrButtonStyle: # new in 2.19
+  Enabled: true
+Capybara/RedundantWithinFind: # new in 2.20
+  Enabled: true
+Capybara/RSpec/HaveSelector: # new in 2.19
+  Enabled: true
+Capybara/RSpec/PredicateMatcher: # new in 2.19
+  Enabled: true
+FactoryBot/ExcessiveCreateList: # new in 2.25
+  Enabled: true
+FactoryBot/IdSequence: # new in 2.24
+  Enabled: true
+RSpec/EmptyMetadata: # new in 2.24
+  Enabled: true
+RSpec/EmptyOutput: # new in 2.29
+  Enabled: true
+RSpec/Eq: # new in 2.24
+  Enabled: true
+RSpec/ExpectInLet: # new in 2.30
+  Enabled: true
+RSpec/IsExpectedSpecify: # new in 2.27
+  Enabled: true
+RSpec/MetadataStyle: # new in 2.24
+  Enabled: true
+RSpec/RedundantPredicateMatcher: # new in 2.26
+  Enabled: true
+RSpec/RemoveConst: # new in 2.26
+  Enabled: true
+RSpec/RepeatedSubjectCall: # new in 2.27
+  Enabled: true
+RSpec/SpecFilePathFormat: # new in 2.24
+  Enabled: true
+RSpec/SpecFilePathSuffix: # new in 2.24
+  Enabled: true
+RSpec/UndescriptiveLiteralsDescription: # new in 2.29
   Enabled: true

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    dor-services-client (15.1.0)
-      activesupport (>= 4.2, < 8)
+    dor-services-client (15.2.1)
+      activesupport (>= 7.0.0)
       cocina-models (~> 0.99.0)
       deprecation
       faraday (~> 2.0)
@@ -12,8 +12,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.2.1)
+    activesupport (7.2.2)
       base64
+      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
@@ -28,6 +29,7 @@ GEM
     ast (2.4.2)
     attr_extras (7.1.0)
     base64 (0.2.0)
+    benchmark (0.4.0)
     bigdecimal (3.1.8)
     byebug (11.1.3)
     cocina-models (0.99.0)
@@ -58,8 +60,9 @@ GEM
     diff-lcs (1.5.1)
     docile (1.4.1)
     drb (2.2.1)
-    dry-core (1.0.1)
+    dry-core (1.0.2)
       concurrent-ruby (~> 1.0)
+      logger
       zeitwerk (~> 2.6)
     dry-inflector (1.1.0)
     dry-logic (1.5.0)
@@ -94,14 +97,14 @@ GEM
     i18n (1.14.6)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    json (2.7.2)
+    json (2.8.1)
     jsonpath (1.1.5)
       multi_json
     language_server-protocol (3.17.0.3)
     logger (1.6.1)
     minitest (5.25.1)
     multi_json (1.15.0)
-    net-http (0.4.1)
+    net-http (0.5.0)
       uri
     nokogiri (1.16.7-arm64-darwin)
       racc (~> 1.4)
@@ -114,7 +117,7 @@ GEM
     openapi_parser (1.0.0)
     optimist (3.1.0)
     parallel (1.26.3)
-    parser (3.3.5.0)
+    parser (3.3.6.0)
       ast (~> 2.4.1)
       racc
     patience_diff (1.2.0)
@@ -124,12 +127,12 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
-    rexml (3.3.8)
+    rexml (3.3.9)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.1)
+    rspec-core (3.13.2)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -138,7 +141,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.66.1)
+    rubocop (1.68.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -148,7 +151,7 @@ GEM
       rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.3)
+    rubocop-ast (1.34.1)
       parser (>= 3.3.1.0)
     rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
@@ -162,7 +165,7 @@ GEM
     rubocop-rspec_rails (2.29.1)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    securerandom (0.3.1)
+    securerandom (0.3.2)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -177,12 +180,12 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.6.0)
-    uri (0.13.1)
+    uri (1.0.1)
     webmock (3.24.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.18)
+    zeitwerk (2.7.1)
 
 PLATFORMS
   arm64-darwin-23

data/README.md

@@ -87,43 +87,21 @@ object_client.update(params: dro)
 # Publish an object (push to PURL)
 object_client.publish(workflow: 'releaseWF', lane_id: 'low')
 
-# Unpublish an object (yank from PURL)
-object_client.unpublish()
-
-# Shelve an object (push to Stacks)
-object_client.shelve(lane_id: 'low')
-
 # Start accessioning an object (initialize assemblyWF or specified workflow, and version object if needed)
 object_client.accession.start(**versioning_params)
 
-# Preserve an object (push to SDR)
-object_client.preserve(lane_id: 'low')
-
-# Update the MARC record (used in the releaseWF)
-object_client.update_marc_record
-
-# Update the DOI metadata (used by robot)
-object_client.update_doi_metadata
-
-# Update the Orcid work (used by robot)
-object_client.update_orcid_work
-
 # Copy metadata from Symphony into descMetadata
 object_client.refresh_descriptive_metadata_from_ils
 
 # Apply defaults from the item's AdminPolicy to the item itself
 object_client.apply_admin_policy_defaults
 
-# Send a notification to goobi
-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')
 # see dor-services-app openapi.yml for optional params
@@ -164,9 +142,8 @@ object_client.release_tags.list(public: true) # only public release tags (i.e. l
 object_client.events.create(type: type, data: data)
 object_client.events.list
 
-# Create and reset workspaces
+# Create workspaces
 object_client.workspace.create(source: object_path_string)
-object_client.workspace.cleanup
 
 # Reindex
 object_client.reindex

data/dor-services-client.gemspec

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

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

@@ -107,8 +107,6 @@ module Dor
           Transfer.new(**parent_params)
         end
 
-        delegate :publish, :unpublish, :preserve, :shelve, to: :transfer
-
         def mutate
           Mutate.new(**parent_params)
         end
@@ -118,68 +116,41 @@ module Dor
         alias refresh_metadata refresh_descriptive_metadata_from_ils
         deprecation_deprecate refresh_metadata: 'Use refresh_descriptive_metadata_from_ils instead'
 
-        # Update the marc record for the given object
+        # Reindex the object in Solr.
         # @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 update_marc_record
-          resp = connection.post do |req|
-            req.url "#{object_path}/update_marc_record"
-          end
-          return true if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
-        # Update the DOI metadata at DataCite
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @return [boolean] true on success
-        def update_doi_metadata
-          resp = connection.post do |req|
-            req.url "#{object_path}/update_doi_metadata"
-          end
-          return true if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
-        # Update the ORCID Work
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @return [Boolean] true on success
-        def update_orcid_work
+        def reindex
           resp = connection.post do |req|
-            req.url "#{object_path}/update_orcid_work"
+            req.url "#{object_path}/reindex"
           end
           return true if resp.success?
 
           raise_exception_based_on_response!(resp)
         end
 
-        # Notify the external Goobi system for a new object that was registered in DOR
+        # 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
-        def notify_goobi
-          resp = connection.post do |req|
-            req.url "#{object_path}/notify_goobi"
+        # @param [String] workflow (nil) which workflow to callback to.
+        # @param [String] lane_id for prioritization (default or low)
+        # @return [String] the URL of the background job on dor-service-app
+        # rubocop:disable Metrics/MethodLength
+        def publish(workflow: nil, lane_id: nil)
+          query_params = [].tap do |params|
+            params << "workflow=#{workflow}" if workflow
+            params << "lane-id=#{lane_id}" if lane_id
           end
-          return true if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
-        # Reindex the object in Solr.
-        # @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 reindex
+          query_string = query_params.any? ? "?#{query_params.join('&')}" : ''
+          publish_path = "#{object_path}/publish#{query_string}"
           resp = connection.post do |req|
-            req.url "#{object_path}/reindex"
+            req.url publish_path
           end
-          return true if resp.success?
+          return resp.headers['Location'] if resp.success?
 
           raise_exception_based_on_response!(resp)
         end
+        # rubocop:enable Metrics/MethodLength
 
         private
 

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

@@ -13,7 +13,7 @@ module Dor
           end
         end
 
-        VersionStatus = Struct.new(:versionId, :open, :openable, :assembling, :accessioning, :closeable, keyword_init: true) do
+        VersionStatus = Struct.new(:versionId, :open, :openable, :assembling, :accessioning, :closeable, :discardable, keyword_init: true) do
           alias_method :version, :versionId
 
           def open?
@@ -39,6 +39,10 @@ module Dor
           def closeable?
             closeable
           end
+
+          def discardable?
+            discardable
+          end
         end
 
         # @param object_identifier [String] the pid for the object
@@ -71,29 +75,6 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
-        # Determines if a new version can be opened for a DOR object.
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [Boolean] true if a new version can be opened
-        # rubocop:disable Metrics/MethodLength
-        def openable?
-          resp = connection.get do |req|
-            req.url "#{base_path}/openable"
-          end
-
-          raise_exception_based_on_response!(resp) unless resp.success?
-
-          case resp.body
-          when 'true'
-            true
-          when 'false'
-            false
-          else
-            raise MalformedResponse, "Expected true or false, not #{resp.body}"
-          end
-        end
-        # rubocop:enable Metrics/MethodLength
-
         # Open new version for an object
         # @param description [String] a description of the object version being opened - required
         # @param opening_user_name [String] sunetid - defaults to nil
@@ -163,6 +144,18 @@ module Dor
           JSON.parse(resp.body)
         end
 
+        # Discard current version for an object
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        def discard
+          resp = connection.delete do |req|
+            req.url "#{base_path}/current"
+          end
+          return if resp.success?
+
+          raise_exception_based_on_response!(resp)
+        end
+
         private
 
         attr_reader :object_identifier

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '15.1.0'
+      VERSION = '15.2.1'
     end
   end
 end

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

@@ -31,24 +31,6 @@ module Dor
         end
         # rubocop:enable Metrics/AbcSize
 
-        # Cleans up and resets the workspace
-        # 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 [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @param [String] lane_id for prioritization (default or low)
-        # @return [String] the URL of the background job on dor-service-app
-        def cleanup(lane_id: nil)
-          cleanup_workspace_path = workspace_path
-          cleanup_workspace_path += "?lane-id=#{lane_id}" if lane_id
-          resp = connection.delete do |req|
-            req.url cleanup_workspace_path
-          end
-          return resp.headers['Location'] if resp.success?
-
-          raise_exception_based_on_response!(resp, object_identifier)
-        end
-
         private
 
         def workspace_path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 15.1.0
+  version: 15.2.1
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-10 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,20 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: cocina-models
   requirement: !ruby/object:Gem::Requirement
@@ -252,7 +246,6 @@ files:
 - lib/dor/services/client/release_tag.rb
 - lib/dor/services/client/release_tags.rb
 - lib/dor/services/client/response_error_formatter.rb
-- lib/dor/services/client/transfer.rb
 - lib/dor/services/client/user_version.rb
 - lib/dor/services/client/version.rb
 - lib/dor/services/client/versioned_service.rb
@@ -280,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A client for dor-services-app

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

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Services
-    class Client
-      # API calls that move data around.
-      class Transfer < VersionedService
-        # @param object_identifier [String] the pid for the object
-        def initialize(connection:, version:, object_identifier:)
-          super(connection: connection, version: version)
-          @object_identifier = object_identifier
-        end
-
-        # 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.
-        # @param [String] workflow (nil) which workflow to callback to.
-        # @param [String] lane_id for prioritization (default or low)
-        # @return [String] the URL of the background job on dor-service-app
-        def publish(workflow: nil, lane_id: nil)
-          query_params = [].tap do |params|
-            params << "workflow=#{workflow}" if workflow
-            params << "lane-id=#{lane_id}" if lane_id
-          end
-          query_string = query_params.any? ? "?#{query_params.join('&')}" : ''
-          publish_path = "#{object_path}/publish#{query_string}"
-          resp = connection.post do |req|
-            req.url publish_path
-          end
-          return resp.headers['Location'] if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
-        # Unpublish an object (yank from to PURL)
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [String] the URL of the background job on dor-service-app
-        def unpublish
-          resp = connection.post do |req|
-            req.url "#{object_path}/unpublish"
-          end
-          return resp.headers['Location'] if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
-        # Preserve an object (send to SDR)
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @param [String] lane_id for prioritization (default or low)
-        # @return [String] URL from Location response header if no errors
-        def preserve(lane_id: nil)
-          query_string = lane_id ? "?lane-id=#{lane_id}" : ''
-          resp = connection.post do |req|
-            req.url "#{object_path}/preserve#{query_string}"
-          end
-          return resp.headers['Location'] if resp.success?
-
-          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.
-        # @param [String] lane_id for prioritization (default or low)
-        # @return [boolean] true on success
-        def shelve(lane_id: nil)
-          query_string = lane_id ? "?lane-id=#{lane_id}" : ''
-          resp = connection.post do |req|
-            req.url "#{object_path}/shelve#{query_string}"
-          end
-          return resp.headers['Location'] if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
-        private
-
-        def object_path
-          "#{api_version}/objects/#{object_identifier}"
-        end
-
-        attr_reader :object_identifier
-      end
-    end
-  end
-end