ezid-client 1.9.0 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6de69095537c80864a186b0089180182a74d08b2f6d9caddbab4628133919ef5
-  data.tar.gz: fefce462bfcb82b6297b5af267c3c9fe5bd49808675892634cf00df004ebd488
+  metadata.gz: c9f57cbf5676426140bcb2dfa38ec0e1ba6bf522bb8a248e13adcbb2bd032d19
+  data.tar.gz: 3e7600a7a594330755d76fb8198bb9648b0369a5b50b43a218ecad8d9edce2c8
 SHA512:
-  metadata.gz: 48ccd47fc68d90bcb867aee4a6880b1a9385cca28470611659d970db01e4a714538ff0f79268cbbcb4617ae6970e0a0c4ac9c640f283e1ed9d723d38d1a0d87d
-  data.tar.gz: 697963d59a8dff29f4da1d78c48eb54a2cf500900b56301a2f18f892067ee7624cb8d601aa2d07a91372b8a8f614e114254a8b820e9a9108754cc902fac2e6b8
+  metadata.gz: c1569bd7a22632bb056ec30bfe3d00eaeb68114fda1a8f087b27ce6cc7a31299cd3777acbb176091ab49275ccebaa66c7d3324c2ef87cadc43183fcc3a441b45
+  data.tar.gz: 63efb714e862e2998411957807420405bed66260c39b351dff5ad8383677481419c212c48299c9f0089a1c64fae91c4e7dfd7cefb96943585c04381827ccb67a

data/.github/workflows/ruby.yml

@@ -9,9 +9,9 @@ name: Ruby
 
 on:
   push:
-    branches: [ develop ]
+    branches: [ main ]
   pull_request:
-    branches: [ develop ]
+    branches: [ main ]
 
 jobs:
   test:

data/VERSION

@@ -1 +1 @@
-1.9.0
+1.9.1

data/lib/ezid/configuration.rb

@@ -36,6 +36,11 @@ module Ezid
     # @example "ark:/99999/fk4"
     attr_accessor :default_shoulder
 
+    # Interval in seconds to wait between
+    # retries of failed requests
+    # @see Ezid::Request#execute.
+    attr_accessor :retry_interval
+
     def initialize
       @user             = ENV["EZID_USER"]
       @password         = ENV["EZID_PASSWORD"]
@@ -43,6 +48,7 @@ module Ezid
       @port             = ENV["EZID_PORT"] || PORT
       @timeout          = ENV["EZID_TIMEOUT"] || TIMEOUT
       @default_shoulder = ENV["EZID_DEFAULT_SHOULDER"]
+      @retry_interval = ( ENV["EZID_RETRY_INTERVAL"] || 15 ).to_i
     end
 
     def inspect

data/lib/ezid/requests/request.rb

@@ -54,7 +54,7 @@ module Ezid
         response_class.new(get_response_for_request)
       rescue Net::HTTPServerException, UnexpectedResponseError => e
         if retries < 2
-          sleep 15
+          sleep client.config.retry_interval
           retries += 1
           retry
         else

data/lib/ezid/responses/response.rb

@@ -15,12 +15,9 @@ module Ezid
     ERROR = "error".freeze
 
     def initialize(http_response)
-      super
+      http_response.value # raises Net::HTTPServerException
 
-      unless __getobj__.code =~ /2\d\d/
-        raise Error, "HTTP response error: %s %s" %
-                     [ __getobj__.code, __getobj__.message ]
-      end
+      super
 
       unless status_line =~ /^(#{SUCCESS}|#{ERROR}): /
         raise UnexpectedResponseError, __getobj__.body

data/lib/ezid/test_helper.rb

@@ -19,6 +19,7 @@ module Ezid
         config.port     = ENV["EZID_TEST_PORT"] || TEST_PORT
         config.logger   = Logger.new(File::NULL)
         config.default_shoulder = ENV["EZID_TEST_SHOULDER"] || TEST_SHOULDER
+        config.retry_interval = 1
       end
     end
 

data/spec/unit/client_spec.rb

@@ -1,15 +1,11 @@
 module Ezid
   RSpec.describe Client do
 
-    let(:http_response) { double }
-
-    before do
-      allow(http_response).to receive(:value) { nil }
-      allow(http_response).to receive(:code) { '200' }
-    end
+    let(:http_response) { double(value: value, body: body) }
+    let(:value)   { nil }
+    let(:body)    { '' }
 
     describe "initialization without a block" do
-      let(:http_response) { double }
       it "should not login" do
         expect_any_instance_of(described_class).not_to receive(:login)
         described_class.new
@@ -18,12 +14,14 @@ module Ezid
 
     describe "#create_identifier" do
       let(:id) { "ark:/99999/fk4fn19h88" }
-      let(:http_response) { double(body: "success: ark:/99999/fk4fn19h88") }
+      let(:body) { "success: ark:/99999/fk4fn19h88" }
       let(:stub_response) { CreateIdentifierResponse.new(http_response) }
+
       before do
         allow(CreateIdentifierRequest).to receive(:execute).with(subject, id, nil) { stub_response }
       end
-      it "should be a success" do
+
+      it "is a success" do
         response = subject.create_identifier(id)
         expect(response).to be_success
         expect(response.id).to eq(id)
@@ -32,19 +30,22 @@ module Ezid
 
     describe "#mint_identifier" do
       let(:stub_response) { MintIdentifierResponse.new(http_response) }
+
       before do
         allow(MintIdentifierRequest).to receive(:execute).with(subject, TEST_ARK_SHOULDER, nil) { stub_response }
       end
+
       describe "which is an ARK" do
-        let(:http_response) { double(body: "success: ark:/99999/fk4fn19h88") }
+        let(:body) { "success: ark:/99999/fk4fn19h88" }
         it "should be a success" do
           response = subject.mint_identifier(TEST_ARK_SHOULDER)
           expect(response).to be_success
           expect(response.id).to eq("ark:/99999/fk4fn19h88")
         end
       end
+
       describe "which is a DOI" do
-        let(:http_response) { double(body: "success: doi:10.5072/FK2TEST | ark:/99999/fk4fn19h88") }
+        let(:body) { "success: doi:10.5072/FK2TEST | ark:/99999/fk4fn19h88" }
         let(:metadata) do
           <<-EOS
 datacite.title: Test
@@ -54,31 +55,38 @@ datacite.publicationyear: 2014
 datacite.resourcetype: Other
 EOS
         end
+
         before do
           allow(MintIdentifierRequest).to receive(:execute).with(subject, TEST_DOI_SHOULDER, metadata) { stub_response }
         end
-        it "should be a sucess" do
+
+        it "is a success" do
           response = subject.mint_identifier(TEST_DOI_SHOULDER, metadata)
           expect(response).to be_success
           expect(response.id).to eq("doi:10.5072/FK2TEST")
           expect(response.shadow_ark).to eq("ark:/99999/fk4fn19h88")
         end
       end
+
       describe "when a shoulder is not given" do
-        let(:http_response) { double(body: "success: ark:/99999/fk4fn19h88") }
+        let(:body) { "success: ark:/99999/fk4fn19h88" }
+
         context "and the :default_shoulder config option is set" do
           before do
             allow(MintIdentifierRequest).to receive(:execute).with(subject, TEST_ARK_SHOULDER, nil) { stub_response }
             allow(Client.config).to receive(:default_shoulder) { TEST_ARK_SHOULDER }
           end
-          it "should use the default shoulder" do
+
+          it "uses the default shoulder" do
             response = subject.mint_identifier
             expect(response).to be_success
           end
         end
+
         context "and the :default_shoulder config option is not set" do
           before { allow(Client.config).to receive(:default_shoulder) { nil } }
-          it "should raise an exception" do
+
+          it "raises an exception" do
             expect { subject.mint_identifier }.to raise_error(Error)
           end
         end
@@ -87,8 +95,8 @@ EOS
 
     describe "#get_identifier_metadata" do
       let(:id) { "ark:/99999/fk4fn19h88" }
-      let(:http_response) do
-        double(body: <<-EOS
+      let(:body) do
+        <<-EOS
 success: ark:/99999/fk4fn19h88
 _updated: 1416507086
 _target: http://ezid.cdlib.org/id/ark:/99999/fk4fn19h88
@@ -99,13 +107,15 @@ _export: yes
 _created: 1416507086
 _status: public
 EOS
-                                     )
+
       end
       let(:stub_response) { GetIdentifierMetadataResponse.new(http_response) }
+
       before do
         allow(GetIdentifierMetadataRequest).to receive(:execute).with(subject, id) { stub_response }
       end
-      it "should retrieve the metadata" do
+
+      it "retrieves the metadata" do
         response = subject.get_identifier_metadata(id)
         expect(response).to be_success
         expect(response.metadata).to eq <<-EOS
@@ -123,18 +133,20 @@ EOS
 
     describe "server status" do
       let(:stub_response) { ServerStatusResponse.new(http_response) }
-      let(:http_response) do
-        double(body: <<-EOS
+      let(:body) do
+        <<-EOS
 success: EZID is up
 noid: up
 ldap: up
 EOS
-               )
+
       end
+
       before do
         allow(ServerStatusRequest).to receive(:execute).with(subject, "*") { stub_response }
       end
-      it "should report the status of EZID and subsystems" do
+
+      it "reports the status of EZID and subsystems" do
         response = subject.server_status("*")
         expect(response).to be_success
         expect(response).to be_up
@@ -147,11 +159,13 @@ EOS
 
     describe "batch download" do
       let(:stub_response) { BatchDownloadResponse.new(http_response) }
-      let(:http_response) { double(body: "success: http://ezid.cdlib.org/download/da543b91a0.xml.gz") }
+      let(:body) { "success: http://ezid.cdlib.org/download/da543b91a0.xml.gz" }
+
       before do
         allow(BatchDownloadRequest).to receive(:execute).with(subject, format: "xml") { stub_response }
       end
-      it "should return the URL to download the batch" do
+
+      it "returns the URL to download the batch" do
         response = subject.batch_download(format: "xml")
         expect(response).to be_success
         expect(response.download_url).to eq("http://ezid.cdlib.org/download/da543b91a0.xml.gz")
@@ -160,33 +174,78 @@ EOS
 
     describe "error handling" do
       let(:stub_response) { GetIdentifierMetadataResponse.new(http_response) }
+
       before do
         allow(GetIdentifierMetadataRequest).to receive(:execute).with(subject, "invalid") { stub_response }
       end
 
       describe "HTTP error response" do
         before do
-          allow(http_response).to receive(:code) { '500' }
-          allow(http_response).to receive(:message) { 'Internal Server Error' }
+          allow(http_response).to receive(:value).and_raise(Net::HTTPServerException.new('Barf!', double))
         end
-        it "should raise an exception" do
-          expect { subject.get_identifier_metadata("invalid") }.to raise_error(Error)
+
+        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(:http_response) { double(body: "error: bad request - no such identifier") }
-        it "should raise an exception" do
+        let(:body) { "error: bad request - no such identifier" }
+
+        it "raises an exception" do
           expect { subject.get_identifier_metadata("invalid") }.to raise_error(Error)
         end
       end
 
-      describe "Unexpected response" do
-        let(:http_response) { double(body: "<html>\n<head><title>Ouch!</title></head>\n<body>Help!</body>\n</html>") }
-        it "should raise an exception" do
+      describe "Unexpected response (body)" do
+        let(:body) do
+          <<-EOS
+<html>
+  <head>
+    <title>Ouch!</title>
+  </head>
+  <body>
+    Help!
+  </body>
+</html>
+EOS
+
+        end
+
+        it "raises an exception" do
           expect { subject.get_identifier_metadata("invalid") }.to raise_error(UnexpectedResponseError)
         end
       end
     end
+
+    describe "retrying on certain errors" do
+      before do
+        allow(GetIdentifierMetadataResponse).to receive(:new).and_raise(exception)
+      end
+
+      describe "HTTP error" do
+        let(:exception) { Net::HTTPServerException.new('Barf!', double) }
+
+        it "retries twice" do
+          begin
+            subject.get_identifier_metadata("invalid")
+          rescue Exception => _
+          end
+          expect(GetIdentifierMetadataResponse).to have_received(:new).exactly(3).times
+        end
+      end
+
+      describe "Unexpected response" do
+        let(:exception) { UnexpectedResponseError.new("HTML?!") }
+
+        it "retries twice" do
+          begin
+            subject.get_identifier_metadata("invalid")
+          rescue Exception => _
+          end
+          expect(GetIdentifierMetadataResponse).to have_received(:new).exactly(3).times
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezid-client
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.9.1
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-09 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie