active_storage-send_zip 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8207888c37b524f02c443b39a3a886c570b4fe6d8a1fab0dc962ede883a24f3d
-  data.tar.gz: 4b960e75cdc3f948e6e77eddea418e8c6e8b07df5166d4739006569957f60d99
+  metadata.gz: a5dbef1dda4a5236e3290d9cd38a23de7e296b5e404356bf222dfbeb0c75197b
+  data.tar.gz: d2558817de8b496c48606c1e3af71df086480eede14b55186ea4a5e7206bfe5c
 SHA512:
-  metadata.gz: 5558ce4b108d0a28a046f774adea7e73e15db5def44e31943ba13c28329ce2a5a35c16285e44b32beef7aa7089f0d3c518208e1cee927316195d84fb4f87f36f
-  data.tar.gz: 27511b5c8a954c4bf1176fc2433b005c42a0265549f649857c46de051e31a6723482e1f741f18f2b7662f0fee8ef8385ecab9f51cea360891bc66bb7d00c216a
+  metadata.gz: 49f3758cc21c8a66dce8f69fe231c679f0802ad8374a222f8a178557ac668b5c2cf3ce7ea4a4f1d0c1e40dcb701a65c200de7bea3e82089cc56a3e20d9495e5f
+  data.tar.gz: 8830d24a60774f277e4576614243a077f661d08313259aaa501692ca5f58cb5bb13ef8975e6659432433d366195211e5f3c38c8bd25e2312feee1352908bf7a6

data/CHANGELOG.yml

@@ -0,0 +1,11 @@
+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`
+    - `SendZip#save_file_on_server` become `ActiveStorage::SendZipHelperSendZip#save_file_on_server`
+    - `SendZip#create_temporary_zip_file` become `ActiveStorage::SendZipHelperSendZip#create_temporary_zip_file`
+  - `send_zip` can now handle an `Hash` param to organize in subfolder
+0.1.1:
+  - handle double filenames
+  - use a radom folder instead of fixed one (this was problematic qith multiples queries at the same times)
+0.1.0:
+  - first versions

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_storage-send_zip (0.1.1)
+    active_storage-send_zip (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,27 +1,14 @@
 # ActiveStorage::SendZip
 
 [![Gem Version](https://badge.fury.io/rb/active_storage-send_zip.svg)](https://badge.fury.io/rb/active_storage-send_zip)
+[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.png?v=103)](https://opensource.org/licenses/mit-license.php)
 
-Create a zip from one or more Active Storage objects and return it in a rails controller
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'active_storage-send_zip'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install active_storage-send_zip
+Add a `send_zip` method in your Rails controller to send a `.zip` file containing one or many [ActiveStorage](https://edgeguides.rubyonrails.org/active_storage_overview.html) objects.
 
 ## Usage
 
+### With `Array`
+
 Assuming you have an ActiveRecord model with ActiveStorage like this:
 
 ~~~ruby
@@ -51,6 +38,64 @@ class UsersController < ApplicationController
 end
 ~~~
 
+Will produce a `.zip` archive like this:
+
+~~~
+├── a.jpg
+├── b.png
+└── c.gif
+~~~
+
+Ii will also prevent duplicate filename and add an [`SecureRandom.uuid`](https://ruby-doc.org/stdlib-2.3.0/libdoc/securerandom/rdoc/SecureRandom.html) if two files as the same name.
+
+
+### With `Hash`
+
+You can also pass an `Hash` parameter at `send_zip` method to organize files in sublfolder:
+
+~~~ruby
+# app/controllers/holidays_controller.rb
+class HolidaysController < ApplicationController
+  include ActiveStorage::SendZip
+
+  def zip
+    send_zip {
+      'Holidays in Lyon <3' => Holidays.where(place: 'lyon').first.pictures,
+      'Holidays in Paris' => Holidays.where(place: 'paris').first.pictures,
+    }
+  end
+end
+~~~
+
+Will produce a `.zip` archive like this:
+
+~~~
+├── Holidays in Lyon <3
+│   ├── a.jpg
+│   ├── b.png
+│   └── c.gif
+└── Holidays in Paris
+    ├── a.jpg
+    ├── b.png
+    └── c.gif
+~~~
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_storage-send_zip'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_storage-send_zip
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -61,10 +106,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/madeindjs/active_storage-send_zip. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
 ## Code of Conduct
 
 Everyone interacting in the ActiveStorage::SendZip project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/madeindjs/active_storage-send_zip/blob/master/CODE_OF_CONDUCT.md).

data/active_storage-send_zip.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['contact@rousseau-alexandre.fr']
 
   spec.summary       = 'Create a zip from one or more Active Storage objects'
-  spec.description   = 'Create a zip from one or more Active Storage objects and return it in a rails controller'
+  spec.description   = 'Add a `send_zip` method in your Rails controller to send a `.zip` file containing one (or many) ActiveStorage object(s)'
   spec.homepage      = 'https://github.com/madeindjs/active_storage-send_zip'
   spec.license       = 'MIT'
 

data/lib/active_storage/send_zip.rb

@@ -1,10 +1,10 @@
 require 'active_storage/send_zip/version'
-require 'rails'
-require 'zip'
-require 'tempfile'
-require 'pathname'
+require 'active_storage/send_zip_helper'
 
+# I `ActiveStorage` namespace to monkey-path my methods into it
 module ActiveStorage
+  # This is an `ActiveSupport::Concern` to include into your controller.
+  # The purpose is just to add a `send_zip` method to your controller
   module SendZip
     extend ActiveSupport::Concern
 
@@ -16,76 +16,10 @@ module ActiveStorage
     # @param filename [ActiveStorage::Attached::Many] files to save
     def send_zip(active_storages, filename: 'my.zip')
       require 'zip'
-      files = save_files_on_server active_storages
-      zip_data = create_temporary_zip_file files
+      files = SendZipHelper.save_files_on_server active_storages
+      zip_data = SendZipHelper.create_temporary_zip_file files
 
       send_data(zip_data, type: 'application/zip', filename: filename)
     end
-
-    private
-
-    # 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 save_files_on_server(files)
-      require 'zip'
-      # get a temporary folder and create it
-      temp_folder = Dir.mktmpdir 'active_storage-send_zip'
-
-      # count each files to avoid duplicates
-      filepaths = []
-
-      # download all ActiveStorage into
-      files.each do |picture|
-        filename = picture.filename.to_s
-        filepath = File.join temp_folder, filename
-
-        # ensure that filename not exists
-        if filepaths.include? filepath
-          # create a new random filenames
-          basename = File.basename filename
-          extension = File.extname filename
-
-          filename = "#{basename}_#{SecureRandom.uuid}#{extension}"
-          filepath = File.join temp_folder, filename
-        end
-
-        File.open(filepath, 'wb') { |f| f.write(picture.download) }
-
-        filepaths << filepath
-      end
-
-      filepaths
-    end
-
-    # Create a temporary zip file & return the content as bytes
-    #
-    # @param filepaths [Array<String>] files paths
-    # @return [String] as content of zip
-    def create_temporary_zip_file(filepaths)
-      temp_file = Tempfile.new('user.zip')
-
-      begin
-        # Initialize the temp file as a zip file
-        Zip::OutputStream.open(temp_file) { |zos| }
-
-        # 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
-          end
-        end
-
-        return File.read(temp_file.path)
-      ensure
-        # close all ressources & remove temporary files
-        temp_file.close
-        temp_file.unlink
-        filepaths.each { |filepath| FileUtils.rm(filepath) }
-      end
-    end
   end
 end

data/lib/active_storage/send_zip/version.rb

@@ -1,5 +1,6 @@
 module ActiveStorage
   module SendZip
-    VERSION = '0.1.1'.freeze
+    # The version of this gem
+    VERSION = '0.2.0'.freeze
   end
 end

data/lib/active_storage/send_zip_helper.rb

@@ -0,0 +1,89 @@
+require 'rails'
+require 'zip'
+require 'tempfile'
+require 'pathname'
+
+module ActiveStorage
+  # This module contains some methods usefull for `ActiveStorage::SendZip.send_zip`
+  # method.
+  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)
+      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 = []
+
+        files.each do |subfolder, filesHash|
+          filesHash.each { |f| filepaths << save_file_on_server(f, temp_folder, subfolder: subfolder) }
+        end
+
+        return filepaths
+      end
+    end
+
+    # Save the given file on the server
+    #
+    # @param file [ActiveStorage::Attached] files to save
+    # @param folder [String] where to store the file
+    # @return [String] the filepath of file created
+    def self.save_file_on_server(file, folder, subfolder: nil)
+      filename = file.filename.to_s
+
+      folder = File.join(folder, subfolder) unless subfolder.nil?
+      Dir.mkdir(folder) unless Dir.exist?(folder)
+
+      # build filepath & create path if not exists
+      filepath = File.join(folder, filename)
+
+      # Ensure that filename not already exists
+      if File.exist? filepath
+        # create a new random filenames
+        basename = File.basename filename
+        extension = File.extname filename
+
+        filename = "#{basename}_#{SecureRandom.uuid}#{extension}"
+        filepath = File.join folder, filename
+      end
+
+      File.open(filepath, 'wb') { |f| f.write(file.download) }
+      filepath
+    end
+
+    # Create a temporary zip file & return the content as bytes
+    #
+    # @param filepaths [Array<String>] files paths
+    # @return [String] as content of zip
+    def self.create_temporary_zip_file(filepaths)
+      temp_file = Tempfile.new('user.zip')
+
+      begin
+        # Initialize the temp file as a zip file
+        Zip::OutputStream.open(temp_file) { |zos| }
+
+        # 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
+          end
+        end
+
+        return File.read(temp_file.path)
+      ensure
+        # close all ressources & remove temporary files
+        temp_file.close
+        temp_file.unlink
+        filepaths.each { |filepath| FileUtils.rm(filepath) }
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_storage-send_zip
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexandre Rousseau
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-03 00:00:00.000000000 Z
+date: 2018-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Create a zip from one or more Active Storage objects and return it in
-  a rails controller
+description: Add a `send_zip` method in your Rails controller to send a `.zip` file
+  containing one (or many) ActiveStorage object(s)
 email:
 - contact@rousseau-alexandre.fr
 executables: []
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.yml
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -73,6 +74,7 @@ files:
 - bin/setup
 - lib/active_storage/send_zip.rb
 - lib/active_storage/send_zip/version.rb
+- lib/active_storage/send_zip_helper.rb
 homepage: https://github.com/madeindjs/active_storage-send_zip
 licenses:
 - MIT