A gem to stream dynamically generated zip files from a rails application. Unlike other solutions that generate zips for user download, zipline does not wait for the entire zip file to be created (or even for the entire input file in the cloud to be downloaded) before it begins sending the zip file to the user. It does this by never seeking backwards during zip creation, and streaming the zip file over http as it is constructed. The advantages of this are:
- Removes need for large disk space or memory allocation to generate zips, even huge zips. So it works on Heroku.
- The user begins downloading immediately, which decreaceses latency, download time, and timeouts on Heroku.
Add this line to your application's Gemfile:
gem 'zipline'
And then execute:
$ bundle
set up some models with carrierwave or paperclip. Right now only plain file storage and S3 are supported in the case of carrierwave and only plain file storage, not S3 in the case of paperclip. Alternatively, you can pass in plain old File objects. Not to be judgy, but plain old file objects are probably not the best option most of the time.
You'll need to be using unicorn or rainbows or some other server that supports streaming output.
class MyController < ApplicationController
# enable streaming responses
include ActionController::Streaming
# enable zipline
include Zipline
def index
users= User.all
files = users.map{ |user| [user.avatar, "#{user.username}.png"] }
zipline( files, 'avatars.zip')
end
end
For directories, just give the files names like "directory/file".
To stream files from a remote URL, use open-uri with a lazy enumerator:
require 'open-uri'
avatars = [
# remote_url zip_path
[ 'http://www.example.com/user1.png', 'avatars/user1.png' ]
[ 'http://www.example.com/user2.png', 'avatars/user2.png' ]
[ 'http://www.example.com/user3.png', 'avatars/user3.png' ]
]
file_mappings = avatars
.lazy # Lazy allows us to begin sending the download immediately instead of waiting to download everything
.map { |url, path| [open(url), path] }
zipline(file_mappings, 'avatars.zip')
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Added some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
- tests!
- extract library for plain ruby streaming zips, which this will depend on.
- get my changes to support streaming zips checked in to the rubyzip library.