ezid-client 1.9.3 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4923cc603a7be145dec5b0cef9680ebefb24914a1edbc7b4cce1e49bbb20a6cc
-  data.tar.gz: 29e09adc2fa5b7444600ad0174267b673c98b67d32dbae9d4e88eb3fe140cb54
+  metadata.gz: '0238bbb49530de30773410dba606a4db95117b344d452bbab62e986e06a29df8'
+  data.tar.gz: 8d846a6821058d66a956635d8b1863a345f086b1586716aa0fb38e71518ca90f
 SHA512:
-  metadata.gz: df3e067372950e605a4e42c85a808b9f4d4d925884fb177c1ef13fed584bf7579b9e54ad1053160e1959f549f5271a297d6dec8bba36b398b6ca0fa58ff53b93
-  data.tar.gz: 8727ff8bb484708a3c2f8552e1208d8f664ce559718b04d0dac65226e95387eb0343fe4bc50483919851827d221c9c3e94ca6fa470f4e1bf8c7bc3b09e8342dc
+  metadata.gz: 8d37ad9714ab1403568642178f805b6b73e3c0c93df42e3202a262e35db3ad32522caa9aa4b53cc69924dc5732a798b606634b1d6a6c8cf8f25b40d28813fb9c
+  data.tar.gz: 536501b2cf78dbd6c276a8c010257df7ef1ad442786f4297d32c92191de17f92f165ca6ad9ae95fef606147f6791453ffbf3aa6fb584eb0e33bb647ab486339d

data/.dockerignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+.config
+.dockerignore
+.git
+.github
+.gitignore
+Dockerfile
+Gemfile.lock

data/.github/workflows/ruby.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
 
     steps:
     - uses: actions/checkout@v2

data/Dockerfile

@@ -0,0 +1,13 @@
+ARG ruby_version="latest"
+
+FROM ruby:${ruby_version}
+
+SHELL ["/bin/bash", "-c"]
+
+WORKDIR /app
+
+COPY VERSION Gemfile ezid-client.gemspec ./
+
+RUN gem install bundler -v '~>2.0' && bundle install
+
+COPY . .

data/README.md

@@ -128,20 +128,20 @@ See http://ezid.cdlib.org/doc/apidoc.html#parameters. Repeated values should be
 ```
 >> batch_download = Ezid::BatchDownload.new(:csv)
  => #<Ezid::BatchDownload format=:csv>
- 
+
 >> batch_download.column = ["_id", "_target"]
  => ["_id", "_target"]
- 
+
 >> batch_download.createdAfter = Date.today.to_time
  => 2016-02-24 00:00:00 -0500
- 
+
 >> batch_download
  => #<Ezid::BatchDownload column=["_id", "_target"] createdAfter=1456290000 format=:csv>
- 
+
 >> batch_download.url
 I, [2016-02-24T18:03:40.828005 #1084]  INFO -- : EZID BatchDownload -- success: http://ezid.cdlib.org/download/4a63401e17.csv.gz
  => "http://ezid.cdlib.org/download/4a63401e17.csv.gz"
- 
+
 >> batch_download.file
  => /current/working/directory/4a63401e17.csv.gz
  ```
