fieldhand 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: fc45bc1384bec75919f2d929ee512748554511d90b0818024b930f4c133a70b2
-  data.tar.gz: c31b6bb9872a34e3bd65bc94cb76364c645c767970e3a277a3c69b6b1831f3c2
+SHA1:
+  metadata.gz: 9c93850935147ebbd65f18c017647d95fb92f0a8
+  data.tar.gz: aa07bb08297620d753ffd50f62fa393450932ec1
 SHA512:
-  metadata.gz: 76896e2562bd40ed991d10fe57bb07532a42aa08f5653c78342756819010d62ff66b854c39cf3fb74d6004ab049623870091a9725fbd960de8a89bcc25d02b83
-  data.tar.gz: 071e2ee3300fa813699eda02ab107c02f1362241a893e7beb2b1d2becba8ac14364ab7890a870fe4de43f0dde1f87a593856a310c19b26b3740f76baf4802d84
+  metadata.gz: 5c17919de0da4c4f435724db51eabf4953ae4d9ad5fbad608fe4b35d3425fef5f65d9fd4492c3cc756ba6bb182ecae913b15156ef42a9502019457603d995e9a
+  data.tar.gz: efa32effd77a428477c16debc10030df6dacc9b2e40e70300613de3d82bed1f09525974006d517d61faf0bc5c05e63b7d4e7bcc57f8990b08b53e51f468df69a

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.9.0  
+**Current version:** 0.10.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.9'
+gem install fieldhand -v '~> 0.10'
 ```
 
 Or, in your `Gemfile`:
 
 ```ruby
-gem 'fieldhand', '~> 0.9'
+gem 'fieldhand', '~> 0.10'
 ```
 
 ## Usage
@@ -115,6 +115,7 @@ A class to represent [an OAI-PMH repository](https://www.openarchives.org/OAI/op
 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 => Logger.new(STDOUT), :timeout => 10, :bearer_token => 'decafbad')
+Fieldhand::Repository.new('http://www.example.com/oai', :logger => Logger.new(STDOUT), :timeout => 10, :headers => { 'Custom header' => 'decafbad')
 ```
 
 Return a new [`Repository`](#fieldhandrepository) instance accessible at the given `uri` (specified
@@ -124,6 +125,7 @@ something that can be coerced into a `URI` such as a `String`) with three option
 * `: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;
 * `:bearer_token`: a `String` bearer token to authorize any HTTP requests, defaults to `nil`.
+* `:headers`: a `Hash` containing custom HTTP headers, defaults to `{}`.
 
 #### `Fieldhand::Repository#identify`
 

data/lib/fieldhand/options.rb

@@ -17,6 +17,7 @@ module Fieldhand
     #             null logger
     # * :timeout - A `Numeric` number of seconds to wait for any HTTP requests, defaults to 60 seconds
     # * :bearer_token - A `String` bearer token to use when sending any HTTP requests, defaults to nil
+    # * :headers - A `Hash` containing custom HTTP headers, defaults to {}.
     def initialize(logger_or_options = {})
       @logger_or_options = logger_or_options
     end
@@ -36,6 +37,14 @@ module Fieldhand
       options[:bearer_token]
     end
 
+    # Build custom headers
+    def headers
+      headers = options.fetch(:headers, {})
+      headers['Authorization'] = "Bearer #{bearer_token}" if bearer_token
+
+      headers
+    end
+
     private
 
     def options

data/lib/fieldhand/paginator.rb

@@ -11,21 +11,21 @@ module Fieldhand
   #
   # See https://www.openarchives.org/OAI/openarchivesprotocol.html#FlowControl
   class Paginator
-    attr_reader :uri, :logger, :timeout, :bearer_token, :http
+    attr_reader :uri, :logger, :timeout, :headers, :http
 
-    # Return a new paginator for the given repository base URI and optional logger, timeout and bearer token.
+    # Return a new paginator for the given repository base URI and optional logger, timeout, bearer token and headers.
     #
     # 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, timeout will default to 60 seconds and the
-    # bearer token will default to nil.
+    # The logger will default to a null logger appropriate to this platform, timeout will default to 60 seconds, the
+    # bearer token will default to nil and headers will default to empty hash.
     def initialize(uri, logger_or_options = {})
       @uri = uri.is_a?(::URI) ? uri : URI(uri)
 
       options = Options.new(logger_or_options)
       @logger = options.logger
       @timeout = options.timeout
-      @bearer_token = options.bearer_token
+      @headers = options.headers
 
       @http = ::Net::HTTP.new(@uri.host, @uri.port)
       @http.read_timeout = @timeout
@@ -104,7 +104,9 @@ module Fieldhand
 
     def authenticated_request(uri)
       request = ::Net::HTTP::Get.new(uri)
-      request['Authorization'] = "Bearer #{bearer_token}" if bearer_token
+      headers.each do |key, value|
+        request[key] = value
+      end
 
       request
     end

data/lib/fieldhand/repository.rb

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

data/spec/fieldhand/options_spec.rb

@@ -69,5 +69,25 @@ module Fieldhand
         expect(options.bearer_token).to eq('decafbad')
       end
     end
+
+    describe '#headers' do
+      it 'defaults to an empty hash' do
+        options = described_class.new({})
+
+        expect(options.headers).to be_empty
+      end
+
+      it 'can be overridden by passing headers in an option' do
+        options = described_class.new(:headers => { 'Crossref-Plus-API-Token' => 'decafbad' })
+
+        expect(options.headers).to eq({ 'Crossref-Plus-API-Token' => 'decafbad' })
+      end
+
+      it 'overrides authorization headers with a bearer_token' do
+        options = described_class.new(:headers => { 'Authorization' => 'Bearer aaabbbccc' }, :bearer_token => 'decafbad')
+
+        expect(options.headers).to eq({ 'Authorization' => 'Bearer decafbad' })
+      end
+    end
   end
 end

data/spec/fieldhand/paginator_spec.rb

@@ -146,22 +146,23 @@ module Fieldhand
       end
     end
 
-    describe '#bearer_token' do
-      it 'defaults to nil' do
+    describe '#headers' do
+      it 'defaults to an empty hash' do
         paginator = described_class.new('http://www.example.com/oai')
 
-        expect(paginator.bearer_token).to be_nil
+        expect(paginator.headers).to be_empty
       end
 
       it 'can be overridden with an option' do
-        paginator = described_class.new('http://www.example.com/oai', :bearer_token => 'decafbad')
+        paginator = described_class.new('http://www.example.com/oai', :headers => { 'Crossref-Plus-API-Token' => 'Bearer decafbad' })
 
-        expect(paginator.bearer_token).to eq('decafbad')
+        expect(paginator.headers).to eq({ 'Crossref-Plus-API-Token' => 'Bearer decafbad' })
       end
 
-      it 'sends no authorization header without a bearer token' do
-        request = stub_oai_request('http://www.example.com/oai?verb=Identify', 'identify.xml')
-        paginator = described_class.new('http://www.example.com/oai')
+      it 'can add custom headers to HTTP request' do
+        request = stub_oai_request('http://www.example.com/oai?verb=Identify', 'identify.xml').
+                    with(:headers => { 'Crossref-Plus-API-Token' => 'Bearer decafbad' })
+        paginator = described_class.new('http://www.example.com/oai', :headers => { 'Crossref-Plus-API-Token' => 'Bearer decafbad' })
 
         paginator.items('Identify', IdentifyParser).first
 
@@ -170,8 +171,18 @@ module Fieldhand
 
       it 'sends an authorization header with a bearer token' do
         request = stub_oai_request('http://www.example.com/oai?verb=Identify', 'identify.xml').
-                    with(:headers => { 'Authorization' => 'Bearer decafbad' })
-        paginator = described_class.new('http://www.example.com/oai', :bearer_token => 'decafbad')
+                    with(:headers => { 'Authorization' => 'Bearer ewterhtr' })
+        paginator = described_class.new('http://www.example.com/oai', :bearer_token => 'ewterhtr')
+
+        paginator.items('Identify', IdentifyParser).first
+
+        expect(request).to have_been_requested
+      end
+
+      it 'can add multiple custom headers to HTTP request' do
+        request = stub_oai_request('http://www.example.com/oai?verb=Identify', 'identify.xml').
+                    with(:headers => { 'Authorization' => 'Bearer ewterhtr', 'Crossref-Plus-API-Token' => 'decafbad' })
+        paginator = described_class.new('http://www.example.com/oai', :bearer_token => 'ewterhtr', :headers => { 'Crossref-Plus-API-Token' => 'decafbad' })
 
         paginator.items('Identify', IdentifyParser).first
 

data/spec/fieldhand/repository_spec.rb

@@ -224,23 +224,33 @@ module Fieldhand
       end
     end
 
-    describe '#bearer_token' do
-      it 'defaults to nil' do
+    describe '#headers' do
+      it 'defaults to an empty hash' do
         repository = described_class.new('http://www.example.com/oai')
 
-        expect(repository.bearer_token).to be_nil
+        expect(repository.headers).to be_empty
       end
 
       it 'can be overridden with an option' do
-        repository = described_class.new('http://www.example.com/oai', :bearer_token => 'decafbad')
+        repository = described_class.new('http://www.example.com/oai', :headers => { 'Crossref-Plus-API-Token' => 'Bearer decafbad' })
 
-        expect(repository.bearer_token).to eq('decafbad')
+        expect(repository.headers).to eq({ 'Crossref-Plus-API-Token' => 'Bearer decafbad' })
       end
 
-      it 'uses the bearer token to authorize HTTP requests' do
+      it 'can add custom headers to HTTP request' do
         request = stub_oai_request('http://www.example.com/oai?verb=Identify', 'identify.xml').
-                    with(:headers => { 'Authorization' => 'Bearer decafbad' })
-        repository = described_class.new('http://www.example.com/oai', :bearer_token => 'decafbad')
+                   with(:headers => { 'Crossref-Plus-API-Token' => 'Bearer decafbad' })
+        repository = described_class.new('http://www.example.com/oai', :headers => { 'Crossref-Plus-API-Token' => 'Bearer decafbad' })
+
+        repository.identify
+
+        expect(request).to have_been_requested
+      end
+
+      it 'can use a bearer token to authorize HTTP requests' do
+        request = stub_oai_request('http://www.example.com/oai?verb=Identify', 'identify.xml').
+                    with(:headers => { 'Authorization' => 'Bearer fhsfag' })
+        repository = described_class.new('http://www.example.com/oai', :bearer_token => 'fhsfag')
 
         repository.identify
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fieldhand
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Paul Mucur
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-26 00:00:00.000000000 Z
+date: 2018-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: An OAI-PMH harvester