pg_export 0.5.1 → 0.6.0

data/lib/pg_export/roles/interactive.rb

@@ -0,0 +1,98 @@
+require 'cli_spinnable'
+require_relative 'colourable_string'
+
+class PgExport
+  module Roles
+    module Interactive
+      include CliSpinnable
+      using ColourableString
+
+      def self.extended(_)
+        puts 'Interactive mode, for restoring dump into database.'.green
+      end
+
+      def call(database, _keep_dumps = nil)
+        initialize_connection
+        dumps = print_all_dumps
+        dump = download_dump(select_dump(dumps))
+        t = Thread.new { container[:ftp_connection].close }
+        restore_downloaded_dump(dump, database)
+        t.join
+        puts 'Success'.green
+        self
+      end
+
+      private
+
+      def initialize_connection
+        with_spinner do |cli|
+          cli.print 'Connecting to FTP'
+          container[:ftp_connection].ftp
+          cli.tick
+        end
+      end
+
+      def print_all_dumps
+        dumps = container[:ftp_repository].all
+        dumps.each.with_index(1) do |name, i|
+          print "(#{i}) "
+          puts name.to_s.gray
+        end
+
+        dumps
+      end
+
+      def select_dump(dumps)
+        puts 'Which dump would you like to import?'
+        number = loop do
+          print "Type from 1 to #{dumps.count} (1): "
+          number = gets.chomp.to_i
+          break number if (1..dumps.count).cover?(number)
+          puts 'Invalid number. Please try again.'.red
+        end
+
+        dumps.fetch(number - 1)
+      end
+
+      def download_dump(name)
+        dump = nil
+
+        with_spinner do |cli|
+          cli.print "Downloading dump #{name}"
+          encrypted_dump = container[:ftp_repository].get(name)
+          cli.print " (#{encrypted_dump.size_human})"
+          cli.tick
+          cli.print "Decrypting dump #{name}"
+          dump = container[:decryptor].call(encrypted_dump)
+          cli.print " (#{dump.size_human})"
+          cli.tick
+        end
+
+        dump
+      rescue OpenSSL::Cipher::CipherError => e
+        puts "Problem decrypting dump file: #{e}. Try again.".red
+        retry
+      end
+
+      def restore_downloaded_dump(dump, database)
+        puts 'To which database you would like to restore the downloaded dump?'
+        if database == 'undefined'
+          print 'Enter a local database name: '
+        else
+          print "Enter a local database name (#{database}): "
+        end
+        db_name = gets.chomp
+        db_name = db_name.empty? ? database : db_name
+        with_spinner do |cli|
+          cli.print "Restoring dump to #{db_name} database"
+          container[:bash_repository].persist(dump, db_name)
+          cli.tick
+        end
+        self
+      rescue PgRestoreError => e
+        puts e.to_s.red
+        retry
+      end
+    end
+  end
+end

data/lib/pg_export/roles/validatable.rb

@@ -0,0 +1,24 @@
+require 'dry-types'
+
+class PgExport
+  module Roles
+    module Validatable
+      include Dry::Types.module
+
+      VALID_NON_EMPTY_STRING = Strict::String.constrained(min_size: 1)
+      VALID_POSITIVE_INTEGER = Strict::Int.constrained(gteq: 0)
+
+      def validate_database_name(database)
+        VALID_NON_EMPTY_STRING[database]
+      rescue Dry::Types::ConstraintError
+        raise ArgumentError, 'The "database" parameter has to be a valid, non-empty string'
+      end
+
+      def validate_keep_dumps(keep_dumps)
+        VALID_POSITIVE_INTEGER[keep_dumps]
+      rescue Dry::Types::ConstraintError
+        raise ArgumentError, 'The "keep_dumps" parameter has to be a valid, non-negative integer'
+      end
+    end
+  end
+end

data/lib/pg_export/services/create_and_export_dump.rb

@@ -0,0 +1,20 @@
+class PgExport
+  module Services
+    class CreateAndExportDump
+      def initialize(bash_factory:, encryptor:, ftp_repository:)
+        @bash_factory, @encryptor, @ftp_repository = bash_factory, encryptor, ftp_repository
+      end
+
+      def call(database_name, keep_dumps)
+        dump = bash_factory.build_dump(database_name)
+        encrypted_dump = encryptor.call(dump)
+        ftp_repository.persist(encrypted_dump)
+        ftp_repository.remove_old(database_name, keep_dumps)
+      end
+
+      private
+
+      attr_reader :bash_factory, :encryptor, :ftp_repository
+    end
+  end
+end

data/lib/pg_export/version.rb

@@ -1,3 +1,3 @@
 class PgExport
-  VERSION = '0.5.1'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/lib/pg_export.rb

@@ -1,67 +1,29 @@
-require 'logger'
-require 'tempfile'
-require 'zlib'
-require 'net/ftp'
-require 'openssl'
-require 'forwardable'
-require 'open3'
-
 require 'pg_export/version'
-require 'pg_export/includable_modules/logging'
-require 'pg_export/includable_modules/dump/size_human'
-require 'pg_export/includable_modules/services_container'
-require 'pg_export/errors'
 require 'pg_export/configuration'
-require 'pg_export/entities/dump'
-require 'pg_export/services/ftp_adapter'
-require 'pg_export/services/ftp_connection'
-require 'pg_export/services/bash_utils'
-require 'pg_export/services/dump_storage'
-require 'pg_export/services/aes'
-require 'pg_export/services/aes/base'
-require 'pg_export/services/aes/encryptor'
-require 'pg_export/services/aes/decryptor'
+require 'pg_export/boot_container'
+require 'pg_export/roles/interactive'
+require 'pg_export/errors'
+require 'pg_export/roles/validatable'
 
 class PgExport
-  extend Forwardable
-  include ServicesContainer
-
-  def_delegators :services_container, :config, :bash_utils, :dump_storage, :ftp_connection, :encryptor, :decryptor
-
-  def initialize
-    yield config if block_given?
+  include Roles::Validatable
+
+  def initialize(**args)
+    config = Configuration.new(**args)
+    extend Roles::Interactive if config.interactive
+    @container = BootContainer.call(config.to_h)
+  rescue Dry::Struct::Error => e
+    raise ArgumentError, e
   end
 
-  def call
-    config.validate
-    concurrently do |threads|
-      threads << create_dump
-      threads << open_ftp_connection
-    end
-    dump_storage.upload(dump)
-    dump_storage.remove_old
-    self
+  def call(database_name, keep_dumps)
+    container[:create_and_export_dump].call(
+      validate_database_name(database_name),
+      validate_keep_dumps(keep_dumps)
+    )
   end
 
   private
 
-  def concurrently
-    [].tap do |threads|
-      yield threads
-    end.each(&:join)
-  end
-
-  def dump
-    create_dump[:dump]
-  end
-
-  def create_dump
-    @create_dump ||= Thread.new do
-      Thread.current[:dump] = encryptor.call(bash_utils.create_dump)
-    end
-  end
-
-  def open_ftp_connection
-    Thread.new { ftp_connection.open }
-  end
+  attr_reader :container
 end

data/pg_export.gemspec

@@ -21,12 +21,13 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.1.0'
 
   spec.add_dependency 'cli_spinnable', '~> 0.2'
+  spec.add_dependency 'dry-types', '~> 0.11.1'
+  spec.add_dependency 'dry-struct', '~> 0.3.1'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rubocop', '~> 0.44'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.4'
   spec.add_development_dependency 'pg', '~> 0.19'
-  spec.add_development_dependency 'simplecov', '~> 0.12'
   spec.add_development_dependency 'pry'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_export
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Krzysztof Maicher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-31 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli_spinnable
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -147,22 +161,26 @@ files:
 - bin/pg_export
 - bin/setup
 - lib/pg_export.rb
+- lib/pg_export/aes.rb
+- lib/pg_export/aes/base.rb
+- lib/pg_export/aes/decryptor.rb
+- lib/pg_export/aes/encryptor.rb
+- lib/pg_export/bash/adapter.rb
+- lib/pg_export/bash/factory.rb
+- lib/pg_export/bash/repository.rb
+- lib/pg_export/boot_container.rb
+- lib/pg_export/build_logger.rb
 - lib/pg_export/configuration.rb
-- lib/pg_export/entities/dump.rb
+- lib/pg_export/dump.rb
 - lib/pg_export/errors.rb
-- lib/pg_export/includable_modules/colourable_string.rb
-- lib/pg_export/includable_modules/dump/size_human.rb
-- lib/pg_export/includable_modules/interactive.rb
-- lib/pg_export/includable_modules/logging.rb
-- lib/pg_export/includable_modules/services_container.rb
-- lib/pg_export/services/aes.rb
-- lib/pg_export/services/aes/base.rb
-- lib/pg_export/services/aes/decryptor.rb
-- lib/pg_export/services/aes/encryptor.rb
-- lib/pg_export/services/bash_utils.rb
-- lib/pg_export/services/dump_storage.rb
-- lib/pg_export/services/ftp_adapter.rb
-- lib/pg_export/services/ftp_connection.rb
+- lib/pg_export/ftp/adapter.rb
+- lib/pg_export/ftp/connection.rb
+- lib/pg_export/ftp/repository.rb
+- lib/pg_export/roles/colourable_string.rb
+- lib/pg_export/roles/human_readable.rb
+- lib/pg_export/roles/interactive.rb
+- lib/pg_export/roles/validatable.rb
+- lib/pg_export/services/create_and_export_dump.rb
 - lib/pg_export/version.rb
 - pg_export.gemspec
 homepage: https://github.com/maicher/pg_export
@@ -185,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: CLI for creating and exporting PostgreSQL dumps to FTP.

data/lib/pg_export/includable_modules/colourable_string.rb

@@ -1,17 +0,0 @@
-class PgExport
-  module ColourableString
-    refine String do
-      def red
-        "\e[31m#{self}\e[0m"
-      end
-
-      def green
-        "\e[0;32;49m#{self}\e[0m"
-      end
-
-      def gray
-        "\e[37m#{self}\e[0m"
-      end
-    end
-  end
-end

data/lib/pg_export/includable_modules/dump/size_human.rb

@@ -1,15 +0,0 @@
-class PgExport
-  class Dump
-    module SizeHuman
-      def size_human
-        {
-          'B'  => 1024,
-          'kB' => 1024 * 1024,
-          'MB' => 1024 * 1024 * 1024,
-          'GB' => 1024 * 1024 * 1024 * 1024,
-          'TB' => 1024 * 1024 * 1024 * 1024 * 1024
-        }.each_pair { |e, s| return "#{(size.to_f / (s / 1024)).round(2)}#{e}" if size < s }
-      end
-    end
-  end
-end

data/lib/pg_export/includable_modules/interactive.rb

@@ -1,97 +0,0 @@
-class PgExport
-  module Interactive
-    include CliSpinnable
-    using ColourableString
-
-    def self.extended(_)
-      puts 'Interactive mode, for restoring dump into database.'.green
-    end
-
-    def call
-      initialize_connection
-      print_all_dumps
-      selected_dump = select_dump
-      dump = download_dump(selected_dump)
-      concurrently do |threads|
-        threads << Thread.new(dump) { restore_downloaded_dump(dump) }
-        threads << Thread.new { ftp_connection.close }
-      end
-      puts 'Success'.green
-      self
-    end
-
-    private
-
-    def initialize_connection
-      with_spinner do |cli|
-        cli.print 'Connecting to FTP'
-        ftp_connection.open
-        cli.tick
-      end
-    end
-
-    def print_all_dumps
-      dumps.each.with_index(1) do |name, i|
-        print "(#{i}) "
-        puts name.to_s.gray
-      end
-      self
-    end
-
-    def select_dump
-      puts 'Which dump would you like to import?'
-      number = loop do
-        print "Type from 1 to #{dumps.count} (1): "
-        number = gets.chomp.to_i
-        break number if (1..dumps.count).cover?(number)
-        puts 'Invalid number. Please try again.'.red
-      end
-
-      dumps.fetch(number - 1)
-    end
-
-    def download_dump(name)
-      dump = nil
-
-      with_spinner do |cli|
-        cli.print "Downloading dump #{name}"
-        encrypted_dump = dump_storage.download(name)
-        cli.print " (#{encrypted_dump.size_human})"
-        cli.tick
-        cli.print "Decrypting dump #{name}"
-        dump = decryptor.call(encrypted_dump)
-        cli.print " (#{dump.size_human})"
-        cli.tick
-      end
-
-      dump
-    rescue OpenSSL::Cipher::CipherError => e
-      puts "Problem decrypting dump file: #{e}. Try again.".red
-      retry
-    end
-
-    def restore_downloaded_dump(dump)
-      puts 'To which database you would like to restore the downloaded dump?'
-      if config.database == 'undefined'
-        print 'Enter a local database name: '
-      else
-        print "Enter a local database name (#{config.database}): "
-      end
-      database = gets.chomp
-      database = database.empty? ? config.database : database
-      with_spinner do |cli|
-        cli.print "Restoring dump to #{database} database"
-        bash_utils.restore_dump(dump, database)
-        cli.tick
-      end
-      self
-    rescue PgRestoreError => e
-      puts e.to_s.red
-      retry
-    end
-
-    def dumps
-      @dumps ||= dump_storage.all
-    end
-  end
-end

data/lib/pg_export/includable_modules/logging.rb

@@ -1,31 +0,0 @@
-class PgExport
-  module Logging
-    FORMAT_PLAIN = ->(_, _, _, message) { "#{message}\n" }
-    FORMAT_TIMESTAMPED = ->(severity, datetime, progname, message) { "#{datetime} #{Process.pid} TID-#{Thread.current.object_id.to_s(36)}#{progname} #{severity}: #{message}\n" }
-    FORMAT_MUTED = ->(_, _, _, _) {}
-
-    class << self
-      def logger
-        @logger ||= Logger.new(STDOUT).tap do |logger|
-          logger.formatter = FORMAT_PLAIN
-        end
-      end
-
-      def format_default
-        logger.formatter = FORMAT_PLAIN
-      end
-
-      def format_timestamped
-        logger.formatter = FORMAT_TIMESTAMPED
-      end
-
-      def mute
-        logger.formatter = FORMAT_MUTED
-      end
-    end
-
-    def logger
-      Logging.logger
-    end
-  end
-end

data/lib/pg_export/includable_modules/services_container.rb

@@ -1,41 +0,0 @@
-class PgExport
-  module ServicesContainer
-    class << self
-      def config
-        @config ||= Configuration.new
-      end
-
-      def aes
-        @aes ||= Aes.new(config.dump_encryption_key)
-      end
-
-      def encryptor
-        @encryptor ||= aes.build_encryptor
-      end
-
-      def decryptor
-        @decryptor ||= aes.build_decryptor
-      end
-
-      def bash_utils
-        @bash_utils ||= BashUtils.new(config.database)
-      end
-
-      def ftp_connection
-        @ftp_connection ||= FtpConnection.new(config.ftp_params)
-      end
-
-      def ftp_adapter
-        @ftp_adapter ||= FtpAdapter.new(ftp_connection)
-      end
-
-      def dump_storage
-        @dump_storage ||= DumpStorage.new(ftp_adapter, config.database, config.keep_dumps)
-      end
-    end
-
-    def services_container
-      @services_container ||= ServicesContainer
-    end
-  end
-end

data/lib/pg_export/services/aes/base.rb

@@ -1,26 +0,0 @@
-class PgExport
-  class Aes
-    class Base
-      include Logging
-
-      def initialize(cipher)
-        @cipher = cipher
-      end
-
-      private
-
-      def copy_using(cipher, from:, to:)
-        cipher.reset
-        to.open(:write) do |f|
-          from.each_chunk do |chunk|
-            f << cipher.update(chunk)
-          end
-          f << cipher.final
-        end
-        self
-      end
-
-      attr_reader :cipher
-    end
-  end
-end

data/lib/pg_export/services/aes/decryptor.rb

@@ -1,12 +0,0 @@
-class PgExport
-  class Aes
-    class Decryptor < Base
-      def call(enc_dump)
-        dump = Dump.new('Dump')
-        copy_using(cipher, from: enc_dump, to: dump)
-        logger.info "Create #{dump}"
-        dump
-      end
-    end
-  end
-end

data/lib/pg_export/services/aes/encryptor.rb

@@ -1,12 +0,0 @@
-class PgExport
-  class Aes
-    class Encryptor < Base
-      def call(dump)
-        enc_dump = Dump.new('Encrypted Dump')
-        copy_using(cipher, from: dump, to: enc_dump)
-        logger.info "Create #{enc_dump}"
-        enc_dump
-      end
-    end
-  end
-end

data/lib/pg_export/services/aes.rb

@@ -1,28 +0,0 @@
-class PgExport
-  class Aes
-    ALGORITHM = 'AES-128-CBC'.freeze
-
-    def initialize(key)
-      @key = key
-    end
-
-    def build_encryptor
-      Aes::Encryptor.new(cipher(:encrypt))
-    end
-
-    def build_decryptor
-      Aes::Decryptor.new(cipher(:decrypt))
-    end
-
-    private
-
-    attr_reader :key
-
-    def cipher(mode)
-      OpenSSL::Cipher.new(ALGORITHM).tap do |cipher|
-        cipher.public_send(mode.to_sym)
-        cipher.key = key
-      end
-    end
-  end
-end