format_parser 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2212d92c3c0ca7aab0e60c9aa6559d0508ec2b8b39e4b2067990d97a7d78327
-  data.tar.gz: 27736f9d52ea1e73a147d96d38608e268040648e61d2b913ca38f164f2d2d0b6
+  metadata.gz: b8efef8742cfefdcde0aa05ab32c726004325c2210b19e25ca2cf866ad786074
+  data.tar.gz: bbd59f6f046a35cff93ea4e20a5168c2912007b06b3fabe7a5b23f7a0ed70c34
 SHA512:
-  metadata.gz: 5f63f74444df32d016fc25dc5c3731671690185b7ecf80ffc06da350b37d82b566f451508091245fec255c816121a115286dd04fb626aa4c1b694836fd645d97
-  data.tar.gz: ee1917287bb7c50bd71d9a7756321e30fbc73aa5e3a4f42e4844eb9494dfe77e89a9a26622732772c9b29c4ea673f3401324d2e6bf67e5bdaa5dac991d12f821
+  metadata.gz: b4a7d965be6ff0cb0abf8cdec5f4d31259aada155ae465c1b31d5eba718f9d0071ee8b7a6b2061e6024add45d32b901c0f95a37373727a59fd4a6562041f52e9
+  data.tar.gz: d314cb6876185ddedcef01c67205cf0635c2d8aebd0871dfd7834f0f54c15c38c31db7cc730c6aea8f8a72aff85949fa6937d970dfb320120a5b8c843f003753

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.29.0
+* Add option `headers:` to `FormatParser.parse_http`
+
 ## 0.28.0
 * Change `FormatParser.parse_http` to follow HTTP redirects
 

data/lib/format_parser.rb

@@ -88,13 +88,14 @@ module FormatParser
   # given to `.parse`. The accepted keyword arguments are the same as the ones for `parse`.
   #
   # @param url[String, URI] the HTTP(S) URL to request the object from using Faraday and `Range:` requests
+  # @param headers[Hash] (optional) the HTTP headers to request the object from using Faraday
   # @param kwargs the keyword arguments to be delegated to `.parse`
   # @see {.parse}
-  def self.parse_http(url, **kwargs)
+  def self.parse_http(url, headers: {}, **kwargs)
     # Do not extract the filename, since the URL
     # can really be "anything". But if the caller
     # provides filename_hint it will be carried over
-    parse(RemoteIO.new(url), **kwargs)
+    parse(RemoteIO.new(url, headers: headers), **kwargs)
   end
 
   # Parses the file at the given `path` and returns the results as if it were any IO

data/lib/format_parser/version.rb

@@ -1,3 +1,3 @@
 module FormatParser
-  VERSION = '0.28.0'
+  VERSION = '0.29.0'
 end

data/lib/remote_io.rb

@@ -24,9 +24,11 @@ class FormatParser::RemoteIO
   end
 
   # @param uri[URI, String] the remote URL to obtain
-  def initialize(uri)
+  # @param headers[Hash] (optional) the HTTP headers to be used in the HTTP request
+  def initialize(uri, headers: {})
     require 'faraday'
     require 'faraday_middleware/response/follow_redirects'
+    @headers = headers
     @uri = uri
     @pos = 0
     @remote_size = false
@@ -79,7 +81,7 @@ class FormatParser::RemoteIO
     # We use a GET and not a HEAD request followed by a GET because
     # S3 does not allow HEAD requests if you only presigned your URL for GETs, so we
     # combine the first GET of a segment and retrieving the size of the resource
-    conn = Faraday.new do |faraday|
+    conn = Faraday.new(headers: @headers) do |faraday|
       faraday.use FaradayMiddleware::FollowRedirects
       # we still need the default adapter, more details: https://blog.thecodewhisperer.com/permalink/losing-time-to-faraday
       faraday.adapter Faraday.default_adapter

data/spec/remote_fetching_spec.rb

@@ -102,6 +102,25 @@ describe 'Fetching data from HTTP remotes' do
     end
   end
 
+  it 'sends provided HTTP headers in the request' do
+    # Faraday is required only after calling .parse_http
+    # This line is just to trigger this require, then it's possible to
+    # add an expectation of how Faraday is initialized after.
+    FormatParser.parse_http('invalid_url') rescue nil
+
+    expect(Faraday)
+      .to receive(:new)
+      .with(headers: {'test-header' => 'test-value'})
+      .and_call_original
+
+    file_information = FormatParser.parse_http(
+      'http://localhost:9399//TIFF/test.tif',
+      headers: {'test-header' => 'test-value'}
+    )
+
+    expect(file_information.format).to eq(:tif)
+  end
+
   after(:all) do
     @server.stop
     @server_thread.join(0.5)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: format_parser
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Noah Berman
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ks