s3_zipper 1.0.5 → 1.0.6

data/Gemfile.lock

@@ -1,34 +1,42 @@
 PATH
   remote: .
   specs:
-    s3_zipper (1.0.4)
+    s3_zipper (1.0.6)
       aws-sdk-s3 (~> 1)
+      concurrent-ruby (~> 1.1)
       ruby-progressbar (~> 1)
       rubyzip (>= 1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     aws-eventstream (1.0.3)
-    aws-partitions (1.159.0)
-    aws-sdk-core (3.50.0)
+    aws-partitions (1.167.0)
+    aws-sdk-core (3.53.1)
       aws-eventstream (~> 1.0, >= 1.0.2)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-kms (1.18.0)
-      aws-sdk-core (~> 3, >= 3.48.2)
+    aws-sdk-kms (1.21.0)
+      aws-sdk-core (~> 3, >= 3.53.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.36.1)
-      aws-sdk-core (~> 3, >= 3.48.2)
+    aws-sdk-s3 (1.40.0)
+      aws-sdk-core (~> 3, >= 3.53.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.0)
     aws-sigv4 (1.1.0)
       aws-eventstream (~> 1.0, >= 1.0.2)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
     docile (1.3.1)
+    jaro_winkler (1.5.2)
     jmespath (1.4.0)
     json (2.2.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
     rake (10.5.0)
     rake-compiler (1.0.7)
       rake
@@ -45,14 +53,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubocop (0.70.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.0)
-    rubyzip (1.2.2)
+    rubyzip (1.2.3)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     thor (0.20.3)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
@@ -62,6 +78,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rake-compiler
   rspec (~> 3.0)
+  rubocop (~> 0.70.0)
   s3_zipper!
   simplecov
   thor

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "s3_zipper"

data/exe/s3_zipper

@@ -1,24 +1,25 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "s3_zipper"
-require 'thor'
-require 'awesome_print'
+require "thor"
+require "awesome_print"
 class CLI < Thor
-  desc 'local_file FILES', 'zip files from s3 to a local file'
-  method_option :filename, type: :string, aliases: 'f', desc: 'Name of the created zip archive'
-  method_option :bucket, type: :string, default: ENV['AWS_BUCKET'], required: !ENV['AWS_BUCKET'].nil?, aliases: 'b', desc: 'Name of the bucket the files are in'
+  desc "local_file FILES", "zip files from s3 to a local file"
+  method_option :filename, type: :string, aliases: "f", desc: "Name of the created zip archive"
+  method_option :bucket, type: :string, default: ENV["AWS_BUCKET"], required: !ENV["AWS_BUCKET"].nil?, aliases: "b", desc: "Name of the bucket the files are in"
 
-  def local_file(*files)
+  def local_file *files
     S3Zipper.new(options[:bucket]).zip_to_local_file(files, file: options[:filename] || SecureRandom.hex)
   end
 
-  desc 's3 FILES', 'zip files from s3 to s3'
-  method_option :filename, type: :string, aliases: 'f', desc: 'Name of the created zip archive'
-  method_option :path, type: :string, aliases: 'p', desc: 'Path to the file in s3'
-  method_option :bucket, type: :string, default: ENV['AWS_BUCKET'], required: !ENV['AWS_BUCKET'].nil?, aliases: 'b', desc: 'Name of the bucket the files are in'
+  desc "s3 FILES", "zip files from s3 to s3"
+  method_option :filename, type: :string, aliases: "f", desc: "Name of the created zip archive"
+  method_option :path, type: :string, aliases: "p", desc: "Path to the file in s3"
+  method_option :bucket, type: :string, default: ENV["AWS_BUCKET"], required: !ENV["AWS_BUCKET"].nil?, aliases: "b", desc: "Name of the bucket the files are in"
 
-  def s3(*files)
+  def s3 *files
     S3Zipper.new(options[:bucket]).zip_to_s3(files, filename: options[:filename] || SecureRandom.hex, path: options[:path])
   end
 end
-CLI.start(ARGV)
+CLI.start(ARGV)

data/lib/s3_zipper/client.rb

@@ -1,5 +1,6 @@
-require 'aws-sdk-s3'
+# frozen_string_literal: true
 
+require "aws-sdk-s3"
 class S3Zipper
   class Client
     attr_accessor :bucket_name, :client, :options, :resource, :pb
@@ -42,18 +43,26 @@ class S3Zipper
       temp.binmode
       temp = download_to_file key, temp
       return if temp.nil?
+
       yield(temp) if block_given?
       temp
     ensure
       temp&.unlink if cleanup
     end
 
-    def get_url(key)
+    def get_url key
       resource.bucket(bucket_name).object(key).public_url
     end
 
     def upload local_path, repo_path, options: {}
-      client.put_object(options.merge!(bucket: bucket_name, key: repo_path, body: File.open(local_path).read))
+      spinner = Spinner.new(
+        enabled: options[:progress],
+        title:   "Uploading zip to #{bucket_name}/#{repo_path}",
+      )
+      spinner.start
+      object = client.put_object(options.merge!(bucket: bucket_name, key: repo_path, body: File.open(local_path).read))
+      spinner.finish title: "Uploaded zip to #{bucket_name}/#{repo_path}"
+      object
     end
   end
 end

data/lib/s3_zipper/progress.rb

@@ -1,38 +1,61 @@
-require 'ruby-progressbar'
+# frozen_string_literal: true
+
+require "ruby-progressbar"
 class Progress
+
   def initialize options = {}
     return unless options[:enabled] || true
+
     @options      = options
     @format       = options[:format]
     @progress_bar = ProgressBar.create(@options)
   end
 
-  def reset(title: nil, total: nil, format: nil)
+  def reset title: nil, total: nil, format: nil
+    return unless @progress_bar
+
     @progress_bar.progress = 0
-    @progress_bar.title    = title
-    @progress_bar.total    = total
-    @progress_bar.format   = format
+    @progress_bar.title    = title if title
+    @progress_bar.total    = total if total
+    @progress_bar.format   = format if format
     refresh
   end
 
+  def spin
+    until @progress_bar.finished?
+      increment
+    end
+  end
+
   def total
-    @progress_bar&.total
+    return unless @progress_bar
+
+    @progress_bar.total
   end
 
   def percentage
-    @progress_bar&.to_h['percentage']
+    return unless @progress_bar
+
+    @progress_bar.to_h["percentage"]
   end
 
   def refresh
-    @progress_bar&.refresh
+    return unless @progress_bar
+
+    @progress_bar.refresh
   end
 
   def progress
-    @progress_bar&.progress
+    return unless @progress_bar
+
+    @progress_bar.progress
   end
 
-  def increment
-    @progress_bar&.increment
+  def increment attrs = {}
+    return unless @progress_bar
+
+    @progress_bar.increment
+    update_attrs(attrs) unless attrs.empty?
   end
 
   def update_attrs attrs
@@ -41,11 +64,13 @@ class Progress
 
   def update attr, value
     return unless @progress_bar
+
     @progress_bar.send("#{attr}=", value)
   end
 
   def finish title: nil, format: nil
     return unless @progress_bar
+
     @progress_bar.title  = title if title
     @progress_bar.format = format if format
     @progress_bar.finish
@@ -57,6 +82,7 @@ class Progress
 
   def get_attr attr
     return unless @progress_bar
+
     @progress_bar.send(attr)
   end
-end
+end

data/lib/s3_zipper/spinner.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "ruby-progressbar"
+require "concurrent-ruby"
+class S3Zipper
+  class Spinner
+    include Concurrent::Async
+
+    def initialize title: "", enabled: true, steps: %w[⎺ ⎻ ⎼ ⎽ ⎼ ⎻]
+      return unless enabled || true
+
+      @progress_bar = ProgressBar.create(
+        format:                           "[%i] %t",
+        total:                            nil,
+        length:                           97,
+        title:                            title,
+        autofinish:                       false,
+        unknown_progress_animation_steps: steps,
+      )
+    end
+
+    def reset title: nil, total: nil, format: nil
+      return unless @progress_bar
+
+      @progress_bar.progress = 0
+      @progress_bar.title    = title if title
+      @progress_bar.total    = total if total
+      @progress_bar.format   = format if format
+      refresh
+    end
+
+    def start
+      async.spin
+    end
+
+    def spin
+      return unless @progress_bar
+      until @progress_bar.finished?
+        increment
+      end
+    end
+
+    def increment
+      return unless @progress_bar
+
+      @progress_bar.increment
+    end
+
+    def finish title: nil
+      return unless @progress_bar
+
+      @progress_bar.title  = title if title
+      @progress_bar.format = "[✔] %t"
+      @progress_bar.finish
+    end
+  end
+end

data/lib/s3_zipper/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class S3Zipper
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

data/lib/s3_zipper.rb

@@ -1,27 +1,32 @@
+# frozen_string_literal: true
+
 require "s3_zipper/version"
-require 's3_zipper/progress'
+require "s3_zipper/progress"
+require "s3_zipper/spinner"
 require "s3_zipper/client"
 require "zip"
 
 class S3Zipper
-  attr_accessor :client, :options, :progress
+  attr_accessor :client, :options, :progress, :zip_client
 
   # @param [String] bucket - bucket that files exist in
   # @param [Hash] options - options for zipper
   # @option options [Boolean] :progress - toggles progress tracking
   # @return [S3Zipper]
   def initialize bucket, options = {}
-    @options  = options
-    @client   = Client.new(bucket, options)
-    @progress = Progress.new(enabled: options[:progress], format: "%e %c/%C %t", total: nil, length: 80, autofinish: false)
+    @options    = options
+    @progress   = Progress.new(enabled: options[:progress], format: "%e %c/%C %t", total: nil, length: 80, autofinish: false)
+    @client     = Client.new(bucket, options)
+    @zip_client = Client.new(options[:zip_bucket], options) if options[:zip_bucket]
+    @zip_client ||= @client
   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, &block)
-    file = file.is_a?(File) ? file : File.open("#{file}.zip", 'w')
+  def zip_to_local_file keys, file: SecureRandom.hex, &block
+    file = file.is_a?(File) ? file : File.open("#{file}.zip", "w")
     zip(keys, file.path, &block)
   end
 
@@ -29,8 +34,8 @@ class S3Zipper
   # @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, &block)
-    zipfile = Tempfile.new([filename, '.zip'])
+  def zip_to_tempfile keys, filename: SecureRandom.hex, cleanup: false, &block
+    zipfile = Tempfile.new([filename, ".zip"])
     result  = zip(keys, zipfile.path, &block)
     zipfile.unlink if cleanup
     result
@@ -42,12 +47,9 @@ class S3Zipper
   # @param [String] path - path for file in s3
   # @return [Hash]
   def zip_to_s3 keys, filename: SecureRandom.hex, path: nil, s3_options: {}, &block
-    progress.update :total, 1
     filename = "#{path ? "#{path}/" : ''}#{filename}.zip"
     result   = zip_to_tempfile(keys, filename: filename, cleanup: false, &block)
-    progress.update_attrs title: "Uploading zip to s3", total: nil
-    client.upload(result.delete(:filename), filename, options: s3_options)
-    progress.finish(title: "Uploaded zip to #{filename}")
+    zip_client.upload(result.delete(:filename), filename, options: s3_options)
     result[:key] = filename
     result[:url] = client.get_url(result[:key])
     result
@@ -59,19 +61,18 @@ class S3Zipper
   # @param [String] path - path to zip
   # @yield [progress]
   # @return [Hash]
-  def zip(keys, path)
-    total = progress.total || 0
-    total += keys.size
-    progress.update_attrs total: total, title: "Zipping Keys to #{path}"
+  def zip keys, path
+    progress.reset total: keys.size, title: "Zipping Keys to #{path}"
     Zip::File.open(path, Zip::File::CREATE) do |zipfile|
       @failed, @successful = client.download_keys keys do |file, key|
-        progress.increment
-        progress.update :title, "Zipping #{key} to #{path}"
+        progress.increment title: "Zipping #{key} to #{path}"
         yield(zipfile, progress) if block_given?
         next if file.nil?
+
         zipfile.add(File.basename(key), file.path)
       end
     end
+    progress.finish(title: "Zipped keys to #{path}")
     @successful.each { |_, temp| temp.unlink }
     {
       filename: path,

data/s3_zipper.gemspec

@@ -1,15 +1,17 @@
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "s3_zipper/version"
 
 Gem::Specification.new do |spec|
   spec.name    = "s3_zipper"
   spec.version = S3Zipper::VERSION
-  spec.authors = ["Capshare", 'Nickolas Komarnitsky']
+  spec.authors = ["Capshare", "Nickolas Komarnitsky"]
   spec.email   = [""]
 
-  spec.summary     = %q{Gem for zipping files in s3}
-  spec.description = %q{}
+  spec.summary     = "Gem for zipping files in s3"
+  spec.description = ""
   spec.homepage    = "https://github.com/capshareinc/s3zipper"
   spec.license     = "MIT"
 
@@ -27,7 +29,7 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
@@ -38,9 +40,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rake-compiler"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.70.0"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "thor"
-  spec.add_dependency 'aws-sdk-s3', '~> 1'
-  spec.add_dependency 'rubyzip', '>= 1.0.0'
-  spec.add_dependency 'ruby-progressbar', '~> 1'
+  spec.add_dependency "aws-sdk-s3", "~> 1"
+  spec.add_dependency "concurrent-ruby", "~> 1.1"
+  spec.add_dependency "ruby-progressbar", "~> 1"
+  spec.add_dependency "rubyzip", ">= 1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3_zipper
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Capshare
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-08 00:00:00.000000000 Z
+date: 2019-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.70.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.70.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -110,19 +124,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: rubyzip
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +151,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: ''
 email:
 - ''
@@ -148,6 +176,8 @@ files:
 - ".env.test"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -162,6 +192,7 @@ files:
 - lib/s3_zipper.rb
 - lib/s3_zipper/client.rb
 - lib/s3_zipper/progress.rb
+- lib/s3_zipper/spinner.rb
 - lib/s3_zipper/version.rb
 - s3_zipper.gemspec
 homepage: https://github.com/capshareinc/s3zipper