zipline 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8de63c7a8518461b8fdbb249ce857b3f06ffc2bf3a7de69d6d5d6c5111f75015
-  data.tar.gz: edfc26eed9a1d52987a4d47330a015d2ebb0e3129f2c0791199a51b3b5abec70
+  metadata.gz: 8735b5a6429dcffa8672a1a970cc37145eadfd5e5ff13e2cb5b3f08166895d14
+  data.tar.gz: a4555919f140b0661cb12fd0e6f92900e419319ebf7ec7c376ce19034dffd9a9
 SHA512:
-  metadata.gz: cc54e592ebd7c24cad03669786938a3662430389e81322ceef258898ec5d8e9949db956a7433ab7c4d139b4671100772c062c525f8d20b6782f3a221b80ea9f3
-  data.tar.gz: 2482828adb931c9630c209b7a9a06c913b43d577232dea8d877b88acb1fa3b60834c35a92175608610da0d7e80ad36d6a1f8cd2379b9af5a249ce2b1f7456990
+  metadata.gz: 758292743ee475bc2a276bd00d953fa4f0b1cb1c4ccd2ceae7b2c7dbeced0e1a901a609d183a68c6eeaa898693045f3d5f4ee23bfece0c35b379fb7ce170cdc2
+  data.tar.gz: 7383e439111008fa964a2d762f6855351d3a0372df973d453e0b205aee57f53d9fc8aea54e4f7efed6719b3b8318768f8d125e314ad277f2855bac29fa63c5e2

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Test (${{ matrix.ruby-version }})
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - '3.1'
+          - '3.0'
+          - '2.7'
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # 'bundle install' and cache
+    - name: Run tests
+      run: bundle exec rake

data/Gemfile

@@ -7,6 +7,7 @@ group :development, :test do
   gem 'rspec', '~> 3'
   gem 'fog-aws'
   gem 'activesupport'
+  gem 'actionpack'
   gem 'aws-sdk-s3'
   gem 'carrierwave'
   gem 'paperclip'

data/README.md

@@ -1,5 +1,5 @@
 # Zipline
