webtranslateit-safe 0.4.3 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43afe3f6fffb6bb4178cfd6c6181767f67f7995f2e836d35c9d5c66556b567fb
-  data.tar.gz: 3fe840117d0c799b65edcafc92b57f73e7ba928297fe53bc1f8262059404e5fe
+  metadata.gz: 63bd94e905a8a424ce2b408fa3d0d2898fc5d22c3be9739a95ff73668cd612ad
+  data.tar.gz: 2f33a476839a38aa403e89a3f0e35ad5c78a9c403756c0472f15c45337a0b575
 SHA512:
-  metadata.gz: 1ad57b335c7585cea8621bbd6007fcd1f2d10e6fe7ba9fa0b1381ce00ce96eb38eb11925912185e06ab3ba2e69ebec165b2fa9a268c0cbeeb0b765e43b166b6f
-  data.tar.gz: c51e5399dc02aa3fe4b0d0bfb99ed6397c9abdbc16ebf5dc8994d056151fcee9d340f0b8085d52f333d00b3eb8d1c0bbbd5b60c28afdde36b7065ed0a821492d
+  metadata.gz: b50f77cc5ee6b609ad05e85fa5fc106ed21af49e014397427aa9a77de4bba9e5d6e3cff8773d78e14314e44388d6f0cf6cbf258d0e3ffd9db0ddeedc063a525d
+  data.tar.gz: e21c75b914bf576842f22893098c872659ba5d7dd27b84d4f087226e7aa80a43f32a133f668a20c09492762f2459707ae1c3e7f9e074db4a8b9fc7c933b4f885

data/CHANGELOG

@@ -1,36 +1,48 @@
-0.4.3
+## 0.4.5 - 2023-06-30
+
+* Add SCP backup strategy.
+
+## 0.4.4 - 2023-06-30
+
+* Remove `default_executable` line and simplify executables definition.
+* Autocorrect rubocop offences.
+* Convert rspec syntax from `should` to `expect`.
+* Remove unused extension `Dir.mktmpdir`.
+* Upload retry logic for SFTP.
+
+## 0.4.3 - 2023-06-29
 
 * Bug fix on builder.
 * Move version number to gemspec file.
 
-0.4.2
+## 0.4.2 - 2023-05-22
 
 * Bug fix on executable
 
-0.4.1
+## 0.4.1 - 2023-05-20
 
 * Add ruby 3.2 compantibility
 * Modernize gem
 * Rename astrails-safe to webtranslateit-safe
 
-0.3.1
+## 0.3.1
 
 * plain ftp support from seroy
 * mongodump support from Matt Berther
 
-0.3.0
+## 0.3.0
 
 * switch to bundler
 * fixed the rspec
 
-0.2.8
+## 0.2.8
 
 * ruby 1.9.2 compatibility (tests mostly)
 * code review, and tons of small fixes
 * check file size before attempting to upload to cloudfiles
 * testing framework changed from micronaut to rspec
 
-0.2.7
+## 0.2.7
 
 * default options for gpg now include '--no-use-agent'
 * support for 'command' option for gpg
@@ -38,13 +50,13 @@
 * add 'lib' to $:
 * [EXPERIMENTAL] Rackspace Cloud Files support
 
-0.2.6
+## 0.2.6
 
 * fix typo in the template config file. (change option to options in pgdump)
 * add example 'options' for tar in the template config file.
 * do not try to upload more then 5G of data to S3. print error instead
 
-0.2.5
+## 0.2.5
 
 * Safety mesure: Disable overwrite of existing configuration keys except for multi-value keys
   supported multi-value keys: skip_tables, exclude, files

data/README.markdown

@@ -155,6 +155,13 @@ The procedure to create and transfer the key is as follows:
         password "ssh password for sftp"
       end
 
+      sftp do
+        host "sftp.astrails.com"
+        user "astrails"
+        # port 8023
+        password "ssh password for scp"
+      end
+
       gpg do
         command "/usr/local/bin/gpg"
         options  "--no-use-agent"
@@ -170,6 +177,7 @@ The procedure to create and transfer the key is as follows:
         s3 100
         cloudfiles 100
         sftp 100
+        scp 100
       end
 
       mysqldump do

data/bin/webtranslateit-safe

@@ -12,16 +12,16 @@ def die(msg)
 end
 
 def usage
