pg_export 0.6.1 → 0.7.0

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

@@ -0,0 +1,22 @@
+# 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/interactive/build_dump.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../interactive_listener'
+
+class PgExport
+  module Listeners
+    class Interactive
+      class BuildDump < InteractiveListener
+        def on_step(step_name:, args:)
+          @spinner = build_spinner("Dumping database #{args.first[:database_name]}")
+        end
+
+        def on_step_succeeded(step_name:, args:, value:)
+          @spinner.success([success, value[:dump]].join(' '))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../interactive_listener'
+
+class PgExport
+  module Listeners
+    class Interactive
+      class CloseFtpConnection < InteractiveListener
+        def on_step(*)
+          @spinner = build_spinner('Closing FTP')
+        end
+
+        def on_step_succeeded(*)
+          @spinner.success(success)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../interactive_listener'
+
+class PgExport
+  module Listeners
+    class Interactive
+      class DecryptDump < InteractiveListener
+        def on_step(*)
+          @spinner = build_spinner('Decrypting')
+        end
+
+        def on_step_succeeded(step_name:, args:, value:)
+          @spinner.success([success, value[:dump]].join(' '))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../interactive_listener'
+
+class PgExport
+  module Listeners
+    class Interactive
+      class DownloadDumpFromFtp < InteractiveListener
+        def on_step(*)
+          @spinner = build_spinner('Downloading')
+        end
+
+        def on_step_succeeded(step_name:, args:, value:)
+          @spinner.success([success, value[:dump]].join(' '))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../interactive_listener'
+
+class PgExport
+  module Listeners
+    class Interactive
+      class EncryptDump < InteractiveListener
+        def on_step(*)
+          @spinner = build_spinner('Encrypting')
+        end
+
+        def on_step_succeeded(step_name:, args:, value:)
+          @spinner.success([success, value[:dump]].join(' '))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../interactive_listener'
+
+class PgExport
+  module Listeners
+    class Interactive
+      class FetchDumpsFromFtp < InteractiveListener
+        def on_step(*)
+          @spinner = build_spinner('Fetching dumps')
+        end
+
+        def on_step_succeeded(*)
+          @spinner.success(success)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../interactive_listener'
+
+class PgExport
+  module Listeners
+    class Interactive
+      class OpenFtpConnection < InteractiveListener
+        def on_step(*)
+          @spinner = build_spinner('Opening ftp connection')
+        end
+
+        def on_step_succeeded(*)
+          @spinner.success(success)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../interactive_listener'
+
+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]}")
+        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"))
+          else
+            @spinner.success([success, 'nothing to remove'].join(' '))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../interactive_listener'
+
+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]}")
+        end
+
+        def on_step_succeeded(*)
+          @spinner.success(success)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../interactive_listener'
+
+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]}")
+        end
+
+        def on_step_succeeded(*)
+          @spinner.success(success)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# auto_register: false
+
+require 'pg_export/import'
+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"))
+      end
+
+      class << self
+        def green(s)
+          "\e[0;32;49m#{s}\e[0m"
+        end
+
+        def red(s)
+          "\e[31m#{s}\e[0m"
+        end
+      end
+
+      private
+
+      SUCCESS_MARK = green("\u2713").freeze
+      ERROR_MARK = red("\u00d7").freeze
+      private_constant :SUCCESS_MARK, :ERROR_MARK
+
+      def build_spinner(message)
+        TTY::Spinner.new(
+          "[:spinner] #{message}...",
+          format: :dots,
+          success_mark: SUCCESS_MARK,
+          error_mark: ERROR_MARK
+        ).tap(&:auto_spin)
+      end
+
+      def success
+        self.class.green('(success)')
+      end
+
+      def error
+        self.class.red('(error)')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../plain_listener'
+
+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]}")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../plain_listener'
+
+class PgExport
+  module Listeners
+    class Plain
+      class CloseFtpConnection < PlainListener
+        def on_step_succeeded(*)
+          logger.info('Close FTP')
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

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

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../plain_listener'
+
+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)")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# 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

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../plain_listener'
+
+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]}")
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../plain_listener'
+
+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]}")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# auto_register: false
+
+require 'pg_export/import'
+
+class PgExport
+  module Listeners
+    class PlainListener
+      include Import['logger']
+
+      def on_step_failed(step_name:, args:, value:)
+        logger.info("Error: #{value[:message]}")
+      end
+    end
+  end
+end

data/lib/pg_export/lib/pg_export/operations/decrypt_dump.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'dry/transaction/operation'
+require 'pg_export/import'
+
+class PgExport
+  module Operations
+    class DecryptDump
+      include Dry::Transaction::Operation
+      include Import['factories.cipher_factory']
+
+      def call(dump:)
+        dump.decrypt(cipher_factory: cipher_factory)
+        Success(dump: dump)
+      rescue OpenSSL::Cipher::CipherError => e
+        Failure(message: "Problem decrypting dump file: #{e}. Try again.")
+      end
+    end
+  end
+end

data/lib/pg_export/lib/pg_export/operations/encrypt_dump.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'dry/transaction/operation'
+require 'pg_export/import'
+
+class PgExport
+  module Operations
+    class EncryptDump
+      include Dry::Transaction::Operation
+      include Import['factories.cipher_factory']
+
+      def call(dump:)
+        dump.encrypt(cipher_factory: cipher_factory)
+        Success(dump: dump)
+      end
+    end
+  end
+end

data/lib/pg_export/lib/pg_export/operations/open_ftp_connection.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'dry/transaction/operation'
+require 'pg_export/import'
+
+class PgExport
+  module Operations
+    class OpenFtpConnection
+      include Dry::Transaction::Operation
+      include Import['factories.ftp_adapter_factory']
+
+      def call(inputs)
+        ftp_adapter = ftp_adapter_factory.ftp_adapter
+        ftp_adapter.open_ftp
+        Success(inputs.merge(ftp_adapter: ftp_adapter))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'dry/transaction/operation'
+require 'pg_export/import'
+
+class PgExport
+  module Operations
+    class RemoveOldDumpsFromFtp
+      include Dry::Transaction::Operation
+      include Import['repositories.ftp_dump_repository', 'config']
+
+      def call(dump:, ftp_adapter:)
+        dumps = ftp_adapter.list(dump.database + '_*').drop(config.keep_dumps)
+        dumps.each do |filename|
+          ftp_adapter.delete(filename)
+        end
+
+        Success(removed_dumps: dumps, ftp_adapter: ftp_adapter)
+      end
+    end
+  end
+end

data/lib/pg_export/lib/pg_export/repositories/ftp_dump_file_repository.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'pg_export/import'
+require 'pg_export/lib/pg_export/entities/dump'
+require 'pg_export/lib/pg_export/value_objects/dump_file'
+
+class PgExport
+  module Repositories
+    class FtpDumpFileRepository
+      def by_name(name:, ftp_adapter:)
+        file = ValueObjects::DumpFile.new
+        ftp_adapter.get(file, name)
+
+        file
+      end
+    end
+  end
+end

data/lib/pg_export/lib/pg_export/repositories/ftp_dump_repository.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'pg_export/import'
+require 'pg_export/lib/pg_export/entities/dump'
+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:|
+          begin
+            dump(name, database_name, size)
+          rescue Dry::Types::ConstraintError
+            nil
+          end
+        end.compact
+      end
+
+      private
+
+      FilePlaceholder = Struct.new(:size)
+      private_constant :FilePlaceholder
+
+      def dump(name, database_name, size)
+        Entities::Dump.new(
+          name: name,
+          database: database_name,
+          file: ValueObjects::DumpFile.new(FilePlaceholder.new(size.to_i)),
+          type: :encrypted
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# auto_register: false
+
+require 'dry/transaction'
+
+require 'pg_export/import'
+require 'pg_export/container'
+require 'pg_export/lib/pg_export/value_objects/dump_file'
+
+class PgExport
+  module Transactions
+    class ExportDump
+      include Dry::Transaction(container: PgExport::Container)
+      include Import['factories.dump_factory', 'adapters.bash_adapter']
+
+      step :prepare_params
+      step :build_dump
+      step :encrypt_dump, with: 'operations.encrypt_dump'
+      step :open_ftp_connection, with: 'operations.open_ftp_connection'
+      step :upload_dump_to_ftp
+      step :remove_old_dumps_from_ftp, with: 'operations.remove_old_dumps_from_ftp'
+      step :close_ftp_connection
+
+      private
+
+      def prepare_params(database_name:)
+        database_name = database_name.to_s
+
+        return Failure(message: 'Invalid database name') if database_name.empty?
+
+        Success(database_name: database_name)
+      end
+
+      def build_dump(database_name:)
+        dump = dump_factory.plain(
+          database: database_name,
+          file: bash_adapter.pg_dump(ValueObjects::DumpFile.new, database_name)
+        )
+        Success(dump: dump)
+      rescue bash_adapter.class::PgDumpError => e
+        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)
+      end
+
+      def close_ftp_connection(removed_dumps:, ftp_adapter:)
+        ftp_adapter.close_ftp
+        Success(ftp_adapter: ftp_adapter)
+      end
+    end
+  end
+end