webtranslateit-safe 0.4.0 → 0.4.1

data/CHANGELOG

@@ -1,9 +1,8 @@
-0.4.0
+0.4.1
 
-* Rename gem to webtranslateit-safe.
-* GitHub Action CI.
-* Rubocop Linting.
-* Ruby 3.2 compatibility.
+* Add ruby 3.2 compantibility
+* Modernize gem
+* Rename astrails-safe to webtranslateit-safe
 
 0.3.1
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    webtranslateit-safe (0.4.0)
+    webtranslateit-safe (0.4.1)
       aws-s3
       cloudfiles
       net-sftp

data/bin/webtranslateit-safe

@@ -2,9 +2,9 @@
 
 require 'rubygems'
 
-require 'webtranslateit/safe'
+require 'astrails/safe'
 
-include WebTranslateIt::Safe
+include Astrails::Safe
 
 def die(msg)
   puts "ERROR: #{msg}"
@@ -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: astrails-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,14 +40,14 @@ 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')
 
   unless File.exist?(config_file)
     die 'Missing configuration file. NOT CREATED! Rerun w/o the -n argument to create a template configuration file.' if is_dry
 
-    FileUtils.cp File.join(WebTranslateIt::Safe::ROOT, 'templates', 'script.rb'), config_file
+    FileUtils.cp File.join(Astrails::Safe::ROOT, 'templates', 'script.rb'), config_file
 
     die "Created default #{config_file}. Please edit and run again."
   end
@@ -61,4 +61,4 @@ def main
   process config
 end
 
-main
+main

data/lib/webtranslateit/safe/archive.rb

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

data/lib/webtranslateit/safe/backup.rb

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

data/lib/webtranslateit/safe/cloudfiles.rb

@@ -74,4 +74,4 @@ module WebTranslateIt
       end
     end
   end
-end
+end

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

@@ -1,19 +1,15 @@
 module WebTranslateIt
-
   module Safe
-
     module Config
-
       class Builder
 
         def initialize(node, data = {})
           @node = node
-          data.each { |k, v| send k, v }
+          data.each { |k, v| self.send k, v }
         end
 
 
         class << self
-
           def simple_value(*names)
             names.each do |m|
               define_method(m) do |value|
@@ -44,7 +40,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
@@ -58,9 +54,8 @@ 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"
@@ -69,15 +64,14 @@ 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
         hash_value :mysqldump, :tar, :gpg, :keep, :pgdump, :tar, :svndump,
-                   :sftp, :ftp, :mongodump
+          :sftp, :ftp, :mongodump
         mixed_value :s3, :local, :cloudfiles
         collection :database, :archive, :repo
 
@@ -90,11 +84,7 @@ 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,21 +1,17 @@
 require 'webtranslateit/safe/config/builder'
 module WebTranslateIt
-
   module Safe
-
     module Config
-
       class Node
-
         attr_reader :parent, :data
 
-        def initialize(parent = nil, data = {}, &)
+        def initialize(parent = nil, data = {}, &block)
           @parent = parent
           @data = {}
-          merge(data, &)
+          merge data, &block
         end
 
-        def merge(data = {}, &block)
+        def merge data = {}, &block
           builder = Builder.new(self, data)
           builder.instance_eval(&block) if block
           self
@@ -25,37 +21,38 @@ module WebTranslateIt
         def get(*path)
           key = path.shift
           value = @data[key.to_s]
-          return value if !value.nil? && path.empty?
+          return value if (nil != value) && path.empty?
 
-          value&.get(*path)
+          value && value.get(*path)
         end
 
         # recursive find
         # starts at the node and continues to the parent
         def find(*path)
-          get(*path) || @parent&.find(*path)
+          get(*path) || @parent && @parent.find(*path)
         end
-        alias [] find
+        alias :[] :find
 
         def set_multi(key, value)
           @data[key.to_s] ||= []
-          @data[key.to_s].push(*value)
+          @data[key.to_s].concat [*value]
         end
 
         def set(key, value)
           @data[key.to_s] = value
         end
-        alias []= set
+        alias :[]= :set
 
-        def each(&)
-          @data.each(&)
+        def each(&block)
+          @data.each(&block)
         end
         include Enumerable
 
         def to_hash
-          @data.keys.each_with_object({}) do |key, res|
+          @data.keys.inject({}) do |res, key|
             value = @data[key]
             res[key] = value.is_a?(Node) ? value.to_hash : value
+            res
           end
         end
 
@@ -63,17 +60,13 @@ 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,7 +1,5 @@
 module WebTranslateIt
-
   module Safe
-
     class Ftp < Sink
 
       protected
@@ -15,44 +13,48 @@ module WebTranslateIt
       end
 
       def save
-        raise 'pipe-streaming not supported for FTP.' unless @backup.path
+        raise RuntimeError, 'pipe-streaming not supported for FTP.' unless @backup.path
 
         puts "Uploading #{host}:#{full_path} via FTP" if verbose? || dry_run?
 
-        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?
+        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
           end
+          puts '...done' if verbose?
         end
-        puts '...done' if verbose?
       end
 
       def cleanup
         return if local_only? || dry_run?
 
-        return unless (keep = config[:keep, :ftp])
+        return unless keep = config[:keep, :ftp]
 
         puts "listing files: #{host}:#{base}*" if verbose?
