fieldhand 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48341fcf65a936b5bc42a7f6cdcc9881d2d3f11ef29352a14f0f545f1318b5a0
-  data.tar.gz: 17ce75aba6b336de464b496604aec0bbda5d673ff98d6c8ee1a659b0f75fb425
+  metadata.gz: fc45bc1384bec75919f2d929ee512748554511d90b0818024b930f4c133a70b2
+  data.tar.gz: c31b6bb9872a34e3bd65bc94cb76364c645c767970e3a277a3c69b6b1831f3c2
 SHA512:
-  metadata.gz: fddd10cde8fc771c259234deadef079468f8a3517174a82e92dd480a29d5ccbbd655dfeb5f1f4fceeda85b1e4d9707ab715ddde8baf6fa2e43fd2fedd6867121
-  data.tar.gz: 9f201592dc6968fdf41c5bd8134c67496f4eed2c89077442474b0491ef83417e170a182da2c1262aaca3d811ad6dd2e756a18e1e8e025a799e4cbd6e1ef2f616
+  metadata.gz: 76896e2562bd40ed991d10fe57bb07532a42aa08f5653c78342756819010d62ff66b854c39cf3fb74d6004ab049623870091a9725fbd960de8a89bcc25d02b83
+  data.tar.gz: 071e2ee3300fa813699eda02ab107c02f1362241a893e7beb2b1d2becba8ac14364ab7890a870fe4de43f0dde1f87a593856a310c19b26b3740f76baf4802d84

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Altmetric LLP
+Copyright (c) 2017-2018 Altmetric LLP
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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.8.0  
+**Current version:** 0.9.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.8'
+gem install fieldhand -v '~> 0.9'
 ```
 
 Or, in your `Gemfile`:
 
 ```ruby
-gem 'fieldhand', '~> 0.8'
+gem 'fieldhand', '~> 0.9'
 ```
 
 ## Usage
@@ -114,15 +114,16 @@ A class to represent [an OAI-PMH repository](https://www.openarchives.org/OAI/op
 ```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 => Logger.new(STDOUT), :timeout => 10)
+Fieldhand::Repository.new('http://www.example.com/oai', :logger => Logger.new(STDOUT), :timeout => 10, :bearer_token => 'decafbad')
 ```
 
 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 two options passed as a `Hash`:
+something that can be coerced into a `URI` such as a `String`) with three 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.
+* `: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`.
 
 #### `Fieldhand::Repository#identify`
 
@@ -632,6 +633,6 @@ This can be used to rescue all the following child error types.
 
 ## License
 
-Copyright © 2017 Altmetric LLP
+Copyright © 2017-2018 Altmetric LLP
 
 Distributed under the MIT License.

data/lib/fieldhand/options.rb

@@ -16,6 +16,7 @@ module Fieldhand
     # * :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
+    # * :bearer_token - A `String` bearer token to use when sending any HTTP requests, defaults to nil
     def initialize(logger_or_options = {})
       @logger_or_options = logger_or_options
     end
@@ -30,6 +31,11 @@ module Fieldhand
       options.fetch(:logger) { Logger.null }
     end
 
+    # Return the current bearer token.
+    def bearer_token
+      options[:bearer_token]
+    end
+
     private
 
     def options

data/lib/fieldhand/paginator.rb

@@ -11,19 +11,21 @@ module Fieldhand
   #
   # See https://www.openarchives.org/OAI/openarchivesprotocol.html#FlowControl
   class Paginator
-    attr_reader :uri, :logger, :timeout, :http
+    attr_reader :uri, :logger, :timeout, :bearer_token, :http
 
-    # Return a new paginator for the given repository base URI and optional logger and timeout.
+    # Return a new paginator for the given repository base URI and optional logger, timeout and bearer token.
     #
     # 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 and timeout will default to 60 seconds.
+    # 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.
     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
 
       @http = ::Net::HTTP.new(@uri.host, @uri.port)
       @http.read_timeout = @timeout
@@ -89,7 +91,7 @@ module Fieldhand
       request_uri.query = encode_query(query)
 
       logger.info('Fieldhand') { "GET #{request_uri}" }
-      http.get(request_uri.request_uri)
+      http.request(authenticated_request(request_uri.request_uri))
     rescue ::Timeout::Error => e
       raise NetworkError, "timeout requesting #{query}: #{e}"
     rescue => e
@@ -99,5 +101,12 @@ module Fieldhand
     def encode_query(query = {})
       query.map { |k, v| ::CGI.escape(k) << '=' << ::CGI.escape(v) }.join('&')
     end
+
+    def authenticated_request(uri)
+      request = ::Net::HTTP::Get.new(uri)
+      request['Authorization'] = "Bearer #{bearer_token}" if bearer_token
+
+      request
+    end
   end
 end

data/lib/fieldhand/repository.rb

@@ -14,22 +14,23 @@ module Fieldhand
   #
   # See https://www.openarchives.org/OAI/openarchivesprotocol.html
   class Repository
-    attr_reader :uri, :logger, :timeout
+    attr_reader :uri, :logger, :timeout, :bearer_token
 
-    # Return a new repository with the given base URL and an optional logger and timeout.
+    # Return a new repository with the given base URL and an optional logger, timeout and bearer token.
     #
     # 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 and timeout.
+    # a logger, timeout and bearer token.
     #
-    # Defaults to using a null logger specific to this platform and a timeout of 60 seconds.
+    # Defaults to using a null logger specific to this platform, a timeout of 60 seconds and no bearer token.
     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
     end
 
     # Send an Identify request to the repository and return an `Identify` response.
@@ -133,7 +134,7 @@ module Fieldhand
     private
 
     def paginator
-      @paginator ||= Paginator.new(uri, :logger => logger, :timeout => timeout)
+      @paginator ||= Paginator.new(uri, :logger => logger, :timeout => timeout, :bearer_token => bearer_token)
     end
   end
 end

data/spec/fieldhand/options_spec.rb

@@ -55,5 +55,19 @@ module Fieldhand
         expect(options.logger).to be_nil
       end
     end
+
+    describe '#bearer_token' do
+      it 'defaults to nil' do
+        options = described_class.new({})
+
+        expect(options.bearer_token).to be_nil
+      end
+
+      it 'can be overridden by passing a token in an option' do
+        options = described_class.new(:bearer_token => 'decafbad')
+
+        expect(options.bearer_token).to eq('decafbad')
+      end
+    end
   end
 end

data/spec/fieldhand/paginator_spec.rb

@@ -145,5 +145,38 @@ module Fieldhand
         expect(paginator.logger).to eq(logger)
       end
     end
+
+    describe '#bearer_token' do
+      it 'defaults to nil' do
+        paginator = described_class.new('http://www.example.com/oai')
+
+        expect(paginator.bearer_token).to be_nil
+      end
+
+      it 'can be overridden with an option' do
+        paginator = described_class.new('http://www.example.com/oai', :bearer_token => 'decafbad')
+
+        expect(paginator.bearer_token).to eq('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')
+
+        paginator.items('Identify', IdentifyParser).first
+
+        expect(request).to have_been_requested
+      end
+
+      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')
+
+        paginator.items('Identify', IdentifyParser).first
+
+        expect(request).to have_been_requested
+      end
+    end
   end
 end

data/spec/fieldhand/repository_spec.rb

@@ -223,5 +223,29 @@ module Fieldhand
         expect(repository.logger).to eq(logger)
       end
     end
+
+    describe '#bearer_token' do
+      it 'defaults to nil' do
+        repository = described_class.new('http://www.example.com/oai')
+
+        expect(repository.bearer_token).to be_nil
+      end
+
+      it 'can be overridden with an option' do
+        repository = described_class.new('http://www.example.com/oai', :bearer_token => 'decafbad')
+
+        expect(repository.bearer_token).to eq('decafbad')
+      end
+
+      it 'uses the bearer token to authorize HTTP requests' 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')
+
+        repository.identify
+
+        expect(request).to have_been_requested
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fieldhand
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Paul Mucur
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-12 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox