zipline 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69a1498073cad22c14b800ca508220aadb0f1237
-  data.tar.gz: 1046ab42fb8678bcb2ad08ca4cd8b4c00f6bf8c7
+  metadata.gz: 96ac7be793e58df09d1d469bdc9caf1ebab6738d
+  data.tar.gz: c6b3d727ce0b40efdc152180f2d9f39a6c457154
 SHA512:
-  metadata.gz: 296f7ba0ba6fa91e78a060b40edbda917ed4c839658faf639f50888d9089b9d992003a5e01348b0b3377b998a7b162bc4548c826569894f29ae6a4f0a632459b
-  data.tar.gz: 987a45caed0f8956172dff50e438198ddc8e36fe2f65c5a55bab67c5b24bc6df1aff7320f57bfe4c139d6f491963ca496f0e97fc292a4bdedee39ee677e0bd8b
+  metadata.gz: f5f83af934fdc07acaa345d62e78ed995529b32b509ee6d828639ba61cd2c7cadc9d9df65df5e27a97293a2ca55e876215569f00aa4ae3e705250d46b7d697bf
+  data.tar.gz: 8f3e3cee734917325717aeb8e6ddbe5d49fa1d17409b8ebdf6a168d6fd2fae7af73d92c8b485b70a13c066087024beeadfe0181fdf3ebb068d388febd2a16150

data/README.md

@@ -32,38 +32,71 @@ You'll need to be using puma or some other server that supports streaming output
 
 ```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.
+    # 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] }
+    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):
 
 ```Ruby
-require 'open-uri'
 avatars = [
-  # remote_url                          zip_path
+  # 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' ]
 ]
-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')
+
+zipline(avatars, 'avatars.zip')
 ```
 
 ## Contributing

data/lib/zipline.rb

@@ -1,5 +1,4 @@
 require "zipline/version"
-require 'curb'
 require 'zip_tricks'
 require "zipline/zip_generator"
 

data/lib/zipline/version.rb

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

data/lib/zipline/zip_generator.rb

@@ -47,15 +47,17 @@ module Zipline
       elsif is_io?(file)
         {file: file}
       elsif defined?(ActiveStorage::Blob) && file.is_a?(ActiveStorage::Blob)
-        {url: file.service_url}
+        {blob: file}
       elsif is_active_storage_attachment?(file) || is_active_storage_one?(file)
-        {url: file.blob.service_url}
+        {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
@@ -64,17 +66,18 @@ module Zipline
     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
@@ -94,5 +97,10 @@ module Zipline
     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

@@ -95,38 +95,38 @@ describe Zipline::ZipGenerator do
       end
 
       context "Attached::One" do
-        it "extracts url" 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(:url)
-          expect(normalized[:url]).to eq('fakeurl')
+          expect(normalized.keys).to include(:blob)
+          expect(normalized[:blob]).to be_a(ActiveStorage::Blob)
         end
       end
 
       context "Attachment" do
-        it "extracts url" 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(:url)
-          expect(normalized[:url]).to eq('fakeurl')
+          expect(normalized.keys).to include(:blob)
+          expect(normalized[:blob]).to be_a(ActiveStorage::Blob)
         end
       end
 
       context "Blob" do
-        it "extracts url" 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(:url)
-          expect(normalized[:url]).to eq('fakeurl')
+          expect(normalized.keys).to include(:blob)
+          expect(normalized[:blob]).to be_a(ActiveStorage::Blob)
         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', '< 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.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Ram Dobson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-21 00:00:00.000000000 Z
+date: 2019-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zip_tricks
@@ -50,26 +50,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.1'
-- !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'
 description: a module for streaming dynamically generated zip files
 email:
 - ram.dobson@solsystemscompany.com
@@ -90,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: []