pgchief 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e11f487141ba0fab474322adf299d2d97676b2af3e26d14a77dce8d1ee2d1f5d
-  data.tar.gz: 45419f8a0f286c9fb415190be6793572b11fb8528999041b432ec69c706121cd
+  metadata.gz: 142a11a0be4792a8b0c428c25119c964fb899564db0f6ace3464fef0409017c6
+  data.tar.gz: d62cd7fd0b58525300e25065b3fff56b1e9bd157af9058f335c5436c88e0090f
 SHA512:
-  metadata.gz: 0aec7a349ff2fa06ec5c3030276953eca2a89fde24df5cf360ba9b5fea29a6ecddc1b13b5b2578983fe16068a94127bcfb9a2b3be3aa8b9dd2dbdfe5f3a761da
-  data.tar.gz: 210b49ddaf86e5515772b24a1da0f03666b44146ae874a638f748d538043fcaf633b4e7865b11094867a71da587ca70be757fe1c2b6b96c924d55f8735b3835a
+  metadata.gz: c02ad41656562151ac067e33a8a61bf8c3c39a915d32b93eda8ed76df0b601bbc4b3bfd8ab5c9979492ae0bb3b543c1e806fbcc9dbfe6b5e9452111662415336
+  data.tar.gz: 9cc987456a024dd1abaa656b2a725152a3e16ec7f345ab8723e3d912bcae6b213b3329e383b73bf23491826f9b8f9769d1e36d67d5688d5ad53f1bc829b5a907

data/.rubocop.yml

@@ -6,3 +6,20 @@ plugins:
 
 AllCops:
   NewCops: enable
+
+Style/Documentation:
+  Exclude:
+    - 'lib/pgchief.rb'
+    - 'spec/**/*.rb'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/pgchief/config.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/pgchief/config.rb'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/pgchief/config.rb'

data/CHANGELOG.md

@@ -13,13 +13,34 @@ 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.
+* 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
 

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`:
@@ -43,11 +43,13 @@ pgchief
 
 $ pgchief --help
 Options:
-  -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
-  -v, --version         Show the version
+  -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.
 ```
 
 > [!Note]
@@ -55,7 +57,7 @@ Options:
 > Pressing the `esc` key at any point amidst a prompt will exit out of the
 > program.
 
-## Config
+## Config via File
 
 Format of `~/.config/pgchief/config.toml`
 
@@ -83,6 +85,22 @@ backup_dir = "~/.pgchief/backups"
 # remote_backup = false  # default: false
 ```
 
+### 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
+```
+
 > [!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
@@ -162,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/lib/pgchief/cli.rb

@@ -10,41 +10,61 @@ module Pgchief
     option :init do
       short '-i'
       long '--init'
-      desc 'Initialize the TOML configuration file'
+      desc 'Initialize the TOML configuration file.'
     end
 
     option :version do
       short '-v'
       long '--version'
-      desc 'Show the version'
+      desc 'Show the version.'
     end
 
     option :'remote-restore' do
       long '--remote-restore'
-      desc 'Restore a database from a remote backup'
+      desc 'Restore a database from a remote backup.'
     end
 
     option :'remote-backup' do
       long '--remote-backup'
-      desc 'Backup a database to a remote location'
+      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'
+      desc 'Print usage.'
     end
 
-    def run
+    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(params)
       end
+    rescue Pgchief::Error => e
+      puts e.message
     end
   end
 end

data/lib/pgchief/command/database_backup.rb

@@ -35,7 +35,11 @@ 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!

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/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/config.rb

@@ -5,6 +5,8 @@ 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,
@@ -18,10 +20,18 @@ module Pgchief
       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!(params, toml_file = "#{Dir.home}/.config/pgchief/config.toml") # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        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]
@@ -35,7 +45,7 @@ module Pgchief
         self.remote_backup    = params[:'remote-backup']  == true ||
                                 params[:'local-backup'] == false ||
                                 config[:remote_backup]
-      rescue Errno::ENOENT
+      rescue Pgchief::Errors::ConfigMissingError
         puts config_missing_error(toml_file)
       end
 
@@ -43,10 +53,6 @@ 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/'
       end
@@ -68,8 +74,27 @@ 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" \
+        "You must create a config file at #{toml_file || DEFAULT_CONFIG}.\n" \
           'run `pgchief --init` to create it.'
       end
     end

data/lib/pgchief/database/backups.rb

@@ -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/version.rb

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

data/lib/pgchief.rb

@@ -36,6 +36,8 @@ 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'
@@ -48,8 +50,21 @@ module Pgchief
 
   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,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pgchief
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Joel Oliveira
 bindir: exe
 cert_chain: []
-date: 2025-03-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -108,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
@@ -158,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.8
 specification_version: 4
 summary: A simple ruby script to manage postgresql databases and users
 test_files: []