-        port ||= 21
+        if !port
+           port = 21
+        end
         Net::FTP.open(host) do |ftp|
           ftp.connect(host, port)
           ftp.login(user, password)
           files = ftp.nlst(path)
-          pattern = File.basename(base.to_s)
-          files = files.select { |x| x.start_with?(pattern) }
-          puts(files.collect { |x| x }) if verbose?
+          pattern = File.basename("#{base}")
+          files = files.reject{ |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)
@@ -79,7 +81,5 @@ module WebTranslateIt
       end
 
     end
-
   end
-
-end
+end

data/lib/webtranslateit/safe/gpg.rb

@@ -1,11 +1,9 @@
 module WebTranslateIt
-
   module Safe
-
     class Gpg < Pipe
 
       def active?
-        raise "can't use both gpg password and pubkey" if key && password
+        raise RuntimeError, "can't use both gpg password and pubkey" if key && password
 
         !!(password || key)
       end
@@ -41,12 +39,8 @@ 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,7 +1,5 @@
 module WebTranslateIt
-
   module Safe
-
     class Gzip < Pipe
 
       protected
@@ -23,7 +21,5 @@ module WebTranslateIt
       end
 
     end
-
   end
-
-end
+end

data/lib/webtranslateit/safe/local.rb

@@ -1,7 +1,5 @@
 module WebTranslateIt
-
   module Safe
-
     class Local < Sink
 
       def active?
@@ -13,7 +11,7 @@ module WebTranslateIt
       protected
 
       def path
-        @path ||= File.expand_path(expand(config[:local, :path] || raise('missing :local/:path')))
+        @path ||= File.expand_path(expand(config[:local, :path] || raise(RuntimeError, 'missing :local/:path')))
       end
 
       def save
@@ -22,34 +20,32 @@ 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
 
-        return if dry_run?
-
-        FileUtils.mkdir_p(path) unless File.directory?(path)
-        benchmark = Benchmark.realtime do
-          system "#{@backup.command}>#{@backup.path}"
+        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
-        puts("command took #{format('%.2f', benchmark)} second(s).") if verbose?
+
       end
 
       def cleanup
-        return unless (keep = config[:keep, :local])
+        return unless keep = config[:keep, :local]
 
         puts "listing files #{base}" if verbose?
 
         # TODO: cleanup ALL zero-length files
 
-        files = Dir["#{base}*"]
-                .select { |f| File.file?(f) && File.size(f).positive? }
-                .sort
+        files = Dir["#{base}*"] .
+          select{|f| File.file?(f) && File.size(f) > 0} .
+          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,30 +1,23 @@
 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'
-
+    
+      def extension; '.tar'; end
+      
       protected
-
       def output_directory
         File.join(TmpFile.tmproot, 'mongodump')
       end
-
     end
-
   end
-
 end

data/lib/webtranslateit/safe/mysqldump.rb

@@ -1,14 +1,12 @@
 module WebTranslateIt
-
   module Safe
-
     class Mysqldump < Source
 
       def command
         "mysqldump --defaults-extra-file=#{mysql_password_file} #{config[:options]} #{mysql_skip_tables} #{@id}"
       end
 
-      def extension = '.sql'
+      def extension; '.sql'; end
 
       protected
 
@@ -24,13 +22,11 @@ module WebTranslateIt
       end
 
       def mysql_skip_tables
-        return unless (skip_tables = config[:skip_tables])
-
-        [*skip_tables].map { |t| "--ignore-table=#{@id}.#{t}" }.join(' ')
+        if skip_tables = config[:skip_tables]
+          [*skip_tables].map{ |t| "--ignore-table=#{@id}.#{t}" }.join(' ')
+        end
       end
 
     end
-
   end
-
-end
+end

data/lib/webtranslateit/safe/pgdump.rb

@@ -1,15 +1,17 @@
 module WebTranslateIt
-
   module Safe
-
     class Pgdump < Source
 
       def command
-        ENV['PGPASSWORD'] = (config['password'] || nil)
+        if config['password']
+          ENV['PGPASSWORD'] = config['password']
+        else
+          ENV['PGPASSWORD'] = nil
+        end
         "pg_dump #{postgres_options} #{postgres_username} #{postgres_host} #{postgres_port} #{@id}"
       end
 
-      def extension = '.sql'
+      def extension; '.sql'; end
 
       protected
 
@@ -18,19 +20,17 @@ module WebTranslateIt
       end
 
       def postgres_host
-        config['host'] && "--host='#{config['host']}'"
+        config['host'] && "--host='#{config["host"]}'"
       end
 
       def postgres_port
-        config['port'] && "--port='#{config['port']}'"
+        config['port'] && "--port='#{config["port"]}'"
       end
 
       def postgres_username
-        config['user'] && "--username='#{config['user']}'"
+        config['user'] && "--username='#{config["user"]}'"
       end
 
     end
-
   end
-
 end

data/lib/webtranslateit/safe/pipe.rb

@@ -1,9 +1,6 @@
 module WebTranslateIt
-
   module Safe
-
     class Pipe < Stream
-
       # process adds required commands to the current
       # shell command string
       # :active?, :pipe, :extension and :post_process are
@@ -15,9 +12,6 @@ module WebTranslateIt
         @backup.extension << extension
         post_process
       end
-
     end
-
   end
-
 end

data/lib/webtranslateit/safe/s3.rb

@@ -77,4 +77,4 @@ module WebTranslateIt
       end
     end
   end
-end
+end