s3_zipper 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca5799b444022886fe0fde36a96089889a94e1bb14786863af324b6c1cdd9706
-  data.tar.gz: 6663551cd431d8b2a81aed43afc22d309c21171eecdb9b10c209b6c19bb0d854
+  metadata.gz: 4f947d741e4eb65d207ac77dd473b115df2cbcd258b65a47c1b190089ee41041
+  data.tar.gz: c23a65147b049ce5b532c78b586404af88c63e78c179fa355cbdc8250237ddb3
 SHA512:
-  metadata.gz: 3fb1c262daaa22a426d28471d5bc5e71c38a72671b5c811246a729e0ff8294c09da4b645e48c7060aa7f0a577617321bb6f069ab87d785676c46ff86c033f423
-  data.tar.gz: be5c2da1e3223029089be6139389a142d36d71d2f755d303411351ccaaec696ddacb0673e17f7a0ef363add24913aa012692b2376d788e12e15a9ed7da64272b
+  metadata.gz: ecb2ebc22d9773907271bab4fb58c07c62858b1c7b1fe60be832b5fae46bdf10a2873c240d3e1c50fd2c1eeb3e59ef02325a73ad2ae4f364b89020db984619b3
+  data.tar.gz: 831da1cc6238f1a49851554cb605f80c857388a5e83d3e1256d822b9c5704898925bd66007bc598ed728528b27bf72dc4d323183f88bc026a626c93783a74a58

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    s3_zipper (0.1.0)
+    s3_zipper (1.0.1)
       aws-sdk-s3 (~> 1)
       ruby-progressbar (~> 1)
       rubyzip (>= 1.0.0)
@@ -10,8 +10,8 @@ GEM
   remote: https://rubygems.org/
   specs:
     aws-eventstream (1.0.3)
-    aws-partitions (1.155.0)
-    aws-sdk-core (3.48.6)
+    aws-partitions (1.156.0)
+    aws-sdk-core (3.49.0)
       aws-eventstream (~> 1.0, >= 1.0.2)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.1)

data/README.md

@@ -25,7 +25,7 @@ Or install it yourself as:
 ```ruby
 zipper = S3Zipper.new(ENV['AWS_BUCKET'])
 files = ["documents/files/790/306/985/original/background-10.jpg", "documents/files/790/307/076/original/background-10.jpg", "documents/files/790/307/029/original/background-10.jpg", "documents/files/790/307/031/original/background-11.jpg", "documents/files/790/307/077/original/background-11.jpg", "documents/files/790/306/983/original/background-11.jpg", "documents/files/790/306/986/original/background-12.jpg", "documents/files/790/307/078/original/background-12.jpg", "documents/files/790/307/032/original/background-12.jpg", "documents/files/790/306/987/original/background-13.jpg"]
-zipper.zip_files(files)
+zipper.zip_to_local_file(files)
 {
   :filename=>"3dc29e9ba0a069eb5d0783f07b12e1b3.zip", 
   :zipped=>["documents/files/790/306/985/original/background-10.jpg", "documents/files/790/307/076/original/background-10.jpg", "documents/files/790/307/029/original/background-10.jpg", "documents/files/790/307/031/original/background-11.jpg", "documents/files/790/307/077/original/background-11.jpg", "documents/files/790/306/983/original/background-11.jpg", "documents/files/790/306/986/original/background-12.jpg", "documents/files/790/307/078/original/background-12.jpg", "documents/files/790/307/032/original/background-12.jpg", "documents/files/790/306/987/original/background-13.jpg"], 

data/lib/s3_zipper/client.rb

@@ -4,6 +4,10 @@ class S3Zipper
   class Client
     attr_accessor :bucket_name, :s3, :options, :pb
 
+    # @param [String] bucket_name - bucket that files exist in
+    # @param [Hash] options - options for zipper
+    # @option options [Boolean] :progress - toggles progress tracking
+    # @return [S3Zipper::Client]
     def initialize bucket_name, options = {}
       @bucket_name = bucket_name
       @s3          = options[:client] || ::Aws::S3::Client.new

data/lib/s3_zipper/version.rb

@@ -1,3 +1,3 @@
 class S3Zipper
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/s3_zipper.rb

@@ -15,6 +15,10 @@ class S3Zipper
     @client  = Client.new(bucket, options)
   end
 
+  # Zips files from s3 to a local zip
+  # @param [Array] keys - Array of s3 keys to zip
+  # @param [String, File] file - Filename or file object for the zip, defaults to a random string
+  # @return [Hash]
   def zip_to_local_file(keys, file: SecureRandom.hex)
     file = file.is_a?(File) ? file : File.open("#{file}.zip", 'w')
     zip keys, file.path do |progress|
@@ -22,23 +26,38 @@ class S3Zipper
     end
   end
 
-  def zip_to_tempfile(keys, filename: SecureRandom.hex)
+  # Zips files from s3 to a temporary zip
+  # @param [Array] keys - Array of s3 keys to zip
+  # @param [String, File] filename - Name of file, defaults to a random string
+  # @return [Hash]
+  def zip_to_tempfile(keys, filename: SecureRandom.hex, cleanup: false)
     zipfile = Tempfile.new([filename, '.zip'])
-    result  = zip(keys, zipfile.path)
-    yield(zipfile, result) if block_given?
-    zipfile.unlink
+    result  = zip(keys, zipfile.path) { |progress| yield(zipfile, progress) if block_given? }
+    zipfile.unlink if cleanup
     result
   end
 
+  # Zips files from s3 to a temporary file, pushes that to s3, and then cleans up
+  # @param [Array] keys - Array of s3 keys to zip
+  # @param [String, File] filename - Name of file, defaults to a random string
+  # @param [String] path - path for file in s3
+  # @return [Hash]
   def zip_to_s3 keys, filename: SecureRandom.hex, path: nil
-    zip_to_tempfile(keys, filename: filename) do |zipfile, result|
-      result[:filename] = "#{path ? "#{path}/" : ''}#{filename}.zip"
-      client.upload(zipfile.path, result[:filename])
+    filename = "#{path ? "#{path}/" : ''}#{filename}.zip"
+    result   = zip_to_tempfile(keys, filename: filename, cleanup: false) do |_, progress|
+      yield(progress) if block_given?
     end
+    client.upload(result[:filename], filename)
+    result[:filename] = filename
+    result
   end
 
   private
 
+  # @param [Array] keys - Array of s3 keys to zip
+  # @param [String] path - path to zip
+  # @yield [progress]
+  # @return [Hash]
   def zip(keys, path)
     failed, successful = client.download_keys keys
     Zip::File.open(path, Zip::File::CREATE) do |zipfile|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3_zipper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nickolas Komarnitsky