pg_export 1.0.0.rc6 → 1.0.0.rc8

data/lib/pg_export/configuration_parser.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'pg_export/configuration'
+
+class PgExport
+  class ConfigurationParser
+    class Error < OptionParser::ParseError; end
+
+    class << self
+      def parse
+        h = {
+          encryption_key: ENV['PG_EXPORT_ENCRYPTION_KEY'],
+          encryption_algorithm: ENV['PG_EXPORT_ENCRYPTION_ALGORITHM'],
+          gateway_user: ENV['PG_EXPORT_GATEWAY_USER'],
+          gateway_host: ENV['PG_EXPORT_GATEWAY_HOST'],
+          gateway_password: ENV['PG_EXPORT_GATEWAY_PASSWORD'],
+          logger_format: ENV['PG_EXPORT_LOGGER_FORMAT'],
+          keep_dumps: ENV['PG_EXPORT_KEEP_DUMPS'],
+          gateway: ENV['PG_EXPORT_GATEWAY'],
+          database: ENV['PG_EXPORT_DATABASE'],
+          mode: ENV['PG_EXPORT_MODE'],
+          command: :export_dump
+        }
+
+        option_parser(h).parse!
+        h[:database] = ARGV.first unless ARGV.empty?
+
+        Configuration.new(**h)
+      rescue OptionParser::ParseError => e
+        error = Error.new(*e.args)
+        error.reason = e.reason
+        raise error
+      end
+
+      def help
+        option_parser.to_s
+      end
+
+      BANNER = <<~TXT
+        NAME
+            pg_export - CLI for exporting/importing PostgreSQL dumps via FTP/SSH
+
+        SYNOPSIS
+            pg_export DATABASE [OPTION..]
+            pg_export --interactive DATABASE [OPTION..]
+
+        EXIT VALUES
+            0 - Success
+            1 - Error
+
+        ARGUMENTS
+            DATABASE - database name to export (when default mode)
+                     - phrase to filter database dumps by (when interactive mode)
+
+        OPTIONS
+      TXT
+
+      EXAMPLE = <<~TXT
+        ENV
+          Each of the above options can be also set using enviromental variables.
+          Use full option names prepending with PG_EXPORT_ phrase.
+          Command line options takes precedence over the ENVs.
+
+          Eg. below two commands are equivalent:
+            pg_export -s -U user -H host database_name -k 10
+
+          Is equivalent to:
+            export PG_EXPORT_GATEWAY_USER=user
+            export PG_EXPORT_GATEWAY_HOST=host
+            export PG_EXPORT_KEEP=20
+            pg_export -s database_name -k 10
+      TXT
+
+      N = "\n                                     "
+
+      O = {
+        g: 'Allowed values: ftp, ssh. Default: ftp',
+        U: 'Gateway (ftp or ssh) user',
+        H: 'Gateway (ftp or ssh) host',
+        P: 'Gateway (ftp or ssh) password',
+        d: "In plain mode: database name to export;#{N}In interactive mode: phrase to filter by",
+        e: 'Dumps will be SSL encrypted using this key. Should have exactly 16 characters',
+        a: "Encryption cipher algorithm (default: AES-128-CBC);#{N}For available option see `$ openssl list -cipher-algorithms`",
+        k: 'Number of dump files to keep on FTP (default: 10)',
+        s: 'Same as "--gateway ssh". When set, the --gateway option is ignored',
+        f: 'Same as "--gateway ftp". When set, the --gateway option is ignored',
+        t: 'Prepends log messages with timestamps',
+        m: 'Mutes log messages. When set, the -t option is ignored. Prints message only on error',
+        i: 'Interactive mode, for importing dumps. Whan set, the -t and -m options are ignored',
+        w: 'Try connecting to the gateway (FTP or SSH) to verify the connection and exit',
+        c: 'Print the configuration and exit',
+        v: 'Print version',
+        h: 'Print this message and exit'
+      }.freeze
+      private_constant :BANNER, :EXAMPLE, :N, :O
+
+      def option_parser(h = {})
+        OptionParser.new do |o|
+          o.banner = BANNER
+          o.program_name = 'pg_export'
+          o.version = PgExport::VERSION
+          o.on('-g', '--gateway GATEWAY', %w[ftp ssh], O[:g]) { |v| h[:gateway] = v }
+          o.on('-U', '--user USER',            String, O[:U]) { |v| h[:gateway_user] = v }
+          o.on('-H', '--host HOST',            String, O[:H]) { |v| h[:gateway_host] = v }
+          o.on('-P', '--password PASSWORD',    String, O[:P]) { |v| h[:gateway_password] = v }
+          o.on('-d', '--database DATABASE',    String, O[:d]) { |v| h[:database] = v }
+          o.on('-e', '--encryption_key KEY',   String, O[:e]) { |v| h[:encryption_key] = v }
+          o.on('-a', '--algorithm ALGORITHM',  String, O[:a]) { |v| h[:encryption_algorithm] = v }
+          o.on('-k', '--keep KEEP',           Integer, O[:k]) { |v| h[:keep_dumps] = v }
+          o.on('-s', '--ssh',                          O[:s]) { h[:gateway] = 'ssh' }
+          o.on('-f', '--ftp',                          O[:f]) { h[:gateway] = 'ftp' }
+          o.on('-t', '--timestamped',                  O[:t]) { h[:logger_format] = 'timestamped' }
+          o.on('-m', '--muted',                        O[:m]) { h[:logger_format] = 'muted' }
+          o.on('-i', '--interactive',                  O[:i]) { h[:command] = :import_dump_interactively }
+          o.on('-w', '--welcome',                      O[:w]) { h[:command] = :gateway_welcome }
+          o.on('-c', '--configuration',                O[:c]) { h[:command] = :print_configuration }
+          o.on('-v', '--version',                      O[:v]) { h[:command] = :print_version }
+          o.on('-h', '--help',                         O[:h]) { h[:command] = :print_help }
+          o.separator ''
+          o.separator EXAMPLE
+        end
+      end
+    end
+  end
+end

data/lib/pg_export/{lib/pg_export/factories → factories}/dump_factory.rb

@@ -3,7 +3,7 @@
 require 'open3'
 require 'tempfile'
 
-require 'pg_export/lib/pg_export/entities/dump'
+require 'pg_export/entities/dump'
 
 class PgExport
   module Factories

data/lib/pg_export/{lib/pg_export/factories → factories}/ftp_gateway_factory.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'pg_export/lib/pg_export/gateways/ftp'
+require 'pg_export/gateways/ftp'
 
 class PgExport
   module Factories

data/lib/pg_export/{lib/pg_export/repositories/gateway_dump_file_repository.rb → factories/gateway_dump_file_factory.rb}

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require 'open3'
-require 'pg_export/lib/pg_export/entities/dump'
-require 'pg_export/lib/pg_export/value_objects/dump_file'
+require 'pg_export/entities/dump'
+require 'pg_export/value_objects/dump_file'
 
 class PgExport
-  module Repositories
-    class GatewayDumpFileRepository
+  module Factories
+    class GatewayDumpFileFactory
       def by_name(name:, gateway:)
         file = ValueObjects::DumpFile.new
         gateway.get(file, name)

data/lib/pg_export/{lib/pg_export/factories → factories}/ssh_gateway_factory.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'pg_export/lib/pg_export/gateways/ssh'
+require 'pg_export/gateways/ssh'
 
 class PgExport
   module Factories

data/lib/pg_export/{lib/pg_export/operations → operations}/decrypt_dump.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'pg_export'
-require 'pg_export/lib/pg_export/value_objects/result'
+require 'pg_export/value_objects/result'
 
 class PgExport
   module Operations

data/lib/pg_export/{lib/pg_export/operations → operations}/encrypt_dump.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'pg_export/lib/pg_export/value_objects/result'
+require 'pg_export/value_objects/result'
 
 class PgExport
   module Operations

data/lib/pg_export/{lib/pg_export/operations → operations}/open_connection.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'pg_export/lib/pg_export/value_objects/result'
+require 'pg_export/value_objects/result'
 
 class PgExport
   module Operations

data/lib/pg_export/{lib/pg_export/operations → operations}/remove_old_dumps.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'pg_export/lib/pg_export/value_objects/result'
+require 'pg_export/value_objects/result'
 
 class PgExport
   module Operations

data/lib/pg_export/{lib/pg_export/repositories → repositories}/gateway_dump_repository.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require 'open3'
-require 'pg_export/lib/pg_export/entities/dump'
-require 'pg_export/lib/pg_export/value_objects/dump_file'
+require 'pg_export/entities/dump'
+require 'pg_export/value_objects/dump_file'
 
 class PgExport
   module Repositories

data/lib/pg_export/{lib/pg_export/transactions → transactions}/export_dump.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-require 'pg_export/lib/pg_export/transactions/evaluator'
-require 'pg_export/lib/pg_export/value_objects/dump_file'
-require 'pg_export/lib/pg_export/value_objects/result'
+require 'pg_export/transactions/evaluator'
+require 'pg_export/value_objects/dump_file'
+require 'pg_export/adapters/shell_adapter'
+require 'pg_export/value_objects/result'
 
 class PgExport
   module Transactions
     class ExportDump
-      def initialize(dump_factory:, bash_adapter:, encrypt_dump:, open_connection:, remove_old_dumps:, listeners:)
+      def initialize(dump_factory:, shell_adapter:, encrypt_dump:, open_connection:, remove_old_dumps:, listeners:)
         @dump_factory = dump_factory
-        @bash_adapter = bash_adapter
+        @shell_adapter = shell_adapter
 
         @evaluator = Evaluator.new(listeners)
         @evaluator << method(:prepare_params)
@@ -27,8 +28,7 @@ class PgExport
 
       private
 
-      attr_reader :evaluator, :dump_factory, :bash_adapter
-
+      attr_reader :evaluator, :dump_factory, :shell_adapter
 
       def prepare_params(database_name:)
         database_name = database_name.to_s
@@ -41,10 +41,10 @@ class PgExport
       def build_dump(database_name:)
         dump = dump_factory.plain(
           database: database_name,
-          file: bash_adapter.pg_dump(ValueObjects::DumpFile.new, database_name)
+          file: shell_adapter.pg_dump(ValueObjects::DumpFile.new, database_name)
         )
         ValueObjects::Success.new(dump: dump)
-      rescue bash_adapter.class::PgDumpError => e
+      rescue Adapters::ShellAdapter::PgDumpError => e
         ValueObjects::Failure.new(message: 'Unable to dump database: ' + e.to_s)
       end
 
@@ -55,7 +55,7 @@ class PgExport
 
       def close_connection(removed_dumps:, gateway:)
         gateway.close
-        ValueObjects::Success.new(gateway: gateway)
+        ValueObjects::Success.new
       end
     end
   end

data/lib/pg_export/{lib/pg_export/transactions → transactions}/import_dump_interactively.rb

@@ -1,16 +1,25 @@
 # frozen_string_literal: true
 
-require 'pg_export/lib/pg_export/transactions/evaluator'
-require 'pg_export/lib/pg_export/value_objects/result'
+require 'pg_export/transactions/evaluator'
+require 'pg_export/adapters/shell_adapter'
+require 'pg_export/value_objects/result'
 
 class PgExport
   module Transactions
     class ImportDumpInteractively
-      def initialize(input:, bash_adapter:, gateway_dump_repository:, gateway_dump_file_repository:, open_connection:, decrypt_dump:, listeners:)
+      def initialize(
+        input:,
+        shell_adapter:,
+        gateway_dump_repository:,
+        gateway_dump_file_factory:,
+        open_connection:,
+        decrypt_dump:,
+        listeners:
+      )
         @input = input
-        @bash_adapter = bash_adapter
+        @shell_adapter = shell_adapter
         @gateway_dump_repository = gateway_dump_repository
-        @gateway_dump_file_repository = gateway_dump_file_repository
+        @gateway_dump_file_factory = gateway_dump_file_factory
 
         @evaluator = Evaluator.new(listeners)
         @evaluator << open_connection
@@ -29,7 +38,7 @@ class PgExport
 
       private
 
-      attr_reader :evaluator, :input, :bash_adapter, :gateway_dump_repository, :gateway_dump_file_repository
+      attr_reader :evaluator, :input, :shell_adapter, :gateway_dump_repository, :gateway_dump_file_factory
 
       def fetch_dumps(database_name:, gateway:)
         dumps = gateway_dump_repository.all(database_name: database_name, gateway: gateway)
@@ -44,7 +53,7 @@ class PgExport
       end
 
       def download_dump(dump:, gateway:)
-        dump.file = gateway_dump_file_repository.by_name(name: dump.name, gateway: gateway)
+        dump.file = gateway_dump_file_factory.by_name(name: dump.name, gateway: gateway)
         ValueObjects::Success.new(dump: dump, gateway: gateway)
       end
 
@@ -59,9 +68,9 @@ class PgExport
       end
 
       def restore(dump:, database:)
-        bash_adapter.pg_restore(dump.file, database)
-        ValueObjects::Success.new({})
-      rescue bash_adapter.class::PgRestoreError => e
+        shell_adapter.pg_restore(dump.file, database)
+        ValueObjects::Success.new(nil)
+      rescue Adapters::ShellAdapter::PgRestoreError => e
         ValueObjects::Failure.new(message: e.to_s)
       end
     end

