down 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bba011a45e65446c7b79dbbaf9995b169cd00457
-  data.tar.gz: cef8bd02a77da2e1274fdc2fe16247c11b97fe77
+  metadata.gz: 932ad54eb266b7cc369a8afa2b71eb6a8d70e289
+  data.tar.gz: 1976c429007e474fa59221ad90d82da674a875e3
 SHA512:
-  metadata.gz: f4cd2ee72598b550d1ec39c57472aadcd31b37f825a168f32ccefb2d7c11dbd3b86aeeb4f14d6dd1bb750b27dc0282c18c2c2214f461274bee542c1a6f2a90e6
-  data.tar.gz: e3254ce5537d4fc99b870057f8ea647a51af92dfe1d232403d7e72be5b445a012e46306e3a271dbb95228c955804c0d814401d9669cf07f7bbc07c75d7e20f28
+  metadata.gz: ff49b59cd8b661135b58070a9079b7989d4ba90ee9727888d050df55e75ab820e0f498b1454470a3696f0bf7abfc31f9ce0bd145cdb93a3e0bf739e29514fe74
+  data.tar.gz: 6a158be107f0cc7eecfcecb582e4481c03a255706f4184adcda34bde57ce19715b9ac11c4a09fbc3ec53b9197398c03be30e165e6d04ba1be90a937696eccff8

data/README.md

@@ -1,6 +1,7 @@
 # Down
 
-Down is a wrapper around `open-uri` for safe downloading of remote files.
+Down is a wrapper around [open-uri] standard library for safe downloading of
+remote files.
 
 ## Installation
 
@@ -66,16 +67,6 @@ 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 it receives a chunk which surpasses the maximum size.
 
-### Progress
-
-You can also tie into the progress of downloading, if you maybe want to display
-a progress bar:
-
-```rb
-Down.download "http://example.com/image.jpg",
-  progress: ->(size) { ... } # called on each chunk
-```
-
 ### Download errors
 
 There are a lot of ways in which a download can fail:
@@ -100,23 +91,29 @@ rescue Down::Error => error
 end
 ```
 
-### Timeout
+### Additional options
 
-You can specify the time after the request will time out:
+Any additional options will be forwarded to [open-uri], so you can for example
+add basic authentication or a timeout:
 
 ```rb
-Down.download "http://example.com/image.jpg", timeout: 5
+Down.download "http://example.com/image.jpg",
+  http_basic_authentication: ['john', 'secret'],
+  read_timeout: 5
 ```
 
-### Additional options
+### Streaming
 
-Any additional options will be forwarded to open-uri, so you can for example
-add basic authentication:
+Down has the ability to stream remote files, yielding chunks when they're
+received:
 
 ```rb
-Down.download "http://example.com/image.jpg", http_basic_authentication: ['john', 'secret']
+Down.stream("http://example.com/image.jpg") { |chunk, content_length| ... }
 ```
 
+The `content_length` argument is set from the `Content-Length` response header
+if it's present.
+
 ### Copying to tempfile
 
 Down has another "hidden" utility method, `#copy_to_tempfile`, which creates
@@ -124,7 +121,8 @@ a Tempfile out of the given file. The `#download` method uses it internally,
 but it's also publicly available for direct use:
 
 ```rb
-tempfile = Down.copy_to_tempfile "path/to/file.jpg"
+io # IO object that you want to copy to tempfile
+tempfile = Down.copy_to_tempfile "basename.jpg", io
 tempfile.path #=> "/var/folders/k7/6zx6dx6x7ys3rv3srh0nyfj00000gn/T/down20151116-77262-jgcx65.jpg"
 ```
 
@@ -152,3 +150,5 @@ $ bin/test-versions
 ## License
 
 [MIT](LICENSE.txt)
+
+[open-uri]: http://ruby-doc.org/stdlib-2.3.0/libdoc/open-uri/rdoc/OpenURI.html

data/down.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "down"
-  spec.version       = "2.0.1"
+  spec.version       = "2.1.0"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko.marohnic@gmail.com"]
 

data/lib/down.rb

@@ -1,7 +1,7 @@
 require "open-uri"
 require "tempfile"
-require "uri"
 require "fileutils"
+require "cgi/util"
 
 module Down
   class Error < StandardError; end
@@ -13,9 +13,13 @@ module Down
   def download(url, options = {})
     uri = URI.parse(url)
 
-    max_size = options.delete(:max_size)
-    progress = options.delete(:progress)
-    timeout  = options.delete(:timeout)
+    warn "Passing :timeout option to `Down.download` is deprecated and will be removed in Down 3. You should use open-uri's :open_timeout and/or :read_timeout." if options.key?(:timeout)
+    warn "Passing :progress option to `Down.download` is deprecated and will be removed in Down 3. You should use open-uri's :progress_proc." if options.key?(:progress)
+
+    max_size            = options.delete(:max_size)
+    progress_proc       = options.delete(:progress_proc) || options.delete(:progress)
+    content_length_proc = options.delete(:content_length_proc)
+    timeout             = options.delete(:timeout)
 
     downloaded_file = uri.open({
       "User-Agent" => "Down/1.0.0",
@@ -23,12 +27,13 @@ module Down
         if size && max_size && size > max_size
           raise Down::TooLarge, "file is too large (max is #{max_size/1024/1024}MB)"
         end
+        content_length_proc.call(size) if content_length_proc
       },
       progress_proc: proc { |current_size|
         if max_size && current_size > max_size
           raise Down::TooLarge, "file is too large (max is #{max_size/1024/1024}MB)"
         end
-        progress.call(current_size) if progress
+        progress_proc.call(current_size) if progress_proc
       },
       read_timeout: timeout,
       redirect: false,
@@ -51,6 +56,35 @@ module Down
     raise Down::NotFound, "file not found"
   end
 
+  def stream(url, options = {})
+    uri = URI.parse(url)
+    http = Net::HTTP.new(uri.host, uri.port)
+
+    # taken from open-uri implementation
+    if uri.is_a?(URI::HTTPS)
+      require "net/https"
+      http.use_ssl = true
+      http.verify_mode = options[:ssl_verify_mode] || OpenSSL::SSL::VERIFY_PEER
+      store = OpenSSL::X509::Store.new
+      if options[:ssl_ca_cert]
+        Array(options[:ssl_ca_cert]).each do |cert|
+          File.directory?(cert) ? store.add_path(cert) : store.add_file(cert)
+        end
+      else
+        store.set_default_paths
+      end
+      http.cert_store = store
+    end
+
+    http.start do
+      req = Net::HTTP::Get.new(uri.to_s)
+      http.request(req) do |response|
+        content_length = response["Content-Length"].to_i if response["Content-Length"]
+        response.read_body { |chunk| yield chunk, content_length }
+      end
+    end
+  end
+
   def copy_to_tempfile(basename, io)
     tempfile = Tempfile.new(["down", File.extname(basename)], binmode: true)
     if io.is_a?(OpenURI::Meta) && io.is_a?(Tempfile)
@@ -66,7 +100,7 @@ module Down
   module DownloadedFile
     def original_filename
       path = base_uri.path
-      path = URI.decode(path)
+      path = CGI.unescape(path)
       File.basename(path) unless path.empty? || path == "/"
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: down
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-06 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Robust file download from URL using open-uri.