pg_export 1.0.0.rc1 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eb793296ca1e2e22519a8abf1644f88fd06daa02a672d392f318a19128c50cb
-  data.tar.gz: '085a37ec1e0b7cc96f811e73a0a3271086e1c12fba3e6a2da831c6f58a4f9fde'
+  metadata.gz: 96c2a7a23f195dba8cb7e21e3de8d9d130fd5849291e68ed153892b1f9e7aef6
+  data.tar.gz: 6f3fe11961d2d6b2089b6abacf93a1f37e48deee88d697c8402a9ac73b3dbbd3
 SHA512:
-  metadata.gz: a3b89d600dc035cca7cdc909b503ac1d62e7844531d5f8a35c8213339968074ccb21d49669a1623f3d616f0aa52c2ccfb1c6c0a54f864e602ffcbe32a43c0886
-  data.tar.gz: 9a93edd9855a3a20d5745491cedbcff104cd8aee180e1c10537c63c129c8ed96933f36d5120476b85812aece2bcaba507391910e282097b5a8555e210a0e209e
+  metadata.gz: 320d541ded251f9053bffa686fb429e22572b306f48227cb9b51aaa4bae76fd452ce2ab8e8f84ac63a0b1b4628bc8c70fbfbfb26d2295d5fc7bd1c1f9188330f
+  data.tar.gz: db3b2d4799b5ddc7e0628070b8d99406655d7fc3111a34a93dc8237a189ea01ef004a72d8ed2716ad03d74b901ec597d4dc796c9e893b0557e0f698639788a48

data/CHANGELOG.md

@@ -6,6 +6,7 @@
   - BACKUP_FTP_PASSWORD -> PG_EXPORT_GATEWAY_PASSWORD
   - DUMP_ENCRYPTION_KEY -> PG_EXPORT_ENCRYPTION_KEY
 - Drop Ruby 2.3 support
+- Add SSH option
 
 ### 0.7.7 - 2020.09.07
 

data/README.md

@@ -74,7 +74,7 @@ __Step 1.__ Prepare ENV variables.
     PG_EXPORT_GATEWAY_USER=user
     PG_EXPORT_GATEWAY_PASSWORD=password
     
-    /* Encryption key shoul have exactly 16 characters. */
+    /* Encryption key should have exactly 16 characters. */
     /* Dumps will be SSL(AES-128-CBC) encrypted using this key. */
     PG_EXPORT_ENCRYPTION_KEY=1234567890abcdef
     

data/bin/pg_export

@@ -11,30 +11,58 @@ ENV['GATEWAY'] = 'ftp'
 interactive = false
 database = nil
 
+
 option_parser = OptionParser.new do |opts|
-  opts.banner = 'Usage: pg_export [options]'
+  opts.banner = <<~TXT
+NAME
+    pg_export - CLI for exporting/importing PostgreSQL dumps via FTP/SSH
+
+SYNOPSIS (default mode)      
+    pg_export DATABASE [options]
+
+SYNOPSIS (interactive mode)      
+    pg_export --interactive [DATABASE] [options]
+
+ARGUMENTS
+    DATABASE - database name to export (when default mode)
+             - phrase to filter database dumps by (when interactive mode)
+
+OPTIONS
+  TXT
 
-  opts.on('-g', '--gateway GATEWAY', String, '[Optional] ssh or ftp (default: ftp)') do |g|
+  opts.on('-g', '--gateway GATEWAY', String, 'ssh or ftp (default: ftp) - credentials need to be set via ENVs') do |g|
     ENV['GATEWAY'] = g
   end
 
-  opts.on('-d', '--database DATABASE', String, '[Required] Name of the database to export') do |d|
+  opts.on('-s', '--ssh', 'Same as "--gateway ssh"') do
+    ENV['GATEWAY'] = 'ssh'
+  end
+
+  opts.on('-f', '--ftp', 'Same as "--gateway ftp"') do
+    ENV['GATEWAY'] = 'ftp'
+  end
+
+  opts.on('-d', '--database DATABASE', String, 'Alternative way of specifying name of the database to export or phrase to filter by') do |d|
     database = d
   end
 
-  opts.on('-k', '--keep [KEEP]', String, "[Optional] Number of dump files to keep on FTP (default: #{ENV['KEEP_DUMPS']})") do |keep|
+  opts.on('-e', '--encryption_key KEY', String, 'Dumps will be SSL(AES-128-CBC) encrypted using this key. Should have exactly 16 characters. Overwrites PG_EXPORT_ENCRYPTION_KEY env') do |key|
+    ENV['PG_EXPORT_ENCRYPTION_KEY'] = key
+  end
+
+  opts.on('-k', '--keep KEEP', String, "Number of dump files to keep on FTP (default: 10). Overwrites KEEP_DUMPS env") do |keep|
     ENV['KEEP_DUMPS'] = keep
   end
 
-  opts.on('-t', '--timestamped', '[Optional] Enables log messages with timestamps') do
+  opts.on('-t', '--timestamped', 'Enables log messages with timestamps') do
     ENV['LOGGER_FORMAT'] = 'timestamped'
   end
 
-  opts.on('-m', '--muted', '[Optional] Mutes log messages (overrides -t option)') do
+  opts.on('-m', '--muted', 'Mutes log messages (overrides -t option)') do
     ENV['LOGGER_FORMAT'] = 'muted'
   end
 
-  opts.on('-i', '--interactive', '[Optional] Interactive command line mode - for restoring dumps into databases') do
+  opts.on('-i', '--interactive', 'Interactive mode, for importing dumps') do
     interactive = true
   end
 
@@ -48,29 +76,44 @@ option_parser = OptionParser.new do |opts|
     exit
   end
 
-  opts.separator "\nSetting can be verified by running following commands:"
+  opts.separator <<~TXT
+
+ENV
+    PG_EXPORT_GATEWAY_HOST           required
+    PG_EXPORT_GATEWAY_USER           required
+    PG_EXPORT_GATEWAY_PASSWORD       optional when eg. authorized key is added
+    PG_EXPORT_ENCRYPTION_KEY         required or set by --encryption_key)
+  TXT
+
+  opts.separator "\nTEST RUN"
 
-  opts.on('-c', '--configuration', 'Prints the configuration') do
+  opts.on('-c', '--configuration', 'Print the configuration') do
     require 'pg_export/container'
     PgExport::Container.start(:config)
     puts PgExport::Container['config'].to_h
     exit
   end
 
-  opts.on('-w', '--welcome', 'Tries connecting to the gateway (FTP or SSH) to verify the connection') do
+  opts.on('-w', '--welcome', 'Try connecting to the gateway (FTP or SSH) to verify the connection') do
     require 'pg_export/container'
     PgExport::Container.start(ENV['GATEWAY'].to_sym)
     gateway = PgExport::Container['factories.gateway_factory'].gateway
     puts gateway.welcome
     exit
   end
+
+  if ARGV.empty?
+    puts opts
+    exit
+  end
 end
 
 begin
   option_parser.parse!
+  database = ARGV.first unless ARGV.empty?
 rescue OptionParser::ParseError => e
   warn e.message.capitalize
-  warn 'Type "pg_export -h" for available options'
+  warn 'Type "pg_export" for available options'
   exit
 end
 

data/lib/pg_export/lib/pg_export/gateways/ftp.rb

@@ -27,9 +27,9 @@ class PgExport
         @ftp&.close
       end
 
-      def list(regex_string)
+      def list(name)
         ftp
-          .list(regex_string)
+          .list([name, '*'].join('_'))
           .map { |row| extracted_meaningful_attributes(row) }
           .sort_by { |item| item[:name] }
           .reverse

data/lib/pg_export/lib/pg_export/gateways/ssh.rb

@@ -2,6 +2,7 @@
 
 # auto_register: false
 
+require 'ed25519'
 require 'net/ssh'
 require 'net/scp'
 
@@ -30,11 +31,18 @@ class PgExport
         @ssh&.close
       end
 
-      def list(regex_string)
+      def list(name)
+        grep =
+          if name.nil? || name.empty?
+            ''
+          else
+            " | grep #{name}"
+          end
+
         ssh
-          .exec!("ls -l | grep #{regex_string.gsub('*', '')}")
-          .split("\n")
-          .map { |row| extract_meaningful_attributes(row) }
+          .exec!("ls -l#{grep}")
+          .split("\n").map { |row| extract_meaningful_attributes(row) }
+          .reject { |item| item[:name].nil? }
           .sort_by { |item| item[:name] }
           .reverse
       end

data/lib/pg_export/lib/pg_export/repositories/gateway_dump_repository.rb

@@ -9,7 +9,7 @@ class PgExport
   module Repositories
     class GatewayDumpRepository
       def all(database_name:, gateway:)
-        gateway.list([database_name, '*'].compact.join('_')).map do |item|
+        gateway.list(database_name).map do |item|
           begin
             dump(item[:name], database_name, item[:size])
           rescue Dry::Types::ConstraintError
@@ -19,7 +19,7 @@ class PgExport
       end
 
       def by_database_name(database_name:, gateway:, offset:)
-        gateway.list(database_name + '_*').drop(offset).map do |item|
+        gateway.list(database_name).drop(offset).map do |item|
           begin
             dump(item[:name], database_name, item[:size])
           rescue Dry::Types::ConstraintError

data/lib/pg_export/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class PgExport
-  VERSION = '1.0.0.rc1'
+  VERSION = '1.0.0.rc2'
 end

data/pg_export.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Krzysztof Maicher']
   spec.email         = ['krzysztof.maicher@gmail.com']
 
-  spec.summary       = 'CLI for creating and exporting PostgreSQL dumps to FTP.'
-  spec.description   = "CLI for creating and exporting PostgreSQL dumps to FTP.\
+  spec.summary       = 'CLI for exporting/importing PostgreSQL dumps via FTP/SSH.'
+  spec.description   = "CLI for exporting/importing PostgreSQL dumps via FTP/SSH.\
                         Can be used for backups or synchronizing databases between production and development environments."
   spec.homepage      = 'https://github.com/maicher/pg_export'
   spec.license       = 'MIT'
@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dry-struct', '~> 1.0'
   spec.add_dependency 'dry-system', '~> 0.18'
   spec.add_dependency 'dry-transaction', '~> 0.13'
+  spec.add_dependency 'ed25519'
   spec.add_dependency 'net-ssh'
   spec.add_dependency 'net-scp'
   spec.add_dependency 'tty-prompt'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_export
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - Krzysztof Maicher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-20 00:00:00.000000000 Z
+date: 2021-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -220,7 +234,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.59.2
-description: CLI for creating and exporting PostgreSQL dumps to FTP.                        Can
+description: CLI for exporting/importing PostgreSQL dumps via FTP/SSH.                        Can
   be used for backups or synchronizing databases between production and development
   environments.
 email:
@@ -319,5 +333,5 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
-summary: CLI for creating and exporting PostgreSQL dumps to FTP.
+summary: CLI for exporting/importing PostgreSQL dumps via FTP/SSH.
 test_files: []