fieldhand 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3beca3a7544bc041d0b89472b73e18ba4c682655
-  data.tar.gz: 33ea99b5627312c8073abda6898f50b30b338907
+  metadata.gz: 67cb8ee7c5ff120c78181ef597a9f2ea46ed4e51
+  data.tar.gz: c83dbeb7abe6832c9e2b65fef55689c195c63805
 SHA512:
-  metadata.gz: ca95ba3dfc8f3ed489edde185c135ec8beb34ba5879fabac66112f5742d63ed1e6ece180711208983882e8ecd636bcd934c3cde7fde8ca502e44ecce502b59d4
-  data.tar.gz: 844fb6b4b2d28b690477fcd58349a67149b2e73a38d2f466f1cde7d70aa8c1e09336cbd5fd048b5f60e905215cc321acbb032451b2c4c6c394807b5235de9e69
+  metadata.gz: b5adbfea0e91229dce93d0e95a4daca0d206cb7746875f956c912e4934170b152e8afd3719ab851190a7f5c57a1b3f852db14b0f73a06aaffda9ad29ca09ad4a
+  data.tar.gz: 667cc59bb4b785d383eeb3314483bc3a05ba66ada5843d27d3998e2d75baf0605ea35de2cc83949bafaf31115a2389b8975bf1523bc66b69ee7b6effb996ba3c

data/README.md

@@ -2,19 +2,19 @@
 
 A Ruby library for harvesting metadata from [OAI-PMH](https://www.openarchives.org/OAI/openarchivesprotocol.html) repositories.
 
-**Current version:** 0.4.0  
+**Current version:** 0.5.0  
 **Supported Ruby versions:** 1.8.7, 1.9.2, 1.9.3, 2.0, 2.1, 2.2
 
 ## Installation
 
 ```
-gem install fieldhand -v '~> 0.4'
+gem install fieldhand -v '~> 0.5'
 ```
 
 Or, in your `Gemfile`:
 
 ```ruby
-gem 'fieldhand', '~> 0.4'
+gem 'fieldhand', '~> 0.5'
 ```
 
 ## Usage
@@ -88,7 +88,8 @@ repository.get('oai:www.example.com:12345')
   * [`#sets`](#fieldhandheadersets)
   * [`#response_date`](#fieldhandheaderresponse_date)
 * [`Fieldhand::NetworkError`](#fieldhandnetworkerror)
-  * [`Fieldhand::NetworkError#response`](#fieldhandnetworkerrorresponse)
+  * [`Fieldhand::ResponseError`](#fieldhandresponseerror)
+    * [`Fieldhand::ResponseError#response`](#fieldhandresponseerrorresponse)
 * [`Fieldhand::ProtocolError`](#fieldhandprotocolerror)
   * [`Fieldhand::BadArgumentError`](#fieldhandbadargumenterror)
   * [`Fieldhand::BadResumptionTokenError`](#fieldhandbadresumptiontokenerror)
@@ -537,19 +538,22 @@ Return the time and date that the response was sent.
 
 ### `Fieldhand::NetworkError`
 
-An error (descended from `StandardError`) to represent any network issues encountered during interaction with the repository.  
+An error (descended from `StandardError`) to represent any network issues encountered during interaction with the repository. Any underlying exception is exposed in Ruby 2.1 onwards through [`Exception#cause`](https://ruby-doc.org/core-2.1.0/Exception.html#method-i-cause).
+
+#### `Fieldhand::ResponseError`
+
+An error (descended from `NetworkError`) to represent any issues in the response from the repository.  
 If the HTTP request is not successful (returning a status code other than 200), 
-a `NetworkError` exception will be raised containing the error message and the response object.  
-Any underlying exception is exposed in Ruby 2.1 onwards through [`Exception#cause`](https://ruby-doc.org/core-2.1.0/Exception.html#method-i-cause).
+a `ResponseError` exception will be raised containing the error message and the response object.
 
-#### Fieldhand::NetworkError#response
+##### Fieldhand::ResponseError#response
 
 ```ruby
 begin
   repository.records.each do |record|
     # ...
   end
-rescue Fieldhand::NetworkError => e
+rescue Fieldhand::ResponseError => e
   puts e.response
   #=> #<Net::HTTPServiceUnavailable 503 Service Unavailable readbody=true>
 end

data/lib/fieldhand/network_errors.rb

@@ -0,0 +1,14 @@
+module Fieldhand
+  NetworkError = ::Class.new(::StandardError)
+
+  # Custom exception to handle unexpected HTTP responses
+  class ResponseError < NetworkError
+    attr_reader :response
+
+    def initialize(response)
+      super("Invalid response: #{response.code} #{response.msg}")
+
+      @response = response
+    end
+  end
+end

data/lib/fieldhand/paginator.rb

@@ -1,5 +1,5 @@
 require 'fieldhand/logger'
-require 'fieldhand/network_error'
+require 'fieldhand/network_errors'
 require 'fieldhand/response_parser'
 require 'cgi'
 require 'net/http'
@@ -67,7 +67,10 @@ module Fieldhand
     private
 
     def parse_response(query = {})
-      response_parser = ResponseParser.new(request(query))
+      response = request(query)
+      raise ResponseError, response unless response.is_a?(::Net::HTTPSuccess)
+
+      response_parser = ResponseParser.new(response.body)
       response_parser.errors.each do |error|
         raise error
       end
@@ -80,14 +83,10 @@ module Fieldhand
       request_uri.query = encode_query(query)
 
       logger.info('Fieldhand') { "GET #{request_uri}" }
-      res = http.get(request_uri.request_uri)
-      raise NetworkError.new("Invalid response: #{res.code} #{res.msg}", res) unless res.is_a?(::Net::HTTPSuccess)
-
-      res.body
+      http.get(request_uri.request_uri)
     rescue ::Timeout::Error => e
       raise NetworkError, "timeout requesting #{query}: #{e}"
     rescue => e
-      raise e if e.is_a?(NetworkError)
       raise NetworkError, "error requesting #{query}: #{e}"
     end
 

data/spec/fieldhand/paginator_spec.rb

@@ -84,6 +84,30 @@ module Fieldhand
         expect { paginator.items('ListSets', ListSetsParser).first }.
           to raise_error(NoSetHierarchyError)
       end
+
+      it 'raises a Response Error if an unsuccessful response is returned' do
+        stub_request(:get, 'http://www.example.com/oai?verb=Identify').
+          to_return(:status => 503, :body => 'Retry after 5 seconds')
+        paginator = described_class.new('http://www.example.com/oai')
+
+        expect { paginator.items('Identify', IdentifyParser).first }.
+          to raise_error(ResponseError)
+      end
+
+      it 'raises a Response Error containing a response object' do
+        stub_request(:get, 'http://www.example.com/oai?verb=Identify').
+          to_return(:status => 503, :body => 'Retry after 5 seconds')
+        paginator = described_class.new('http://www.example.com/oai')
+        error = nil
+
+        begin
+          paginator.items('Identify', IdentifyParser).first
+        rescue => e
+          error = e
+        end
+
+        expect(error.response.body).to eq('Retry after 5 seconds')
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fieldhand
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Paul Mucur
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-10 00:00:00.000000000 Z
+date: 2017-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -101,7 +101,7 @@ files:
 - lib/fieldhand/list_sets_parser.rb
 - lib/fieldhand/logger.rb
 - lib/fieldhand/metadata_format.rb
-- lib/fieldhand/network_error.rb
+- lib/fieldhand/network_errors.rb
 - lib/fieldhand/paginator.rb
 - lib/fieldhand/record.rb
 - lib/fieldhand/repository.rb

data/lib/fieldhand/network_error.rb

@@ -1,11 +0,0 @@
-module Fieldhand
-  # Custom exception to handle connection errors and invalid requests
-  class NetworkError < StandardError
-    attr_reader :response
-
-    def initialize(message, response = nil)
-      super(message)
-      @response = response
-    end
-  end
-end