preservation-client 3.2.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 346519c8c530b30507578d91469ffd1f50cf08fe3b6b5f5e46905f35e6d870ab
-  data.tar.gz: 38afa1c113b86737ac3593101b3bfc1133de42bc58398de19250636bbdbefc05
+  metadata.gz: 295c6b5719f6730587b25339215cb69a2a0577c83bb703cc0bc17bb0372b64e3
+  data.tar.gz: 26c60ca8f89488ed4d8e9ee301fb1632727ddb852ddaf4f2db796cf97f0a51f3
 SHA512:
-  metadata.gz: 81c98f1a410de28f6c8bf90dff39c5537670aa4c8ce4625779d21bd8fbbe3c6341a0930f0fc8572a417d6fd1bd5cba4d69586deb402cf8d9d70e695114138306
-  data.tar.gz: 38e22150bc23cf59501893becb24a39c98eb51d8ac12b5acad80f0a8ad108381a6d9cf88a5f1120a32e9388cfc36c0d1e1dfea5c6cf8b3cf42de74e2c6bda5d7
+  metadata.gz: 9d715a4987ea8c1091ba263eed8975feb66ab15e58669011860376a43ce7c80f7bbf771701f4416e9309fe7fb1dfa08e7986c0d7bf556bab939eab419e4c3fae
+  data.tar.gz: 2f27d27f5c0c02b0a9fb18943e5c25228e6e6d0f5ca24e190da9d7de20146f8f80d437f1351f659a627178ea52933c185aea811dcad6eff82586d6977ff6e733

data/lib/preservation/client.rb

@@ -17,13 +17,18 @@ module Preservation
   class Client
     class Error < StandardError; end
 
-    # Error that is raised when the remote server returns a 404 Not Found
+    # Error raised when server returns 404 Not Found
     class NotFoundError < Error; end
 
-    # Error that is raised when the remote server returns some unexpected response
-    # e.g. 4xx or 5xx status
+    # Error raised when server returns 423 Locked
+    class LockedError < Error; end
+
+    # Error raised when server returns an unexpected response
+    # e.g., 4xx or 5xx status not otherwise handled
     class UnexpectedResponseError < Error; end
 
+    # Error raised when Faraday gem fails to connect, e.g., on SSL errors or
+    # timeouts
     class ConnectionFailedError < Error; end
 
     DEFAULT_API_VERSION = 'v1'

data/lib/preservation/client/objects.rb

@@ -75,6 +75,7 @@ module Preservation
       # @param [String] druid - with or without prefix: 'druid:ab123cd4567' or 'ab123cd4567'
       # @return [String] the storage location of the primary moab for the given druid
       # @raise [Preservation::Client::NotFoundError] when druid is not found
+      # @raise [Preservation::Client::LockedError] when druid is in locked state (not available for versioning)
       def primary_moab_location(druid:)
         get("objects/#{druid}/primary_moab_location", {}, on_data: nil)
       end

data/lib/preservation/client/version.rb

@@ -2,6 +2,6 @@
 
 module Preservation
   class Client
-    VERSION = '3.2.1'
+    VERSION = '3.3.0'
   end
 end

data/lib/preservation/client/versioned_api_service.rb

@@ -25,14 +25,14 @@ module Preservation
 
         errmsg = ResponseErrorFormatter
                  .format(response: resp, object_id: object_id, client_method_name: caller_locations.first.label)
-        raise Preservation::Client::UnexpectedResponseError, errmsg
+        raise UnexpectedResponseError, errmsg
       rescue Faraday::ResourceNotFound
         errmsg = "#{object_id} not found in Preservation at #{connection.url_prefix}#{req_url}"
-        raise Preservation::Client::NotFoundError, errmsg
+        raise NotFoundError, errmsg
       rescue Faraday::Error => e
         errmsg = "Preservation::Client.#{caller_locations.first.label} for #{object_id} " \
           "got #{e.response[:status]} from Preservation at #{req_url}: #{e.response[:body]}"
-        raise Preservation::Client::UnexpectedResponseError, errmsg
+        raise UnexpectedResponseError, errmsg
       end
 
       # @param path [String] path to be appended to connection url (no leading slash)
@@ -83,18 +83,20 @@ module Preservation
             request_json = params.to_json if params&.any?
             connection.public_send(method, req_url, request_json, 'Content-Type' => 'application/json')
           end
+
         return resp.body if resp.success?
 
         errmsg = ResponseErrorFormatter.format(response: resp, client_method_name: caller_locations.first.label)
-        raise Preservation::Client::UnexpectedResponseError, errmsg
+        raise UnexpectedResponseError, errmsg
       rescue Faraday::ResourceNotFound => e
         errmsg = "Preservation::Client.#{caller_locations.first.label} " \
           "got #{e.response[:status]} from Preservation at #{req_url}: #{e.response[:body]}"
-        raise Preservation::Client::NotFoundError, errmsg
+        raise NotFoundError, errmsg
       rescue Faraday::Error => e
         errmsg = "Preservation::Client.#{caller_locations.first.label} " \
           "got #{e.response[:status]} from Preservation at #{req_url}: #{e.response[:body]}"
-        raise Preservation::Client::UnexpectedResponseError, errmsg
+        exception_class = e.response[:status] == 423 ? LockedError : UnexpectedResponseError
+        raise exception_class, errmsg
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preservation-client
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Naomi Dushay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A thin client for getting info from SDR preservation.