data/lib/pg_export/{lib/pg_export/value_objects → value_objects}/result.rb

@@ -5,7 +5,7 @@ class PgExport
     class Result
       attr_reader :value
 
-      def initialize(value)
+      def initialize(value = nil)
         @value = value
       end
     end

data/lib/pg_export/version.rb

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

data/lib/pg_export.rb

@@ -2,27 +2,25 @@
 
 require 'pg_export/version'
 require 'pg_export/configuration'
-require 'pg_export/factory'
+require 'pg_export/configuration_parser'
+require 'pg_export/commands_factory'
 
 class PgExport
-  class InitializationError < StandardError; end
+  def initialize(config)
+    raise ArgumentError, 'config is not a PgExport::Configuration' unless config.is_a?(PgExport::Configuration)
 
-  attr_reader :config
-
-  def initialize
-    @config = PgExport::Configuration.build(ENV)
-    @factory = PgExport::Factory.new(config: config)
-  end
-
-  def call(database_name, &block)
-    factory.transaction.call(database_name: database_name, &block)
+    @command_name = config.command
+    @database_name = config.database
+    @commands_factory = PgExport::CommandsFactory.new(config: config)
   end
 
-  def gateway_welcome
-    container.gateway_factory.gateway.welcome
+  def call
+    commands_factory
+      .public_send(command_name)
+      .call(database_name: database_name)
   end
 
   private
 
-  attr_reader :factory
+  attr_reader :command_name, :database_name, :commands_factory
 end

data/pg_export.gemspec

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'pg_export/version'
+require_relative 'lib/pg_export/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'pg_export'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_export
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc6
+  version: 1.0.0.rc8
 platform: ruby
 authors:
 - Krzysztof Maicher
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-17 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
@@ -203,54 +203,55 @@ files:
 - bin/pg_export
 - bin/setup
 - lib/pg_export.rb
+- lib/pg_export/adapters/shell_adapter.rb
+- lib/pg_export/commands_factory.rb
 - lib/pg_export/configuration.rb
-- lib/pg_export/factory.rb
-- lib/pg_export/lib/pg_export/adapters/shell_adapter.rb
-- lib/pg_export/lib/pg_export/entities/dump.rb
-- lib/pg_export/lib/pg_export/factories/cipher_factory.rb
-- lib/pg_export/lib/pg_export/factories/dump_factory.rb
-- lib/pg_export/lib/pg_export/factories/ftp_gateway_factory.rb
-- lib/pg_export/lib/pg_export/factories/ssh_gateway_factory.rb
-- lib/pg_export/lib/pg_export/gateways/ftp.rb
-- lib/pg_export/lib/pg_export/gateways/ssh.rb
-- lib/pg_export/lib/pg_export/listeners/interactive/build_dump.rb
-- lib/pg_export/lib/pg_export/listeners/interactive/close_connection.rb
-- lib/pg_export/lib/pg_export/listeners/interactive/decrypt_dump.rb
-- lib/pg_export/lib/pg_export/listeners/interactive/download_dump.rb
-- lib/pg_export/lib/pg_export/listeners/interactive/encrypt_dump.rb
-- lib/pg_export/lib/pg_export/listeners/interactive/fetch_dumps.rb
-- lib/pg_export/lib/pg_export/listeners/interactive/open_connection.rb
-- lib/pg_export/lib/pg_export/listeners/interactive/remove_old_dumps.rb
-- lib/pg_export/lib/pg_export/listeners/interactive/restore.rb
-- lib/pg_export/lib/pg_export/listeners/interactive/select_database.rb
-- lib/pg_export/lib/pg_export/listeners/interactive/select_dump.rb
-- lib/pg_export/lib/pg_export/listeners/interactive/upload_dump.rb
-- lib/pg_export/lib/pg_export/listeners/interactive_listener.rb
-- lib/pg_export/lib/pg_export/listeners/plain/build_dump.rb
-- lib/pg_export/lib/pg_export/listeners/plain/close_connection.rb
-- lib/pg_export/lib/pg_export/listeners/plain/decrypt_dump.rb
-- lib/pg_export/lib/pg_export/listeners/plain/download_dump.rb
-- lib/pg_export/lib/pg_export/listeners/plain/encrypt_dump.rb
-- lib/pg_export/lib/pg_export/listeners/plain/fetch_dumps.rb
-- lib/pg_export/lib/pg_export/listeners/plain/open_connection.rb
-- lib/pg_export/lib/pg_export/listeners/plain/prepare_params.rb
-- lib/pg_export/lib/pg_export/listeners/plain/remove_old_dumps.rb
-- lib/pg_export/lib/pg_export/listeners/plain/restore.rb
-- lib/pg_export/lib/pg_export/listeners/plain/upload_dump.rb
-- lib/pg_export/lib/pg_export/listeners/plain_listener.rb
-- lib/pg_export/lib/pg_export/operations/decrypt_dump.rb
-- lib/pg_export/lib/pg_export/operations/encrypt_dump.rb
-- lib/pg_export/lib/pg_export/operations/open_connection.rb
-- lib/pg_export/lib/pg_export/operations/remove_old_dumps.rb
-- lib/pg_export/lib/pg_export/repositories/gateway_dump_file_repository.rb
-- lib/pg_export/lib/pg_export/repositories/gateway_dump_repository.rb
-- lib/pg_export/lib/pg_export/transactions/evaluator.rb
-- lib/pg_export/lib/pg_export/transactions/export_dump.rb
-- lib/pg_export/lib/pg_export/transactions/import_dump_interactively.rb
-- lib/pg_export/lib/pg_export/ui/interactive/input.rb
-- lib/pg_export/lib/pg_export/ui/plain/input.rb
-- lib/pg_export/lib/pg_export/value_objects/dump_file.rb
-- lib/pg_export/lib/pg_export/value_objects/result.rb
+- lib/pg_export/configuration_parser.rb
+- lib/pg_export/entities/dump.rb
+- lib/pg_export/factories/cipher_factory.rb
+- lib/pg_export/factories/dump_factory.rb
+- lib/pg_export/factories/ftp_gateway_factory.rb
+- lib/pg_export/factories/gateway_dump_file_factory.rb
+- lib/pg_export/factories/ssh_gateway_factory.rb
+- lib/pg_export/gateways/ftp.rb
+- lib/pg_export/gateways/ssh.rb
+- lib/pg_export/listeners/interactive/build_dump.rb
+- lib/pg_export/listeners/interactive/close_connection.rb
+- lib/pg_export/listeners/interactive/decrypt_dump.rb
+- lib/pg_export/listeners/interactive/download_dump.rb
+- lib/pg_export/listeners/interactive/encrypt_dump.rb
+- lib/pg_export/listeners/interactive/fetch_dumps.rb
+- lib/pg_export/listeners/interactive/open_connection.rb
+- lib/pg_export/listeners/interactive/remove_old_dumps.rb
+- lib/pg_export/listeners/interactive/restore.rb
+- lib/pg_export/listeners/interactive/select_database.rb
+- lib/pg_export/listeners/interactive/select_dump.rb
+- lib/pg_export/listeners/interactive/upload_dump.rb
+- lib/pg_export/listeners/interactive_listener.rb
+- lib/pg_export/listeners/plain/build_dump.rb
+- lib/pg_export/listeners/plain/close_connection.rb
+- lib/pg_export/listeners/plain/decrypt_dump.rb
+- lib/pg_export/listeners/plain/download_dump.rb
+- lib/pg_export/listeners/plain/encrypt_dump.rb
+- lib/pg_export/listeners/plain/fetch_dumps.rb
+- lib/pg_export/listeners/plain/open_connection.rb
+- lib/pg_export/listeners/plain/prepare_params.rb
+- lib/pg_export/listeners/plain/remove_old_dumps.rb
+- lib/pg_export/listeners/plain/restore.rb
+- lib/pg_export/listeners/plain/upload_dump.rb
+- lib/pg_export/listeners/plain_listener.rb
+- lib/pg_export/operations/decrypt_dump.rb
+- lib/pg_export/operations/encrypt_dump.rb
+- lib/pg_export/operations/open_connection.rb
+- lib/pg_export/operations/remove_old_dumps.rb
+- lib/pg_export/repositories/gateway_dump_repository.rb
+- lib/pg_export/transactions/evaluator.rb
+- lib/pg_export/transactions/export_dump.rb
+- lib/pg_export/transactions/import_dump_interactively.rb
+- lib/pg_export/ui/interactive/input.rb
+- lib/pg_export/ui/plain/input.rb
+- lib/pg_export/value_objects/dump_file.rb
+- lib/pg_export/value_objects/result.rb
 - lib/pg_export/version.rb
 - pg_export.gemspec
 homepage: https://github.com/maicher/pg_export