fieldhand 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 52d3d4940c27abdd47bf06f7ad49f46e742a6e92
-  data.tar.gz: 22510d14c27a88f49529a36f6f6e901674073ece
+SHA256:
+  metadata.gz: 48341fcf65a936b5bc42a7f6cdcc9881d2d3f11ef29352a14f0f545f1318b5a0
+  data.tar.gz: 17ce75aba6b336de464b496604aec0bbda5d673ff98d6c8ee1a659b0f75fb425
 SHA512:
-  metadata.gz: bd40718309d4404942fc03fe278121d3bb9bdbba21c0c632fa9e5770fe6b38dbcac55725cb121730ce851ddb03711e98996a00b0746cdc82a6747aa4b8e6708b
-  data.tar.gz: 665247958faacf0cf52fe06884b3642918b1a34185babf4947f527733827a18e7345b5ce273b9297d2cb1ef9791a26e52baa3c7a707e26fa47831f2f8028b6a9
+  metadata.gz: fddd10cde8fc771c259234deadef079468f8a3517174a82e92dd480a29d5ccbbd655dfeb5f1f4fceeda85b1e4d9707ab715ddde8baf6fa2e43fd2fedd6867121
+  data.tar.gz: 9f201592dc6968fdf41c5bd8134c67496f4eed2c89077442474b0491ef83417e170a182da2c1262aaca3d811ad6dd2e756a18e1e8e025a799e4cbd6e1ef2f616

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.7.0  
+**Current version:** 0.8.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.7'
+gem install fieldhand -v '~> 0.8'
 ```
 
 Or, in your `Gemfile`:
 
 ```ruby
-gem 'fieldhand', '~> 0.7'
+gem 'fieldhand', '~> 0.8'
 ```
 
 ## Usage
@@ -43,7 +43,7 @@ repository.get('oai:www.example.com:12345')
 ## API Documentation
 
 * [`Fieldhand::Repository`](#fieldhandrepository)
-  * [`.new(uri[, logger])`](#fieldhandrepositorynewuri-logger)
+  * [`.new(uri[, options])`](#fieldhandrepositorynewuri-options)
   * [`#identify`](#fieldhandrepositoryidentify)
   * [`#metadata_formats([identifier])`](#fieldhandrepositorymetadata_formatsidentifier)
   * [`#sets`](#fieldhandrepositorysets)
@@ -109,19 +109,20 @@ A class to represent [an OAI-PMH repository](https://www.openarchives.org/OAI/op
 > requests [...]. A repository is managed by a data provider to expose metadata
 > to harvesters.
 
-#### `Fieldhand::Repository.new(uri[, logger])`
+#### `Fieldhand::Repository.new(uri[, options])`
 
 ```ruby
 Fieldhand::Repository.new('http://www.example.com/oai')
 Fieldhand::Repository.new(URI('http://www.example.com/oai'))
-Fieldhand::Repository.new('http://www.example.com/oai', Logger.new(STDOUT))
+Fieldhand::Repository.new('http://www.example.com/oai', :logger => Logger.new(STDOUT), :timeout => 10)
 ```
 
 Return a new [`Repository`](#fieldhandrepository) instance accessible at the given `uri` (specified
 either as a [`URI`][URI] or
-something that can be coerced into a `URI` such as a `String`) with an optional
-[`Logger`](http://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html)-compatible
-`logger`.
+something that can be coerced into a `URI` such as a `String`) with two options passed as a `Hash`:
+
+* `:logger`: a [`Logger`](http://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html)-compatible `logger`, defaults to a platform-specific null logger;
+* `:timeout`: a `Numeric` number of seconds to wait before timing out any HTTP requests, defaults to 60.
 
 #### `Fieldhand::Repository#identify`
 

data/lib/fieldhand/options.rb

@@ -0,0 +1,41 @@
+require 'fieldhand/logger'
+
+module Fieldhand
+  # A wrapper around Repository and Paginator options for backward-compatibility.
+  #
+  # In short, this handles passing a Logger directly or passing it and a timeout as a hash.
+  # Note this attempts to preserve the previous behaviour of passing nil/falsey values as a
+  # logger even though this will cause errors if someone tries to use it that way.
+  class Options
+    attr_reader :logger_or_options
+
+    # Return a new, normalized set of options based on the given value.
+    #
+    # This supports both a `Logger`-compatible object to use for logging directly and a hash of options:
+    #
+    # * :logger - A `Logger`-compatible class for logging the activity of the library, defaults to a platform-specific
+    #             null logger
+    # * :timeout - A `Numeric` number of seconds to wait for any HTTP requests, defaults to 60 seconds
+    def initialize(logger_or_options = {})
+      @logger_or_options = logger_or_options
+    end
+
+    # Return the current timeout in seconds.
+    def timeout
+      options.fetch(:timeout, 60)
+    end
+
+    # Return the current logger.
+    def logger
+      options.fetch(:logger) { Logger.null }
+    end
+
+    private
+
+    def options
+      return logger_or_options if logger_or_options.is_a?(Hash)
+
+      { :logger => logger_or_options }
+    end
+  end
+end

data/lib/fieldhand/paginator.rb

@@ -1,5 +1,5 @@
-require 'fieldhand/logger'
 require 'fieldhand/network_errors'
+require 'fieldhand/options'
 require 'fieldhand/response_parser'
 require 'cgi'
 require 'net/http'
@@ -11,17 +11,23 @@ module Fieldhand
   #
   # See https://www.openarchives.org/OAI/openarchivesprotocol.html#FlowControl
   class Paginator
-    attr_reader :uri, :logger, :http
+    attr_reader :uri, :logger, :timeout, :http
 
-    # Return a new paginator for the given repository base URI and optional logger.
+    # Return a new paginator for the given repository base URI and optional logger and timeout.
     #
     # The URI can be passed as either a `URI` or something that can be parsed as a URI such as a string.
     #
-    # The logger will default to a null logger appropriate to this platform.
-    def initialize(uri, logger = Logger.null)
+    # The logger will default to a null logger appropriate to this platform and timeout will default to 60 seconds.
+    def initialize(uri, logger_or_options = {})
       @uri = uri.is_a?(::URI) ? uri : URI(uri)
-      @logger = logger
+
+      options = Options.new(logger_or_options)
+      @logger = options.logger
+      @timeout = options.timeout
+
       @http = ::Net::HTTP.new(@uri.host, @uri.port)
+      @http.read_timeout = @timeout
+      @http.open_timeout = @timeout
       @http.use_ssl = true if @uri.scheme == 'https'
     end
 

data/lib/fieldhand/repository.rb

@@ -5,7 +5,7 @@ require 'fieldhand/list_identifiers_parser'
 require 'fieldhand/list_metadata_formats_parser'
 require 'fieldhand/list_records_parser'
 require 'fieldhand/list_sets_parser'
-require 'fieldhand/logger'
+require 'fieldhand/options'
 require 'fieldhand/paginator'
 require 'uri'
 
@@ -14,16 +14,22 @@ module Fieldhand
   #
   # See https://www.openarchives.org/OAI/openarchivesprotocol.html
   class Repository
-    attr_reader :uri, :logger
+    attr_reader :uri, :logger, :timeout
 
-    # Return a new repository with the given base URL and an optional logger.
+    # Return a new repository with the given base URL and an optional logger and timeout.
     #
     # The base URL can be passed as a `URI` or anything that can be parsed as a URI such as a string.
     #
-    # Defaults to using a null logger specific to this platform.
-    def initialize(uri, logger = Logger.null)
+    # For backward compatibility, the second argument can either be a logger or a hash containing
+    # a logger and timeout.
+    #
+    # Defaults to using a null logger specific to this platform and a timeout of 60 seconds.
+    def initialize(uri, logger_or_options = {})
       @uri = uri.is_a?(::URI) ? uri : URI(uri)
-      @logger = logger
+
+      options = Options.new(logger_or_options)
+      @logger = options.logger
+      @timeout = options.timeout
     end
 
     # Send an Identify request to the repository and return an `Identify` response.
@@ -127,7 +133,7 @@ module Fieldhand
     private
 
     def paginator
-      @paginator ||= Paginator.new(uri, logger)
+      @paginator ||= Paginator.new(uri, :logger => logger, :timeout => timeout)
     end
   end
 end

data/spec/fieldhand/options_spec.rb

@@ -0,0 +1,59 @@
+require 'fieldhand/options'
+
+module Fieldhand
+  RSpec.describe Options do
+    describe '#timeout' do
+      it 'defaults to 60 seconds' do
+        options = described_class.new({})
+
+        expect(options.timeout).to eq(60)
+      end
+
+      it 'can be overridden by passing an option' do
+        options = described_class.new(:timeout => 10)
+
+        expect(options.timeout).to eq(10)
+      end
+
+      it 'can be set to nil' do
+        options = described_class.new(:timeout => nil)
+
+        expect(options.timeout).to be_nil
+      end
+    end
+
+    describe '#logger' do
+      it 'defaults to a null logger' do
+        options = described_class.new({})
+
+        expect(options.logger).to be_a(::Logger)
+      end
+
+      it 'can be overridden by passing a logger directly' do
+        logger = ::Logger.new(STDOUT)
+        options = described_class.new(logger)
+
+        expect(options.logger).to eq(logger)
+      end
+
+      it 'can be overridden by passing a logger in an option' do
+        logger = ::Logger.new(STDOUT)
+        options = described_class.new(:logger => logger)
+
+        expect(options.logger).to eq(logger)
+      end
+
+      it 'can be set to nil directly' do
+        options = described_class.new(nil)
+
+        expect(options.logger).to be_nil
+      end
+
+      it 'can be set to nil through an option' do
+        options = described_class.new(:logger => nil)
+
+        expect(options.logger).to be_nil
+      end
+    end
+  end
+end

data/spec/fieldhand/paginator_spec.rb

@@ -109,5 +109,41 @@ module Fieldhand
         expect(error.response.body).to eq('Retry after 5 seconds')
       end
     end
+
+    describe '#timeout' do
+      it 'defaults to 60 seconds' do
+        paginator = described_class.new('http://www.example.com/oai')
+
+        expect(paginator.timeout).to eq(60)
+      end
+
+      it 'can be overridden with an option' do
+        paginator = described_class.new('http://www.example.com/oai', :timeout => 10)
+
+        expect(paginator.timeout).to eq(10)
+      end
+    end
+
+    describe '#logger' do
+      it 'defaults to a null logger' do
+        paginator = described_class.new('http://www.example.com/oai')
+
+        expect(paginator.logger).to be_a(::Logger)
+      end
+
+      it 'can be overridden with an option' do
+        logger = ::Logger.new(STDOUT)
+        paginator = described_class.new('http://www.example.com/oai', :logger => logger)
+
+        expect(paginator.logger).to eq(logger)
+      end
+
+      it 'can be overridden by passing as a second argument for historic reasons' do
+        logger = ::Logger.new(STDOUT)
+        paginator = described_class.new('http://www.example.com/oai', logger)
+
+        expect(paginator.logger).to eq(logger)
+      end
+    end
   end
 end

data/spec/fieldhand/repository_spec.rb

@@ -187,5 +187,41 @@ module Fieldhand
           to have_attributes(:identifier => 'oai:oai.datacite.org:32356')
       end
     end
+
+    describe '#timeout' do
+      it 'defaults to 60 seconds' do
+        repository = described_class.new('http://www.example.com/oai')
+
+        expect(repository.timeout).to eq(60)
+      end
+
+      it 'can be overridden with an option' do
+        repository = described_class.new('http://www.example.com/oai', :timeout => 10)
+
+        expect(repository.timeout).to eq(10)
+      end
+    end
+
+    describe '#logger' do
+      it 'defaults to a null logger' do
+        repository = described_class.new('http://www.example.com/oai')
+
+        expect(repository.logger).to be_a(::Logger)
+      end
+
+      it 'can be overridden with an option' do
+        logger = ::Logger.new(STDOUT)
+        repository = described_class.new('http://www.example.com/oai', :logger => logger)
+
+        expect(repository.logger).to eq(logger)
+      end
+
+      it 'can be overridden by passing as a second argument for historic reasons' do
+        logger = ::Logger.new(STDOUT)
+        repository = described_class.new('http://www.example.com/oai', logger)
+
+        expect(repository.logger).to eq(logger)
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+require 'date'
 require 'webmock/rspec'
 
 RSpec.configure do |config|

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: fieldhand
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Paul Mucur
 - Maciej Gajewski
 - Giovanni Derks
+- Abeer Salameh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-27 00:00:00.000000000 Z
+date: 2018-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -102,6 +103,7 @@ files:
 - lib/fieldhand/logger.rb
 - lib/fieldhand/metadata_format.rb
 - lib/fieldhand/network_errors.rb
+- lib/fieldhand/options.rb
 - lib/fieldhand/paginator.rb
 - lib/fieldhand/record.rb
 - lib/fieldhand/repository.rb
@@ -112,6 +114,7 @@ files:
 - spec/fieldhand/header_spec.rb
 - spec/fieldhand/identify_spec.rb
 - spec/fieldhand/metadata_format_spec.rb
+- spec/fieldhand/options_spec.rb
 - spec/fieldhand/paginator_spec.rb
 - spec/fieldhand/record_spec.rb
 - spec/fieldhand/repository_spec.rb
@@ -137,18 +140,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: An OAI-PMH harvester
 test_files:
-- spec/fieldhand/arguments_spec.rb
-- spec/fieldhand/datestamp_spec.rb
+- spec/spec_helper.rb
+- spec/fieldhand/set_spec.rb
+- spec/fieldhand/repository_spec.rb
+- spec/fieldhand/options_spec.rb
 - spec/fieldhand/header_spec.rb
-- spec/fieldhand/identify_spec.rb
-- spec/fieldhand/metadata_format_spec.rb
 - spec/fieldhand/paginator_spec.rb
+- spec/fieldhand/arguments_spec.rb
 - spec/fieldhand/record_spec.rb
-- spec/fieldhand/repository_spec.rb
-- spec/fieldhand/set_spec.rb
-- spec/spec_helper.rb
+- spec/fieldhand/identify_spec.rb
+- spec/fieldhand/datestamp_spec.rb
+- spec/fieldhand/metadata_format_spec.rb