-[![Build Status](https://travis-ci.org/fringd/zipline.svg?branch=master)](https://travis-ci.org/fringd/zipline)
+[![Tests](https://github.com/fringd/zipline/actions/workflows/ci.yml/badge.svg)](https://github.com/fringd/zipline/actions/workflows/ci.yml)
 [![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:
@@ -41,7 +41,10 @@ class MyController < ApplicationController
     # responds to :url, :path or :file.
     # :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')
+
+    # we can force duplicate file names to be renamed, or raise an error
+    # we can also pass in our own writer if required to conform with the Delegated [ZipTricks::Streamer object](https://github.com/WeTransfer/zip_tricks/blob/main/lib/zip_tricks/streamer.rb#L147) object.
+    zipline(files, 'avatars.zip', auto_rename_duplicate_filenames: true) 
   end
 end
 ```

data/lib/zipline/version.rb

@@ -1,3 +1,3 @@
 module Zipline
-  VERSION = "1.3.0"
+  VERSION = "1.5.0"
 end

data/lib/zipline/zip_generator.rb

@@ -3,8 +3,9 @@
 module Zipline
   class ZipGenerator
     # takes an array of pairs [[uploader, filename], ... ]
-    def initialize(files)
+    def initialize(files,  **kwargs_for_new)
       @files = files
+      @kwargs_for_new = kwargs_for_new
     end
 
     #this is supposed to be streamed!
@@ -29,7 +30,7 @@ module Zipline
       # this might pose a problem. Unlikely that it will be an issue here though.
       write_buffer_size = 16 * 1024
       write_buffer = ZipTricks::WriteBuffer.new(fake_io_writer, write_buffer_size)
-      ZipTricks::Streamer.open(write_buffer) do |streamer|
+      ZipTricks::Streamer.open(write_buffer, **@kwargs_for_new) do |streamer|
         @files.each do |file, name, options = {}|
           handle_file(streamer, file, name.to_s, options)
         end
@@ -80,7 +81,7 @@ module Zipline
     end
 
     def write_file(streamer, file, name, options)
-      streamer.write_deflated_file(name, options) do |writer_for_file|
+      streamer.write_deflated_file(name, **options.slice(:modification_time)) do |writer_for_file|
         if file[:url]
           the_remote_uri = URI(file[:url])
 

data/lib/zipline.rb

@@ -1,3 +1,4 @@
+require 'content_disposition'
 require "zipline/version"
 require 'zip_tricks'
 require "zipline/zip_generator"
@@ -11,9 +12,9 @@ require "zipline/zip_generator"
 #   end
 # end
 module Zipline
-  def zipline(files, zipname = 'zipline.zip')
-    zip_generator = ZipGenerator.new(files)
-    headers['Content-Disposition'] = "attachment; filename=\"#{zipname.gsub '"', '\"'}\""
+  def zipline(files, zipname = 'zipline.zip', **kwargs_for_new)
+    zip_generator = ZipGenerator.new(files, **kwargs_for_new)
+    headers['Content-Disposition'] = ContentDisposition.format(disposition: 'attachment', filename: zipname)
     headers['Content-Type'] = Mime::Type.lookup_by_extension('zip').to_s
     response.sending_file = true
     response.cache_control[:public] ||= false

data/spec/lib/zipline/zip_generator_spec.rb

@@ -199,7 +199,7 @@ describe Zipline::ZipGenerator do
       it 'passes a string as filename to ZipTricks' do
         allow(file).to receive(:url).and_return('fakeurl')
         expect_any_instance_of(ZipTricks::Streamer).to receive(:write_deflated_file)
-          .with('test', {})
+          .with('test')
         generator.each { |_| 'Test' }
       end
     end
@@ -216,11 +216,11 @@ describe Zipline::ZipGenerator do
 
       it 'passes the options hash through handle_file' do
         expect(generator).to receive(:handle_file)
-          .with(anything, anything, anything, modification_time: mtime)
+          .with(anything, anything, anything, { modification_time: mtime })
         generator.each { |_| 'Test' }
       end
 
-      it 'passes the options hash to ZipTricks' do
+      it 'passes the options hash to ZipTricks as kwargs' 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)
@@ -239,12 +239,37 @@ describe Zipline::ZipGenerator do
         generator.each { |_| 'Test' }
       end
 
-      it 'passes the options hash to ZipTricks' do
+      it 'passes the options hash to ZipTricks as kwargs' do
         allow(file).to receive(:url).and_return('fakeurl')
         expect_any_instance_of(ZipTricks::Streamer).to receive(:write_deflated_file)
-          .with(anything, {})
+          .with(anything)
         generator.each { |_| 'Test' }
       end
     end
+
+    context 'with extra invalid options' do
+      let(:mtime) { 1.day.ago }
+      let(:generator) do
+        Zipline::ZipGenerator.new([[file, 'test', modification_time: mtime, extra: 'invalid']])
+      end
+
+      it 'passes the whole options hash through handle_file' do
+        expect(generator).to receive(:handle_file)
+          .with(anything, anything, anything, { modification_time: mtime, extra: 'invalid' })
+        generator.each { |_| 'Test' }
+      end
+
+      it 'only passes the kwargs to ZipTricks that it expects (i.e., :modification_time)' 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
+  end
+  it 'passes along constructor options to ZipTricks streamer' do
+    expect(ZipTricks::Streamer).to receive(:open).with(anything, { :some => 'options' })
+    generator = Zipline::ZipGenerator.new([file, 'somefile'], :some => 'options')
+    generator.each { |_| 'Test' }
   end
 end

data/spec/lib/zipline/zipline_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'ostruct'
+
+describe Zipline do
+  before { Fog.mock! }
+
+  let (:undertest) {
+    class TestZipline
+
+      attr_accessor :headers
+      attr_accessor :response
+      attr_accessor :response_body
+      def initialize 
+        @headers = {}
+        @response = OpenStruct.new(:cache_control => {}, :headers => {} )
+      end
+      include Zipline
+    end 
+    return TestZipline.new()
+  }
+
+
+  it 'passes arguments along' do
+    expect(Zipline::ZipGenerator).to receive(:new)
+          .with(['some', 'fake', 'files'], { some: 'options' })
+    undertest.zipline(['some', 'fake', 'files'], 'myfiles.zip', some: 'options')
+    expect(undertest.headers['Content-Disposition']).to eq("attachment; filename=\"myfiles.zip\"; filename*=UTF-8''myfiles.zip")
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'rspec'
 require 'active_support'
 require 'active_support/core_ext'
+require 'action_dispatch'
+
 require 'zipline'
 require 'paperclip'
 require 'fog-aws'

data/zipline.gemspec

@@ -16,6 +16,12 @@ Gem::Specification.new do |gem|
   gem.version       = Zipline::VERSION
   gem.licenses      = ['MIT']
 
-  gem.add_dependency 'actionpack', ['>= 3.2.1', '< 7.0']
+  gem.required_ruby_version = ">= 2.7"
+
+  gem.add_dependency 'actionpack', ['>= 6.0', '< 8.0']
+  gem.add_dependency 'content_disposition', '~> 1.0'
   gem.add_dependency 'zip_tricks', ['>= 4.2.1', '< 6.0']
+
+  # https://github.com/rspec/rspec-mocks/issues/1457
+  gem.add_development_dependency 'rspec-mocks', '3.10.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zipline
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Ram Dobson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,20 +16,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: content_disposition
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: zip_tricks
   requirement: !ruby/object:Gem::Requirement
@@ -50,6 +64,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.10.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.10.2
 description: a module for streaming dynamically generated zip files
 email:
 - ram.dobson@solsystemscompany.com
@@ -57,7 +85,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".travis.yml"
+- ".github/workflows/ci.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -67,6 +95,7 @@ files:
 - lib/zipline/zip_generator.rb
 - spec/fakefile.txt
 - spec/lib/zipline/zip_generator_spec.rb
+- spec/lib/zipline/zipline_spec.rb
 - spec/spec_helper.rb
 - zipline.gemspec
 homepage: http://github.com/fringd/zipline
@@ -81,18 +110,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: stream zip files from rails
 test_files:
 - spec/fakefile.txt
 - spec/lib/zipline/zip_generator_spec.rb
+- spec/lib/zipline/zipline_spec.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - 3.0