@@ -155,13 +155,13 @@ I, [2016-02-24T18:03:40.828005 #1084]  INFO -- : EZID BatchDownload -- success:
 ```
 >> require 'ezid/batch'
  => true
- 
+
 >> batch = Ezid::Batch.new(:anvl, "spec/fixtures/anvl_batch.txt")
  => #<Ezid::Batch:0x007f87a8900308 @format=:anvl, @batch_file="spec/fixtures/anvl_batch.txt">
- 
+
 >> id = batch.first
  => #<Ezid::Identifier id=ark:/99999/fk4086hs23>
- 
+
 >> id.target
  => "http://example.com"
 
@@ -318,6 +318,15 @@ See http://ezid.cdlib.org/doc/apidoc.html#testing-the-api.
 
 In order to run the integration tests successfully, you must supply the password for the test account "apitest" (contact EZID).  To run the test suite without the integration tests, use the `rake ci` task.
 
+## Dockerfile
+
+A basic Dockerfile is provided based on Docker official Ruby image tags.
+
+An example building an image with the latest Ruby and running the unit tests:
+
+    $ docker build -t ezid-client .
+    $ docker run --rm -it ezid-client bundle exec rspec ./spec/unit/
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/ezid-client/fork )

data/VERSION

@@ -1 +1 @@
-1.9.3
+1.10.0

data/lib/ezid/error.rb

@@ -10,4 +10,6 @@ module Ezid
   class DeletionError < Error; end
 
   class UnexpectedResponseError < Error; end
+
+  class ServerError < Error; end
 end

data/lib/ezid/requests/request.rb

@@ -22,6 +22,10 @@ module Ezid
     POST = Net::HTTP::Post
     DELETE = Net::HTTP::Delete
 
+    RETRIABLE_SERVER_ERRORS = %w[500 502 503 504].freeze
+
+    RETRIES = ENV.fetch('EZID_REQUEST_RETRIES', '2').to_i
+
     class << self
       attr_accessor :http_method, :path, :response_class
 
@@ -37,7 +41,7 @@ module Ezid
     end
 
     attr_reader :client
-    def_delegators :client, :connection, :user, :password, :session
+    def_delegators :client, :connection, :user, :password, :session, :logger, :config
 
     # @param client [Ezid::Client] the client
     def initialize(client, *args)
@@ -50,12 +54,24 @@ module Ezid
     # @return [Ezid::Response] the response
     def execute
       retries = 0
+
       begin
-        response_class.new(get_response_for_request)
-      rescue Net::HTTPServerException, UnexpectedResponseError => e
-        if retries < 2
-          sleep client.config.retry_interval
+        http_response = get_response_for_request
+
+        if RETRIABLE_SERVER_ERRORS.include? http_response.code
+          raise ServerError, "#{http_response.code} #{http_response.msg}"
+        end
+
+        response_class.new(http_response)
+
+      rescue ServerError, UnexpectedResponseError => e
+        if retries < RETRIES
+          logger.error "EZID error: #{e}"
+
           retries += 1
+          logger.info "Retry (#{retries} of #{RETRIES}) of #{short_name} #{path} in #{config.retry_interval} seconds ..."
+          sleep config.retry_interval
+
           retry
         else
           raise
@@ -85,6 +101,10 @@ module Ezid
     # @return [String] the query string
     def query; end
 
+    def short_name
+      self.class.short_name
+    end
+
     def authentication_required?
       true
     end

data/lib/ezid/responses/response.rb

@@ -15,8 +15,6 @@ module Ezid
     ERROR = "error".freeze
 
     def initialize(http_response)
-      http_response.value # raises Net::HTTPServerException
-
       super
 
       unless status_line =~ /^(#{SUCCESS}|#{ERROR}): /

data/spec/unit/client_spec.rb

@@ -179,16 +179,6 @@ EOS
         allow(GetIdentifierMetadataRequest).to receive(:execute).with(subject, "invalid") { stub_response }
       end
 
-      describe "HTTP error response" do
-        before do
-          allow(http_response).to receive(:value).and_raise(Net::HTTPServerException.new('Barf!', double))
-        end
-
-        it "raises an exception" do
-          expect { subject.get_identifier_metadata("invalid") }.to raise_error(Net::HTTPServerException)
-        end
-      end
-
       describe "EZID API error response" do
         let(:body) { "error: bad request - no such identifier" }
 
@@ -220,11 +210,12 @@ EOS
 
     describe "retrying on certain errors" do
       before do
+        allow(subject.config).to receive(:retry_interval) { 1 }
         allow(GetIdentifierMetadataResponse).to receive(:new).and_raise(exception)
       end
 
-      describe "HTTP error" do
-        let(:exception) { Net::HTTPServerException.new('Barf!', double) }
+      describe "retriable server error" do
+        let(:exception) { ServerError.new('502 Bad Gateway') }
 
         it "retries twice" do
           begin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezid-client
 version: !ruby/object:Gem::Version
-  version: 1.9.3
+  version: 1.10.0
 platform: ruby
 authors:
 - David Chandek-Stark
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -121,9 +121,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -185,7 +187,7 @@ homepage: https://github.com/duke-libraries/ezid-client
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -200,8 +202,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.5.6
+signing_key:
 specification_version: 4
 summary: Ruby client for EZID API Version 2
 test_files: