active_storage-send_zip 0.2.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5dbef1dda4a5236e3290d9cd38a23de7e296b5e404356bf222dfbeb0c75197b
-  data.tar.gz: d2558817de8b496c48606c1e3af71df086480eede14b55186ea4a5e7206bfe5c
+  metadata.gz: 966ba7df8726b10f7eb60c06e8dcd853d83314df3f6b32864f6f664c6232bd3a
+  data.tar.gz: 4de295c7dbf7b745e25479dc14cb6ea7e0820de91af42624dcc0e2d2c9ba2032
 SHA512:
-  metadata.gz: 49f3758cc21c8a66dce8f69fe231c679f0802ad8374a222f8a178557ac668b5c2cf3ce7ea4a4f1d0c1e40dcb701a65c200de7bea3e82089cc56a3e20d9495e5f
-  data.tar.gz: 8830d24a60774f277e4576614243a077f661d08313259aaa501692ca5f58cb5bb13ef8975e6659432433d366195211e5f3c38c8bd25e2312feee1352908bf7a6
+  metadata.gz: b33e45e395f5afefa479cb379d415186180d8c0841eaa3eb7ac37a935e982e7ef726c1b1b1c5aa7fb789b975d78403b21028a5db9c0f6b01e238bdc2f2200737
+  data.tar.gz: 0afb7ed7c8b781bde6b8673e6d5d2536e6891deb6c35959b18944d5ee2f3977ea3c39720a1de1a0c93d2311e4ee2d10ddbde0d94d2292f023ff2cecda4b1446d

data/CHANGELOG.yml

@@ -1,3 +1,11 @@
+0.3.4:
+  - add resize before download capability
+0.3.2:
+  - correct rubyzip dependency
+0.3.1:
+  - correct comportement when `ActiveStorage::Attached::Many` is given as paramter
+0.3.0:
+  - correct subfolders creation (and break some methods signature)
 0.2.0:
   - move some methods to avoid to polute controller methods
     - `ActiveStorage::SendZip#save_files_on_server` become `ActiveStorage::SendZipHelperSendZip#save_files_on_server`

data/Gemfile

@@ -4,7 +4,3 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in active_storage-send_zip.gemspec
 gemspec
-
-gem "rails", "~> 5.2"
-
-gem "rubyzip", "~> 1.2"

data/Gemfile.lock

@@ -1,130 +1,146 @@
 PATH
   remote: .
   specs:
-    active_storage-send_zip (0.2.0)
+    active_storage-send_zip (0.3.4)
+      rails (> 5.2)
+      rubyzip (< 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.1.1)
-      actionpack (= 5.2.1.1)
+    actioncable (6.0.3.2)
+      actionpack (= 6.0.3.2)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.1.1)
-      actionpack (= 5.2.1.1)
-      actionview (= 5.2.1.1)
-      activejob (= 5.2.1.1)
+    actionmailbox (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.1.1)
-      actionview (= 5.2.1.1)
-      activesupport (= 5.2.1.1)
-      rack (~> 2.0)
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.1.1)
-      activesupport (= 5.2.1.1)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.1.1)
-      activesupport (= 5.2.1.1)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.2)
+      activesupport (= 6.0.3.2)
       globalid (>= 0.3.6)
-    activemodel (5.2.1.1)
-      activesupport (= 5.2.1.1)
-    activerecord (5.2.1.1)
-      activemodel (= 5.2.1.1)
-      activesupport (= 5.2.1.1)
-      arel (>= 9.0)
-    activestorage (5.2.1.1)
-      actionpack (= 5.2.1.1)
-      activerecord (= 5.2.1.1)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activestorage (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
       marcel (~> 0.3.1)
-    activesupport (5.2.1.1)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (9.0.0)
-    builder (3.2.3)
-    concurrent-ruby (1.1.3)
-    crass (1.0.4)
-    erubi (1.7.1)
-    globalid (0.4.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    erubi (1.9.0)
+    globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.1.1)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    loofah (2.2.3)
+    loofah (2.6.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
-    method_source (0.9.2)
-    mimemagic (0.3.2)
-    mini_mime (1.0.1)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
-    nio4r (2.3.1)
-    nokogiri (1.8.5)
-      mini_portile2 (~> 2.3.0)
-    rack (2.0.6)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    nio4r (2.5.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.1.1)
-      actioncable (= 5.2.1.1)
-      actionmailer (= 5.2.1.1)
-      actionpack (= 5.2.1.1)
-      actionview (= 5.2.1.1)
-      activejob (= 5.2.1.1)
-      activemodel (= 5.2.1.1)
-      activerecord (= 5.2.1.1)
-      activestorage (= 5.2.1.1)
-      activesupport (= 5.2.1.1)
+    rails (6.0.3.2)
+      actioncable (= 6.0.3.2)
+      actionmailbox (= 6.0.3.2)
+      actionmailer (= 6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actiontext (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       bundler (>= 1.3.0)
-      railties (= 5.2.1.1)
+      railties (= 6.0.3.2)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.1.1)
-      actionpack (= 5.2.1.1)
-      activesupport (= 5.2.1.1)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
-    rake (10.5.0)
-    rubyzip (1.2.2)
-    sprockets (3.7.2)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    rubyzip (2.3.0)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.2.1)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    thor (0.20.3)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    websocket-driver (0.7.0)
+    websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   active_storage-send_zip!
-  bundler (~> 1.17)
+  bundler
   minitest (~> 5.0)
-  rails (~> 5.2)
-  rake (~> 10.0)
-  rubyzip (~> 1.2)
+  rake
 
 BUNDLED WITH
-   1.17.1
+   2.1.4

data/README.md

@@ -61,7 +61,10 @@ class HolidaysController < ApplicationController
   def zip
     send_zip {
       'Holidays in Lyon <3' => Holidays.where(place: 'lyon').first.pictures,
-      'Holidays in Paris' => Holidays.where(place: 'paris').first.pictures,
+      'Holidays in Paris' => [
+        'Eiffle Tower' => Holidays.where(place: 'eiffle_tower').first.pictures,
+        Holidays.where(place: 'paris').first.pictures
+      ]
     }
   end
 end
@@ -75,11 +78,43 @@ Will produce a `.zip` archive like this:
 │   ├── b.png
 │   └── c.gif
 └── Holidays in Paris
+    ├── Eiffle Tower
+        ├── d.jpg
+        ├── e.jpg
+        ├── f.jpg
     ├── a.jpg
     ├── b.png
     └── c.gif
 ~~~
 
+
+### Resize images before downloading
+
+You can resize the images before zipping and downloading them :
+
+~~~ruby
+# app/controllers/galleries_controller.rb
+class GalleriesController < ApplicationController
+  include ActiveStorage::SendZip
+
+  # ...
+
+  # GET /galleries/1/download
+  def download
+    respond_to do |format|
+      if params[:format] == 'web_size'
+        format.zip { send_zip @gallery.photos, resize_to_limit: [1920, 1080] }
+      elsif params[:format] == 'tiny'
+        format.zip { send_zip @gallery.photos, resize_to_limit: [480, 270] }
+      else
+        format.zip { send_zip @gallery.photos }
+      end
+    end
+  end
+end
+~~~
+
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/active_storage-send_zip.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'active_storage/send_zip/version'
@@ -5,7 +7,7 @@ require 'active_storage/send_zip/version'
 Gem::Specification.new do |spec|
   spec.name          = 'active_storage-send_zip'
   spec.version       = ActiveStorage::SendZip::VERSION
-  spec.authors       = ['Alexandre Rousseau']
+  spec.authors       = ['Alexandre Rousseau', 'Maxime `biximilien` Gauthier']
   spec.email         = ['contact@rousseau-alexandre.fr']
 
   spec.summary       = 'Create a zip from one or more Active Storage objects'
@@ -35,7 +37,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake'
+  spec.add_dependency 'rails', '> 5.2'
+  spec.add_dependency 'rubyzip', '< 3.0'
 end

data/lib/active_storage/send_zip.rb

@@ -14,9 +14,10 @@ module ActiveStorage
     #
     # @param active_storages [ActiveStorage::Attached::Many] files to save
     # @param filename [ActiveStorage::Attached::Many] files to save
-    def send_zip(active_storages, filename: 'my.zip')
+    # @param resize_to_limit [Array] resize to limit filter in ImageProcessing format [width, height]
+    def send_zip(active_storages, filename: 'my.zip', resize_to_limit: nil)
       require 'zip'
-      files = SendZipHelper.save_files_on_server active_storages
+      files = SendZipHelper.save_files_on_server active_storages, resize_to_limit: resize_to_limit
       zip_data = SendZipHelper.create_temporary_zip_file files
 
       send_data(zip_data, type: 'application/zip', filename: filename)

data/lib/active_storage/send_zip/version.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module ActiveStorage
   module SendZip
     # The version of this gem
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.4'
   end
 end

data/lib/active_storage/send_zip_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails'
 require 'zip'
 require 'tempfile'
@@ -9,32 +11,60 @@ module ActiveStorage
   module SendZipHelper
     # Download active storage files on server in a temporary folder
     #
-    # @param files [ActiveStorage::Attached::Many] files to save
-    # @return [Array<String>] files paths of saved files
-    def self.save_files_on_server(files)
+    # @param files [ActiveStorage::Attached::One|ActiveStorage::Attached::Many|Array|Hash] file(s) to save
+    # @param resize_to_limit [Array] resize to limit filter in ImageProcessing format [width, height]
+    # @return [String] folder path of saved files
+    def self.save_files_on_server(files, resize_to_limit: nil)
       require 'zip'
       # get a temporary folder and create it
       temp_folder = Dir.mktmpdir 'active_storage-send_zip'
 
-      if files.is_a? Array
-        return files.map { |file| save_file_on_server(file, temp_folder) }
-      elsif files.is_a? Hash
-        filepaths = []
+      if files.is_a? Hash
+        filepaths = construct_with_hash(files, temp_folder)
+      elsif files.respond_to? :each
+        files.each { |file| save_file_on_server(file, temp_folder, resize_to_limit: resize_to_limit) }
+      else
+        raise ArgumentError, '`files` must be an hash or an iterable object'
+      end
 
-        files.each do |subfolder, filesHash|
-          filesHash.each { |f| filepaths << save_file_on_server(f, temp_folder, subfolder: subfolder) }
-        end
+      temp_folder
+    end
+
+    # Parses hash to build out directories where folders are key names
+    #
+    # @param files [ActiveStorage::Attached::One|ActiveStorage::Attached::Many|Array|Hash] file(s) to save
+    # @return [String] folder path of saved files
+    def self.construct_with_hash(files, temp_folder)
+      filepaths = []
+
+      files.each do |subfolder, filesHash|
+        filesHash = [filesHash] unless filesHash.is_a? Array
+
+        filesHash.each do |f|
+          # Build directory strucutre recursively for hashes
+          if f.is_a? Hash
+            # Build folder for hash entry
+            folder = File.join(temp_folder, subfolder.to_s)
+            Dir.mkdir(folder) unless Dir.exist?(folder)
 
-        return filepaths
+            filepaths += construct_with_hash(f, folder)
+          # Save attachement
+          else
+            filepaths << save_file_on_server(f, temp_folder, subfolder: subfolder.to_s)
+          end
+        end
       end
+
+      filepaths
     end
 
     # Save the given file on the server
     #
     # @param file [ActiveStorage::Attached] files to save
     # @param folder [String] where to store the file
+    # @param resize_to_limit [Array] resize to limit filter in ImageProcessing format [width, height]
     # @return [String] the filepath of file created
-    def self.save_file_on_server(file, folder, subfolder: nil)
+    def self.save_file_on_server(file, folder, subfolder: nil, resize_to_limit: nil)
       filename = file.filename.to_s
 
       folder = File.join(folder, subfolder) unless subfolder.nil?
@@ -53,16 +83,26 @@ module ActiveStorage
         filepath = File.join folder, filename
       end
 
-      File.open(filepath, 'wb') { |f| f.write(file.download) }
+      # resize images if needed
+      unless resize_to_limit.nil?
+        file = file.variant(resize_to_limit: resize_to_limit).processed
+      end
+
+      # write the file on disk
+      File.open(filepath, 'wb') { |f| f.write(file.service.download(file.key)) }
+
       filepath
     end
 
     # Create a temporary zip file & return the content as bytes
     #
-    # @param filepaths [Array<String>] files paths
+    # @param folderpath [String] folder path
     # @return [String] as content of zip
-    def self.create_temporary_zip_file(filepaths)
+    def self.create_temporary_zip_file(folderpath)
       temp_file = Tempfile.new('user.zip')
+      folderpath_glob = File.join folderpath, '**', '*'
+
+      files = Dir.glob(folderpath_glob).reject { |e| File.directory? e }
 
       begin
         # Initialize the temp file as a zip file
@@ -70,19 +110,18 @@ module ActiveStorage
 
         # open the zip
         Zip::File.open(temp_file.path, Zip::File::CREATE) do |zip|
-          filepaths.each do |filepath|
-            filename = File.basename filepath
-            # add file into the zip
-            zip.add filename, filepath
+          files.each do |filepath|
+            filepath_zip = filepath.sub(folderpath, '').sub(File::SEPARATOR, '')
+            zip.add filepath_zip, filepath
           end
         end
 
-        return File.read(temp_file.path)
+        File.read(temp_file.path)
       ensure
         # close all ressources & remove temporary files
-        temp_file.close
-        temp_file.unlink
-        filepaths.each { |filepath| FileUtils.rm(filepath) }
+        # temp_file.close
+        # temp_file.unlink
+        # FileUtils.rm_rf(folderpath)
       end
     end
   end

metadata

@@ -1,29 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: active_storage-send_zip
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.4
 platform: ruby
 authors:
 - Alexandre Rousseau
+- Maxime `biximilien` Gauthier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-04 00:00:00.000000000 Z
+date: 2020-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +43,44 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
 description: Add a `send_zip` method in your Rails controller to send a `.zip` file
   containing one (or many) ActiveStorage object(s)
 email:
@@ -97,8 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Create a zip from one or more Active Storage objects