pgchief 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c695989f5431e21f2c33b016b34a7197fb5cca9ea62592391fab10fcdbfe385
-  data.tar.gz: 195ab95c85943e54d41455ae25b1458aa538d6bc4b6319685b609de7549504f9
+  metadata.gz: 142a11a0be4792a8b0c428c25119c964fb899564db0f6ace3464fef0409017c6
+  data.tar.gz: d62cd7fd0b58525300e25065b3fff56b1e9bd157af9058f335c5436c88e0090f
 SHA512:
-  metadata.gz: 352d1edab7569b64483b3abf178297cf2a213ff1c24dfdc40f39ecd8548a06acfffd650ae30a7284fba34368c15e7d58c09e9f3153e9cfc8657613fa01fe4da0
-  data.tar.gz: e6e5f42192398383a2b8bc481c6a2b5f37722eef72111a04e2250a84bd1ac4125a9e783123ea1b3d4d64d2c3721a177482b3c83fd1bc656cc4d9b564ac2af4fc
+  metadata.gz: c02ad41656562151ac067e33a8a61bf8c3c39a915d32b93eda8ed76df0b601bbc4b3bfd8ab5c9979492ae0bb3b543c1e806fbcc9dbfe6b5e9452111662415336
+  data.tar.gz: 9cc987456a024dd1abaa656b2a725152a3e16ec7f345ab8723e3d912bcae6b213b3329e383b73bf23491826f9b8f9769d1e36d67d5688d5ad53f1bc829b5a907

data/.rubocop.yml

@@ -1,34 +1,25 @@
-require:
- - rubocop-performance
- - rubocop-rake
- - rubocop-rspec
+inherit_from: .rubocop_todo.yml
+
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 3.0
   NewCops: enable
 
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
-
-Metrics/BlockLength:
+Style/Documentation:
   Exclude:
-    - 'spec/**/*'
-    - '*.gemspec'
-
-Lint/MixedRegexpCaptureTypes:
-  Enabled: false
+    - 'lib/pgchief.rb'
+    - 'spec/**/*.rb'
 
-RSpec/MultipleExpectations:
-  Max: 5
-
-RSpec/ExampleLength:
-  Max: 20
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/pgchief/config.rb'
 
-Lint/MissingSuper:
-  Enabled: false
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/pgchief/config.rb'
 
-Metrics/ParameterLists:
-  Enabled: false
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/pgchief/config.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,39 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-03-25 01:44:14 UTC using RuboCop version 1.74.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: AllowedParentClasses.
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/pgchief/command/database_privileges_grant.rb'
+    - 'lib/pgchief/command/retrieve_connection_string.rb'
+
+# Offense count: 2
+Lint/MixedRegexpCaptureTypes:
+  Exclude:
+    - 'lib/pgchief/config/s3.rb'
+    - 'lib/pgchief/connection_string.rb'
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 12
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 9
+
+# Offense count: 15
+RSpec/MultipleExpectations:
+  Max: 5
+
+# Offense count: 4
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 6

data/CHANGELOG.md

@@ -13,6 +13,39 @@ and this project will try its best to adhere to [Semantic Versioning](https://se
 
 ### Fixes
 
+## [0.6.0]
+
+### Additions
+
+* Adds `--backup database_name` option to cli to quickly backup a provided database.
+
+### Changes
+
+* Update restore command to only act on objects `--if-exists` (if they exist)
+* Allow for config to be set via ENV variables
+* Don't raise error when a database doesn't exist when a drop is attempted - just notify
+
+### Fixes
+
+* Fix method signature in `Database::Backups` - `remote` should be a kwarg and should
+  pass it along as such.
+* When backing up a database, we add the db name to the end of the pg connection string.
+  In cases where that DATABASE_URL already has the database name tacked on at the end,
+  make sure it's only there once.
+
+## [0.5.4]
+
+### Additions
+
+* Improve CLI usability with `--version` and `--help` flags.
+* Adds `--remote-backup` and `--remote-restore` CLI options.
+* Modifies `DatabaseRestore` and prompt flows to conditionally operate on remote backups.
+* Adds `--restore database_name` option to cli to quickly restore latest backup for a provided database.
+
+### Changes
+
+* Updates the config loader to respect CLI flags and TOML values for remote_backup and remote_restore.
+
 ## [0.5.3]
 
 ### Additions

data/README.md

@@ -24,7 +24,7 @@ below for the feature check-list and current progress.
 ## Usage
 
 ```sh
-# System dependency `libpq-dev` must be installed
+# System dependencies `build-essential` and `libpq-dev` must be installed
 gem install pgchief
 
 # To initialize the config file at `~/.config/pgchief/config.toml`:
@@ -38,9 +38,26 @@ pgchief --init
 # export DATABASE_URL=postgresql://postgres:password@postgres.local:5432
 
 pgchief
+
+# Full usage:
+
+$ pgchief --help
+Options:
+  -b, --backup string   Quickly backup specific database. Pass name of db.
+  -h, --help            Print usage.
+  -i, --init            Initialize the TOML configuration file.
+      --remote-backup   Backup a database to a remote location.
+      --remote-restore  Restore a database from a remote backup.
+  -r, --restore string  Quickly restore specific database. Pass name of db.
+  -v, --version         Show the version.
 ```
 
-## Config
+> [!Note]
+> Prompts accept both `↑` and `↓` arrows, as well as `j` and `k`.
+> Pressing the `esc` key at any point amidst a prompt will exit out of the
+> program.
+
+## Config via File
 
 Format of `~/.config/pgchief/config.toml`
 
@@ -53,14 +70,42 @@ backup_dir = "~/.pgchief/backups"
 
 # ** OPTIONAL **
 
-# Location of encrypted database connection strings
-# credentials_file = "~/.pgchief/credentials"
+# Location of saved database connection strings
+# credentials_file = "~/.config/pgchief/credentials"
+
+# S3 config
+# ---------
+# s3_key = ""
+# s3_secret = ""
+# s3_region = "us-east-1"
+# s3_objects_path = "s3://bucket-name/database-backups/"
+
+# Backup and restore from remote locations?
+# remote_restore = false # default: false
+# remote_backup = false  # default: false
 ```
 
-Note:
+### OR ... Config via Environment Variables
+
+The following environment variables will be picked up in the absence of a config
+file.
+
+```env
+# Required
+DATABASE_URL
+
+# Optional
+AWS_ACCESS_KEY_ID       or   AWS_ACCESS_KEY
+AWS_SECRET_ACCESS_KEY   or   AWS_SECRET_KEY
+AWS_DEFAULT_REGION      or   AWS_REGION
+S3_BACKUPS_PATH
+```
 
-1. Prompts accept both `↑` and `↓` arrows, as well as `j` and `k`.
-2. Pressing the `esc` key at any point amidst a prompt will exit out of the program.
+> [!IMPORTANT]
+> Backup files must be named starting with `[Database Name]-` in order for the
+> file(s) to be found for restoration. Eg: A database named
+> `project_production` that has backups named `project_production-20250325.tar`
+> will be picked up and given the option to restore.
 
 ## Development of the gem
 
@@ -135,7 +180,7 @@ Give "rando-username" access to database(s):
 * [x] Back up database to S3
 * [x] Restore local database
 * [x] Restore remote database @ S3
-* [ ] Quickly back up via command line option
-* [ ] Quickly restore via command line option
+* [x] Quickly back up via command line option
+* [x] Quickly restore via command line option
 * [ ] Task for inclusion in a Rakefile
-* [ ] Support environment variables in config
+* [x] Support environment variables in config

data/Rakefile

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
 # Set up Rubocop tasks
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop) do |t|
   t.options = [
-    "--autocorrect-all",
-    "--cache=true",
-    "--display-cop-names",
-    "--display-time",
-    "--parallel"
+    '--autocorrect-all',
+    '--cache=true',
+    '--display-cop-names',
+    '--display-time',
+    '--parallel'
   ]
 end
 

data/config/pgchief.toml

@@ -9,8 +9,13 @@ backup_dir = "~/.config/pgchief/backups"
 # Location of saved database connection strings
 # credentials_file = "~/.config/pgchief/credentials"
 
-# S3 config - if present, will back up to S3 instead of local filesystem
+# S3 config
+# ---------
 # s3_key = ""
 # s3_secret = ""
 # s3_region = "us-east-1"
 # s3_objects_path = "s3://bucket-name/database-backups/"
+
+# Backup and restore from remote locations?
+# remote_restore = false # default: false
+# remote_backup = false  # default: false

data/exe/pgchief

@@ -5,7 +5,7 @@
 libdir = "#{__dir__}/../lib"
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
-require "pgchief"
+require 'pgchief'
 
 cli = Pgchief::Cli.new
 cli.parse(ARGV)

data/lib/pgchief/cli.rb

@@ -5,18 +5,66 @@ module Pgchief
   class Cli
     include TTY::Option
 
+    banner 'Usage: pgchief [OPTIONS]'
+
     option :init do
-      short "-i"
-      long "--init"
-      desc "Initialize the TOML configuration file"
+      short '-i'
+      long '--init'
+      desc 'Initialize the TOML configuration file.'
+    end
+
+    option :version do
+      short '-v'
+      long '--version'
+      desc 'Show the version.'
+    end
+
+    option :'remote-restore' do
+      long '--remote-restore'
+      desc 'Restore a database from a remote backup.'
+    end
+
+    option :'remote-backup' do
+      long '--remote-backup'
+      desc 'Backup a database to a remote location.'
+    end
+
+    option :restore do
+      short '-r'
+      long '--restore string'
+      arity 1
+      desc 'Quickly restore specific database. Pass name of db.'
+    end
+
+    option :backup do
+      short '-b'
+      long '--backup string'
+      arity 1
+      desc 'Quickly backup specific database. Pass name of db.'
+    end
+
+    flag :help do
+      short '-h'
+      long '--help'
+      desc 'Print usage.'
     end
 
-    def run
-      if params[:init]
+    def run # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      if params[:help]
+        print help
+      elsif params[:init]
         Pgchief::Command::ConfigCreate.call
+      elsif params[:version]
+        puts Pgchief::VERSION
+      elsif params[:restore]
+        puts Pgchief::Command::QuickRestore.call(params, params[:restore])
+      elsif params[:backup]
+        puts Pgchief::Command::QuickBackup.call(params, params[:backup])
       else
-        Pgchief::Prompt::Start.call
+        Pgchief::Prompt::Start.call(params)
       end
+    rescue Pgchief::Error => e
+      puts e.message
     end
   end
 end

data/lib/pgchief/command/config_create.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "fileutils"
+require 'fileutils'
 
 module Pgchief
   module Command
@@ -13,7 +13,7 @@ module Pgchief
       def call(dir: "#{Dir.home}/.config/pgchief")
         return if File.exist?("#{dir}/config.toml")
 
-        template = File.join(__dir__, "..", "..", "..", "config", "pgchief.toml")
+        template = File.join(__dir__, '..', '..', '..', 'config', 'pgchief.toml')
         FileUtils.mkdir_p(dir)
         FileUtils.cp(template, "#{dir}/config.toml")
 

data/lib/pgchief/command/database_backup.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "forwardable"
+require 'forwardable'
 
 module Pgchief
   module Command
@@ -35,11 +35,15 @@ module Pgchief
       private
 
       def backup!
-        `pg_dump -Fc #{Pgchief::Config.pgurl}/#{database} -f #{local_location}`
+        # if the provided `pgurl` already has a database at the tail
+        # end of the string, remove it. We'll explicitly add it below.
+        pgurl = Pgchief::Config.pgurl.gsub(%r{/[a-zA-Z\-_]*$}, '')
+
+        `pg_dump -Fc #{pgurl}/#{database} -f #{local_location}`
       end
 
       def check_backup!
-        raise Pgchief::Errors::BackupError, "Backup file has 0 bytes" unless File.size?(local_location)
+        raise Pgchief::Errors::BackupError, 'Backup file has 0 bytes' unless File.size?(local_location)
       end
 
       def db_exists?
@@ -53,7 +57,7 @@ module Pgchief
 
       def local_location
         @local_location ||= begin
-          timestamp = Time.now.strftime("%Y%m%d%H%M%S")
+          timestamp = Time.now.strftime('%Y%m%d%H%M%S')
           "#{Pgchief::Config.backup_dir}#{database}-#{timestamp}.dump"
         end
       end

data/lib/pgchief/command/database_drop.rb

@@ -8,10 +8,10 @@ module Pgchief
 
       def call
         @database = params.first
-        raise Pgchief::Errors::DatabaseMissingError unless db_exists?
 
-        conn.exec("DROP DATABASE #{database}")
+        return "Database '#{database}' does not exist." unless db_exists?
 
+        conn.exec("DROP DATABASE #{database}")
         "Database '#{database}' dropped successfully!"
       rescue PG::Error => e
         "Error: #{e.message}"

data/lib/pgchief/command/database_privileges_grant.rb

@@ -19,7 +19,7 @@ module Pgchief
           store_credentials!
         end
 
-        "Privileges granted to #{username} on #{@databases.join(", ")}"
+        "Privileges granted to #{username} on #{@databases.join(', ')}"
       end
 
       private

data/lib/pgchief/command/database_restore.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "forwardable"
+require 'forwardable'
 
 module Pgchief
   module Command
@@ -17,7 +17,7 @@ module Pgchief
         @filename = params.last
         raise Pgchief::Errors::DatabaseMissingError unless db_exists?
 
-        download! if configured?
+        download! if Pgchief::Config.remote_restore
         restore!
 
         "Database '#{database}' restored from #{filename}"
@@ -38,7 +38,7 @@ module Pgchief
       end
 
       def restore!
-        `pg_restore --clean --no-owner --dbname=#{Pgchief::Config.pgurl}/#{database} #{local_location}`
+        `pg_restore --clean --if-exists --no-owner --dbname=#{Pgchief::Config.pgurl}/#{database} #{local_location}`
       end
 
       def db_exists?

data/lib/pgchief/command/quick_backup.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pgchief
+  module Command
+    # Command object to quickly restore the latest backup for a database
+    class QuickBackup < Base
+      def call
+        database = params.last
+        Pgchief::Config.load_config!(params.first)
+        Pgchief::Config.set_up_file_structure!
+        Pgchief::Command::DatabaseBackup.call(database)
+      end
+    end
+  end
+end

data/lib/pgchief/command/quick_restore.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pgchief
+  module Command
+    # Command object to quickly restore the latest backup for a database
+    class QuickRestore < Base
+      def call
+        database = params.last
+        Pgchief::Config.load_config!(params.first)
+        Pgchief::Config.set_up_file_structure!
+
+        filename = Pgchief::Database
+                   .backups_for(database, remote: Pgchief::Config.remote_restore)
+                   .first
+
+        Pgchief::Command::DatabaseRestore.call(database, filename)
+      end
+    end
+  end
+end

data/lib/pgchief/command/retrieve_connection_string.rb

@@ -17,7 +17,7 @@ module Pgchief
           @connection_string = line if regex.match?(line)
         end
 
-        @connection_string.nil? ? "No connection string found" : @connection_string
+        @connection_string.nil? ? 'No connection string found' : @connection_string
       end
 
       private

data/lib/pgchief/command/s3_upload.rb

@@ -15,9 +15,9 @@ module Pgchief
         s3.client.put_object(
           bucket: s3.bucket,
           key: "#{s3.path}#{file_name}",
-          body: File.open(local_location, "rb"),
-          acl: "private",
-          content_type: "application/octet-stream"
+          body: File.open(local_location, 'rb'),
+          acl: 'private',
+          content_type: 'application/octet-stream'
         )
       end
 

data/lib/pgchief/command/store_connection_string.rb

@@ -15,7 +15,7 @@ module Pgchief
       end
 
       def call
-        File.open(Config.credentials_file, "a") do |file|
+        File.open(Config.credentials_file, 'a') do |file|
           file.puts @connection_string
         end
       end

data/lib/pgchief/command/user_create.rb

@@ -44,7 +44,7 @@ module Pgchief
       end
 
       def user_options
-        USER_OPTIONS.join(" ")
+        USER_OPTIONS.join(' ')
       end
 
       def connection_string

data/lib/pgchief/command/user_drop.rb

@@ -48,7 +48,7 @@ module Pgchief
               AND datname NOT IN ('postgres', 'template1', 'template0')
           SQL
 
-          results.map { |row| row["datname"] }
+          results.map { |row| row['datname'] }
         end
       end
     end

data/lib/pgchief/config/s3.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "forwardable"
+require 'forwardable'
 
 module Pgchief
   class Config

data/lib/pgchief/config.rb

@@ -1,25 +1,37 @@
 # frozen_string_literal: true
 
-require "toml-rb"
+require 'toml-rb'
 
 module Pgchief
   # Class to store configuration settings
   class Config
+    DEFAULT_CONFIG = "#{Dir.home}/.config/pgchief/config.toml".freeze
+
     class << self
       attr_accessor \
         :s3_key,
         :s3_secret,
-        :s3_region
+        :s3_region,
+        :remote_restore,
+        :remote_backup
 
       attr_writer :pgurl
 
       attr_reader \
         :s3_objects_path,
         :backup_dir,
-        :credentials_file
+        :credentials_file,
+        :toml_file
+
+      # explicitly define getter so that pgurl is always available if
+      # load_config! is not run.
+      def pgurl
+        ENV.fetch('DATABASE_URL', ENV.fetch('DB_URL', @pgurl))
+      end
 
-      def load_config!(toml_file = "#{Dir.home}/.config/pgchief/config.toml") # rubocop:disable Metrics/AbcSize
-        config                = TomlRB.load_file(toml_file, symbolize_keys: true)
+      def load_config!(params, toml_file = DEFAULT_CONFIG)
+        @toml_file            = toml_file
+        config                = toml_config || env_config
         self.backup_dir       = config[:backup_dir]
         self.credentials_file = config[:credentials_file]
         self.pgurl            = config[:pgurl]
@@ -27,7 +39,13 @@ module Pgchief
         self.s3_secret        = config[:s3_secret]
         self.s3_region        = config[:s3_region]
         self.s3_objects_path  = config[:s3_objects_path] || config[:s3_path_prefix]
-      rescue Errno::ENOENT
+        self.remote_restore   = params[:'remote-restore'] == true ||
+                                params[:'local-restore'] == false ||
+                                config[:remote_restore]
+        self.remote_backup    = params[:'remote-backup']  == true ||
+                                params[:'local-backup'] == false ||
+                                config[:remote_backup]
+      rescue Pgchief::Errors::ConfigMissingError
         puts config_missing_error(toml_file)
       end
 
@@ -35,20 +53,16 @@ module Pgchief
         @s3 ||= Pgchief::Config::S3.new(self)
       end
 
-      def pgurl
-        ENV.fetch("DATABASE_URL", @pgurl)
-      end
-
       def backup_dir=(value)
-        @backup_dir = value ? "#{value.chomp("/")}/".gsub("~", Dir.home) : "/tmp/"
+        @backup_dir = value ? "#{value.chomp('/')}/".gsub('~', Dir.home) : '/tmp/'
       end
 
       def s3_objects_path=(value)
-        @s3_objects_path = value ? "#{value.chomp("/")}/" : nil
+        @s3_objects_path = value ? "#{value.chomp('/')}/" : nil
       end
 
       def credentials_file=(value)
-        @credentials_file = value&.gsub("~", Dir.home)
+        @credentials_file = value&.gsub('~', Dir.home)
       end
 
       def set_up_file_structure!
@@ -60,9 +74,28 @@ module Pgchief
 
       private
 
+      def toml_config
+        return unless File.exist?(toml_file.to_s)
+
+        TomlRB.load_file(toml_file, symbolize_keys: true)
+      end
+
+      def env_config
+        pgurl = ENV.fetch('DATABASE_URL', ENV.fetch('DB_URL', nil))
+        raise Pgchief::Errors::ConfigMissingError if pgurl.nil?
+
+        {
+          pgurl: pgurl,
+          s3_key: ENV.fetch('AWS_ACCESS_KEY_ID', ENV.fetch('AWS_ACCESS_KEY', nil)),
+          s3_secret: ENV.fetch('AWS_SECRET_ACCESS_KEY', ENV.fetch('AWS_SECRET_KEY', nil)),
+          s3_region: ENV.fetch('AWS_DEFAULT_REGION', ENV.fetch('AWS_REGION', nil)),
+          s3_objects_path: ENV.fetch('S3_BACKUPS_PATH', nil)
+        }
+      end
+
       def config_missing_error(toml_file)
-        "You must create a config file at #{toml_file}.\n" \
-          "run `pgchief --init` to create it."
+        "You must create a config file at #{toml_file || DEFAULT_CONFIG}.\n" \
+          'run `pgchief --init` to create it.'
       end
     end
   end

data/lib/pgchief/connection_string.rb

@@ -9,7 +9,7 @@ module Pgchief
       :?(?<password>[^@]*)?
       @?(?<host>[^:]*)?
       :?(?<port>\d+)?
-      /?(?<database>[^\?]*)?
+      /?(?<database>[^?]*)?
       \z}
 
     attr_reader :database_url
@@ -39,19 +39,19 @@ module Pgchief
     end
 
     def username
-      @username || ("" if matched[:host].empty? && !matched[:username].empty?) || matched[:username] || ""
+      @username || ('' if matched[:host].empty? && !matched[:username].empty?) || matched[:username] || ''
     end
 
     def password
-      @password || matched[:password] || ""
+      @password || matched[:password] || ''
     end
 
     def port
-      @port || matched[:port] || "5432"
+      @port || matched[:port] || '5432'
     end
 
     def database
-      @database || matched[:database] || ""
+      @database || matched[:database] || ''
     end
 
     private

data/lib/pgchief/database/backups.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "forwardable"
+require 'forwardable'
 
 module Pgchief
   class Database
@@ -10,13 +10,13 @@ module Pgchief
 
       def_delegators :s3, :bucket, :path, :client
 
-      def self.for(database, remote)
-        new(database, remote).for
+      def self.for(database, remote:)
+        new(database, remote: remote).for
       end
 
       attr_reader :database, :remote
 
-      def initialize(database, remote)
+      def initialize(database, remote:)
         @database = database
         @remote = remote
       end

data/lib/pgchief/database.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require "pg"
+require 'pg'
 
 module Pgchief
   # Database information and operations
   class Database
     def self.all
       conn = PG.connect(Pgchief::Config.pgurl)
-      result = conn.exec("SELECT datname FROM pg_database WHERE datistemplate = false")
+      result = conn.exec('SELECT datname FROM pg_database WHERE datistemplate = false')
       result
-        .map { |row| row["datname"] }
-        .reject { |name| name == "postgres" }
+        .map { |row| row['datname'] }
+        .reject { |name| name == 'postgres' }
     ensure
       conn.close
     end

data/lib/pgchief/prompt/backup_database.rb

@@ -5,7 +5,7 @@ module Pgchief
     # Class to prompt for which database to backup
     class BackupDatabase < Base
       def call
-        database = prompt.select("Which database needs backing up?", Pgchief::Database.all)
+        database = prompt.select('Which database needs backing up?', Pgchief::Database.all)
         result   = Pgchief::Command::DatabaseBackup.call(database)
 
         prompt.say result

data/lib/pgchief/prompt/base.rb

@@ -20,7 +20,7 @@ module Pgchief
 
       def klassify(scope, words)
         Object.const_get([
-          "Pgchief", "::", scope.capitalize, "::",
+          'Pgchief', '::', scope.capitalize, '::',
           words.split.map(&:capitalize)
         ].flatten.join)
       end
@@ -33,8 +33,8 @@ module Pgchief
       def prompt
         @prompt ||= TTY::Prompt.new.tap do |p|
           p.on(:keypress) do |event|
