dor-services-client 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6338147f1bdeea6d2fb56ae0660572d3392c2e44593966a8bfabdcd8beff1a8
-  data.tar.gz: fef44c433121a01e04d35525070b06c3c57a8ed0cce512c33bc6166e079eb9f2
+  metadata.gz: 98ce334358d0f3233121f562d96610339aa762e7758d3805a78fce94af96ae15
+  data.tar.gz: 72ca530a50cb19d8f37c9923942bcc222b4a19367ce760c638e1c9635adafbfa
 SHA512:
-  metadata.gz: 72bd89f9b543f4454218b6df062e28ee2adeab2059909e4c720c70b6a88697f6a0904baa9da585bb074ddcbc4ad7f0d7605072ae39d3a1cc8f23abd560a8fd74
-  data.tar.gz: c70e8a9dbbd29e597513073d966af7d3a602b535cd95ce1f36d91d50d5961c6ef09bc40a1d799e82a3e81245d53720bd2dcad565b080374592139a7d39cb14ba
+  metadata.gz: 689c2c25b4409e7a84cd9dfe5ac956027e1c41acfd95abc6643da2f97256b714a89d48699a0a85f683eb01811c5b8f9a3f65e1a6dd9c75417213f77362562397
+  data.tar.gz: d40443664b067ce06f4050695746fc9e6f8099d756b3c9c664699b1474e61253169a31701bd54565c95aa5ead3c4463f8ee10b57ac816dcb913b06696eaf3c5f

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

@@ -11,7 +11,8 @@ module Dor
           @object_identifier = object_identifier
         end
 
-        # @return [String] The Dublin Core XML representation of the object
+        # @return [String, NilClass] The Dublin Core XML representation of the object or nil if response is 404
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
         def dublin_core
           resp = connection.get do |req|
             req.url "#{base_path}/dublin_core"
@@ -19,10 +20,11 @@ module Dor
           return resp.body if resp.success?
           return if resp.status == 404
 
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body}) for #{object_identifier}"
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp, object_identifier: object_identifier)
         end
 
-        # @return [String] The descriptive metadata XML representation of the object
+        # @return [String, NilClass] The descriptive metadata XML representation of the object or nil if response is 404
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
         def descriptive
           resp = connection.get do |req|
             req.url "#{base_path}/descriptive"
@@ -30,7 +32,7 @@ module Dor
           return resp.body if resp.success?
           return if resp.status == 404
 
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body}) for #{object_identifier}"
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp, object_identifier: object_identifier)
         end
 
         private

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

@@ -111,7 +111,7 @@ module Dor
 
         def raise_exception_based_on_response!(response)
           raise (response.status == 404 ? NotFoundResponse : UnexpectedResponse),
-                "#{response.reason_phrase}: #{response.status} (#{response.body})"
+                ResponseErrorFormatter.format(response: response)
         end
       end
     end

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

@@ -87,14 +87,14 @@ module Dor
 
         def raise_exception_based_on_response!(response)
           raise (response.status == 404 ? NotFoundResponse : UnexpectedResponse),
-                "#{response.reason_phrase}: #{response.status} (#{response.body})"
+                ResponseErrorFormatter.format(response: response)
         end
 
         # Make request to server to open a new version
         # @param params [Hash] optional params (see dor-services-app)
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raises [UnexpectedResponse] on an unsuccessful response from the server
-        # @returns [String] the plain text from the server
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        # @return [String] the plain text from the server
         def open_new_version_response(**params)
           resp = connection.post do |req|
             req.url open_new_version_path

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

@@ -16,8 +16,8 @@ module Dor
 
         # make the registration request to the server
         # @param params [Hash] optional params (see dor-services-app)
-        # @raises [UnexpectedResponse] on an unsuccessful response from the server
-        # @returns [String] the raw JSON from the server
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        # @return [String] the raw JSON from the server
         def register_response(params:)
           resp = connection.post do |req|
             req.url "#{api_version}/objects"
@@ -28,7 +28,7 @@ module Dor
           end
           return resp.body if resp.success?
 
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})"
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp)
         end
       end
     end

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

@@ -16,7 +16,7 @@ module Dor
         # @param what [String]
         # @param to [String]
         # @param who [String]
-        # @raises [UnexpectedResponse] if the request is unsuccessful.
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
         # @return [Boolean] true if successful
         # rubocop:disable Metrics/MethodLength
         def create(release:, what:, to:, who:)
@@ -31,7 +31,7 @@ module Dor
             req.headers['Content-Type'] = 'application/json'
             req.body = params.to_json
           end
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp) unless resp.success?
 
           true
         end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # Format HTTP response-related errors
+      class ResponseErrorFormatter
+        DEFAULT_BODY = 'Response from dor-services-app did not contain a body. \
+                        Check honeybadger for dor-services-app for backtraces, \
+                        and look into adding a `rescue_from` in dor-services-app \
+                        to provide more details to the client in the future'
+
+        def self.format(response:, object_identifier: nil)
+          new(response: response, object_identifier: object_identifier).format
+        end
+
+        attr_reader :reason_phrase, :status, :body, :object_identifier
+
+        def initialize(response:, object_identifier: nil)
+          @reason_phrase = response.reason_phrase
+          @status = response.status
+          @body = response.body.present? ? response.body : DEFAULT_BODY
+          @object_identifier = object_identifier
+        end
+
+        def format
+          return "#{reason_phrase}: #{status} (#{body})" if object_identifier.nil?
+
+          "#{reason_phrase}: #{status} (#{body}) for #{object_identifier}"
+        end
+      end
+    end
+  end
+end

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

@@ -34,7 +34,7 @@ module Dor
           resp = signature_catalog_response
 
           return Moab::SignatureCatalog.new(digital_object_id: object_identifier, version_id: 0) if resp.status == 404
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body}) for #{object_identifier}" unless resp.success?
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp, object_identifier: object_identifier) unless resp.success?
 
           Moab::SignatureCatalog.parse resp.body
         end
@@ -54,7 +54,8 @@ module Dor
         end
 
         # @param [String] datastream The identifier of the metadata datastream
-        # @return [String] The datastream contents from the previous version of the digital object (fetched from SDR storage)
+        # @return [String, NilClass] datastream content from previous version of the object (from SDR storage), or nil if response status is 404
+        # @raise [UnexpectedResponse] on an unsuccessful, non-404 response from the server
         def metadata(datastream:)
           resp = connection.get do |req|
             req.url "#{base_path}/metadata/#{datastream}.xml"
@@ -62,7 +63,7 @@ module Dor
           return resp.body if resp.success?
           return if resp.status == 404
 
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body}) for #{object_identifier}"
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp, object_identifier: object_identifier)
         end
 
         private
@@ -76,15 +77,15 @@ module Dor
         end
 
         # make the request to the server for the currentVersion xml
-        # @raises [UnexpectedResponse] on an unsuccessful response from the server
-        # @returns [String] the raw xml from the server
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        # @return [String] the raw xml from the server
         def current_version_response
           resp = connection.get do |req|
             req.url current_version_path
           end
           return resp.body if resp.success?
 
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body}) for #{object_identifier}"
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp, object_identifier: object_identifier)
         end
 
         def current_version_path
@@ -92,15 +93,15 @@ module Dor
         end
 
         # make the request to the server for the content diff
-        # @raises [UnexpectedResponse] on an unsuccessful response from the server
-        # @returns [String] the raw xml from the server
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        # @return [String] the raw xml from the server
         def content_diff_response(current_content:, subset:, version:)
           resp = connection.post do |req|
             req.url content_diff_path(subset: subset, version: version)
             req.headers['Content-Type'] = 'application/xml'
             req.body = current_content
           end
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body}) for #{object_identifier}" unless resp.success?
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp, object_identifier: object_identifier) unless resp.success?
 
           resp.body
         end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '2.3.0'
+      VERSION = '2.4.0'
     end
   end
 end

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

@@ -13,24 +13,24 @@ module Dor
 
         # Initializes a new workspace
         # @param source [String] the path to the object
-        # @raises [UnexpectedResponse] if the request is unsuccessful.
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
         # @return nil
         def create(source:)
           resp = connection.post do |req|
             req.url workspace_path
             req.params['source'] = source
           end
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp) unless resp.success?
         end
 
         # Cleans up a workspace
-        # @raises [UnexpectedResponse] if the request is unsuccessful.
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
         # @return nil
         def cleanup
           resp = connection.delete do |req|
             req.url workspace_path
           end
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp) unless resp.success?
         end
 
         private

data/lib/dor/services/client.rb

@@ -2,6 +2,7 @@
 
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/object/blank'
 require 'faraday'
 require 'singleton'
 require 'zeitwerk'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-22 00:00:00.000000000 Z
+date: 2019-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -185,6 +185,7 @@ files:
 - 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/sdr.rb
 - lib/dor/services/client/version.rb
 - lib/dor/services/client/versioned_service.rb
@@ -208,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A client for dor-services-app