down 2.3.2 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 351b0f1708bc156090b334caf7ad619cd439dee6
-  data.tar.gz: 72b4dbb2e6a62358292dddbea558c406477c5167
+  metadata.gz: 37212a130ab08cdcb38cbb6bcdd207bd8f3d56ec
+  data.tar.gz: eff7327b20920806bc416e469d924c82fa8ea980
 SHA512:
-  metadata.gz: c1387a3d10dae8c1c22df454d7dc47d16e6b9a752329168a86f8c9934713dab3e32b079afb6d0231901129dfc6cea5c27eda2129271e9d825c5ca01259362aae
-  data.tar.gz: 6be19252cc1a7b9439c26ca87da199e4c009e5c5286bd3a3809db8ca9eff9600ad9bdd4bb3c7c8572e864990d03a6b3ba9e4246b140be9a6f58cc1432b931a25
+  metadata.gz: 2418a368cc8e8c0118650bf46d23660ecf30cb3aa0da5f8dc78fa84df9d3200e655367a8279f9b030d1be5fd89fa5d946fc5346b3ef3f144fe1e801c6c7b3ed6
+  data.tar.gz: f7a4f49dc00a43251582ee8cf0d08c3f217e42ba8e4f6bb944b1e884a99e055c2af92b3c52e4381c9166b9935140a1df9d12681542febaeab6cc1230c0bb2592

data/README.md

@@ -127,10 +127,10 @@ tempfile.path #=> "/var/folders/k7/6zx6dx6x7ys3rv3srh0nyfj00000gn/T/down20151116
 
 ## Streaming
 
-Down has the ability to stream the remote file as it is being downloaded. The
-`Down.open` method returns an IO object which represents the remote file on the
-given URL. When you read from it, Down internally downloads chunks of the
-remote file, but only how much is needed.
+Down has the ability to access contents of the remote file *as it is being
+downloaded*. The `Down.open` method returns an IO object which represents the
+remote file on the given URL. When you read from it, Down internally downloads
+chunks of the remote file, but only how much is needed.
 
 ```rb
 remote_file = Down.open("http://example.com/image.jpg")
@@ -154,8 +154,40 @@ remote_file = Down.open("http://example.com/image.jpg")
 remote_file.each_chunk do |chunk|
   # ...
 end
+remote_file.close
 ```
 
+### `Down::ChunkedIO`
+
+The `Down.open` method uses `Down::ChunkedIO` internally. However,
+`Down::ChunkedIO` is designed to be generic, it can wrap any kind of streaming.
+
+```rb
+Down::ChunkedIO.new(...)
+```
+
+* `:size` – size of the file, if it's known
+* `:chunks` – an `Enumerator` which returns chunks
+* `:on_close` – called when streaming finishes
+
+Here is an example of wrapping streaming MongoDB files:
+
+```rb
+mongo = Mongo::Client.new(...)
+bucket = mongo.database.fs
+
+content_length = bucket.find(_id: id).first["length"]
+stream = bucket.open_download_stream(id)
+
+io = Down::ChunkedIO.new(
+  size: content_length,
+  chunks: stream.enum_for(:each),
+  on_close: -> { stream.close },
+)
+```
+
+### Down
+
 ## Supported Ruby versions
 
 * MRI 1.9.3

data/lib/down.rb

@@ -138,9 +138,8 @@ module Down
     def initialize(options)
       @size     = options.fetch(:size)
       @chunks   = options.fetch(:chunks)
-      @on_close = options.fetch(:on_close, nil)
+      @on_close = options.fetch(:on_close, ->{})
       @tempfile = Tempfile.new("down", binmode: true)
-      @eof      = false
     end
 
     def size
@@ -148,19 +147,17 @@ module Down
     end
 
     def read(length = nil, outbuf = nil)
-      loop do
-        break if length && (@tempfile.pos + length <= @tempfile.size)
-        next_chunk or break
-      end
+      download_chunk until enough_downloaded?(length) || download_finished?
       @tempfile.read(length, outbuf)
     end
 
-    def each_chunk(&block)
-      @chunks.each(&block)
+    def each_chunk
+      return enum_for(__method__) if !block_given?
+      yield download_chunk until download_finished?
     end
 
     def eof?
-      @eof
+      @tempfile.eof? && download_finished?
     end
 
     def rewind
@@ -168,19 +165,36 @@ module Down
     end
 
     def close
-      @on_close.call if @on_close
+      terminate_download
       @tempfile.close!
     end
 
     private
 
-    def next_chunk
+    def download_chunk
       chunk = @chunks.next
       write(chunk)
+      begin
+        @chunks.peek
+      rescue StopIteration
+        terminate_download
+      end
       chunk
-    rescue StopIteration
-      @eof = true
-      nil
+    end
+
+    def enough_downloaded?(length)
+      length && (@tempfile.pos + length <= @tempfile.size)
+    end
+
+    def download_finished?
+      !@on_close
+    end
+
+    def terminate_download
+      if @on_close
+        @on_close.call
+        @on_close = nil
+      end
     end
 
     def write(chunk)

data/lib/down/version.rb

@@ -1,3 +1,3 @@
 module Down
-  VERSION = "2.3.2"
+  VERSION = "2.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: down
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.3.3
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2016-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake