down 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 932ad54eb266b7cc369a8afa2b71eb6a8d70e289
-  data.tar.gz: 1976c429007e474fa59221ad90d82da674a875e3
+  metadata.gz: 2a8a682287353edfab10f1e5f6850b7e0dc2266f
+  data.tar.gz: a2ad18a8a32409594fb3918fa5e4dff851872d18
 SHA512:
-  metadata.gz: ff49b59cd8b661135b58070a9079b7989d4ba90ee9727888d050df55e75ab820e0f498b1454470a3696f0bf7abfc31f9ce0bd145cdb93a3e0bf739e29514fe74
-  data.tar.gz: 6a158be107f0cc7eecfcecb582e4481c03a255706f4184adcda34bde57ce19715b9ac11c4a09fbc3ec53b9197398c03be30e165e6d04ba1be90a937696eccff8
+  metadata.gz: f50514a9c905dab165f460e114be9bee93815306394fcaf6a4be4e530979e97114b772293f1e38dcc0fc9f9f10c0b2d79cecf854143c0c1b0f13ebb9c8a91c1b
+  data.tar.gz: 55ee7597729abb451f06a579c4978a882b958023c737232a4858b8f6d0fd1d6dc794874dd8b80ab56e33e79afd612fe69f4f21842b602b26e9580737f3422073

data/README.md

@@ -67,6 +67,18 @@ 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.
 
+### Redirects
+
+By default open-uri's redirects are turned off, since open-uri doesn't have a
+way to limit maximum number of redirects. Instead Down itself implements
+following redirects, by default allowing maximum of 2 redirects.
+
+```rb
+Down.download("http://example.com/image.jpg")                   # 2 redirects allowed
+Down.download("http://example.com/image.jpg", max_redirects: 5) # 5 redirects allowed
+Down.download("http://example.com/image.jpg", max_redirects: 0) # 0 redirects allowed
+```
+
 ### Download errors
 
 There are a lot of ways in which a download can fail:
@@ -75,7 +87,6 @@ There are a lot of ways in which a download can fail:
 * URL is a little bit invalid, e.g. "http:/example.com" (`Errno::ECONNREFUSED`)
 * Domain wasn't not found (`SocketError`)
 * Domain was found, but status is 4xx or 5xx (`OpenURI::HTTPError`)
-* Request went into a redirect loop (`RuntimeError`)
 * Request timeout out (`Timeout::Error`)
 
 Down unifies all of these errors into one `Down::NotFound` error (because this

data/down.gemspec

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

data/lib/down.rb

@@ -11,33 +11,44 @@ module Down
   module_function
 
   def download(url, options = {})
-    uri = URI.parse(url)
-
     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)
+    max_redirects       = options.delete(:max_redirects) || 2
     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",
-      content_length_proc: proc { |size|
-        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_proc.call(current_size) if progress_proc
-      },
-      read_timeout: timeout,
-      redirect: false,
-    }.merge(options))
+    requests_left = max_redirects + 1
+
+    begin
+      uri = URI.parse(url)
+      downloaded_file = uri.open({
+        "User-Agent" => "Down/1.0.0",
+        content_length_proc: proc { |size|
+          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_proc.call(current_size) if progress_proc
+        },
+        read_timeout: timeout,
+        redirect: false,
+      }.merge(options))
+    rescue OpenURI::HTTPRedirect => error
+      url = error.uri.to_s
+      retry if (requests_left -= 1) > 0
+      raise Down::NotFound, "too many redirects"
+    rescue => error
+      raise if error.is_a?(Down::Error)
+      raise Down::NotFound, "file not found"
+    end
 
     # open-uri will return a StringIO instead of a Tempfile if the filesize is
     # less than 10 KB, so if it happens we convert it back to Tempfile. We want
@@ -50,10 +61,6 @@ module Down
 
     downloaded_file.extend DownloadedFile
     downloaded_file
-
-  rescue => error
-    raise if error.is_a?(Down::Error)
-    raise Down::NotFound, "file not found"
   end
 
   def stream(url, options = {})
@@ -100,8 +107,10 @@ module Down
   module DownloadedFile
     def original_filename
       path = base_uri.path
-      path = CGI.unescape(path)
-      File.basename(path) unless path.empty? || path == "/"
+      unless path.empty? || path == "/"
+        filename = path.split("/").last
+        CGI.unescape(filename)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: down
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-12 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake