zipline 0.0.10 → 0.0.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2f04b0aaf25dba39d30fa57d3b7dee52ab4f7db
+  data.tar.gz: af226cf8bd006c78e95e7fba5918b8888ab15893
+SHA512:
+  metadata.gz: af1e5037946364838761db1c030dcb7c5480f779dc97a88117bcfc3f923097f598d1571ec87a27f83b1dc08c72e43b1176b5e379e5eca25f8f8cf9f30abd1eca
+  data.tar.gz: eb28c47cae2d33c2176242667d240747c632c71c210650645e35420d6af7ea5939319a14cefbc9b7e163c613b8e0acfebf524690c71f8ef6b795dbc4431f6d17

data/Gemfile

@@ -4,7 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rspec', '~> 3.0.0.beta'
+  gem 'rubyzip', '~> 1.2'
+  gem 'rspec', '~> 3'
   gem 'fog'
   gem 'carrierwave'
   gem 'paperclip'

data/README.md

@@ -17,10 +17,13 @@ And then execute:
 
 ## Usage
 
-set up some models with [carrierwave](https://github.com/jnicklas/carrierwave) or [paperclip](https://github.com/thoughtbot/paperclip).
- Right now only plain file storage and S3 are supported in the case of [carrierwave](https://github.com/jnicklas/carrierwave) and only plain file storage, not S3 in the case of [paperclip](https://github.com/thoughtbot/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](http://unicorn.bogomips.org/) or rainbows or some other server that supports streaming output.
+Set up some models with [carrierwave](https://github.com/jnicklas/carrierwave)
+or [paperclip](https://github.com/thoughtbot/paperclip).  Right now only plain
+file storage and S3 are supported in the case of
+[carrierwave](https://github.com/jnicklas/carrierwave) and only plain file
+storage and S3 are supported in the case of
+[paperclip](https://github.com/thoughtbot/paperclip).
+You'll need to be using puma or some other server that supports streaming output.
 
     class MyController < ApplicationController
       # enable streaming responses
@@ -29,13 +32,29 @@ You'll need to be using [unicorn](http://unicorn.bogomips.org/) or rainbows or s
       include Zipline
       
       def index
-        users= User.all
+        users = User.all
+        # you can replace user.avatar with any stream or any object that
+        # responds to :url
         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](http://ruby-doc.org/core-2.0.0/Enumerator/Lazy.html):
+
+    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')
     
 ## Contributing
 
@@ -48,5 +67,3 @@ For directories, just give the files names like "directory/file".
 ## TODO (possible contributions?)
 
 * 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.

data/lib/zipline.rb

@@ -1,10 +1,6 @@
 require "zipline/version"
-
-require 'zip'
 require 'curb'
-
-require "zipline/fake_stream"
-require "zipline/output_stream"
+require 'zip_tricks'
 require "zipline/zip_generator"
 
 # class MyController < ApplicationController

data/lib/zipline/version.rb

@@ -1,3 +1,3 @@
 module Zipline
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/lib/zipline/zip_generator.rb

@@ -13,21 +13,21 @@ module Zipline
     end
 
     def each(&block)
-      output = new_output(&block)
-      OutputStream.open(output) do |zip|
-        @files.each {|file, name| handle_file(zip, file, name) }
+      fake_io_writer = ZipTricks::BlockWrite.new(&block)
+      ZipTricks::Streamer.open(fake_io_writer) do |streamer|
+        @files.each {|file, name| handle_file(streamer, file, name) }
       end
     end
 
-    def handle_file(zip, file, name)
+    def handle_file(streamer, file, name)
       file = normalize(file)
       name = uniquify_name(name)
-      write_file(zip, file, name)
+      write_file(streamer, file, name)
     end
 
     def normalize(file)
       unless is_io?(file)
-        if file.respond_to?(:url) && (!defined?(::Paperclip::Attachment) || !file.is_a?(::Paperclip::Attachment))
+        if file.respond_to?(:url) || file.respond_to?(:expiring_url)
           file = file
         elsif file.respond_to? :file
           file = File.open(file.file)
@@ -40,42 +40,28 @@ module Zipline
       file
     end
 
-    def new_output(&block)
-      FakeStream.new(&block)
-    end
-
-    def write_file(zip, file, name)
-      size = get_size(file)
-      zip.put_next_entry name, size
-
-      if is_io?(file)
-        while buffer = file.read(2048)
-          zip << buffer
-        end
-      else
-        the_remote_url = file.url(Time.now + 1.minutes)
-        c = Curl::Easy.new(the_remote_url) do |curl|
-          curl.on_body do |data|
-            zip << data
-            data.bytesize
-          end
+    def write_file(streamer, file, name)
+      streamer.write_stored_file(name) do |writer_for_file|
+        if file.respond_to?(:url) || file.respond_to?(:expiring_url)
+          # expiring_url seems needed for paperclip to work
+          the_remote_url = file.respond_to?(:expiring_url) ? file.expiring_url : file.url
+          c = Curl::Easy.new(the_remote_url) do |curl|
+            curl.on_body do |data|
+              writer_for_file << data
+              data.bytesize
+            end
+	  end
+          c.perform
+        elsif is_io?(file)
+          IO.copy_stream(file, writer_for_file)
+	else 
+          raise(ArgumentError, 'Bad File/Stream')
         end
-        c.perform
-      end
-    end
-
-    def get_size(file)
-      if is_io?(file) || file.respond_to?(:size)
-        file.size
-      elsif file.respond_to? :content_length
-        file.content_length
-      else
-        throw 'cannot determine file size'
       end
     end
 
-    def is_io?(file)
-      file.is_a?(IO) || (defined?(StringIO) && file.is_a?(StringIO))
+    def is_io?(io_ish)
+      io_ish.respond_to? :read
     end
 
     def uniquify_name(name)

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@ Dir["#{File.expand_path('..', __FILE__)}/support/**/*.rb"].each { |f| require f
 
 
 RSpec.configure do |config|
-  config.color_enabled = true
+  config.color = true
   config.order = :random
   config.run_all_when_everything_filtered = true
 end

data/zipline.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('../lib/zipline/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Ram Dobson"]
   gem.email         = ["ram.dobson@solsystemscompany.com"]
-  gem.description   = %q{this is a giant pile of hax that may let you stream dynamically generated zip files}
+  gem.description   = %q{a module for streaming dynamically generated zip files}
   gem.summary       = %q{stream zip files from rails}
   gem.homepage      = "http://github.com/fringd/zipline"
 
@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Zipline::VERSION
 
-  gem.add_dependency 'rubyzip', ['>= 1.0', '<= 1.1.2']
-  gem.add_dependency 'rails', ['>= 3.2.1', '< 4.3']
-  gem.add_dependency 'curb'
+  gem.add_dependency 'zip_tricks', ['>= 4.0.0', '<= 5.0.0']
+  gem.add_dependency 'rails', ['>= 3.2.1', '< 5.1']
+  gem.add_dependency 'curb', ['>= 0.8.0', '< 0.10']
 end

metadata

@@ -1,78 +1,76 @@
 --- !ruby/object:Gem::Specification
 name: zipline
 version: !ruby/object:Gem::Version
-  version: 0.0.10
-  prerelease: 
+  version: 0.0.11
 platform: ruby
 authors:
 - Ram Dobson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2016-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubyzip
+  name: zip_tricks
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - <=
+        version: 4.0.0
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - <=
+        version: 4.0.0
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.1
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.1
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: curb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
-description: this is a giant pile of hax that may let you stream dynamically generated
-  zip files
+        version: '0.10'
+description: a module for streaming dynamically generated zip files
 email:
 - ram.dobson@solsystemscompany.com
 executables: []
@@ -84,8 +82,6 @@ files:
 - README.md
 - Rakefile
 - lib/zipline.rb
-- lib/zipline/fake_stream.rb
-- lib/zipline/output_stream.rb
 - lib/zipline/version.rb
 - lib/zipline/zip_generator.rb
 - spec/lib/zipline/zip_generator_spec.rb
@@ -93,27 +89,26 @@ files:
 - zipline.gemspec
 homepage: http://github.com/fringd/zipline
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: stream zip files from rails
 test_files:
 - spec/lib/zipline/zip_generator_spec.rb

data/lib/zipline/fake_stream.rb

@@ -1,43 +0,0 @@
-#this is a class that acts like an IO::Stream, but really puts to the browser
-module Zipline
-  class FakeStream
-
-    # &block is the block that each gets from rails... we pass it strings to send data
-    def initialize(&block)
-      @block = block
-      @pos = 0
-    end
-
-    def tell
-      @pos
-    end
-
-    def pos
-      @pos
-    end
-
-    def seek
-      throw :fit
-    end
-
-    def pos=
-      throw :fit
-    end
-
-    def to_s
-      throw :fit
-    end
-
-    def <<(x)
-      return if x.blank?
-      throw "bad class #{x.class}" unless x.class == String
-      @pos += x.bytesize
-      @block.call(x.to_s)
-    end
-
-    def close
-      nil
-    end
-
-  end
-end

data/lib/zipline/output_stream.rb

@@ -1,55 +0,0 @@
-# a ZipOutputStream that never rewinds output
-# in order for that to be possible we store only uncompressed files
-module Zipline
-  class OutputStream < Zip::OutputStream
-
-    #we need to be able to hand out own custom output in order to stream to browser
-    def initialize(io)
-      # Create an io stream thing
-      super StringIO.new, true
-      # Overwrite it with my own
-      @output_stream = io
-    end
-
-    def stream
-      @output_stream
-    end
-
-    def put_next_entry(entry_name, size)
-      new_entry = Zip::Entry.new(@file_name, entry_name)
-
-      #THIS IS THE MAGIC, tells zip to look after data for size, crc
-      new_entry.gp_flags = new_entry.gp_flags | 0x0008
-
-      super(new_entry)
-
-      # Uncompressed size in the local file header must be zero when bit 3
-      # of the general purpose flags is set, so set the size after the header
-      # has been written.
-      new_entry.size = size
-    end
-
-    # just reset state, no rewinding required
-    def finalize_current_entry
-      if current_entry
-        entry = current_entry
-        super
-        write_local_footer(entry)
-      end
-    end
-
-    def write_local_footer(entry)
-      @output_stream << [ 0x08074b50, entry.crc, entry.compressed_size, entry.size].pack('VVVV')
-    end
-
-    #never need to do this because we set correct sizes up front
-    def update_local_headers
-      nil
-    end
-
-    # helper to deal with difference between rubyzip 1.0 and 1.1
-    def current_entry
-      @currentEntry || @current_entry
-    end
-  end
-end