fieldhand 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbb2e358fe735e190c98cdbb891d1e061ac9c94a
-  data.tar.gz: 64d94a760f881779790518e59a9508a1678d2be2
+  metadata.gz: 3beca3a7544bc041d0b89472b73e18ba4c682655
+  data.tar.gz: 33ea99b5627312c8073abda6898f50b30b338907
 SHA512:
-  metadata.gz: 59ba22ea64add43e36fa2dab85230818515950ca78ddaa4e9db6fb322de59b9b59ecf7ae4fcbdc3cf85f177ebc084773bfaf96f86da15e5843b148296e529de6
-  data.tar.gz: 114f1acb87901c6935dea29b9b03e7d115ca937486f069ef4af939a1f3a39592fe4a9d9abb50557ac7ff8ac9f27676f6b7cfb619a79cb9313aeb82f6b46e73ec
+  metadata.gz: ca95ba3dfc8f3ed489edde185c135ec8beb34ba5879fabac66112f5742d63ed1e6ece180711208983882e8ecd636bcd934c3cde7fde8ca502e44ecce502b59d4
+  data.tar.gz: 844fb6b4b2d28b690477fcd58349a67149b2e73a38d2f466f1cde7d70aa8c1e09336cbd5fd048b5f60e905215cc321acbb032451b2c4c6c394807b5235de9e69

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.3.1  
+**Current version:** 0.4.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.3'
+gem install fieldhand -v '~> 0.4'
 ```
 
 Or, in your `Gemfile`:
 
 ```ruby
-gem 'fieldhand', '~> 0.3'
+gem 'fieldhand', '~> 0.4'
 ```
 
 ## Usage
@@ -88,6 +88,7 @@ repository.get('oai:www.example.com:12345')
   * [`#sets`](#fieldhandheadersets)
   * [`#response_date`](#fieldhandheaderresponse_date)
 * [`Fieldhand::NetworkError`](#fieldhandnetworkerror)
+  * [`Fieldhand::NetworkError#response`](#fieldhandnetworkerrorresponse)
 * [`Fieldhand::ProtocolError`](#fieldhandprotocolerror)
   * [`Fieldhand::BadArgumentError`](#fieldhandbadargumenterror)
   * [`Fieldhand::BadResumptionTokenError`](#fieldhandbadresumptiontokenerror)
@@ -536,7 +537,25 @@ 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. 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).
+An error (descended from `StandardError`) to represent any network issues encountered during interaction with 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).
+
+#### Fieldhand::NetworkError#response
+
+```ruby
+begin
+  repository.records.each do |record|
+    # ...
+  end
+rescue Fieldhand::NetworkError => e
+  puts e.response
+  #=> #<Net::HTTPServiceUnavailable 503 Service Unavailable readbody=true>
+end
+```
+
+Returns the unsuccessful `Net::HTTPResponse` that caused this error or `nil` if no response was available.
 
 ### `Fieldhand::ProtocolError`
 

data/lib/fieldhand/network_error.rb

@@ -0,0 +1,11 @@
+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

data/lib/fieldhand/paginator.rb

@@ -1,12 +1,11 @@
 require 'fieldhand/logger'
+require 'fieldhand/network_error'
 require 'fieldhand/response_parser'
 require 'cgi'
 require 'net/http'
 require 'uri'
 
 module Fieldhand
-  NetworkError = ::Class.new(::StandardError)
-
   # An abstraction over interactions with an OAI-PMH repository, handling requests, responses and paginating over
   # results using a resumption token.
   #
@@ -81,10 +80,14 @@ module Fieldhand
       request_uri.query = encode_query(query)
 
       logger.info('Fieldhand') { "GET #{request_uri}" }
-      http.get(request_uri.request_uri).body
+      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
     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
 

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: fieldhand
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Paul Mucur
 - Maciej Gajewski
+- Giovanni Derks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2017-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -100,6 +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/paginator.rb
 - lib/fieldhand/record.rb
 - lib/fieldhand/repository.rb