down 4.6.1 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b7f648a8ac6e6d684978399684d40d346f64b60b09cd65cefd5c51a079ff232
-  data.tar.gz: 867598c75cbdfb7ad946104c01ea9d97c753953b2575e5ccb6355dabbc625ff7
+  metadata.gz: 2a731d7a9096d275efb334bb06f6a7d2060f9711ac8973f4db286170a0f288e9
+  data.tar.gz: 89924b87d6fea6ba6fb3d5fc2ceed6d50a312758a1a9ec57baaeeaefd5283a8f
 SHA512:
-  metadata.gz: add25eccfc67ddd7070ea8f7c6315566399c91de00c90389ac00b14b882d17220ed8b064a6036e77d142e23fef5339307ccbf9266a0cbd727a8b7de63d412301
-  data.tar.gz: fa3de4d91657ec8cfaa1cda9e25ed61cebfd8ab9ea198dbf9ef2576a73d4dff30aa9d8f2b355718d607561b97976634fc9086fd782b97211c447f0088e549be1
+  metadata.gz: f63e9bbf2f5e8f10105816ffc9369f5aff75e65667ffb85e0e0c71f96c0b1861c5e727d379c55fd5695855e409ca49c306ce70fa5927a7bbb826cfb780b2ac77
+  data.tar.gz: 49db0e8cee2494962384613c4cbb84b232e3e9a6872cc13a19e7a4b4f86b86e09e70a65620ab1c067a8557f0ae43de9d37f2fc0255d8fed42e46ed4705aa7911

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.7.0 (2018-11-18)
+
+* Allow request headers to be passed via `:headers` to `Down::NetHttp#download` and `#open` (@janko-m)
+
 ## 4.6.1 (2018-10-24)
 
 * Release HTTP.rb version constraint to allow HTTP.rb 4.x (@janko-m)

data/README.md

@@ -261,10 +261,10 @@ as open-uri doesn't support downloading on-demand.
 
 #### Redirects
 
-`Down.download` turns off open-uri's following redirects, as open-uri doesn't
-have a way to limit the maximum number of hops, and implements its own. By
-default maximum of 2 redirects will be followed, but you can change it via the
-`:max_redirects` option:
+`Down::NetHttp#download` turns off open-uri's following redirects, as open-uri
+doesn't have a way to limit the maximum number of hops, and implements its own.
+By default maximum of 2 redirects will be followed, but you can change it via
+the `:max_redirects` option:
 
 ```rb
 Down::NetHttp.download("http://example.com/image.jpg")                   # 2 redirects allowed
@@ -278,24 +278,42 @@ Down::NetHttp.open("http://example.com/image.jpg", max_redirects: 0)     # 0 red
 
 #### Proxy
 
-Both `Down.download` and `Down.open` support a `:proxy` option, where you can
-specify a URL to an HTTP proxy which should be used when downloading.
+An HTTP proxy can be specified via the `:proxy` option:
 
 ```rb
 Down::NetHttp.download("http://example.com/image.jpg", proxy: "http://proxy.org")
-Down::NetHttp.open("http://example.com/image.jpg",     proxy: "http://user:password@proxy.org")
+Down::NetHttp.open("http://example.com/image.jpg", proxy: "http://user:password@proxy.org")
 ```
 
 #### Timeouts
 
-Both `Down.download` and `Down.open` support `:read_timeout` and `:open_timeout`
-options, which are forwarded to `Net::HTTP`:
+Timeouts can be configured via the `:open_timeout` and `:read_timeout` options:
 
 ```rb
 Down::NetHttp.download("http://example.com/image.jpg", open_timeout: 5)
 Down::NetHttp.open("http://example.com/image.jpg", read_timeout: 10)
 ```
 
+#### Headers
+
+Request headers can be added via the `:headers` option:
+
+```rb
+Down::NetHttp.download("http://example.com/image.jpg", headers: { "Header" => "Value" })
+Down::NetHttp.open("http://example.com/image.jpg", headers: { "Header" => "Value" })
+```
+
+#### SSL options
+
+The `:ssl_ca_cert` and `:ssl_verify_mode` options are supported, and they have
+the same semantics as in `open-uri`:
+
+```rb
+Down::NetHttp.open("http://example.com/image.jpg",
+  ssl_ca_cert:     "/path/to/cert",
+  ssl_verify_mode: OpenSSL::SSL::VERIFY_PEER)
+```
+
 #### Additional options
 
 Any additional options passed to `Down.download` will be forwarded to
@@ -307,14 +325,6 @@ Down::NetHttp.download "http://example.com/image.jpg",
   read_timeout: 5
 ```
 
-`Down.open` accepts `:ssl_verify_mode` and `:ssl_ca_cert` options with the same
-semantics as in open-uri, and any options with String keys will be interpreted
-as request headers, like with open-uri.
-
-```rb
-Down::NetHttp.open("http://example.com/image.jpg", {"Authorization" => "..."})
-```
-
 You can also initialize the backend with default options:
 
 ```rb

data/lib/down/net_http.rb

@@ -32,6 +32,7 @@ module Down
       progress_proc       = options.delete(:progress_proc)
       content_length_proc = options.delete(:content_length_proc)
       destination         = options.delete(:destination)
+      headers             = options.delete(:headers) || {}
 
       # Use open-uri's :content_lenth_proc or :progress_proc to raise an
       # exception early if the file is too large.
@@ -71,6 +72,7 @@ module Down
       end
 
       open_uri_options.merge!(options)
+      open_uri_options.merge!(headers)
 
       uri = ensure_uri(addressable_normalize(url))
 
@@ -249,10 +251,11 @@ module Down
       http.read_timeout = options[:read_timeout] if options.key?(:read_timeout)
       http.open_timeout = options[:open_timeout] if options.key?(:open_timeout)
 
-      request_headers = options.select { |key, value| key.is_a?(String) }
-      request_headers["Accept-Encoding"] = "" # Net::HTTP's inflater causes FiberErrors
+      headers = options.select { |key, value| key.is_a?(String) }
+      headers.merge!(options[:headers]) if options[:headers]
+      headers["Accept-Encoding"] = "" # Net::HTTP's inflater causes FiberErrors
 
-      get = Net::HTTP::Get.new(uri.request_uri, request_headers)
+      get = Net::HTTP::Get.new(uri.request_uri, headers)
       get.basic_auth(uri.user, uri.password) if uri.user || uri.password
 
       [http, get]

data/lib/down/version.rb

@@ -1,5 +1,5 @@
 # frozen-string-literal: true
 
 module Down
-  VERSION = "4.6.1"
+  VERSION = "4.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: down
 version: !ruby/object:Gem::Version
-  version: 4.6.1
+  version: 4.7.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2018-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable