down 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fe68b913e3b94078cfc74c7599ef57cab7d4ac2
-  data.tar.gz: f2cc86395be9ee08f188bd40d90cac2b9ae0ab59
+  metadata.gz: a80bdc5c9a560cb80bb1ad7ff6ff5d37c7286516
+  data.tar.gz: f9015c19819666eaeeaa13dbcf5e9537e63699f9
 SHA512:
-  metadata.gz: 6a28ee64408befa22c4fb0eb51a5863daaa83555bb4dc5a72c3ee536cb32a2aaa0781cf163284144cdf42c179fdf0f3530bf5c5e804b18e6ff2dea2ab3e48fb6
-  data.tar.gz: 45d8928e426182b463dee00daa5956e0a828a547e672b7e611cf135e333da696aa19fdf7f29eff45ce46580918c48c1720c1f5727d4d8bf01e534b2aa4d9f093
+  metadata.gz: 3a250ed7339d70e339f8591e260a85925395add6f18d8b4c2aa5cea40bfa420442606e0bdfa96b76df2661beec0830b1c011d609a16d15996bca80072b41c5e9
+  data.tar.gz: 884481d0a865cf7664715a77fcd0ae9a43fc36aa6dc0bc7729197c1dea6c1382aaca80925a2c6411390ca2c72e6ea825e2be41681399c59bd0cc0e1fe403a020

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 4.4.0 (2018-04-12)
+
+* Add `:method` option to `Down::Http` for specifying the request method (@janko-m)
+
+* Set default timeout of 30 for each operation to all backends (@janko-m)
+
 ## 4.3.0 (2018-03-11)
 
 * Accept CLI arguments as a list of symbols in `Down::Wget#download` (@janko-m)

data/README.md

@@ -41,7 +41,7 @@ Down allows you to pass a `:max_size` option:
 
 ```rb
 Down.download("http://example.com/image.jpg", max_size: 5 * 1024 * 1024) # 5 MB
-# !~> Down::TooLarge
+# Down::TooLarge: file is too large (max is 5MB)
 ```
 
 What is the advantage over simply checking size after downloading? Well, Down
@@ -57,7 +57,6 @@ specific location on disk, you can specify the `:destination` option:
 
 ```rb
 Down.download("http://example.com/image.jpg", destination: "/path/to/destination")
-#=> nil
 ```
 
 ### Basic authentication
@@ -355,7 +354,7 @@ Net::HTTP include:
 All additional options will be forwarded to `HTTP::Client#request`:
 
 ```rb
-Down::Http.download("http://example.org/image.jpg", timeout: { connect: 3 })
+Down::Http.download("http://example.org/image.jpg", headers: { "Foo" => "Bar" })
 Down::Http.open("http://example.org/image.jpg", follow: { max_hops: 0 })
 ```
 
@@ -370,7 +369,7 @@ end
 You can also initialize the backend with default options:
 
 ```rb
-http = Down::Http.new(timeout: { connect: 3 })
+http = Down::Http.new(headers: { "Foo" => "Bar" })
 # or
 http = Down::Http.new(HTTP.timeout(connect: 3))
 
@@ -378,6 +377,19 @@ http.download("http://example.com/image.jpg")
 http.open("http://example.com/image.jpg")
 ```
 
+#### Request method
+
+By default `Down::Http` makes a `GET` request to the specified endpoint, but you
+can specify a different request method using the `:method` option:
+
+```rb
+Down::Http.download("http://example.org/image.jpg", method: :post)
+Down::Http.open("http://example.org/image.jpg", method: :post)
+
+down = Down::Http.new(method: :post)
+down.download("http://example.org/image.jpg")
+```
+
 ### Wget (experimental)
 
 ```rb

data/lib/down/http.rb

@@ -15,8 +15,15 @@ end
 module Down
   class Http < Backend
     def initialize(client_or_options = {})
-      options  = client_or_options.is_a?(HTTP::Client) ? client_or_options.default_options : client_or_options
-      @options = { headers: { "User-Agent" => "Down/#{Down::VERSION}" }, follow: { max_hops: 2 } }.merge(options)
+      options = client_or_options.is_a?(HTTP::Client) ? client_or_options.default_options.to_hash : client_or_options
+
+      @method  = options.delete(:method) || :get
+      @options = {
+        headers:         { "User-Agent" => "Down/#{Down::VERSION}" },
+        follow:          { max_hops: 2 },
+        timeout_class:   HTTP::Timeout::PerOperation,
+        timeout_options: { write_timeout: 30, connect_timeout: 30, read_timeout: 30 }
+      }.merge(options)
     end
 
     def download(url, max_size: nil, progress_proc: nil, content_length_proc: nil, destination: nil, **options, &block)
@@ -58,7 +65,7 @@ module Down
     end
 
     def open(url, rewindable: true, **options, &block)
-      response = get(url, **options, &block)
+      response = request(url, **options, &block)
 
       response_error!(response) unless response.status.success?
 
@@ -78,13 +85,13 @@ module Down
       @default_client ||= HTTP::Client.new(@options)
     end
 
-    def get(url, **options, &block)
+    def request(url, method: @method, **options, &block)
       url = process_url(url, options)
 
       client = default_client
       client = block.call(client) if block
 
-      client.get(url, options)
+      client.send(method.to_s.downcase, url, options)
     rescue => exception
       request_error!(exception)
     end

data/lib/down/net_http.rb

@@ -12,7 +12,12 @@ require "cgi"
 module Down
   class NetHttp < Backend
     def initialize(options = {})
-      @options = { "User-Agent" => "Down/#{Down::VERSION}", max_redirects: 2 }.merge(options)
+      @options = {
+        "User-Agent" => "Down/#{Down::VERSION}",
+        max_redirects: 2,
+        open_timeout:  30,
+        read_timeout:  30,
+      }.merge(options)
     end
 
     def download(url, options = {})

data/lib/down/version.rb

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

data/lib/down/wget.rb

@@ -16,7 +16,13 @@ require "cgi"
 module Down
   class Wget < Backend
     def initialize(*arguments)
-      @arguments = [max_redirect: 2, user_agent: "Down/#{Down::VERSION}"] + arguments
+      @arguments = [
+        user_agent:      "Down/#{Down::VERSION}",
+        max_redirect:    2,
+        dns_timeout:     30,
+        connect_timeout: 30,
+        read_timeout:    30,
+      ] + arguments
     end
 
     def download(url, *args, max_size: nil, content_length_proc: nil, progress_proc: nil, destination: nil, **options)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: down
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-11 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest