dor-services-client 6.35.0 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f284625ef5de76b844cbfa7569c83e1dc7deae5d19c94b4bb845f1cf69bab2e
-  data.tar.gz: 37cce8c5f6f95008bec16638f4ed2d30dd19ad01e7eb6da5e4b58ac2b330f7b4
+  metadata.gz: 26ea6df47f6abced00a0cc0aa06683f0ffffc3b7e09c04df374245ca0e510fa0
+  data.tar.gz: a19dfa02264725f02f51713077bc3a391a15c6f26e96dd2074be4546d6dfdc9d
 SHA512:
-  metadata.gz: 5b3f568bce673ef4d722d8140a7db715d35234e1312718205d9b352850899b10b59daaac34771ad27efe9a8715b6be5b4ba1c396d6fdc068c17b83e32abb4fcf
-  data.tar.gz: 5307d1ff1cd2a067168e452996761bb8bfde4b4c62ddf63cc070cb35478fe1dbe6b13fa1f6a3accf9dfc7bc6758dc496acea4cfe111bea4737f47231c4c1835b
+  metadata.gz: a53f6fb8e64122cfb94267fad031ed6594fb7df1d9dcb94828e7ad377f31842790faa7d5cabbdc6bba9425013075639f0b7b06c1f72a08c9d0466d0ea6572568
+  data.tar.gz: f78536e5a84e2579eabcf662b445090889748576ff9fa9a8d0a2445052712929f49f46695f0cd068f9afc8b4968ee566fbca98c40f3668511278b6b14f108548

data/.rubocop.yml

@@ -8,3 +8,72 @@ Metrics/BlockLength:
   Exclude:
     - 'dor-services-client.gemspec'
     - 'spec/**/*'
+
+Gemspec/DateAssignment: # (new in 1.10)
+  Enabled: true
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+Lint/EmptyInPattern: # (new in 1.16)
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+Lint/NumberedParameterAssignment: # (new in 1.9)
+  Enabled: true
+Lint/OrAssignmentToConstant: # (new in 1.9)
+  Enabled: true
+Lint/RedundantDirGlobSort: # (new in 1.8)
+  Enabled: true
+Lint/SymbolConversion: # (new in 1.9)
+  Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+Lint/TripleQuotes: # (new in 1.9)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+Style/HashConversion: # (new in 1.10)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # (new in 1.9)
+  Enabled: true
+Style/InPatternThen: # (new in 1.16)
+  Enabled: true
+Style/MultilineInPatternThen: # (new in 1.16)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/QuotedSymbols: # (new in 1.16)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/StringChars: # (new in 1.12)
+  Enabled: true
+Style/SwapValues: # (new in 1.1)
+  Enabled: true

data/README.md

@@ -61,6 +61,7 @@ objects_client = Dor::Services::Client.objects
 
 # Register a non-existent object
 objects_client.register(params: {})
+objects_client.register(params: {}, assign_doi: true)
 
 # Interact with virtual objects
 virtual_objects_client = Dor::Services::Client.virtual_objects
@@ -156,10 +157,6 @@ object_client.administrative_tags.update(current: 'Current : Tag', new: 'Replace
 object_client.administrative_tags.destroy(tag: 'Delete : Me')
 object_client.administrative_tags.list
 
-# Create and list release tags for an object
-object_client.release_tags.create(release: release, what: what, to: to, who: who)
-object_client.release_tags.list
-
 # Create and list events for an object
 object_client.events.create(type: type, data: data)
 object_client.events.list

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.60.0' # leave pinned to patch level until cocina-models hits 1.0
+  spec.add_dependency 'cocina-models', '~> 0.61.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.rb

@@ -26,11 +26,17 @@ module Dor
       # Base class for Dor::Services::Client exceptions
       class Error < StandardError; end
 
-      # Error that is raised when the remote server returns a 404 Not Found
+      # Error that is raised when the ultimate remote server returns a 404 Not Found for the id in our request (e.g. for druid, barcode, catkey)
       class NotFoundResponse < Error; end
 
+      # Error that is raised when the remote server returns some unparsable response
+      class MalformedResponse < Error; end
+
+      # Error that wraps Faraday connection exceptions
+      class ConnectionFailed < Error; end
+
       # Error that is raised when the remote server returns some unexpected response
-      # this could be any 4xx or 5xx status
+      # this could be any 4xx or 5xx status (except the ones that are direct children of the Error class above)
       class UnexpectedResponse < Error; end
 
       # Error that is raised when the remote server returns a 401 Unauthorized
@@ -39,11 +45,8 @@ module Dor
       # Error that is raised when the remote server returns a 409 Conflict
       class ConflictResponse < UnexpectedResponse; end
 
-      # Error that is raised when the remote server returns some unparsable response
-      class MalformedResponse < Error; end
-
-      # Error that wraps Faraday connection exceptions
-      class ConnectionFailed < Error; end
+      # Error that is raised when the remote server returns a 400 Bad Request; apps should not retry the request
+      class BadRequestError < UnexpectedResponse; end
 
       # @param object_identifier [String] the pid for the object
       # @raise [ArgumentError] when `object_identifier` is `nil`

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

@@ -21,6 +21,7 @@ module Dor
           return resp.body if resp.success? && resp.body.present?
 
           # This method needs its own exception handling logic due to how the endpoint service (SearchWorks) operates
+          # raise a NotFoundResponse because the resource being requested was not found in the ILS (via dor-services-app)
           raise NotFoundResponse, ResponseErrorFormatter.format(response: resp) if resp.success? && resp.body.blank?
 
           raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp)
@@ -42,10 +43,12 @@ module Dor
           end
 
           # This method needs its own exception handling logic due to how the endpoint service (Symphony) operates
-          #
+
           # DOR Services App does not respond with a 404 when no match in Symphony.
           # Rather, it responds with a 500 containing "Record not found in Symphony" in the body.
+          # raise a NotFoundResponse because the resource being requested was not found in the ILS (via dor-services-app)
           raise NotFoundResponse, ResponseErrorFormatter.format(response: resp) if !resp.success? && resp.body.match?(/Record not found in Symphony/)
+
           raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp) unless resp.success?
 
           resp.body

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

@@ -27,10 +27,6 @@ module Dor
           @workspace ||= Workspace.new(**parent_params)
         end
 
-        def release_tags
-          @release_tags ||= ReleaseTags.new(**parent_params)
-        end
-
         def administrative_tags
           @administrative_tags ||= AdministrativeTags.new(**parent_params)
         end
@@ -108,6 +104,18 @@ module Dor
           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
+
         # Notify the external Goobi system for a new object that was registered in DOR
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.

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

@@ -8,10 +8,11 @@ module Dor
       # API calls that are about a repository objects
       class Objects < VersionedService
         # Creates a new object in DOR
-        # @param [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAPO]
+        # @param params [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAPO]
+        # @param assign_doi [Boolean]
         # @return [Cocina::Models::RequestDRO,Cocina::Models::RequestCollection,Cocina::Models::RequestAPO] the returned model
-        def register(params:)
-          json_str = register_response(params: params)
+        def register(params:, assign_doi: false)
+          json_str = register_response(params: params, assign_doi: assign_doi)
           json = JSON.parse(json_str)
 
           Cocina::Models.build(json)
@@ -21,14 +22,16 @@ module Dor
 
         # make the registration request to the server
         # @param params [Hash] optional params (see dor-services-app)
+        # @param assign_doi [Boolean]
         # @raise [UnexpectedResponse] on an unsuccessful response from the server
         # @return [String] the raw JSON from the server
-        def register_response(params:)
+        def register_response(params:, assign_doi:)
           resp = connection.post do |req|
             req.url "#{api_version}/objects"
             req.headers['Content-Type'] = 'application/json'
             # asking the service to return JSON (else it'll be plain text)
             req.headers['Accept'] = 'application/json'
+            req.params[:assign_doi] = true if assign_doi
             req.body = params.to_json
           end
           return resp.body if resp.success?

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '6.35.0'
+      VERSION = '7.2.0'
     end
   end
 end

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

@@ -22,10 +22,12 @@ module Dor
         # rubocop:disable Metrics/MethodLength
         def raise_exception_based_on_response!(response, object_identifier = nil)
           exception_class = case response.status
-                            when 404
-                              NotFoundResponse
+                            when 400
+                              BadRequestError
                             when 401
                               UnauthorizedResponse
+                            when 404
+                              NotFoundResponse
                             when 409
                               ConflictResponse
                             else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 6.35.0
+  version: 7.2.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 0.61.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 0.61.0
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -243,7 +243,6 @@ files:
 - lib/dor/services/client/object.rb
 - lib/dor/services/client/object_version.rb
 - lib/dor/services/client/objects.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/version.rb

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

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Services
-    class Client
-      # API calls that are about a repository object
-      class ReleaseTags < 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
-
-        # Creates a new release tag for the object
-        # @param release [Boolean]
-        # @param what [String]
-        # @param to [String]
-        # @param who [String]
-        # @return [Boolean] true if successful
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] if the request is unsuccessful.
-        # rubocop:disable Metrics/MethodLength
-        def create(release:, what:, to:, who:)
-          params = {
-            to: to,
-            who: who,
-            what: what,
-            release: release
-          }
-          resp = connection.post do |req|
-            req.url "#{api_version}/objects/#{object_identifier}/release_tags"
-            req.headers['Content-Type'] = 'application/json'
-            req.body = params.to_json
-          end
-          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
-
-          true
-        end
-        # rubocop:enable Metrics/MethodLength
-
-        # List new release tags for the object
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] if the request is unsuccessful.
-        # @return [Hash] (see Dor::ReleaseTags::IdentityMetadata.released_for)
-        def list
-          resp = connection.get do |req|
-            req.url "#{api_version}/objects/#{object_identifier}/release_tags"
-          end
-
-          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
-
-          JSON.parse(resp.body)
-        end
-
-        private
-
-        attr_reader :object_identifier
-      end
-    end
-  end
-end