zipline 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f78131919f81ca6a316cb1f1c7173515a230cee
-  data.tar.gz: 5143037d6d038adf9af45b269f8653f4dd9c1d47
+  metadata.gz: 69a1498073cad22c14b800ca508220aadb0f1237
+  data.tar.gz: 1046ab42fb8678bcb2ad08ca4cd8b4c00f6bf8c7
 SHA512:
-  metadata.gz: 641f00ccfa244d4a5d7e25cb99aaac1356069e9ed1bdf1ea52da7437f613ebf6cc0a31ba0c707777bf0772c899f24d556e657ee29a39a3672a8841ff5d7ef7d7
-  data.tar.gz: bf7592dc54f890f4aadd6628d814048958308c8f20ea51ff3a34088312f497bc4b882b1b4a6fb8e8728dd03b130130cbb4c72617adc86484a738d9af810d22f6
+  metadata.gz: 296f7ba0ba6fa91e78a060b40edbda917ed4c839658faf639f50888d9089b9d992003a5e01348b0b3377b998a7b162bc4548c826569894f29ae6a4f0a632459b
+  data.tar.gz: 987a45caed0f8956172dff50e438198ddc8e36fe2f65c5a55bab67c5b24bc6df1aff7320f57bfe4c139d6f491963ca496f0e97fc292a4bdedee39ee677e0bd8b

data/.travis.yml

@@ -1,4 +1,8 @@
 language: ruby
+cache: bundler
 rvm:
+  - 2.3
   - 2.4
+  - 2.5
+  - 2.6
   

data/README.md

@@ -1,4 +1,6 @@
 # Zipline
+[![Build Status](https://travis-ci.org/fringd/zipline.svg?branch=master)](https://travis-ci.org/fringd/zipline)
+[![Gem Version](https://badge.fury.io/rb/zipline.svg)](https://badge.fury.io/rb/zipline)
 
 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:
 
@@ -28,37 +30,42 @@ supported with [shrine](https://github.com/janko-m/shrine).
 
 You'll need to be using puma 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
-        # 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
+```Ruby
+class MyController < ApplicationController
+  # enable streaming responses
+  include ActionController::Streaming
+  # enable zipline
+  include Zipline
+
+  def index
+    users = User.all
+    # you can replace user.avatar with any stream or any object that
+    # responds to :url.
+    # :modification_time is an optional third argument you can use.
+    files =  users.map{ |user| [user.avatar, "#{user.username}.png", modification_time: 1.day.ago] }
+    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')
-    
+```Ruby
+require 'open-uri'
+avatars = [
+  # remote_url                          zip_path
+  [ 'http://www.example.com/user1.png', 'avatars/user1.png', modification_time: Time.now.utc ]
+  [ 'http://www.example.com/user2.png', 'avatars/user2.png', modification_time: 1.day.ago ]
+  [ '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
 
 1. Fork it

data/lib/zipline.rb

@@ -6,9 +6,9 @@ require "zipline/zip_generator"
 # class MyController < ApplicationController
 #   include Zipline
 #   def index
-#     users= User.all
-#     files =  users.map{ |user| [user.avatar, "#{user.username}.png"] }
-#     zipline( files, 'avatars.zip')
+#     users = User.all
+#     files = users.map{ |user| [user.avatar, "#{user.username}.png", modification_time: 1.day.ago] }
+#     zipline(files, 'avatars.zip')
 #   end
 # end
 module Zipline

data/lib/zipline/version.rb

@@ -1,3 +1,3 @@
 module Zipline
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/zipline/zip_generator.rb

@@ -15,13 +15,15 @@ module Zipline
     def each(&block)
       fake_io_writer = ZipTricks::BlockWrite.new(&block)
       ZipTricks::Streamer.open(fake_io_writer) do |streamer|
-        @files.each {|file, name| handle_file(streamer, file, name) }
+        @files.each do |file, name, options = {}|
+          handle_file(streamer, file, name, options)
+        end
       end
     end
 
-    def handle_file(streamer, file, name)
+    def handle_file(streamer, file, name, options)
       file = normalize(file)
-      write_file(streamer, file, name)
+      write_file(streamer, file, name, options)
     end
 
     # This extracts either a url or a local file from the provided file.
@@ -46,6 +48,8 @@ module Zipline
         {file: file}
       elsif defined?(ActiveStorage::Blob) && file.is_a?(ActiveStorage::Blob)
         {url: file.service_url}
+      elsif is_active_storage_attachment?(file) || is_active_storage_one?(file)
+        {url: file.blob.service_url}
       elsif file.respond_to? :url
         {url: file.url}
       elsif file.respond_to? :path
@@ -57,8 +61,8 @@ module Zipline
       end
     end
 
-    def write_file(streamer, file, name)
-      streamer.write_deflated_file(name) do |writer_for_file|
+    def write_file(streamer, file, name, options)
+      streamer.write_deflated_file(name, options) do |writer_for_file|
         if file[:url]
           the_remote_url = file[:url]
           c = Curl::Easy.new(the_remote_url) do |curl|
@@ -80,5 +84,15 @@ module Zipline
     def is_io?(io_ish)
       io_ish.respond_to? :read
     end
+
+    private
+
+    def is_active_storage_attachment?(file)
+      defined?(ActiveStorage::Attachment) && file.is_a?(ActiveStorage::Attachment)
+    end
+
+    def is_active_storage_one?(file)
+      defined?(ActiveStorage::Attached::One) && file.is_a?(ActiveStorage::Attached::One)
+    end
   end
 end

data/spec/lib/zipline/zip_generator_spec.rb

@@ -84,29 +84,70 @@ describe Zipline::ZipGenerator do
         end
       end
     end
-    context "ActiveStorage::Blob" do
+    context "ActiveStorage" do
       module ActiveStorage
-        class Filename; end
+        class Attached
+          class One < Attached
+          end
+        end
+        class Attachment; end
         class Blob; end
       end
 
-      let(:tempfile){ Tempfile.new('t').read }
-      let(:filename) do
-        fn = ActiveStorage::Filename.new()
-        allow(fn).to receive(:to_s).and_return('spec/fakefile.txt')
-        fn
+      context "Attached::One" do
+        it "extracts url" do
+          attached = create_attached_one
+          allow_any_instance_of(Object).to receive(:defined?).and_return(true)
+
+          normalized = generator.normalize(attached)
+
+          expect(normalized.keys).to include(:url)
+          expect(normalized[:url]).to eq('fakeurl')
+        end
+      end
+
+      context "Attachment" do
+        it "extracts url" do
+          attachment = create_attachment
+          allow_any_instance_of(Object).to receive(:defined?).and_return(true)
+
+          normalized = generator.normalize(attachment)
+
+          expect(normalized.keys).to include(:url)
+          expect(normalized[:url]).to eq('fakeurl')
+        end
+      end
+
+      context "Blob" do
+        it "extracts url" do
+          blob = create_blob
+          allow_any_instance_of(Object).to receive(:defined?).and_return(true)
+
+          normalized = generator.normalize(blob)
+
+          expect(normalized.keys).to include(:url)
+          expect(normalized[:url]).to eq('fakeurl')
+        end
+      end
+
+      def create_attached_one
+        attached = ActiveStorage::Attached::One.new
+        blob = create_blob
+        allow(attached).to receive(:blob).and_return(blob)
+        attached
       end
-      let(:file) do
-        f = ActiveStorage::Blob.new()
-        allow(f).to receive(:filename).and_return(filename)
-        allow(f).to receive(:service_url).and_return('fakeurl')
-        f
+
+      def create_attachment
+        attachment = ActiveStorage::Attachment.new
+        blob = create_blob
+        allow(attachment).to receive(:blob).and_return(blob)
+        attachment
       end
-      it "creates a File" do
-        allow_any_instance_of(Object).to receive(:defined?).and_return(true)
-        normalized = generator.normalize(file)
-        expect(normalized.keys).to include(:url)
-        expect(normalized[:url]).to eq('fakeurl')
+
+      def create_blob
+        blob = ActiveStorage::Blob.new
+        allow(blob).to receive(:service_url).and_return('fakeurl')
+        blob
       end
     end
     context "Fog" do
@@ -130,4 +171,46 @@ describe Zipline::ZipGenerator do
     end
   end
 
+  describe 'passing an options hash' do
+    let(:file) { StringIO.new('passthrough') }
+
+    context 'with optional arguments' do
+      let(:mtime) { 1.day.ago }
+      let(:generator) do
+        Zipline::ZipGenerator.new([[file, 'test', modification_time: mtime]])
+      end
+
+      it 'passes the options hash through handle_file' do
+        expect(generator).to receive(:handle_file)
+          .with(anything, anything, anything, modification_time: mtime)
+        generator.each { |_| 'Test' }
+      end
+
+      it 'passes the options hash to ZipTricks' do
+        allow(file).to receive(:url).and_return('fakeurl')
+        expect_any_instance_of(ZipTricks::Streamer).to receive(:write_deflated_file)
+          .with(anything, modification_time: mtime)
+        generator.each { |_| 'Test' }
+      end
+    end
+
+    context 'without optional arguments' do
+      let(:generator) do
+        Zipline::ZipGenerator.new([[file, 'test']])
+      end
+
+      it 'passes the options hash through handle_file' do
+        expect(generator).to receive(:handle_file)
+          .with(anything, anything, anything, {})
+        generator.each { |_| 'Test' }
+      end
+
+      it 'passes the options hash to ZipTricks' do
+        allow(file).to receive(:url).and_return('fakeurl')
+        expect_any_instance_of(ZipTricks::Streamer).to receive(:write_deflated_file)
+          .with(anything, {})
+        generator.each { |_| 'Test' }
+      end
+    end
+  end
 end

data/zipline.gemspec

@@ -16,6 +16,6 @@ Gem::Specification.new do |gem|
   gem.version       = Zipline::VERSION
 
   gem.add_dependency 'zip_tricks', ['>= 4.2.1', '<= 5.0.0']
-  gem.add_dependency 'rails', ['>= 3.2.1', '< 5.3']
+  gem.add_dependency 'rails', ['>= 3.2.1', '< 6.1']
   gem.add_dependency 'curb', ['>= 0.8.0', '< 0.10']
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zipline
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Ram Dobson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-24 00:00:00.000000000 Z
+date: 2019-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zip_tricks
@@ -39,7 +39,7 @@ dependencies:
         version: 3.2.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: 3.2.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: curb
   requirement: !ruby/object:Gem::Requirement