dor-services-client 6.31.0 → 6.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c85fd522359334f94d23ad939efb45cc660e4e0dc31e0578dc5ce0609fbe59fe
-  data.tar.gz: 60e2758cf72fe578a1cd5a8fdf4af895b222761461ea8e26d31de13285d2baba
+  metadata.gz: 9a432159ad7c4d7f287ec97a252c2783e3e3a7c2d67cea054577727b97acfa52
+  data.tar.gz: 710bca4a6fd453a73842b534616f5a8eae79040544ab563f1141e5151f903fde
 SHA512:
-  metadata.gz: b0cf506dbafdafdeb7970cfe60bd4107358c2fb65813c20406c42964dba3266e2098632682aec91f434a6e4a61add553054a3fb50bc37cd40f99e2de572f787d
-  data.tar.gz: 7b7c62fa90a5518de1a1db9b3c38c96f1ad393c89e658b6c1e4b94edff48b1cecc3babe683dd53e1c38ebc3e6d872d303256f7df1692b154232ef49e102846f9
+  metadata.gz: '0486fff69b07ebd63f409b9b8f587622fa6595d279a8cfc657dfbd230016d433fe2b01fd9b6ecef9742067bb9467e79d91d4fea28aecb38dd2601f5d7b114431'
+  data.tar.gz: 99a486c70acb3b5926977555be3515d16dc8ff062661427037b585014024ba929515b8a71d3e2911a7118d9309222a89e10cfbd39a41d0c6c10f5d58c62436a9

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

@@ -129,6 +129,9 @@ object_client.metadata.dublin_core
 # Get the public descriptive XML representation
 object_client.metadata.descriptive
 
+# Get the public XML representation
+object_client.metadata.public_xml
+
 # Update legacy XML representation
 object_client.metadata.legacy_update(
   descriptive: {
@@ -166,10 +169,6 @@ object_client.workspace.create(source: object_path_string)
 object_client.workspace.cleanup
 object_client.workspace.reset
 
-
-# Update embargo
-object_client.embargo.update(embargo_date: date_string, requesting_user: username_string)
-
 # Search for administrative tags:
 Dor::Services::Client.administrative_tags.search(q: 'Project')
 ```

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

@@ -63,6 +63,18 @@ module Dor
           raise_exception_based_on_response!(resp, object_identifier)
         end
 
+        # @return [String, NilClass] The public XML representation of the object or nil if response is 404
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        def public_xml
+          resp = connection.get do |req|
+            req.url "#{base_path}/public_xml"
+          end
+          return resp.body if resp.success?
+          return if resp.status == 404
+
+          raise_exception_based_on_response!(resp, object_identifier)
+        end
+
         # @return [String, NilClass] the dor object's source MODS XML or nil if response is 404
         # @raise [UnexpectedResponse] on an unsuccessful response from the server
         def mods

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

@@ -39,10 +39,6 @@ module Dor
           @version ||= ObjectVersion.new(**parent_params)
         end
 
-        def embargo
-          @embargo ||= Embargo.new(**parent_params)
-        end
-
         def accession(params = {})
           @accession ||= Accession.new(**parent_params.merge(params))
         end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '6.31.0'
+      VERSION = '6.36.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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 6.31.0
+  version: 6.36.0
 platform: ruby
 authors:
 - Justin Coyne
 - Michael Giarlo
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.0
+        version: 0.60.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.0
+        version: 0.60.0
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -205,7 +205,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - jcoyne@justincoyne.com
 - leftwing@alumni.rutgers.edu
@@ -234,7 +234,6 @@ files:
 - lib/dor/services/client/background_job_results.rb
 - lib/dor/services/client/collections.rb
 - lib/dor/services/client/connection_wrapper.rb
-- lib/dor/services/client/embargo.rb
 - lib/dor/services/client/error_faraday_middleware.rb
 - lib/dor/services/client/events.rb
 - lib/dor/services/client/marcxml.rb
@@ -254,7 +253,7 @@ files:
 homepage: https://github.com/sul-dlss/dor-services-client
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -269,8 +268,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A client for dor-services-app
 test_files: []

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

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Services
-    class Client
-      # API calls that are about managing embargo on a repository object
-      class Embargo < 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
-
-        # @param [String] embargo_date The date to update the embargo to (ISO 8601)
-        # @param [String] requesting_user Who is making this change.
-        #
-        # @example
-        #   client.update(embargo_date: '2099-10-20', requesting_user: 'jane')
-        #
-        # @raise [UnexpectedResponse] on an unsuccessful response from the server
-        #
-        # @return [NilClass] when the update is successful
-        def update(embargo_date:, requesting_user:)
-          resp = connection.patch do |req|
-            req.url path
-            req.headers['Content-Type'] = 'application/json'
-            req.body = {
-              embargo_date: embargo_date,
-              requesting_user: requesting_user
-            }.to_json
-          end
-          return if resp.success?
-
-          raise_exception_based_on_response!(resp, object_identifier)
-        end
-
-        private
-
-        attr_reader :object_identifier
-
-        def path
-          "#{api_version}/objects/#{object_identifier}/embargo"
-        end
-      end
-    end
-  end
-end