down 4.2.1 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16efde61a43b30f68aa001eb0f06bdc8403d2e7c
-  data.tar.gz: 0e56e5adc2bb0bc0387f7198af7b0063ab577aef
+  metadata.gz: 4fe68b913e3b94078cfc74c7599ef57cab7d4ac2
+  data.tar.gz: f2cc86395be9ee08f188bd40d90cac2b9ae0ab59
 SHA512:
-  metadata.gz: b2f9108523aea427699de88ffc65f8e6d114d75850317f07bce6c3c7019e7f5add1b52ee660e57c109b526d1a8ea42f81c0944564c17ba6f6b18d537f51f4a69
-  data.tar.gz: 535dbb6812caba261e692ec713bf25df4aa57ec97027a1b74474aef060b2c9c182267a0d8008210e760d66826e7c978b898efdf4dc0d66355507c39755d84944
+  metadata.gz: 6a28ee64408befa22c4fb0eb51a5863daaa83555bb4dc5a72c3ee536cb32a2aaa0781cf163284144cdf42c179fdf0f3530bf5c5e804b18e6ff2dea2ab3e48fb6
+  data.tar.gz: 45d8928e426182b463dee00daa5956e0a828a547e672b7e611cf135e333da696aa19fdf7f29eff45ce46580918c48c1720c1f5727d4d8bf01e534b2aa4d9f093

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 4.3.0 (2018-03-11)
+
+* Accept CLI arguments as a list of symbols in `Down::Wget#download` (@janko-m)
+
+* Avoid potential URL parsing errors in `Down::Http::DownloadedFile#filename_from_url` (@janko-m)
+
+* Make memory usage of `Down::Wget#download` constant (@janko-m)
+
+* Add `:destination` option to `Down.download` for specifying download destination (@janko-m)
+
 ## 4.2.1 (2018-01-29)
 
 * Reduce memory allocation in `Down::ChunkedIO` by 10x when buffer string is used (@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
-# raises Down::TooLarge
+# !~> Down::TooLarge
 ```
 
 What is the advantage over simply checking size after downloading? Well, Down
@@ -49,6 +49,17 @@ terminates the download very early, as soon as it gets the `Content-Length`
 header. And if the `Content-Length` header is missing, Down will terminate the
 download as soon as the downloaded content surpasses the maximum size.
 
+### Destination
+
+By default the remote file will be downloaded into a temporary location and
+returned as a `Tempfile`. If you would like the file to be downloaded to a
+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
 
 `Down.download` and `Down.open` will automatically detect and apply HTTP basic

data/down.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.1"
 
-  spec.summary      = "Robust streaming downloads using net/http."
+  spec.summary      = "Robust streaming downloads using Net::HTTP, HTTP.rb or wget."
   spec.homepage     = "https://github.com/janko-m/down"
   spec.authors      = ["Janko Marohnić"]
   spec.email        = ["janko.marohnic@gmail.com"]

data/lib/down/backend.rb

@@ -4,6 +4,8 @@ require "down/version"
 require "down/chunked_io"
 require "down/errors"
 
+require "fileutils"
+
 module Down
   class Backend
     def self.download(*args, &block)
@@ -13,5 +15,17 @@ module Down
     def self.open(*args, &block)
       new.open(*args, &block)
     end
+
+    private
+
+    def download_result(tempfile, destination)
+      if destination
+        tempfile.close
+        FileUtils.mv tempfile.path, destination
+        nil
+      else
+        tempfile
+      end
+    end
   end
 end

data/lib/down/chunked_io.rb

@@ -276,8 +276,8 @@ module Down
 
     # Creates a Fiber wrapper around the underlying enumerator. The advantage
     # of using a Fiber here is that we can terminate the chunk retrieval, in a
-    # way that executes any cleanup code that the enumerator carries. At the
-    # end of iteration the :on_close callback is executed if one was specified.
+    # way that executes any cleanup code that the enumerator potentially
+    # carries. At the end of iteration the :on_close callback is executed.
     def chunks_fiber
       @chunks_fiber ||= Fiber.new do
         begin

data/lib/down/http.rb

@@ -19,7 +19,7 @@ module Down
       @options = { headers: { "User-Agent" => "Down/#{Down::VERSION}" }, follow: { max_hops: 2 } }.merge(options)
     end
 
-    def download(url, max_size: nil, progress_proc: nil, content_length_proc: nil, **options, &block)
+    def download(url, max_size: nil, progress_proc: nil, content_length_proc: nil, destination: nil, **options, &block)
       io = open(url, **options, rewindable: false, &block)
 
       content_length_proc.call(io.size) if content_length_proc && io.size
@@ -32,7 +32,9 @@ module Down
       tempfile = Tempfile.new(["down-http", extname], binmode: true)
 
       until io.eof?
-        tempfile.write(io.readpartial(nil, buffer ||= String.new))
+        chunk = io.readpartial(nil, buffer ||= String.new)
+
+        tempfile.write(chunk)
 
         progress_proc.call(tempfile.size) if progress_proc
 
@@ -47,7 +49,7 @@ module Down
       tempfile.url     = io.data[:response].uri.to_s
       tempfile.headers = io.data[:headers]
 
-      tempfile
+      download_result(tempfile, destination)
     rescue
       tempfile.close! if tempfile
       raise
@@ -152,7 +154,7 @@ module Down
       private
 
       def content_type_header
-        ::HTTP::ContentType.parse(headers["Content-Type"])
+        HTTP::ContentType.parse(headers["Content-Type"])
       end
 
       def filename_from_content_disposition
@@ -163,7 +165,7 @@ module Down
       end
 
       def filename_from_url
-        path = URI(url).path
+        path = HTTP::URI.parse(url).path
         filename = path.split("/").last
         CGI.unescape(filename) if filename
       end

data/lib/down/net_http.rb

@@ -22,6 +22,7 @@ module Down
       max_redirects       = options.delete(:max_redirects)
       progress_proc       = options.delete(:progress_proc)
       content_length_proc = options.delete(:content_length_proc)
+      destination         = options.delete(:destination)
 
       open_uri_options = {
         content_length_proc: proc { |size|
@@ -70,7 +71,7 @@ module Down
       OpenURI::Meta.init tempfile, open_uri_file # add back open-uri methods
       tempfile.extend Down::NetHttp::DownloadedFile
 
-      tempfile
+      download_result(tempfile, destination)
     end
 
     def open(url, options = {})

data/lib/down/version.rb

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

data/lib/down/wget.rb

@@ -19,8 +19,8 @@ module Down
       @arguments = [max_redirect: 2, user_agent: "Down/#{Down::VERSION}"] + arguments
     end
 
-    def download(url, *args, max_size: nil, content_length_proc: nil, progress_proc: nil, **options)
-      io = open(url, **options, rewindable: false)
+    def download(url, *args, max_size: nil, content_length_proc: nil, progress_proc: nil, destination: nil, **options)
+      io = open(url, *args, **options, rewindable: false)
 
       content_length_proc.call(io.size) if content_length_proc && io.size
 
@@ -32,7 +32,9 @@ module Down
       tempfile = Tempfile.new(["down-wget", extname], binmode: true)
 
       until io.eof?
-        tempfile.write(io.readpartial)
+        chunk = io.readpartial(nil, buffer ||= String.new)
+
+        tempfile.write(chunk)
 
         progress_proc.call(tempfile.size) if progress_proc
 
@@ -47,7 +49,7 @@ module Down
       tempfile.url     = url
       tempfile.headers = io.data[:headers]
 
-      tempfile
+      download_result(tempfile, destination)
     rescue
       tempfile.close! if tempfile
       raise
@@ -105,10 +107,12 @@ module Down
       command = %W[wget --no-verbose --save-headers -O -]
 
       options = @arguments.grep(Hash).inject({}, :merge).merge(options)
-      args    = @arguments.grep(Symbol) + args
+      args    = @arguments.grep(->(o){!o.is_a?(Hash)}) + args
 
       (args + options.to_a).each do |option, value|
-        if option.length == 1
+        if option.is_a?(String)
+          command << option
+        elsif option.length == 1
           command << "-#{option}"
         else
           command << "--#{option.to_s.gsub("_", "-")}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: down
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.3.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-29 00:00:00.000000000 Z
+date: 2018-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -150,5 +150,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Robust streaming downloads using net/http.
+summary: Robust streaming downloads using Net::HTTP, HTTP.rb or wget.
 test_files: []