Contents

# Can be used as a Rack response body directly. Will yield
# a {ZipTricks::Streamer} for adding entries to the archive and writing
# zip entry bodies.
class ZipTricks::RackBody
  # Prepares a new Rack response body with a Zip output stream.
  # The block given to the constructor will be called when the response
  # body will be read by the webserver, and will receive a {ZipTricks::Streamer}
  # as it's block argument. You can then add entries to the Streamer as usual.
  # The archive will be automatically closed at the end of the block.
  #
  #     # Precompute the Content-Length ahead of time
  #     content_length = ZipTricks::StoredSizeEstimator.perform_fake_archiving do | estimator |
  #       estimator.add_stored_entry('large.tif', size=1289894)
  #     end
  #
  #     # Prepare the response body. The block will only be called when the response starts to be written.
  #     body = ZipTricks::RackBody.new do | streamer |
  #       streamer.add_stored_entry('large.tif', size=1289894, crc32=198210)
  #       streamer << large_file.read(1024*1024) until large_file.eof?
  #       ...
  #     end
  #
  #     return [200, {'Content-Type' => 'binary/octet-stream', 'Content-Length' => content_length.to_s}, body]
  def initialize(&blk)
    @archiving_block = blk
  end

  # Connects a {ZipTricks::BlockWrite} to the Rack webserver output,
  # and calls the proc given to the constructor with a {ZipTricks::Streamer}
  # for archive writing.
  def each(&body_chunk_block)
    fake_io = ZipTricks::BlockWrite.new(&body_chunk_block)
    ZipTricks::Streamer.open(fake_io, &@archiving_block)
  end

  # Does nothing because nothing has to be deallocated or canceled
  # even if the zip output is incomplete. The archive gets closed
  # automatically as part of {ZipTricks::Streamer.open}
  def close
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
zip_tricks-2.8.1	lib/zip_tricks/rack_body.rb
zip_tricks-2.8.0	lib/zip_tricks/rack_body.rb
zip_tricks-2.7.0	lib/zip_tricks/rack_body.rb
zip_tricks-2.6.1	lib/zip_tricks/rack_body.rb