pg_export 0.7.7 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb53d0f011376ea9e5aa335950e88d42a658109c674d5c8c274523515bb07774
-  data.tar.gz: b97c9d38adc50f6dba5bb41a0146fa40548277459725cf07045485b6c4d55a6b
+  metadata.gz: 3eb793296ca1e2e22519a8abf1644f88fd06daa02a672d392f318a19128c50cb
+  data.tar.gz: '085a37ec1e0b7cc96f811e73a0a3271086e1c12fba3e6a2da831c6f58a4f9fde'
 SHA512:
-  metadata.gz: 5d732adabd60d8b71fa56f81a87cc2d5f49a3e01e80ac11cd22000941fb994c1a27705c3dbf375a0a2ccd41a28070d4d8061ada78494806b228f268779993101
-  data.tar.gz: c4a7d99c20eb88534eb6adda2080d200de4725bf1d7fc3cfb3781c4ffa17ace711434bac75f0469e50e0c482d3f751f2b2f02f15d1eff7bb3c498c7e7fc3b088
+  metadata.gz: a3b89d600dc035cca7cdc909b503ac1d62e7844531d5f8a35c8213339968074ccb21d49669a1623f3d616f0aa52c2ccfb1c6c0a54f864e602ffcbe32a43c0886
+  data.tar.gz: 9a93edd9855a3a20d5745491cedbcff104cd8aee180e1c10537c63c129c8ed96933f36d5120476b85812aece2bcaba507391910e282097b5a8555e210a0e209e

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,12 @@
+### 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
+
 ### 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. */
     /* 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} 
+    => {:dump_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,15 +4,20 @@
 require 'optparse'
 
 require 'pg_export'
-require 'pg_export/container'
 
 ENV['KEEP_DUMPS'] = ENV['KEEP_DUMPS'] || '10'
+ENV['GATEWAY'] = 'ftp'
+
 interactive = false
 database = nil
 
 option_parser = OptionParser.new do |opts|
   opts.banner = 'Usage: pg_export [options]'
 
+  opts.on('-g', '--gateway GATEWAY', String, '[Optional] ssh or ftp (default: ftp)') do |g|
+    ENV['GATEWAY'] = g
+  end
+
   opts.on('-d', '--database DATABASE', String, '[Required] Name of the database to export') do |d|
     database = d
   end
@@ -33,6 +38,11 @@ option_parser = OptionParser.new do |opts|
     interactive = true
   end
 
+  opts.on('-v', '--version', 'Show version') do
+    puts PgExport::VERSION
+    exit
+  end
+
   opts.on('-h', '--help', 'Show this message') do
     puts opts
     exit
@@ -41,16 +51,17 @@ option_parser = OptionParser.new do |opts|
   opts.separator "\nSetting can be verified by running following commands:"
 
   opts.on('-c', '--configuration', 'Prints 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', 'Tries 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
 end
@@ -63,6 +74,8 @@ rescue OptionParser::ParseError => e
   exit
 end
 
+require 'pg_export/container'
+
 begin
   pg_export =
     if interactive
@@ -78,5 +91,5 @@ end
 
 pg_export.call(database) do |result|
   result.success { puts 'Success' }
-  result.failure { |message:| warn message }
+  result.failure { |outcome| warn outcome[:message] }
 end

data/lib/pg_export/configuration.rb

@@ -8,18 +8,18 @@ class PgExport
     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 :gateway_host,        Strict::String
+    attribute :gateway_user,        Strict::String
+    attribute :gateway_password,    Strict::String.optional
     attribute :logger_format,       Coercible::String.enum('plain', 'timestamped', 'muted')
     attribute :keep_dumps,          Coercible::Integer.constrained(gteq: 0)
 
     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'],
+        dump_encryption_key: env['PG_EXPORT_ENCRYPTION_KEY'],
+        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
       )
@@ -27,6 +27,10 @@ class PgExport
       raise PgExport::InitializationError, e.message.gsub('[PgExport::Configuration.new] ', '')
     end
 
+    def gateway
+      ENV['GATEWAY'].to_sym
+    end
+
     def logger_muted?
       logger_format == 'muted'
     end

data/lib/pg_export/container.rb

@@ -16,32 +16,41 @@ class PgExport
 
     boot(:ftp) do
       init do
-        require 'pg_export/lib/pg_export/factories/ftp_adapter_factory'
+        require 'pg_export/lib/pg_export/factories/ftp_gateway_factory'
       end
 
       start do
         use :config
+        register('factories.gateway_factory') { ::PgExport::Factories::FtpGatewayFactory.new }
+      end
+    end
+
+    boot(:ssh) do
+      init do
+        require 'pg_export/lib/pg_export/factories/ssh_gateway_factory'
+      end
 
-        register('factories.ftp_adapter_factory') do
-          ::PgExport::Factories::FtpAdapterFactory.new
-        end
+      start do
+        use :config
+        register('factories.gateway_factory') { ::PgExport::Factories::SshGatewayFactory.new }
       end
     end
 
-    boot(:main) do
+    boot(:main) do |system|
       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'
+        require 'pg_export/lib/pg_export/operations/open_connection'
       end
 
       start do
-        use :ftp
+        use(system[:config].gateway)
+
         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 }
+        register('operations.open_connection') { ::PgExport::Operations::OpenConnection.new }
       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/ftp_gateway_factory.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# auto_register: false
+
+require 'pg_export/lib/pg_export/gateways/ftp'
+require 'pg_export/import'
+
+class PgExport
+  module Factories
+    class FtpGatewayFactory
+      include Import['config']
+
+      def gateway
+        ::PgExport::Gateways::Ftp.new(
+          host: config.gateway_host,
+          user: config.gateway_user,
+          password: config.gateway_password
+        )
+      end
+    end
+  end
+end

data/lib/pg_export/lib/pg_export/factories/ssh_gateway_factory.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# auto_register: false
+
+require 'pg_export/lib/pg_export/gateways/ssh'
+require 'pg_export/import'
+
+class PgExport
+  module Factories
+    class SshGatewayFactory
+      include Import['config']
+
+      def gateway
+        ::PgExport::Gateways::Ssh.new(
+          host: config.gateway_host,
+          user: config.gateway_user,
+          password: config.gateway_password
+        )
+      end
+    end
+  end
+end

data/lib/pg_export/lib/pg_export/{adapters/ftp_adapter.rb → gateways/ftp.rb}

@@ -5,22 +5,25 @@
 require 'net/ftp'
 
 class PgExport
-  module Adapters
-    class FtpAdapter
+  module Gateways
+    class Ftp
       CHUNK_SIZE = (2**16).freeze
 
       def initialize(host:, user:, password:)
         @host, @user, @password, @logger = host, user, password
-        ObjectSpace.define_finalizer(self, proc { ftp.close if @ftp })
       end
 
-      def open_ftp
+      def open
         @ftp = Net::FTP.new(host, user, password)
         @ftp.passive = true
         @ftp
       end
 
-      def close_ftp
+      def welcome
+        open.welcome
+      end
+
+      def close
         @ftp&.close
       end
 
@@ -49,7 +52,7 @@ class PgExport
       end
 
       def ftp
-        @ftp ||= open_ftp
+        @ftp ||= open
       end
 
       private

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# auto_register: false
+
+require 'net/ssh'
+require 'net/scp'
+
+class PgExport
+  module Gateways
+    class Ssh
+      CHUNK_SIZE = (2**16).freeze
+
+      def initialize(host:, user:, password:)
+        @host, @user, @password, @logger = host, user, password
+      end
+
+      def open
+        if password.nil?
+          @ssh = Net::SSH.start(host, user)
+        else
+          @ssh = Net::SSH.start(host, user, password)
+        end
+      end
+
+      def welcome
+        open.exec!('hostname')
+      end
+
+      def close
+        @ssh&.close
+      end
+
+      def list(regex_string)
+        ssh
+          .exec!("ls -l | grep #{regex_string.gsub('*', '')}")
+          .split("\n")
+          .map { |row| extract_meaningful_attributes(row) }
+          .sort_by { |item| item[:name] }
+          .reverse
+      end
+
+      def delete(name)
+        # @TODO
+      end
+
+      def persist(file, name)
+        ssh.scp.upload(file.path, name).wait
+      end
+
+      def get(file, name)
+        ssh.scp.download(name, file.path).wait
+      end
+
+      def to_s
+        host
+      end
+
+      def ssh
+        @ssh ||= open
+      end
+
+      private
+
+      attr_reader :host, :user, :password
+
+      def extract_meaningful_attributes(item)
+        MEANINGFUL_KEYS.zip(item.split(' ').values_at(8, 4)).to_h
+      end
+
+      MEANINGFUL_KEYS = %i[name size].freeze
+      private_constant :MEANINGFUL_KEYS
+    end
+  end
+end

data/lib/pg_export/lib/pg_export/listeners/interactive/build_dump.rb

@@ -6,12 +6,12 @@ class PgExport
   module Listeners
     class Interactive
       class BuildDump < InteractiveListener
-        def on_step(step_name:, args:)
-          @spinner = build_spinner("Dumping database #{args.first[:database_name]}")
+        def on_step(event)
+          @spinner = build_spinner("Dumping database #{event[:args].first[:database_name]}")
         end
 
-        def on_step_succeeded(step_name:, args:, value:)
-          @spinner.success([success, value[:dump]].join(' '))
+        def on_step_succeeded(event)
+          @spinner.success([success, event[:value][:dump]].join(' '))
         end
       end
     end

data/lib/pg_export/lib/pg_export/listeners/interactive/{close_ftp_connection.rb → close_connection.rb}

@@ -5,7 +5,7 @@ require_relative '../interactive_listener'
 class PgExport
   module Listeners
     class Interactive
-      class CloseFtpConnection < InteractiveListener
+      class CloseConnection < InteractiveListener
         def on_step(*)
           @spinner = build_spinner('Closing FTP')
         end

data/lib/pg_export/lib/pg_export/listeners/interactive/decrypt_dump.rb

@@ -10,8 +10,8 @@ class PgExport
           @spinner = build_spinner('Decrypting')
         end
 
-        def on_step_succeeded(step_name:, args:, value:)
-          @spinner.success([success, value[:dump]].join(' '))
+        def on_step_succeeded(event)
+          @spinner.success([success, event[:value][:dump]].join(' '))
         end
       end
     end

data/lib/pg_export/lib/pg_export/listeners/interactive/download_dump_from_ftp.rb

@@ -10,8 +10,8 @@ class PgExport
           @spinner = build_spinner('Downloading')
         end
 
-        def on_step_succeeded(step_name:, args:, value:)
-          @spinner.success([success, value[:dump]].join(' '))
+        def on_step_succeeded(event)
+          @spinner.success([success, event[:value][:dump]].join(' '))
         end
       end
     end

data/lib/pg_export/lib/pg_export/listeners/interactive/encrypt_dump.rb

@@ -10,8 +10,8 @@ class PgExport
           @spinner = build_spinner('Encrypting')
         end
 
-        def on_step_succeeded(step_name:, args:, value:)
-          @spinner.success([success, value[:dump]].join(' '))
+        def on_step_succeeded(event)
+          @spinner.success([success, event[:value][:dump]].join(' '))
         end
       end
     end

data/lib/pg_export/lib/pg_export/listeners/interactive/{open_ftp_connection.rb → open_connection.rb}

@@ -5,7 +5,7 @@ require_relative '../interactive_listener'
 class PgExport
   module Listeners
     class Interactive
-      class OpenFtpConnection < InteractiveListener
+      class OpenConnection < InteractiveListener
         def on_step(*)
           @spinner = build_spinner('Opening ftp connection')
         end

data/lib/pg_export/lib/pg_export/listeners/interactive/remove_old_dumps_from_ftp.rb

@@ -6,13 +6,13 @@ class PgExport
   module Listeners
     class Interactive
       class RemoveOldDumpsFromFtp < InteractiveListener
-        def on_step(step_name:, args:)
-          @spinner = build_spinner("Checking for old dumps on #{args.first[:ftp_adapter]}")
+        def on_step(event)
+          @spinner = build_spinner("Checking for old dumps on #{event[:args].first[:gateway]}")
         end
 
-        def on_step_succeeded(step_name:, args:, value:)
-          if value[:removed_dumps].any?
-            @spinner.success([success, value[:removed_dumps].map { |filename| "    #{filename} removed" }].join("\n"))
+        def on_step_succeeded(event)
+          if event[:value][:removed_dumps].any?
+            @spinner.success([success, event[:value][:removed_dumps].map { |filename| "    #{filename} removed" }].join("\n"))
           else
             @spinner.success([success, 'nothing to remove'].join(' '))
           end

data/lib/pg_export/lib/pg_export/listeners/interactive/restore.rb

@@ -6,8 +6,8 @@ class PgExport
   module Listeners
     class Interactive
       class Restore < InteractiveListener
-        def on_step(step_name:, args:)
-          @spinner = build_spinner("Restoring dump to database #{args.first[:database]}")
+        def on_step(event)
+          @spinner = build_spinner("Restoring dump to database #{event[:args].first[:database]}")
         end
 
         def on_step_succeeded(*)

data/lib/pg_export/lib/pg_export/listeners/interactive/upload_dump_to_ftp.rb

@@ -6,8 +6,8 @@ class PgExport
   module Listeners
     class Interactive
       class UploadDumpToFtp < InteractiveListener
-        def on_step(step_name:, args:)
-          @spinner = build_spinner("Uploading #{args.first[:dump]} to #{args.first[:ftp_adapter]}")
+        def on_step(event)
+          @spinner = build_spinner("Uploading #{event[:args].first[:dump]} to #{event[:args].first[:gateway]}")
         end
 
         def on_step_succeeded(*)

data/lib/pg_export/lib/pg_export/listeners/interactive_listener.rb

@@ -8,8 +8,8 @@ require 'tty-spinner'
 class PgExport
   module Listeners
     class InteractiveListener
-      def on_step_failed(step_name:, args:, value:)
-        @spinner.error([error, self.class.red(value[:message])].join("\n"))
+      def on_step_failed(event)
+        @spinner.error([error, self.class.red(event[:value][:message])].join("\n"))
       end
 
       class << self

data/lib/pg_export/lib/pg_export/listeners/plain/build_dump.rb

@@ -6,8 +6,8 @@ class PgExport
   module Listeners
     class Plain
       class BuildDump < PlainListener
-        def on_step_succeeded(step_name:, args:, value:)
-          logger.info("Dump database #{value[:dump].database} to #{value[:dump]}")
+        def on_step_succeeded(event)
+          logger.info("Dump database #{event[:value][:dump].database} to #{event[:value][:dump]}")
         end
       end
     end

data/lib/pg_export/lib/pg_export/listeners/plain/{close_ftp_connection.rb → close_connection.rb}

@@ -5,9 +5,9 @@ require_relative '../plain_listener'
 class PgExport
   module Listeners
     class Plain
-      class CloseFtpConnection < PlainListener
+      class CloseConnection < PlainListener
         def on_step_succeeded(*)
-          logger.info('Close FTP')
+          logger.info('Close connection')
         end
       end
     end

data/lib/pg_export/lib/pg_export/listeners/plain/decrypt_dump.rb

@@ -6,8 +6,8 @@ class PgExport
   module Listeners
     class Plain
       class DecryptDump < PlainListener
-        def on_step_succeeded(step_name:, args:, value:)
-          logger.info("Decrypt #{value[:dump]}")
+        def on_step_succeeded(event)
+          logger.info("Decrypt #{event[:value][:dump]}")
         end
       end
     end

data/lib/pg_export/lib/pg_export/listeners/plain/download_dump_from_ftp.rb

@@ -6,8 +6,8 @@ class PgExport
   module Listeners
     class Plain
       class DownloadDumpFromFtp < PlainListener
-        def on_step_succeeded(step_name:, args:, value:)
-          logger.info("Download #{value[:dump]}")
+        def on_step_succeeded(event)
+          logger.info("Download #{event[:value][:dump]}")
         end
       end
     end

data/lib/pg_export/lib/pg_export/listeners/plain/encrypt_dump.rb

@@ -6,8 +6,8 @@ class PgExport
   module Listeners
     class Plain
       class EncryptDump < PlainListener
-        def on_step_succeeded(step_name:, args:, value:)
-          logger.info("Encrypt #{value[:dump]}")
+        def on_step_succeeded(event)
+          logger.info("Encrypt #{event[:value][:dump]}")
         end
       end
     end

data/lib/pg_export/lib/pg_export/listeners/plain/fetch_dumps_from_ftp.rb

@@ -6,8 +6,8 @@ class PgExport
   module Listeners
     class Plain
       class FetchDumpsFromFtp < PlainListener
-        def on_step_succeeded(step_name:, args:, value:)
-          logger.info("Fetch dumps (#{value[:dumps].count} items)")
+        def on_step_succeeded(event)
+          logger.info("Fetch dumps (#{event[:value][:dumps].count} items)")
         end
       end
     end

data/lib/pg_export/lib/pg_export/listeners/plain/open_connection.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../plain_listener'
+
+class PgExport
+  module Listeners
+    class Plain
+      class OpenConnection < PlainListener
+        def on_step_succeeded(event)
+          logger.info("Connect to #{event[:value][:gateway]}")
+        end
+      end
+    end
+  end
+end

data/lib/pg_export/lib/pg_export/listeners/plain/remove_old_dumps_from_ftp.rb

@@ -6,9 +6,9 @@ class PgExport
   module Listeners
     class Plain
       class RemoveOldDumpsFromFtp < PlainListener
-        def on_step_succeeded(step_name:, args:, value:)
-          value[:removed_dumps].each do |filename|
-            logger.info("Remove #{filename} from #{value[:ftp_adapter]}")
+        def on_step_succeeded(event)
+          event[:value][:removed_dumps].each do |filename|
+            logger.info("Remove #{filename} from #{event[:value][:gateway]}")
           end
         end
       end

data/lib/pg_export/lib/pg_export/listeners/plain/restore.rb

@@ -6,7 +6,7 @@ class PgExport
   module Listeners
     class Plain
       class Restore < PlainListener
-        def on_step_succeeded(step_name:, args:, value:)
+        def on_step_succeeded(event)
           logger.info("Restore dump to database #{args.first[:database]}")
         end
       end

data/lib/pg_export/lib/pg_export/listeners/plain/upload_dump_to_ftp.rb

@@ -6,8 +6,8 @@ class PgExport
   module Listeners
     class Plain
       class UploadDumpToFtp < PlainListener
-        def on_step_succeeded(step_name:, args:, value:)
-          logger.info("Upload #{value[:dump]} to #{value[:ftp_adapter]}")
+        def on_step_succeeded(event)
+          logger.info("Upload #{event[:value][:dump]} to #{event[:value][:gateway]}")
         end
       end
     end

data/lib/pg_export/lib/pg_export/listeners/plain_listener.rb

@@ -9,8 +9,8 @@ class PgExport
     class PlainListener
       include Import['logger']
 
-      def on_step_failed(step_name:, args:, value:)
-        logger.info("Error: #{value[:message]}")
+      def on_step_failed(event)
+        logger.info("Error: #{event[:value][:message]}")
       end
     end
   end

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

@@ -5,14 +5,14 @@ require 'pg_export/import'
 
 class PgExport
   module Operations
-    class OpenFtpConnection
+    class OpenConnection
       include Dry::Transaction::Operation
-      include Import['factories.ftp_adapter_factory']
+      include Import['factories.gateway_factory']
 
       def call(inputs)
-        ftp_adapter = ftp_adapter_factory.ftp_adapter
-        ftp_adapter.open_ftp
-        Success(inputs.merge(ftp_adapter: ftp_adapter))
+        gateway = gateway_factory.gateway
+        gateway.open
+        Success(inputs.merge(gateway: gateway))
       end
     end
   end

data/lib/pg_export/lib/pg_export/operations/remove_old_dumps_from_ftp.rb

@@ -7,19 +7,19 @@ class PgExport
   module Operations
     class RemoveOldDumpsFromFtp
       include Dry::Transaction::Operation
-      include Import['repositories.ftp_dump_repository', 'config']
+      include Import['repositories.gateway_dump_repository', 'config']
 
-      def call(dump:, ftp_adapter:)
-        dumps = ftp_dump_repository.by_database_name(
+      def call(dump:, gateway:)
+        dumps = gateway_dump_repository.by_database_name(
           database_name: dump.database,
-          ftp_adapter: ftp_adapter,
+          gateway: gateway,
           offset: config.keep_dumps
         )
         dumps.each do |d|
-          ftp_adapter.delete(d.name)
+          gateway.delete(d.name)
         end
 
-        Success(removed_dumps: dumps, ftp_adapter: ftp_adapter)
+        Success(removed_dumps: dumps, gateway: gateway)
       end
     end
   end

data/lib/pg_export/lib/pg_export/repositories/{ftp_dump_file_repository.rb → gateway_dump_file_repository.rb}

@@ -7,10 +7,10 @@ require 'pg_export/lib/pg_export/value_objects/dump_file'
 
 class PgExport
   module Repositories
-    class FtpDumpFileRepository
-      def by_name(name:, ftp_adapter:)
+    class GatewayDumpFileRepository
+      def by_name(name:, gateway:)
         file = ValueObjects::DumpFile.new
-        ftp_adapter.get(file, name)
+        gateway.get(file, name)
 
         file
       end

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

@@ -7,21 +7,21 @@ require 'pg_export/lib/pg_export/value_objects/dump_file'
 
 class PgExport
   module Repositories
-    class FtpDumpRepository
-      def all(database_name:, ftp_adapter:)
-        ftp_adapter.list([database_name, '*'].compact.join('_')).map do |name:, size:|
+    class GatewayDumpRepository
+      def all(database_name:, gateway:)
+        gateway.list([database_name, '*'].compact.join('_')).map do |item|
           begin
-            dump(name, database_name, size)
+            dump(item[:name], database_name, item[:size])
           rescue Dry::Types::ConstraintError
             nil
           end
         end.compact
       end
 
-      def by_database_name(database_name:, ftp_adapter:, offset:)
-        ftp_adapter.list(database_name + '_*').drop(offset).map do |name:, size:|
+      def by_database_name(database_name:, gateway:, offset:)
+        gateway.list(database_name + '_*').drop(offset).map do |item|
           begin
-            dump(name, database_name, size)
+            dump(item[:name], database_name, item[:size])
           rescue Dry::Types::ConstraintError
             nil
           end

data/lib/pg_export/lib/pg_export/transactions/export_dump.rb

@@ -17,10 +17,10 @@ class PgExport
       step :prepare_params
       step :build_dump
       step :encrypt_dump, with: 'operations.encrypt_dump'
-      step :open_ftp_connection, with: 'operations.open_ftp_connection'
+      step :open_connection, with: 'operations.open_connection'
       step :upload_dump_to_ftp
       step :remove_old_dumps_from_ftp, with: 'operations.remove_old_dumps_from_ftp'
-      step :close_ftp_connection
+      step :close_connection
 
       private
 
@@ -42,14 +42,14 @@ class PgExport
         Failure(message: 'Unable to dump database: ' + e.to_s)
       end
 
-      def upload_dump_to_ftp(dump:, ftp_adapter:)
-        ftp_adapter.persist(dump.file, dump.name)
-        Success(dump: dump, ftp_adapter: ftp_adapter)
+      def upload_dump_to_ftp(dump:, gateway:)
+        gateway.persist(dump.file, dump.name)
+        Success(dump: dump, gateway: gateway)
       end
 
-      def close_ftp_connection(removed_dumps:, ftp_adapter:)
-        ftp_adapter.close_ftp
-        Success(ftp_adapter: ftp_adapter)
+      def close_connection(removed_dumps:, gateway:)
+        gateway.close
+        Success(gateway: gateway)
       end
     end
   end

data/lib/pg_export/lib/pg_export/transactions/import_dump_interactively.rb

@@ -13,41 +13,41 @@ class PgExport
       include Dry::Transaction(container: PgExport::Container)
       include Import[
         'adapters.bash_adapter',
-        'repositories.ftp_dump_repository',
-        'repositories.ftp_dump_file_repository',
+        'repositories.gateway_dump_repository',
+        'repositories.gateway_dump_file_repository',
         'ui_input'
       ]
 
-      step :open_ftp_connection, with: 'operations.open_ftp_connection'
+      step :open_connection, with: 'operations.open_connection'
       step :fetch_dumps_from_ftp
       step :select_dump
       step :download_dump_from_ftp
-      step :close_ftp_connection
+      step :close_connection
       step :decrypt_dump, with: 'operations.decrypt_dump'
       step :select_database
       step :restore
 
       private
 
-      def fetch_dumps_from_ftp(database_name:, ftp_adapter:)
-        dumps = ftp_dump_repository.all(database_name: database_name, ftp_adapter: ftp_adapter)
+      def fetch_dumps_from_ftp(database_name:, gateway:)
+        dumps = gateway_dump_repository.all(database_name: database_name, gateway: gateway)
         return Failure(message: 'No dumps') if dumps.none?
 
-        Success(ftp_adapter: ftp_adapter, dumps: dumps)
+        Success(gateway: gateway, dumps: dumps)
       end
 
-      def select_dump(dumps:, ftp_adapter:)
+      def select_dump(dumps:, gateway:)
         dump = ui_input.select_dump(dumps)
-        Success(dump: dump, ftp_adapter: ftp_adapter)
+        Success(dump: dump, gateway: gateway)
       end
 
-      def download_dump_from_ftp(dump:, ftp_adapter:)
-        dump.file = ftp_dump_file_repository.by_name(name: dump.name, ftp_adapter: ftp_adapter)
-        Success(dump: dump, ftp_adapter: ftp_adapter)
+      def download_dump_from_ftp(dump:, gateway:)
+        dump.file = gateway_dump_file_repository.by_name(name: dump.name, gateway: gateway)
+        Success(dump: dump, gateway: gateway)
       end
 
-      def close_ftp_connection(dump:, ftp_adapter:)
-        Thread.new { ftp_adapter.close_ftp }
+      def close_connection(dump:, gateway:)
+        Thread.new { gateway.close }
         Success(dump: dump)
       end
 

data/lib/pg_export/system/boot/interactive.rb

@@ -17,7 +17,7 @@ PgExport::Container.boot(:interactive) do
       use :logger
 
       %i[
-        open_ftp_connection
+        open_connection
         fetch_dumps_from_ftp
         download_dump_from_ftp
         decrypt_dump

data/lib/pg_export/system/boot/plain.rb

@@ -19,10 +19,10 @@ PgExport::Container.boot(:plain) do
       %i[
         build_dump
         encrypt_dump
-        open_ftp_connection
+        open_connection
         upload_dump_to_ftp
         remove_old_dumps_from_ftp
-        close_ftp_connection
+        close_connection
       ].each do |step|
         transaction.subscribe(step => target["listeners.#{type}.#{step}"])
       end

data/lib/pg_export/version.rb

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

data/pg_export.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/maicher/pg_export'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
   spec.executables   = ['pg_export']
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.3.0'
@@ -26,13 +26,15 @@ 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 'net-ssh'
+  spec.add_dependency 'net-scp'
   spec.add_dependency 'tty-prompt'
   spec.add_dependency 'tty-spinner'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'pg', '~> 0.21'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.4'
   spec.add_development_dependency 'rubocop', '~> 0.59.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_export
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Krzysztof Maicher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-07 00:00:00.000000000 Z
+date: 2021-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  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-scp
+  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: tty-prompt
   requirement: !ruby/object:Gem::Requirement
@@ -154,16 +182,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -222,39 +250,41 @@ files:
 - lib/pg_export/container.rb
 - lib/pg_export/import.rb
 - lib/pg_export/lib/pg_export/adapters/bash_adapter.rb
-- lib/pg_export/lib/pg_export/adapters/ftp_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_adapter_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_ftp_connection.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_from_ftp.rb
 - lib/pg_export/lib/pg_export/listeners/interactive/encrypt_dump.rb
 - lib/pg_export/lib/pg_export/listeners/interactive/fetch_dumps_from_ftp.rb
-- lib/pg_export/lib/pg_export/listeners/interactive/open_ftp_connection.rb
+- lib/pg_export/lib/pg_export/listeners/interactive/open_connection.rb
 - lib/pg_export/lib/pg_export/listeners/interactive/remove_old_dumps_from_ftp.rb
 - lib/pg_export/lib/pg_export/listeners/interactive/restore.rb
 - lib/pg_export/lib/pg_export/listeners/interactive/upload_dump_to_ftp.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_ftp_connection.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_from_ftp.rb
 - lib/pg_export/lib/pg_export/listeners/plain/encrypt_dump.rb
 - lib/pg_export/lib/pg_export/listeners/plain/fetch_dumps_from_ftp.rb
-- lib/pg_export/lib/pg_export/listeners/plain/open_ftp_connection.rb
+- lib/pg_export/lib/pg_export/listeners/plain/open_connection.rb
 - lib/pg_export/lib/pg_export/listeners/plain/remove_old_dumps_from_ftp.rb
 - lib/pg_export/lib/pg_export/listeners/plain/restore.rb
 - lib/pg_export/lib/pg_export/listeners/plain/upload_dump_to_ftp.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_ftp_connection.rb
+- lib/pg_export/lib/pg_export/operations/open_connection.rb
 - lib/pg_export/lib/pg_export/operations/remove_old_dumps_from_ftp.rb
-- lib/pg_export/lib/pg_export/repositories/ftp_dump_file_repository.rb
-- lib/pg_export/lib/pg_export/repositories/ftp_dump_repository.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/export_dump.rb
 - lib/pg_export/lib/pg_export/transactions/import_dump_interactively.rb
 - lib/pg_export/lib/pg_export/types.rb
@@ -282,11 +312,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: CLI for creating and exporting PostgreSQL dumps to FTP.

data/lib/pg_export/lib/pg_export/factories/ftp_adapter_factory.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-# auto_register: false
-
-require 'pg_export/lib/pg_export/adapters/ftp_adapter'
-require 'pg_export/import'
-
-class PgExport
-  module Factories
-    class FtpAdapterFactory
-      include Import['config']
-
-      def ftp_adapter
-        ::PgExport::Adapters::FtpAdapter.new(
-          host: config.ftp_host,
-          user: config.ftp_user,
-          password: config.ftp_password
-        )
-      end
-    end
-  end
-end

data/lib/pg_export/lib/pg_export/listeners/plain/open_ftp_connection.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../plain_listener'
-
-class PgExport
-  module Listeners
-    class Plain
-      class OpenFtpConnection < PlainListener
-        def on_step_succeeded(step_name:, args:, value:)
-          logger.info("Connect to #{value[:ftp_adapter]}")
-        end
-      end
-    end
-  end
-end