-            p.trigger(:keydown) if event.value == "j"
-            p.trigger(:keyup) if event.value == "k"
+            p.trigger(:keydown) if event.value == 'j'
+            p.trigger(:keyup) if event.value == 'k'
           end
 
           p.on(:keyescape) do

data/lib/pgchief/prompt/create_database.rb

@@ -5,7 +5,7 @@ module Pgchief
     # Class to ask for database name, in order to create it
     class CreateDatabase < Base
       def call
-        database = prompt.ask("Database name:")
+        database = prompt.ask('Database name:')
         result   = Pgchief::Command::DatabaseCreate.call(database)
 
         prompt.say result

data/lib/pgchief/prompt/create_user.rb

@@ -5,8 +5,8 @@ module Pgchief
     # Class to prompt for user creation details
     class CreateUser < Base
       def call
-        username = prompt.ask("Username:")
-        password = prompt.mask("Password:")
+        username = prompt.ask('Username:')
+        password = prompt.mask('Password:')
         result   = Pgchief::Command::UserCreate.call(username, password)
 
         prompt.say result

data/lib/pgchief/prompt/database_management.rb

@@ -6,14 +6,14 @@ module Pgchief
     class DatabaseManagement < Base
       def call
         prompt = TTY::Prompt.new
-        result = prompt.select("Database management", [
-                                 "Create database",
-                                 "Drop database",
-                                 "Database List",
-                                 "Backup database",
-                                 "Restore database"
+        result = prompt.select('Database management', [
+                                 'Create database',
+                                 'Drop database',
+                                 'Database List',
+                                 'Backup database',
+                                 'Restore database'
                                ])
-        scope = result == "Database List" ? "command" : "prompt"
+        scope = result == 'Database List' ? 'command' : 'prompt'
 
         klassify(scope, result).call
       end

data/lib/pgchief/prompt/drop_database.rb

@@ -5,7 +5,7 @@ module Pgchief
     # Class to prompt for which database to drop
     class DropDatabase < Base
       def call
-        database = prompt.select("Which database needs to be dropped?", Pgchief::Database.all)
+        database = prompt.select('Which database needs to be dropped?', Pgchief::Database.all)
         result   = Pgchief::Command::DatabaseDrop.call(database)
 
         prompt.say result

data/lib/pgchief/prompt/drop_user.rb

@@ -5,7 +5,7 @@ module Pgchief
     # Class to prompt for which user to drop
     class DropUser < Base
       def call
-        user   = prompt.select("Which user needs to be deleted?", Pgchief::User.all)
+        user   = prompt.select('Which user needs to be deleted?', Pgchief::User.all)
         result = Pgchief::Command::UserDrop.call(user)
 
         prompt.say result

data/lib/pgchief/prompt/grant_database_privileges.rb

@@ -15,11 +15,11 @@ module Pgchief
       end
 
       def select_user
-        prompt.select("Select user to update:", Pgchief::User.all)
+        prompt.select('Select user to update:', Pgchief::User.all)
       end
 
       def ask_for_password
-        prompt.mask("Password:")
+        prompt.mask('Password:')
       end
     end
   end

data/lib/pgchief/prompt/restore_database.rb

@@ -5,11 +5,16 @@ module Pgchief
     # Class to prompt for which database to restore
     class RestoreDatabase < Base
       def call
-        database   = prompt.select("Which database needs restoring?", Pgchief::Database.all)
-        local_file = prompt.select("Which backup file do you want to restore?", Pgchief::Database.backups_for(database))
-        result     = Pgchief::Command::DatabaseRestore.call(database, local_file)
+        database = prompt.select('Which database needs restoring?', Pgchief::Database.all)
+        backups  = Pgchief::Database.backups_for(database, remote: Pgchief::Config.remote_restore)
 
-        prompt.say result
+        if backups.empty?
+          prompt.warn "No backup files found for database '#{database}'"
+        else
+          local_file = prompt.select('Which backup file do you want to restore?', backups)
+          result = Pgchief::Command::DatabaseRestore.call(database, local_file)
+          prompt.say result
+        end
       end
     end
   end

data/lib/pgchief/prompt/start.rb

@@ -8,20 +8,20 @@ module Pgchief
         manage_config!
 
         result = prompt.select(
-          "Welcome! How can I help?",
+          'Welcome! How can I help?',
           [
-            "Database management",
-            "User management"
+            'Database management',
+            'User management'
           ]
         )
 
-        klassify("prompt", result).call
+        klassify('prompt', result).call
       end
 
       private
 
       def manage_config!
-        Pgchief::Config.load_config!
+        Pgchief::Config.load_config!(params.first)
         Pgchief::Config.set_up_file_structure!
       end
     end

data/lib/pgchief/prompt/user_management.rb

@@ -5,15 +5,15 @@ module Pgchief
     # Class to manage users
     class UserManagement < Base
       def call
-        result = prompt.select("User management", [
-                                 "Create user",
-                                 "Drop user",
-                                 "User list",
-                                 "Grant database privileges",
-                                 "View database connection string"
+        result = prompt.select('User management', [
+                                 'Create user',
+                                 'Drop user',
+                                 'User list',
+                                 'Grant database privileges',
+                                 'View database connection string'
                                ])
 
-        scope = result == "User list" ? "command" : "prompt"
+        scope = result == 'User list' ? 'command' : 'prompt'
         klassify(scope, result).call
       end
     end

data/lib/pgchief/prompt/view_database_connection_string.rb

@@ -6,15 +6,15 @@ module Pgchief
     class ViewDatabaseConnectionString < Base
       def call
         username = params.first || select_user
-        database = prompt.select("Database you're connecting to:", Pgchief::Database.all + ["None"])
-        database = nil if database == "None"
+        database = prompt.select("Database you're connecting to:", Pgchief::Database.all + ['None'])
+        database = nil if database == 'None'
         result   = Pgchief::Command::RetrieveConnectionString.call(username, database)
 
         prompt.say result
       end
 
       def select_user
-        prompt.select("Select user to update:", Pgchief::User.all)
+        prompt.select('Select user to update:', Pgchief::User.all)
       end
     end
   end

data/lib/pgchief/user.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require "pg"
+require 'pg'
 
 module Pgchief
   # Database information and operations
   class User
     def self.all
       conn   = PG.connect(Pgchief::Config.pgurl)
-      result = conn.exec("SELECT usename FROM pg_user")
+      result = conn.exec('SELECT usename FROM pg_user')
 
-      result.map { |row| row["usename"] }.reject { |name| name == "postgres" }
+      result.map { |row| row['usename'] }.reject { |name| name == 'postgres' }
     ensure
       conn.close
     end

data/lib/pgchief/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pgchief
-  VERSION = "0.5.3"
+  VERSION = '0.6.0'
 end

data/lib/pgchief.rb

@@ -1,55 +1,70 @@
 # frozen_string_literal: true
 
-require "pg"
-require "tty-prompt"
-require "tty-option"
-require "aws-sdk-s3"
-
-require "pgchief/cli"
-require "pgchief/config"
-require "pgchief/config/s3"
-require "pgchief/connection_string"
-require "pgchief/version"
-require "pgchief/database"
-require "pgchief/database/backups"
-require "pgchief/user"
-
-require "pgchief/prompt/base"
-require "pgchief/prompt/backup_database"
-require "pgchief/prompt/create_database"
-require "pgchief/prompt/create_user"
-require "pgchief/prompt/database_management"
-require "pgchief/prompt/drop_database"
-require "pgchief/prompt/drop_user"
-require "pgchief/prompt/grant_database_privileges"
-require "pgchief/prompt/restore_database"
-require "pgchief/prompt/start"
-require "pgchief/prompt/user_management"
-require "pgchief/prompt/view_database_connection_string"
-
-require "pgchief/command"
-require "pgchief/command/base"
-require "pgchief/command/config_create"
-require "pgchief/command/database_backup"
-require "pgchief/command/database_create"
-require "pgchief/command/database_drop"
-require "pgchief/command/database_list"
-require "pgchief/command/database_privileges_grant"
-require "pgchief/command/database_restore"
-require "pgchief/command/retrieve_connection_string"
-require "pgchief/command/s3_upload"
-require "pgchief/command/store_connection_string"
-require "pgchief/command/user_create"
-require "pgchief/command/user_drop"
-require "pgchief/command/user_list"
+require 'pg'
+require 'tty-prompt'
+require 'tty-option'
+require 'aws-sdk-s3'
+
+require 'pgchief/cli'
+require 'pgchief/config'
+require 'pgchief/config/s3'
+require 'pgchief/connection_string'
+require 'pgchief/version'
+require 'pgchief/database'
+require 'pgchief/database/backups'
+require 'pgchief/user'
+
+require 'pgchief/prompt/base'
+require 'pgchief/prompt/backup_database'
+require 'pgchief/prompt/create_database'
+require 'pgchief/prompt/create_user'
+require 'pgchief/prompt/database_management'
+require 'pgchief/prompt/drop_database'
+require 'pgchief/prompt/drop_user'
+require 'pgchief/prompt/grant_database_privileges'
+require 'pgchief/prompt/restore_database'
+require 'pgchief/prompt/start'
+require 'pgchief/prompt/user_management'
+require 'pgchief/prompt/view_database_connection_string'
+
+require 'pgchief/command'
+require 'pgchief/command/base'
+require 'pgchief/command/config_create'
+require 'pgchief/command/database_backup'
+require 'pgchief/command/database_create'
+require 'pgchief/command/database_drop'
+require 'pgchief/command/database_list'
+require 'pgchief/command/database_privileges_grant'
+require 'pgchief/command/database_restore'
+require 'pgchief/command/quick_restore'
+require 'pgchief/command/quick_backup'
+require 'pgchief/command/retrieve_connection_string'
+require 'pgchief/command/s3_upload'
+require 'pgchief/command/store_connection_string'
+require 'pgchief/command/user_create'
+require 'pgchief/command/user_drop'
+require 'pgchief/command/user_list'
 
 module Pgchief
   class Error < StandardError; end
 
   module Errors
     class UserExistsError < Error; end
-    class DatabaseExistsError < Error; end
-    class DatabaseMissingError < Error; end
+
     class BackupError < Error; end
+
+    class ConfigMissingError < Error; end
+
+    class DatabaseExistsError < Error
+      def message
+        'The database already exists.'
+      end
+    end
+
+    class DatabaseMissingError < Error
+      def message
+        'The database requested does not exist.'
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pgchief
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Joel Oliveira
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -80,7 +79,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - joel.oliveira@gmail.com
 executables:
@@ -91,6 +89,7 @@ files:
 - ".env.sample"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
@@ -109,6 +108,8 @@ files:
 - lib/pgchief/command/database_list.rb
 - lib/pgchief/command/database_privileges_grant.rb
 - lib/pgchief/command/database_restore.rb
+- lib/pgchief/command/quick_backup.rb
+- lib/pgchief/command/quick_restore.rb
 - lib/pgchief/command/retrieve_connection_string.rb
 - lib/pgchief/command/s3_upload.rb
 - lib/pgchief/command/store_connection_string.rb
@@ -145,7 +146,6 @@ metadata:
   source_code_uri: https://github.com/jayroh/pgchief
   changelog_uri: https://github.com/jayroh/pgchief/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,8 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: A simple ruby script to manage postgresql databases and users
 test_files: []