-  puts <<-END
-Usage: webtranslateit-safe [OPTIONS] CONFIG_FILE
-Options:
-  -h, --help           This help screen
-  -v, --verbose        be verbose, duh!
-  -n, --dry-run        just pretend, don't do anything.
-  -L, --local          skip S3 and Cloud Files
-
-Note: config file will be created from template if missing
-END
+  puts <<~END
+    Usage: webtranslateit-safe [OPTIONS] CONFIG_FILE
+    Options:
+      -h, --help           This help screen
+      -v, --verbose        be verbose, duh!
+      -n, --dry-run        just pretend, don't do anything.
+      -L, --local          skip S3 and Cloud Files
+
+    Note: config file will be created from template if missing
+  END
   exit 1
 end
 
@@ -30,7 +30,7 @@ OPTS = [
   '-v', '--verbose', '--not-verbose',
   '-n', '--dry-run', '--not-dry-run',
   '-L', '--local', '--not-local'
-]
+].freeze
 def main
   opts = ARGV & OPTS
   args = ARGV - OPTS
@@ -40,7 +40,7 @@ def main
 
   config_file = File.expand_path(args.first)
 
-  is_dry = (opts.delete('-n') || opts.delete('--dry-run')) && ! opts.delete('--not-dry-run')
+  is_dry = (opts.delete('-n') || opts.delete('--dry-run')) && !opts.delete('--not-dry-run')
   is_verbose = (opts.delete('-v') || opts.delete('--verbose')) && !opts.delete('--not-verbose')
   is_local_only = (opts.delete('-L') || opts.delete('--local')) && !opts.delete('--not-local')
 
@@ -61,4 +61,4 @@ def main
   process config
 end
 
-main
+main

data/lib/webtranslateit/safe/archive.rb

@@ -1,24 +1,29 @@
 module WebTranslateIt
+
   module Safe
+
     class Archive < Source
 
       def command
         "tar -cf - #{config[:options]} #{tar_exclude_files} #{tar_files}"
       end
 
-      def extension; '.tar'; end
+      def extension = '.tar'
 
       protected
 
       def tar_exclude_files
-        [*config[:exclude]].compact.map{|x| "--exclude=#{x}"}.join(' ')
+        [*config[:exclude]].compact.map { |x| "--exclude=#{x}" }.join(' ')
       end
 
       def tar_files
-        raise RuntimeError, 'missing files for tar' unless config[:files]
-        [*config[:files]].map{|s| s.strip}.join(' ')
+        raise 'missing files for tar' unless config[:files]
+
+        [*config[:files]].map(&:strip).join(' ')
       end
 
     end
+
   end
+
 end

data/lib/webtranslateit/safe/backup.rb

@@ -1,10 +1,14 @@
 module WebTranslateIt
+
   module Safe
+
     class Backup
+
       attr_accessor :id, :kind, :filename, :extension, :command, :compressed, :timestamp, :path
+
       def initialize(opts = {})
         opts.each do |k, v|
-          self.send("#{k}=", v)
+          send("#{k}=", v)
         end
       end
 
@@ -15,6 +19,9 @@ module WebTranslateIt
           WebTranslateIt::Safe.const_get(mod).new(config, self).process
         end
       end
+
     end
+
   end
-end
+
+end

data/lib/webtranslateit/safe/cloudfiles.rb

@@ -1,7 +1,10 @@
 module WebTranslateIt
+
   module Safe
+
     class Cloudfiles < Sink
-      MAX_CLOUDFILES_FILE_SIZE = 5368709120
+
+      MAX_CLOUDFILES_FILE_SIZE = 5_368_709_120
 
       def active?
         container && user && api_key
@@ -21,24 +24,24 @@ module WebTranslateIt
       end
 
       def save
-        raise RuntimeError, 'pipe-streaming not supported for S3.' unless @backup.path
+        raise 'pipe-streaming not supported for S3.' unless @backup.path
 
         # needed in cleanup even on dry run
         cf = CloudFiles::Connection.new(user, api_key, true, service_net) unless local_only?
         puts "Uploading #{container}:#{full_path} from #{@backup.path}" if verbose? || dry_run?
-        unless dry_run? || local_only?
-          if get_file_size(@backup.path) > MAX_CLOUDFILES_FILE_SIZE
-            STDERR.puts "ERROR: File size exceeds maximum allowed for upload to Cloud Files (#{MAX_CLOUDFILES_FILE_SIZE}): #{@backup.path}"
-            return
-          end
-          benchmark = Benchmark.realtime do
-            cf_container = cf.create_container(container)
-            o = cf_container.create_object(full_path,true)
-            o.write(File.open(@backup.path))
-          end
-          puts '...done' if verbose?
-          puts('Upload took ' + sprintf('%.2f', benchmark) + ' second(s).') if verbose?
+        return if dry_run? || local_only?
+
+        if get_file_size(@backup.path) > MAX_CLOUDFILES_FILE_SIZE
+          warn "ERROR: File size exceeds maximum allowed for upload to Cloud Files (#{MAX_CLOUDFILES_FILE_SIZE}): #{@backup.path}"
+          return
         end
+        benchmark = Benchmark.realtime do
+          cf_container = cf.create_container(container)
+          o = cf_container.create_object(full_path, true)
+          o.write(File.open(@backup.path))
+        end
+        puts '...done' if verbose?
+        puts("Upload took #{format('%.2f', benchmark)} second(s).") if verbose?
       end
 
       def cleanup
@@ -49,7 +52,7 @@ module WebTranslateIt
         puts "listing files: #{container}:#{base}*" if verbose?
         cf = CloudFiles::Connection.new(user, api_key, true, service_net) unless local_only?
         cf_container = cf.container(container)
-        files = cf_container.objects(:prefix => base).sort
+        files = cf_container.objects(prefix: base).sort
 
         cleanup_with_limit(files, keep) do |f|
           puts "removing Cloud File #{container}:#{f}" if dry_run? || verbose?
@@ -72,6 +75,9 @@ module WebTranslateIt
       def service_net
         config[:cloudfiles, :service_net] || false
       end
+
     end
+
   end
+
 end

data/lib/webtranslateit/safe/config/builder.rb

@@ -1,15 +1,19 @@
 module WebTranslateIt
+
   module Safe
+
     module Config
+
       class Builder
 
         def initialize(node, data = {})
           @node = node
-          data.each { |k, v| self.send k, v }
+          data.each { |k, v| send k, v }
         end
 
 
         class << self
+
           def simple_value(*names)
             names.each do |m|
               define_method(m) do |value|
@@ -40,7 +44,7 @@ module WebTranslateIt
 
           def mixed_value(*names)
             names.each do |m|
-              define_method(m) do |data={}, &block|
+              define_method(m) do |data = {}, &block|
                 ensure_uniq(m)
                 if data.is_a?(Hash) || block
                   ensure_hash(m, data) if block
@@ -54,8 +58,9 @@ module WebTranslateIt
 
           def collection(*names)
             names.each do |m|
-              define_method(m) do |id, data={}, &block|
+              define_method(m) do |id, data = {}, &block|
                 raise "bad collection id: #{id.inspect}" unless id
+
                 ensure_hash(m, data)
 
                 name = "#{m}s"
@@ -64,14 +69,15 @@ module WebTranslateIt
               end
             end
           end
+
         end
 
         simple_value :verbose, :dry_run, :local_only, :path, :command,
-          :options, :user, :host, :port, :password, :key, :secret, :bucket,
-          :api_key, :container, :socket, :service_net, :repo_path
+                     :options, :user, :host, :port, :password, :key, :secret, :bucket,
+                     :api_key, :container, :socket, :service_net, :repo_path
         multi_value :skip_tables, :exclude, :files
         mixed_value :s3, :local, :cloudfiles, :sftp, :mysqldump, :tar, :gpg, :keep, :pgdump, :tar, :svndump,
-          :ftp, :mongodump
+                    :ftp, :mongodump, :scp
         collection :database, :archive, :repo
 
         private
@@ -83,7 +89,11 @@ module WebTranslateIt
         def ensure_hash(k, v)
           raise "#{k}: hash expected: #{v.inspect}" unless v.is_a?(Hash)
         end
+
       end
+
     end
+
   end
+
 end

data/lib/webtranslateit/safe/config/node.rb

@@ -1,8 +1,12 @@
 require 'webtranslateit/safe/config/builder'
 module WebTranslateIt
+
   module Safe
+
     module Config
+
       class Node
+
         attr_reader :parent, :data
 
         def initialize(parent = nil, data = {}, &block)
@@ -11,7 +15,7 @@ module WebTranslateIt
           merge data, &block
         end
 
-        def merge data = {}, &block
+        def merge(data = {}, &block)
           builder = Builder.new(self, data)
           builder.instance_eval(&block) if block
           self
@@ -21,27 +25,27 @@ module WebTranslateIt
         def get(*path)
           key = path.shift
           value = @data[key.to_s]
-          return value if (nil != value) && path.empty?
+          return value if !value.nil? && path.empty?
 
-          value && value.get(*path)
+          value&.get(*path)
         end
 
         # recursive find
         # starts at the node and continues to the parent
         def find(*path)
-          get(*path) || @parent && @parent.find(*path)
+          get(*path) || @parent&.find(*path)
         end
-        alias :[] :find
+        alias [] find
 
         def set_multi(key, value)
           @data[key.to_s] ||= []
-          @data[key.to_s].concat [*value]
+          @data[key.to_s].push(*value)
         end
 
         def set(key, value)
           @data[key.to_s] = value
         end
-        alias :[]= :set
+        alias []= set
 
         def each(&block)
           @data.each(&block)
@@ -49,10 +53,9 @@ module WebTranslateIt
         include Enumerable
 
         def to_hash
-          @data.keys.inject({}) do |res, key|
+          @data.keys.each_with_object({}) do |key, res|
             value = @data[key]
             res[key] = value.is_a?(Node) ? value.to_hash : value
-            res
           end
         end
 
@@ -60,13 +63,17 @@ module WebTranslateIt
           @data.each do |key, value|
             if value.is_a?(Node)
               puts "#{indent}#{key}:"
-              value.dump(indent + '    ')
+              value.dump("#{indent}    ")
             else
               puts "#{indent}#{key}: #{value.inspect}"
             end
           end
         end
+
       end
+
     end
+
   end
+
 end

data/lib/webtranslateit/safe/ftp.rb

@@ -1,5 +1,7 @@
 module WebTranslateIt
+
   module Safe
+
     class Ftp < Sink
 
       protected
@@ -13,26 +15,24 @@ module WebTranslateIt
       end
 
       def save
-        raise RuntimeError, 'pipe-streaming not supported for FTP.' unless @backup.path
+        raise 'pipe-streaming not supported for FTP.' unless @backup.path
 
         puts "Uploading #{host}:#{full_path} via FTP" if verbose? || dry_run?
 
-        unless dry_run? || local_only?
-          if !port
-            port = 21
-          end
-          Net::FTP.open(host) do |ftp|
-            ftp.connect(host, port)
-            ftp.login(user, password)
-            puts "Sending #{@backup.path} to #{full_path}" if verbose?
-            begin
-              ftp.put(@backup.path, full_path)
-            rescue Net::FTPPermError
-              puts "Ensuring remote path (#{path}) exists" if verbose?
-            end
+        return if dry_run? || local_only?
+
+        port ||= 21
+        Net::FTP.open(host) do |ftp|
+          ftp.connect(host, port)
+          ftp.login(user, password)
+          puts "Sending #{@backup.path} to #{full_path}" if verbose?
+          begin
+            ftp.put(@backup.path, full_path)
+          rescue Net::FTPPermError
+            puts "Ensuring remote path (#{path}) exists" if verbose?
           end
-          puts '...done' if verbose?
         end
+        puts '...done' if verbose?
       end
 
       def cleanup
@@ -41,20 +41,18 @@ module WebTranslateIt
         return unless keep = config[:keep, :ftp]
 
         puts "listing files: #{host}:#{base}*" if verbose?
-        if !port
-           port = 21
-        end
+        port ||= 21
         Net::FTP.open(host) do |ftp|
           ftp.connect(host, port)
           ftp.login(user, password)
           files = ftp.nlst(path)
-          pattern = File.basename("#{base}")
-          files = files.reject{ |x| !x.start_with?(pattern)}
-          puts files.collect {|x| x} if verbose?
+          pattern = File.basename(base.to_s)
+          files = files.select { |x| x.start_with?(pattern) }
+          puts files.collect { |x| x } if verbose?
 
-          files = files.
-            collect {|x| x }.
-            sort
+          files = files
+                  .collect { |x| x }
+                  .sort
 
           cleanup_with_limit(files, keep) do |f|
             file = File.join(path, f)
@@ -81,5 +79,7 @@ module WebTranslateIt
       end
 
     end
+
   end
-end
+
+end

data/lib/webtranslateit/safe/gpg.rb

@@ -1,9 +1,11 @@
 module WebTranslateIt
+
   module Safe
+
     class Gpg < Pipe
 
       def active?
-        raise RuntimeError, "can't use both gpg password and pubkey" if key && password
+        raise "can't use both gpg password and pubkey" if key && password
 
         !!(password || key)
       end
@@ -39,8 +41,12 @@ module WebTranslateIt
 
       def gpg_password_file(pass)
         return 'TEMP_GENERATED_FILENAME' if dry_run?
+
         WebTranslateIt::Safe::TmpFile.create('gpg-pass') { |file| file.write(pass) }
       end
+
     end
+
   end
-end
+
+end

data/lib/webtranslateit/safe/gzip.rb

@@ -1,5 +1,7 @@
 module WebTranslateIt
+
   module Safe
+
     class Gzip < Pipe
 
       protected
@@ -21,5 +23,7 @@ module WebTranslateIt
       end
 
     end
+
   end
-end
+
+end

data/lib/webtranslateit/safe/local.rb

@@ -1,5 +1,7 @@
 module WebTranslateIt
+
   module Safe
+
     class Local < Sink
 
       def active?
@@ -11,7 +13,7 @@ module WebTranslateIt
       protected
 
       def path
-        @path ||= File.expand_path(expand(config[:local, :path] || raise(RuntimeError, 'missing :local/:path')))
+        @path ||= File.expand_path(expand(config[:local, :path] || raise('missing :local/:path')))
       end
 
       def save
@@ -20,14 +22,13 @@ module WebTranslateIt
         # FIXME: probably need to change this to smth like @backup.finalize!
         @backup.path = full_path # need to do it outside DRY_RUN so that it will be avialable for S3 DRY_RUN
 
-        unless dry_run?
-          FileUtils.mkdir_p(path) unless File.directory?(path)
-          benchmark = Benchmark.realtime do
-            system "#{@backup.command}>#{@backup.path}"
-          end
-          puts('command took ' + sprintf('%.2f', benchmark) + ' second(s).') if verbose?
-        end
+        return if dry_run?
 
+        FileUtils.mkdir_p(path) unless File.directory?(path)
+        benchmark = Benchmark.realtime do
+          system "#{@backup.command}>#{@backup.path}"
+        end
+        puts("command took #{format('%.2f', benchmark)} second(s).") if verbose?
       end
 
       def cleanup
@@ -37,15 +38,18 @@ module WebTranslateIt
 
         # TODO: cleanup ALL zero-length files
 
-        files = Dir["#{base}*"] .
-          select{|f| File.file?(f) && File.size(f) > 0} .
-          sort
+        files = Dir["#{base}*"]
+                .select { |f| File.file?(f) && File.size(f).positive? }
+                .sort
 
         cleanup_with_limit(files, keep) do |f|
           puts "removing local file #{f}" if dry_run? || verbose?
           File.unlink(f) unless dry_run?
         end
       end
+
     end
+
   end
+
 end

data/lib/webtranslateit/safe/mongodump.rb

@@ -1,23 +1,29 @@
 module WebTranslateIt
+
   module Safe
+
     class Mongodump < Source
-      
+
       def command
         opts = []
         opts << "--host #{config[:host]}" if config[:host]
         opts << "-u #{config[:user]}" if config[:user]
         opts << "-p #{config[:password]}" if config[:password]
         opts << "--out #{output_directory}"
-      
-        "mongodump -q \"{xxxx : { \\$ne : 0 } }\" --db #{@id} #{opts.join(" ")} && cd #{output_directory} && tar cf - ."
+
+        "mongodump -q \"{xxxx : { \\$ne : 0 } }\" --db #{@id} #{opts.join(' ')} && cd #{output_directory} && tar cf - ."
       end
-    
-      def extension; '.tar'; end
-      
+
+      def extension = '.tar'
+
       protected
+
       def output_directory
         File.join(TmpFile.tmproot, 'mongodump')
       end
+
     end
+
   end
+
 end