zipline 1.0.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d870d86f6be0fe78deb3549c7037808bcb91551d
-  data.tar.gz: fe5c5fac16ca3d02ac37c1fd8981e8eda1052ad6
+  metadata.gz: 60e9847b29f301c7d2a2b7ff9614454f0e3a1193
+  data.tar.gz: b9b391b9478f96f0fa067918e4368a5415332123
 SHA512:
-  metadata.gz: 1622bf22aecbe54887642408a64b2cafa40559d6b17cb7b2f3ec3e42275dca4af77675237145f09537cf64c35cc909d8842fcedc1c632268e76f3d860acb600b
-  data.tar.gz: fa212e4a62d7c44508b2374b2619b07a97b8db35565f9b6b07541f26306d308f8612ae31bc6d7145fe584c1bbe913f205c5746e5f046a000dd8b6e12df0f861e
+  metadata.gz: e25c8bba3c7b7d6c093637c1323d0a4bb6660e94457e4445cc3e6798f7125e8c5c0b99a334de0430ef4ced180e00a4001c29b6ab9c92525dd0a6eca689b0dbe7
+  data.tar.gz: db9b45bfb987cf97f025c4c2cbeb818a821bd7968524df56ac44d6eaebea4b8420b634815b6a6cde8ff32976e67b20183f8dfa404a0ffa05b91aef824c645a79

data/.travis.yml

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

data/Gemfile

@@ -4,7 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rubyzip', '~> 1.2'
   gem 'rspec', '~> 3'
   gem 'fog'
   gem 'fog-aws'
@@ -12,4 +11,6 @@ group :development, :test do
   gem 'aws-sdk'
   gem 'carrierwave'
   gem 'paperclip'
+  gem 'rake'
+  gem 'rake-rspec'
 end

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:
 
@@ -19,45 +21,84 @@ And then execute:
 
 ## Usage
 
