preservation-client 5.1.1 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c2de24ad9435d7b9ae73d7973f54f2b2f2fd5fdae08d0e2e7e958feec532658
-  data.tar.gz: 5c08e269ef3d3b2f6c4e0d5094dcd563ac474fd9d4631cdf9dfe343b2608c3b9
+  metadata.gz: fecead20f03947d189027e250689d1af848866f889dadfd81f553ee3bb00d07b
+  data.tar.gz: fa4aa6b61ac54291a787e91eef05fa63b4c3fb607a4dbbb8e9f29068194510ee
 SHA512:
-  metadata.gz: 8a7ac074a5e6b1f621a2ed02986e7233f2195fe7bba3eeb7682f201c49bf0006e815a0f7923aa4efe595ae814427c3e2a7e5d897fa4268f8030cacbdc934df56
-  data.tar.gz: 38a734aad0ff248bde114ee4d26dd89c72c5acd7de352f9abee2d2b98a3d8d523801b5cf7c0c65231bc5d59f7a5a7a2d76ffb15a5cca195c6a3e5cdc06bb2861
+  metadata.gz: 2fbb241aa2b6422213de3b5b54a76c38a96d1c892b901384472087ee684718b269130522931d806536abea3e30b51edc2396c55b6cdbb00d76ce34c7a17c14c7
+  data.tar.gz: '0986527f81fec0dfdad8faefbcfbcc03dde1066b46382ac34babe5dec7da5459733eec8a6c7bf09c79e0f5b8ac291e177749b7a13f2337f2ac0ae81832bbe5f2'

data/.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2.1
 orbs:
-  ruby-rails: sul-dlss/ruby-rails@3.1.2
+  ruby-rails: sul-dlss/ruby-rails@3.2.0
 workflows:
   build:
     jobs:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    preservation-client (5.1.1)
+    preservation-client (5.3.0)
       activesupport (>= 4.2, < 8)
       faraday (~> 2.0)
       moab-versioning (>= 5.0.0, < 7)
@@ -36,14 +36,14 @@ GEM
     json (2.6.3)
     method_source (1.0.0)
     minitest (5.17.0)
-    moab-versioning (5.2.0)
+    moab-versioning (6.1.0)
       druid-tools (>= 1.0.0)
       json
       nokogiri
       nokogiri-happymapper
-    nokogiri (1.14.0-x86_64-darwin)
+    nokogiri (1.14.1-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.14.0-x86_64-linux)
+    nokogiri (1.14.1-x86_64-linux)
       racc (~> 1.4)
     nokogiri-happymapper (0.9.0)
       nokogiri (~> 1.5)
@@ -66,7 +66,7 @@ GEM
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
+    rspec-core (3.12.1)
       rspec-support (~> 3.12.0)
     rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -75,7 +75,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.43.0)
+    rubocop (1.44.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -102,7 +102,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
     webmock (3.18.1)
@@ -113,6 +113,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-darwin-20
   x86_64-linux
 
 DEPENDENCIES
@@ -128,4 +129,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.3.26
+   2.4.6

data/lib/preservation/client/version.rb

@@ -2,6 +2,6 @@
 
 module Preservation
   class Client
-    VERSION = '5.1.1'
+    VERSION = '5.3.0'
   end
 end

data/lib/preservation/client/versioned_api_service.rb

@@ -95,8 +95,19 @@ module Preservation
       rescue Faraday::Error => e
         errmsg = "Preservation::Client.#{caller_locations.first.label} " \
                  "got #{e.response[:status]} from Preservation at #{req_url}: #{e.response[:body]}"
-        exception_class = e.response[:status] == 423 ? LockedError : UnexpectedResponseError
-        raise exception_class, errmsg
+        raise http_exception_class(e.response[:status]), errmsg
+      end
+
+      # @param status_code [Integer] the HTTP status code to translate to an exception class
+      def http_exception_class(status_code)
+        case status_code
+        when 423
+          LockedError
+        when 409
+          ConflictError
+        else
+          UnexpectedResponseError
+        end
       end
     end
   end

data/lib/preservation/client.rb

@@ -23,6 +23,9 @@ module Preservation
     # Error raised when server returns 423 Locked
     class LockedError < Error; end
 
+    # Error raised when server returns 409 Conflict
+    class ConflictError < Error; end
+
     # Error raised when server returns an unexpected response
     # e.g., 4xx or 5xx status not otherwise handled
     class UnexpectedResponseError < Error; end
@@ -32,6 +35,7 @@ module Preservation
     class ConnectionFailedError < Error; end
 
     DEFAULT_API_VERSION = 'v1'
+    DEFAULT_TIMEOUT = 300
     TOKEN_HEADER = 'Authorization'
 
     include Singleton
@@ -47,11 +51,13 @@ module Preservation
     end
 
     class << self
-      # @param [String] url
+      # @param [String] url the endpoint URL
       # @param [String] token a bearer token for HTTP authentication
-      def configure(url:, token:)
+      # @param [Integer] read_timeout the value in seconds of the read timeout
+      def configure(url:, token:, read_timeout: DEFAULT_TIMEOUT)
         instance.url = url
         instance.token = token
+        instance.read_timeout = read_timeout
 
         # Force connection to be re-established when `.configure` is called
         instance.connection = nil
@@ -62,7 +68,7 @@ module Preservation
       delegate :objects, :update, to: :instance
     end
 
-    attr_writer :url, :connection, :token
+    attr_writer :connection, :read_timeout, :token, :url
 
     delegate :update, to: :catalog
 
@@ -76,8 +82,12 @@ module Preservation
       @token || raise(Error, 'auth token has not been configured')
     end
 
+    def read_timeout
+      @read_timeout || raise(Error, 'read timeout has not been configured')
+    end
+
     def connection
-      @connection ||= Faraday.new(url, request: { read_timeout: 300 }) do |builder|
+      @connection ||= Faraday.new(url, request: { read_timeout: read_timeout }) do |builder|
         builder.use ErrorFaradayMiddleware
         builder.use Faraday::Request::UrlEncoded
         builder.use Faraday::Response::RaiseError # raise exceptions on 40x, 50x responses

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preservation-client
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 5.3.0
 platform: ruby
 authors:
 - Naomi Dushay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-26 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -255,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.10
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: A thin client for getting info from SDR preservation.