pg_export 0.7.7 → 1.0.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb53d0f011376ea9e5aa335950e88d42a658109c674d5c8c274523515bb07774
-  data.tar.gz: b97c9d38adc50f6dba5bb41a0146fa40548277459725cf07045485b6c4d55a6b
+  metadata.gz: b927b4b2f8c0ca36682a15ae9f90aa975980d9d3874989f7ab19fe256fcecb7d
+  data.tar.gz: b653c480d52143bf58864f7904a404a21802aa389e9b24ee9f271dbafa064969
 SHA512:
-  metadata.gz: 5d732adabd60d8b71fa56f81a87cc2d5f49a3e01e80ac11cd22000941fb994c1a27705c3dbf375a0a2ccd41a28070d4d8061ada78494806b228f268779993101
-  data.tar.gz: c4a7d99c20eb88534eb6adda2080d200de4725bf1d7fc3cfb3781c4ffa17ace711434bac75f0469e50e0c482d3f751f2b2f02f15d1eff7bb3c498c7e7fc3b088
+  metadata.gz: c1ae01b513f51ef4675b1dbae7337ac6ffe11d3ca481bf272ea6338e1f1b1bcd5fb75b240aefdcc12117e721a6097e945b1832af56344ac232ebfad55a5e98db
+  data.tar.gz: 31dc4ab7b943ce973f14b6a42867d388fa18a8c8f56d52bd9c0e5e30b241258555e804a4d59b53ed9d409fae8d7a8aa8ad8a130356383b66cbbbc4b1a1b75aba

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.idea

data/.travis.yml

@@ -1,9 +1,12 @@
-sudo: false
 language: ruby
 rvm:
-  - 2.3.0
+  - 3.0.0
+  - 2.7.2
+  - 2.4.10
+services:
+  - postgresql
 addons:
   code_climate:
     repo_token: db03e5968c5bcd68b12ca50f5d41ae07dd74fe80d4e1421d754e31c316e7477a
-before_install: gem install bundler -v 1.16.6
+before_install: gem install bundler -v 2.2.3
 after_success: codeclimate-test-reporter

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+### 1.0.0 - 2021.03.20
+- Make it compatible with Ruby 3.0
+- Change configuration envs:
+  - BACKUP_FTP_HOST -> PG_EXPORT_GATEWAY_HOST
+  - BACKUP_FTP_USER -> PG_EXPORT_GATEWAY_USER
+  - BACKUP_FTP_PASSWORD -> PG_EXPORT_GATEWAY_PASSWORD
+  - DUMP_ENCRYPTION_KEY -> PG_EXPORT_ENCRYPTION_KEY
+- Drop Ruby 2.3 support
+- Add SSH option
+- Add +encryption_algorith+ moption to interface
+
 ### 0.7.7 - 2020.09.07
 
 - Upgrade dry-initializer 

data/README.md

@@ -26,7 +26,7 @@ Features:
 
 ## Dependencies
 
-  * Ruby >= 2.3.0
+  * Ruby >= 2.4 (works with Ruby 3.0)
   * $ pg_dump
   * $ pg_restore
 
@@ -51,29 +51,32 @@ Or install it yourself as:
     $ pg_export -h
 
     Usage: pg_export [options]
+        -g, --gateway GATEWAY            [Optional] ssh or ftp (default: ftp)
         -d, --database DATABASE          [Required] Name of the database to export
         -k, --keep [KEEP]                [Optional] Number of dump files to keep on FTP (default: 10)
         -t, --timestamped                [Optional] Enables log messages with timestamps
         -m, --muted                      [Optional] Mutes log messages (overrides -t option)
         -i, --interactive                [Optional] Interactive command line mode - for restoring dumps into databases
+        -v, --version                    Show version
         -h, --help                       Show this message
-    
+
     Setting can be verified by running following commands:
         -c, --configuration              Prints the configuration
-        -f, --ftp                        Tries connecting to FTP to verify the connection
+        -w, --welcome                    Tries connecting to the gateway (FTP or SSH) to verify the connection
+
 
 ## How to start
 
 __Step 1.__ Prepare ENV variables.
 
     /* FTP storage for database dumps. */
-    BACKUP_FTP_HOST=yourftp.example.com
-    BACKUP_FTP_USER=user
-    BACKUP_FTP_PASSWORD=password
+    PG_EXPORT_GATEWAY_HOST=yourftp.example.com
+    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. */
-    DUMP_ENCRYPTION_KEY=1234567890abcdef
+    PG_EXPORT_ENCRYPTION_KEY=1234567890abcdef
     
     /* Dumps to be kept on FTP */
     /* Optional, defaults to 10 */
@@ -84,12 +87,12 @@ Note, that variables cannot include `#` sign, [more info](http://serverfault.com
 __Step 2.__ Print the configuration to verify if env variables has been loaded properly.
 
     $ pg_export --configuration
-    => {:dump_encryption_key=>"k4***", :ftp_host=>"yourftp.example.com", :ftp_user=>"your_ftp_user", 
-       :ftp_password=>"pass***", :logger_format=>"plain", :keep_dumps=>2} 
+    => {:encryption_key=>"k4***", :gateway_host=>"yourftp.example.com", :gateway_user=>"your_gateway_user",
+       :gateway_password=>"pass***", :logger_format=>"plain", :keep_dumps=>2}
        
 __Step 3.__ Try connecting to FTP to verify the connection.
 
-    $ pg_export --ftp
+    $ pg_export --gateway ftp --welcome
     => 230 User your_ftp_user logged in
     
 __Step 4.__ Perform database export.

data/bin/pg_export

@@ -4,33 +4,79 @@
 require 'optparse'
 
 require 'pg_export'
-require 'pg_export/container'
+require 'pg_export/version'
 
 ENV['KEEP_DUMPS'] = ENV['KEEP_DUMPS'] || '10'
-interactive = false
+ENV['GATEWAY'] = 'ftp'
+ENV['PG_EXPORT_MODE'] = 'plain'
+ENV['PG_EXPORT_ENCRYPTION_ALGORITHM'] = 'AES-128-CBC'
+
 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]
 
-  opts.on('-d', '--database DATABASE', String, '[Required] Name of the database to export') do |d|
+    ARGUMENTS
+        DATABASE - database name to export (when default mode)
+                 - phrase to filter database dumps by (when interactive mode)
+
+    OPTIONS
+  TXT
+
+  opts.program_name = 'pg_export'
+  opts.version = PgExport::VERSION
+
+  opts.on('-g', '--gateway GATEWAY', %w[ftp ssh], 'Allowed values: ftp, ssh. Default: ftp. Credentials need to be set via ENVs') do |g|
+    ENV['GATEWAY'] = g
+  end
+
+  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 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('-a', '--algorithm ALGORITHM', String, 'Encryption cipher algorithm (default: AES-128-CBC). Overwrites PG_EXPORT_ENCRYPTION_ALGORITHM env. For available option see `$ openssl list -cipher-algorithms`') 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
-    interactive = true
+  opts.on('-i', '--interactive', 'Interactive mode, for importing dumps') do
+    ENV['PG_EXPORT_MODE'] = 'interactive'
+  end
+
+  opts.on('-v', '--version', 'Show version') do
+    puts PgExport::VERSION
+    exit
   end
 
   opts.on('-h', '--help', 'Show this message') do
@@ -38,45 +84,65 @@ 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)
+        PG_EXPORT_ENCRYPTION_ALGORITHM   required or set by --algorithm)
+  TXT
 
-  opts.on('-c', '--configuration', 'Prints the configuration') do
+  opts.separator "\nTEST RUN"
+
+  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('-f', '--ftp', 'Tries connecting to FTP to verify the connection') do
-    PgExport::Container.start(:ftp)
-    ftp_adapter = PgExport::Container['factories.ftp_adapter_factory'].ftp_adapter
-    ftp = ftp_adapter.open_ftp
-    puts ftp.welcome
+  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 'Details:'
+  warn option_parser.to_s.split("\n").grep(/ #{e.args.first}/).join("\n")
+  warn 'Type "pg_export" for available options'
   exit
 end
 
+require 'pg_export/container'
+
 begin
-  pg_export =
-    if interactive
-      PgExport.interactive
-    else
-      PgExport.plain
-    end
+  pg_export = PgExport.boot
 rescue PgExport::InitializationError => e
   warn 'Unable to initialize PgExport due to invalid configuration. Check you ENVs.'
   warn "Detailed message: #{e.message}"
   exit
 end
 
-pg_export.call(database) do |result|
-  result.success { puts 'Success' }
-  result.failure { |message:| warn message }
+begin
+  pg_export.call(database) do |result|
+    result.success { puts 'Success' }
+    result.failure { |outcome| warn outcome[:message] }
+  end
+rescue Interrupt
+  puts
 end

data/lib/pg_export.rb

@@ -1,24 +1,16 @@
 # frozen_string_literal: true
 
 require 'pg_export/container'
+require 'pg_export/import'
 
 class PgExport
   class InitializationError < StandardError; end
 
-  class << self
-    def interactive
-      PgExport::Container.start(:interactive)
-      new(transaction: PgExport::Container['transactions.import_dump_interactively'])
-    end
+  include Import['transaction']
 
-    def plain
-      PgExport::Container.start(:plain)
-      new(transaction: PgExport::Container['transactions.export_dump'])
-    end
-  end
-
-  def initialize(transaction:)
-    @transaction = transaction
+  def self.boot
+    PgExport::Container.start(:main)
+    new
   end
 
   def call(database_name, &block)

data/lib/pg_export/configuration.rb

@@ -1,34 +1,34 @@
 # frozen_string_literal: true
 
-require 'dry-types'
+require 'pg_export/lib/pg_export/types'
 require 'dry-struct'
 
 class PgExport
   class Configuration < Dry::Struct
-    include Dry::Types()
-
-    attribute :dump_encryption_key, Strict::String.constrained(size: 16)
-    attribute :ftp_host,            Strict::String
-    attribute :ftp_user,            Strict::String
-    attribute :ftp_password,        Strict::String
-    attribute :logger_format,       Coercible::String.enum('plain', 'timestamped', 'muted')
-    attribute :keep_dumps,          Coercible::Integer.constrained(gteq: 0)
+    attribute :encryption_key,       PgExport::Types::Strict::String.constrained(size: 16)
+    attribute :encryption_algorithm, PgExport::Types::Strict::String
+    attribute :gateway_host,         PgExport::Types::Strict::String
+    attribute :gateway_user,         PgExport::Types::Strict::String
+    attribute :gateway_password,     PgExport::Types::Strict::String.optional
+    attribute :logger_format,        PgExport::Types::Coercible::Symbol.enum(:plain, :timestamped, :muted)
+    attribute :keep_dumps,           PgExport::Types::Coercible::Integer.constrained(gteq: 0)
+    attribute :gateway,              PgExport::Types::Coercible::Symbol.enum(:ftp, :ssh)
+    attribute :mode,                 PgExport::Types::Coercible::Symbol.enum(:plain, :interactive)
 
     def self.build(env)
       new(
-        dump_encryption_key: env['DUMP_ENCRYPTION_KEY'],
-        ftp_host: env['BACKUP_FTP_HOST'],
-        ftp_user: env['BACKUP_FTP_USER'],
-        ftp_password: env['BACKUP_FTP_PASSWORD'],
+        encryption_key: env['PG_EXPORT_ENCRYPTION_KEY'],
+        encryption_algorithm: env['PG_EXPORT_ENCRYPTION_ALGORITHM'],
+        gateway_host: env['PG_EXPORT_GATEWAY_HOST'],
+        gateway_user: env['PG_EXPORT_GATEWAY_USER'],
+        gateway_password: env['PG_EXPORT_GATEWAY_PASSWORD'] == '' ? nil : env['PG_EXPORT_GATEWAY_PASSWORD'],
         logger_format: env['LOGGER_FORMAT'] || 'plain',
-        keep_dumps: env['KEEP_DUMPS'] || 10
+        keep_dumps: env['KEEP_DUMPS'] || 10,
+        gateway: env['GATEWAY'],
+        mode: env['PG_EXPORT_MODE']
       )
     rescue Dry::Struct::Error => e
       raise PgExport::InitializationError, e.message.gsub('[PgExport::Configuration.new] ', '')
     end
-
-    def logger_muted?
-      logger_format == 'muted'
-    end
   end
 end

data/lib/pg_export/container.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'dry/system/container'
-require 'pg_export/lib/pg_export/types'
 
 class PgExport
   class Container < Dry::System::Container
@@ -14,35 +13,11 @@ class PgExport
 
     load_paths!('lib')
 
-    boot(:ftp) do
-      init do
-        require 'pg_export/lib/pg_export/factories/ftp_adapter_factory'
-      end
-
-      start do
-        use :config
-
-        register('factories.ftp_adapter_factory') do
-          ::PgExport::Factories::FtpAdapterFactory.new
-        end
-      end
-    end
-
-    boot(:main) do
-      init do
-        require 'pg_export/lib/pg_export/operations/encrypt_dump'
-        require 'pg_export/lib/pg_export/operations/decrypt_dump'
-        require 'pg_export/lib/pg_export/operations/remove_old_dumps_from_ftp'
-        require 'pg_export/lib/pg_export/operations/open_ftp_connection'
-      end
-
-      start do
-        use :ftp
-        register('operations.encrypt_dump') { ::PgExport::Operations::EncryptDump.new }
-        register('operations.decrypt_dump') { ::PgExport::Operations::DecryptDump.new }
-        register('operations.remove_old_dumps_from_ftp') { ::PgExport::Operations::RemoveOldDumpsFromFtp.new }
-        register('operations.open_ftp_connection') { ::PgExport::Operations::OpenFtpConnection.new }
-      end
+    boot(:main) do |system|
+      use(:config)
+      use(system[:config].gateway) # ftp/ssh
+      use(:operations)
+      use(system[:config].mode)    # plain/interactive
     end
   end
 end

data/lib/pg_export/import.rb

@@ -3,5 +3,5 @@
 require_relative 'container'
 
 class PgExport
-  Import = PgExport::Container.injector.hash
+  Import = PgExport::Container.injector
 end

data/lib/pg_export/lib/pg_export/factories/cipher_factory.rb

@@ -9,23 +9,20 @@ class PgExport
       include Import['config']
 
       def encryptor
-        cipher(:encrypt)
+        build_cipher(:encrypt)
       end
 
       def decryptor
-        cipher(:decrypt)
+        build_cipher(:decrypt)
       end
 
       private
 
-      ALGORITHM = 'AES-128-CBC'
-      private_constant :ALGORITHM
-
-      def cipher(type)
-        OpenSSL::Cipher.new(ALGORITHM).tap do |cipher|
-          cipher.public_send(type)
-          cipher.key = config.dump_encryption_key
-        end
+      def build_cipher(type)
+        cipher = OpenSSL::Cipher.new(config.encryption_algorithm)
+        cipher.public_send(type)
+        cipher.key = config.encryption_key
+        cipher
       end
     end
   end