-Set up some models with [carrierwave](https://github.com/jnicklas/carrierwave), [paperclip](https://github.com/thoughtbot/paperclip), or [shrine](https://github.com/janko-m/shrine).  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). [Mutiple file storages](http://shrinerb.com/#external) are supported with [shrine](https://github.com/janko-m/shrine).
+Set up some models with [ActiveStorage](http://edgeguides.rubyonrails.org/active_storage_overview.html)
+[carrierwave](https://github.com/jnicklas/carrierwave), [paperclip](https://github.com/thoughtbot/paperclip), or
+[shrine](https://github.com/janko-m/shrine). 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). [Mutiple file storages](http://shrinerb.com/#external) are
+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 zipline
+  include Zipline
+
+  def index
+    users = User.all
+    # you can replace user.avatar with any stream or any object that
+    # 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')
+  end
+end
+```
+
+### ActiveStorage
+
+```Ruby
+users = User.all
+files = users.map{ |user| [user.avatar, user.avatar.filename] }
+zipline(files, 'avatars.zip')
+```
+
+### Carrierwave
+
+```Ruby
+users = User.all
+files = users.map{ |user| [user.avatar, user.avatar_identifier] }
+zipline(files, 'avatars.zip')
+```
+
+### Paperclip ([deprecated](https://thoughtbot.com/blog/closing-the-trombone))
+
+```Ruby
+users = User.all
+files = users.map{ |user| [user.avatar, user.avatar_file_name] }
+zipline(files, 'avatars.zip')
+```
+
+### Url
+
+If you know the URL of the remote file you want to include, you can just pass in the
+URL directly in place of the attachment object.
+```Ruby
+avatars = [
+  ['http://www.example.com/user1.png', 'user1.png']
+  ['http://www.example.com/user2.png', 'user2.png']
+  ['http://www.example.com/user3.png', 'user3.png']
+]
+zipline(avatars, 'avatars.zip')
+```
+
+### Directories
 
 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
+avatars = [
+  # remote_url                          zip_path             zip_tricks_options
+  [ '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' ]
+]
+
+zipline(avatars, 'avatars.zip')
+```
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,2 +1,4 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rake/rspec"
+task :default => :spec

data/lib/zipline.rb

@@ -1,14 +1,13 @@
 require "zipline/version"
-require 'curb'
 require 'zip_tricks'
 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.1"
+  VERSION = "1.2.1"
 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.
@@ -44,31 +46,38 @@ module Zipline
         {file: File.open(file.path)}
       elsif is_io?(file)
         {file: file}
+      elsif defined?(ActiveStorage::Blob) && file.is_a?(ActiveStorage::Blob)
+        {blob: file}
+      elsif is_active_storage_attachment?(file) || is_active_storage_one?(file)
+        {blob: file.blob}
       elsif file.respond_to? :url
         {url: file.url}
       elsif file.respond_to? :path
         {file: File.open(file.path)}
       elsif file.respond_to? :file
         {file: File.open(file.file)}
+      elsif is_url?(file)
+        {url: file}
       else
         raise(ArgumentError, 'Bad File/Stream')
       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|
-            curl.on_body do |data|
-              writer_for_file << data
-              data.bytesize
+          the_remote_uri = URI(file[:url])
+
+          Net::HTTP.get_response(the_remote_uri) do |response|
+            response.read_body do |chunk|
+              writer_for_file << chunk
             end
           end
-          c.perform
         elsif file[:file]
           IO.copy_stream(file[:file], writer_for_file)
           file[:file].close
+        elsif file[:blob]
+          file[:blob].download { |chunk| writer_for_file << chunk }
         else
           raise(ArgumentError, 'Bad File/Stream')
         end
@@ -78,5 +87,20 @@ 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
+
+    def is_url?(url)
+      url = URI.parse(url) rescue false
+      url.kind_of?(URI::HTTP) || url.kind_of?(URI::HTTPS)
+    end
   end
 end

data/spec/lib/zipline/zip_generator_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 require 'tempfile'
 
 describe Zipline::ZipGenerator do
-
   before { Fog.mock! }
   let(:file_attributes){ {
     key: 'fog_file_tests',
@@ -67,7 +66,7 @@ describe Zipline::ZipGenerator do
       end
     end
     context "Paperclip" do
-      context "Local" do 
+      context "Local" do
         let(:file){ Paperclip::Attachment.new(:name, :instance) }
         it "creates a File" do
           allow(file).to receive(:path).and_return('spec/fakefile.txt')
@@ -76,7 +75,7 @@ describe Zipline::ZipGenerator do
           expect(normalized[:file]).to be_a File
         end
       end
-      context "Remote" do 
+      context "Remote" do
         let(:file){ Paperclip::Attachment.new(:name, :instance, storage: :s3) }
         it "creates a URL" do
           allow(file).to receive(:expiring_url).and_return('fakeurl')
@@ -85,6 +84,72 @@ describe Zipline::ZipGenerator do
         end
       end
     end
+    context "ActiveStorage" do
+      module ActiveStorage
+        class Attached
+          class One < Attached
+          end
+        end
+        class Attachment; end
+        class Blob; end
+      end
+
+      context "Attached::One" do
+        it "get blob" 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(:blob)
+          expect(normalized[:blob]).to be_a(ActiveStorage::Blob)
+        end
+      end
+
+      context "Attachment" do
+        it "get blob" do
+          attachment = create_attachment
+          allow_any_instance_of(Object).to receive(:defined?).and_return(true)
+
+          normalized = generator.normalize(attachment)
+
+          expect(normalized.keys).to include(:blob)
+          expect(normalized[:blob]).to be_a(ActiveStorage::Blob)
+        end
+      end
+
+      context "Blob" do
+        it "get blob" do
+          blob = create_blob
+          allow_any_instance_of(Object).to receive(:defined?).and_return(true)
+
+          normalized = generator.normalize(blob)
+
+          expect(normalized.keys).to include(:blob)
+          expect(normalized[:blob]).to be_a(ActiveStorage::Blob)
+        end
+      end
+
+      def create_attached_one
+        attached = ActiveStorage::Attached::One.new
+        blob = create_blob
+        allow(attached).to receive(:blob).and_return(blob)
+        attached
+      end
+
+      def create_attachment
+        attachment = ActiveStorage::Attachment.new
+        blob = create_blob
+        allow(attachment).to receive(:blob).and_return(blob)
+        attachment
+      end
+
+      def create_blob
+        blob = ActiveStorage::Blob.new
+        allow(blob).to receive(:service_url).and_return('fakeurl')
+        blob
+      end
+    end
     context "Fog" do
       it "extracts url" do
         allow(file).to receive(:url).and_return('fakeurl')
@@ -106,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

@@ -14,8 +14,8 @@ Gem::Specification.new do |gem|
   gem.name          = "zipline"
   gem.require_paths = ["lib"]
   gem.version       = Zipline::VERSION
+  gem.licenses      = ['MIT']
 
-  gem.add_dependency 'zip_tricks', ['>= 4.2.1', '<= 5.0.0']
-  gem.add_dependency 'rails', ['>= 3.2.1', '< 5.3']
-  gem.add_dependency 'curb', ['>= 0.8.0', '< 0.10']
+  gem.add_dependency 'zip_tricks', ['>= 4.2.1', '< 6.0']
+  gem.add_dependency 'rails', ['>= 3.2.1', '< 6.1']
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zipline
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Ram Dobson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2020-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zip_tricks
@@ -17,9 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.1
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.1
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -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,27 +49,7 @@ dependencies:
         version: 3.2.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
-- !ruby/object:Gem::Dependency
-  name: curb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '6.1'
 description: a module for streaming dynamically generated zip files
 email:
 - ram.dobson@solsystemscompany.com
@@ -77,6 +57,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -89,7 +70,8 @@ files:
 - spec/spec_helper.rb
 - zipline.gemspec
 homepage: http://github.com/fringd/zipline
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []