pgchief 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 627e9af2dc140bd7210c9f4e999f5be13ba0bf514e6397619d42bef8a6d8b838
-  data.tar.gz: 78a5456432854cebd9b6d6fb68f9f02256a9a37c626ac0d78ef35b3bf79f4f21
+  metadata.gz: adccab6ee77468761bf0d05d12954f7b0360547b95f5295797b911ed80f731e2
+  data.tar.gz: 2a4ae39f43e0da9913f252e70e0583d0e21dd45e48931e94a62c309298d287f8
 SHA512:
-  metadata.gz: 26a19391751adbd9846cd70532becfa91c4f2e6a704405764c207e817f388b5ad900a5993eb2e20b574e09e78a089658b9f1f14591e9ea5f0349476fa7b49c13
-  data.tar.gz: e96db718dd3e594b4f612d47b2d63bfe0792e94b4ba622d9093db6b2d8138c02cf8dc45885557a8048f767d280f597103a410468914496dd937e25b759eb2c18
+  metadata.gz: 7dea359e077b5c473c7df21e53067954dee0c426df76b8a375a026a3976593dbdd4024c6582650a2fbe1404a34affb1030fe0065842065ad594119cd3f757ace
+  data.tar.gz: 3b16494cea09736f6b2c16e55d2c5054898a6f023bf06b8862585313617104dc858e98750397baf6b606126aaf2f5bb109f9f02fbf11699b281bdeefd6c41c38

data/CHANGELOG.md

@@ -13,6 +13,29 @@ and this project will try its best to adhere to [Semantic Versioning](https://se
 
 ### Fixes
 
+## [0.5.0]
+
+### Additions
+
+* Restore database from local file(s)
+* Restore database from s3
+
+## [0.4.0]
+
+### Changes
+
+* Clean up the config object
+
+### Additions
+
+* Back up option for databases: save to local filesystem or S3.
+
+### Fixes
+
+* Capture error where the config file does not exist and provide some guidance.
+* Make a `PG::ConnectionBad` error a little less scary(?)
+* Do not inherit the base `Command` class in `ConfigCreate`. It doesn't need to connect to the DB.
+
 ## [0.3.1]
 
 ### Changes
@@ -75,7 +98,9 @@ and this project will try its best to adhere to [Semantic Versioning](https://se
 - Drop user ✅
 - List databases ✅
 
-[Unreleased]: https://github.com/jayroh/pgchief/compare/v0.3.0...HEAD
+[Unreleased]: https://github.com/jayroh/pgchief/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/jayroh/pgchief/releases/tag/v0.4.0
+[0.3.1]: https://github.com/jayroh/pgchief/releases/tag/v0.3.1
 [0.3.0]: https://github.com/jayroh/pgchief/releases/tag/v0.3.0
 [0.2.0]: https://github.com/jayroh/pgchief/releases/tag/v0.2.0
 [0.1.0]: https://github.com/jayroh/pgchief/releases/tag/v0.1.0

data/README.md

@@ -41,7 +41,7 @@ pgchief
 
 ## Config
 
-Format of `~/.pgchief.toml`
+Format of `~/.config/pgchief/config.toml`
 
 ```toml
 # Connection string to superuser account at your PG instance
@@ -130,5 +130,9 @@ Give "rando-username" access to database(s):
 * [x] Give user permissions to use database
 * [x] Initialize toml file
 * [x] Display connection information
-* [ ] Back up database
-* [ ] Restore database
+* [x] Back up database locally
+* [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

data/config/pgchief.toml

@@ -8,3 +8,9 @@ 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_key = ""
+# s3_secret = ""
+# s3_region = "us-east-1"
+# s3_path_prefix = "s3://bucket-name/database-backups/"

data/lib/pgchief/command/base.rb

@@ -13,6 +13,8 @@ module Pgchief
       def initialize(*params)
         @params = params
         @conn = PG.connect(Pgchief::Config.pgurl)
+      rescue PG::ConnectionBad => e
+        puts "Cannot connect to database. #{e.message}"
       end
 
       def call

data/lib/pgchief/command/config_create.rb

@@ -5,7 +5,11 @@ require "fileutils"
 module Pgchief
   module Command
     # Create a configuration file at $HOME
-    class ConfigCreate < Base
+    class ConfigCreate
+      def self.call(dir: "#{Dir.home}/.config/pgchief")
+        new.call(dir: dir)
+      end
+
       def call(dir: "#{Dir.home}/.config/pgchief")
         return if File.exist?("#{dir}/config.toml")
 

data/lib/pgchief/command/database_backup.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Pgchief
+  module Command
+    # Command object to drop a database
+    class DatabaseBackup < Base
+      extend Forwardable
+
+      def_delegators :@uploader, :configured?, :upload!, :s3_location
+
+      attr_reader :database
+
+      def call
+        @database = params.first
+        @uploader = Pgchief::Command::S3Upload.new(local_location)
+        raise Pgchief::Errors::DatabaseMissingError unless db_exists?
+
+        backup!
+        upload! if configured?
+
+        "Database '#{database}' backed up to #{location}"
+      rescue PG::Error => e
+        "Error: #{e.message}"
+      ensure
+        conn.close
+      end
+
+      private
+
+      def backup!
+        `pg_dump -Fc #{database} -f #{local_location}`
+      end
+
+      def db_exists?
+        query = "SELECT 1 FROM pg_database WHERE datname = '#{database}'"
+        conn.exec(query).any?
+      end
+
+      def location
+        configured? ? s3_location : local_location
+      end
+
+      def local_location
+        @local_location ||= begin
+          timestamp = Time.now.strftime("%Y%m%d%H%M%S")
+          "#{Pgchief::Config.backup_dir}#{database}-#{timestamp}.dump"
+        end
+      end
+    end
+  end
+end

data/lib/pgchief/command/database_restore.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Pgchief
+  module Command
+    # Command object to restore a database
+    class DatabaseRestore < Base
+      extend Forwardable
+
+      attr_reader :database, :filename
+
+      def_delegators :s3, :configured?, :client, :bucket, :path
+
+      def call
+        @database = params.first
+        @filename = params.last
+        raise Pgchief::Errors::DatabaseMissingError unless db_exists?
+
+        download! if configured?
+        restore!
+
+        "Database '#{database}' restored from #{filename}"
+      rescue PG::Error => e
+        "Error: #{e.message}"
+      ensure
+        conn.close
+      end
+
+      private
+
+      def download!
+        client.get_object(
+          bucket: bucket,
+          key: "#{path}#{filename}",
+          response_target: local_location
+        )
+      end
+
+      def restore!
+        `pg_restore --clean --no-owner --dbname=#{Pgchief::Config.pgurl}/#{database} #{local_location}`
+      end
+
+      def db_exists?
+        query = "SELECT 1 FROM pg_database WHERE datname = '#{database}'"
+        conn.exec(query).any?
+      end
+
+      def local_location
+        "#{Pgchief::Config.backup_dir}/#{filename}"
+      end
+
+      def s3
+        Pgchief::Config.s3
+      end
+    end
+  end
+end

data/lib/pgchief/command/s3_upload.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Pgchief
+  module Command
+    # Class to upload a file to S3
+    class S3Upload
+      attr_reader :local_location, :file_name, :bucket, :path
+
+      def initialize(local_location)
+        @local_location = local_location
+        @file_name      = File.basename(local_location)
+      end
+
+      def upload!
+        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"
+        )
+      end
+
+      def s3_location
+        "s3://#{s3.bucket}/#{s3.path}#{file_name}"
+      end
+
+      def configured?
+        s3.configured?
+      end
+
+      private
+
+      def s3
+        Pgchief::Config.s3
+      end
+    end
+  end
+end

data/lib/pgchief/config/s3.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Pgchief
+  class Config
+    # Class to store s3 configuration settings
+    class S3
+      extend Forwardable
+
+      def_delegators \
+        :config,
+        :s3_key,
+        :s3_secret,
+        :s3_region,
+        :s3_path_prefix
+
+      PREFIX_REGEX = %r{\As3://(?<bucket>(\w|-)*)/(?<path>(\w|/)*/)\z}
+
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def client
+        @client ||= Aws::S3::Client.new(
+          access_key_id: s3_key,
+          secret_access_key: s3_secret,
+          region: s3_region
+        )
+      end
+
+      def bucket
+        s3_match[:bucket]
+      end
+
+      def path
+        s3_match[:path]
+      end
+
+      def configured?
+        [
+          s3_key,
+          s3_secret,
+          s3_region,
+          s3_path_prefix
+        ].none?(&:nil?)
+      end
+
+      private
+
+      def s3_match
+        @s3_match ||= s3_path_prefix.match(PREFIX_REGEX)
+      end
+    end
+  end
+end

data/lib/pgchief/config.rb

@@ -7,30 +7,63 @@ module Pgchief
   class Config
     class << self
       attr_accessor \
-        :backup_dir,
-        :credentials_file
+        :s3_key,
+        :s3_secret,
+        :s3_region
 
       attr_writer :pgurl
 
-      def load_config!(toml_file = "#{Dir.home}/.config/pgchief/config.toml")
-        config = TomlRB.load_file(toml_file, symbolize_keys: true)
+      attr_reader \
+        :s3_path_prefix,
+        :backup_dir,
+        :credentials_file
+
+      def load_config!(toml_file = "#{Dir.home}/.config/pgchief/config.toml") # rubocop:disable Metrics/AbcSize
+        config                = TomlRB.load_file(toml_file, symbolize_keys: true)
+        self.backup_dir       = config[:backup_dir]
+        self.credentials_file = config[:credentials_file]
+        self.pgurl            = config[:pgurl]
+        self.s3_key           = config[:s3_key]
+        self.s3_secret        = config[:s3_secret]
+        self.s3_region        = config[:s3_region]
+        self.s3_path_prefix   = config[:s3_path_prefix]
+      rescue Errno::ENOENT
+        puts config_missing_error(toml_file)
+      end
 
-        @backup_dir = config[:backup_dir].gsub("~", Dir.home)
-        @credentials_file = config[:credentials_file]&.gsub("~", Dir.home)
-        @pgurl = config[:pgurl]
+      def s3
+        @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
+
+      def s3_path_prefix=(value)
+        @s3_path_prefix = value ? "#{value.chomp("/")}/" : nil
+      end
+
+      def credentials_file=(value)
+        @credentials_file = value&.gsub("~", Dir.home)
+      end
+
       def set_up_file_structure!
         FileUtils.mkdir_p(backup_dir)
-
         return unless credentials_file && !File.exist?(credentials_file)
 
         FileUtils.touch(credentials_file)
       end
+
+      private
+
+      def config_missing_error(toml_file)
+        "You must create a config file at #{toml_file}.\n" \
+          "run `pgchief --init` to create it."
+      end
     end
   end
 end

data/lib/pgchief/database/backups.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "pry"
+
+module Pgchief
+  class Database
+    # Get a list of all backups for a given database
+    class Backups
+      extend Forwardable
+
+      def_delegators :s3, :bucket, :path, :client
+
+      def self.for(database, remote)
+        new(database, remote).for
+      end
+
+      attr_reader :database, :remote
+
+      def initialize(database, remote)
+        @database = database
+        @remote = remote
+      end
+
+      def for
+        remote ? remote_backups : local_backups
+      end
+
+      def remote_backups
+        @remote_backups ||= client.list_objects(
+          bucket: bucket,
+          prefix: "#{path}#{database}-"
+        ).contents
+                                  .map(&:key)
+                                  .sort
+                                  .last(3)
+                                  .reverse
+                                  .map { |f| File.basename(f) }
+      end
+
+      def local_backups
+        Dir["#{Pgchief::Config.backup_dir}#{database}-*.dump"]
+          .sort_by { |f| File.mtime(f) }
+          .reverse
+          .last(3)
+          .map { |f| File.basename(f) }
+      end
+
+      private
+
+      def s3
+        Pgchief::Config.s3
+      end
+    end
+  end
+end

data/lib/pgchief/database.rb

@@ -14,5 +14,9 @@ module Pgchief
     ensure
       conn.close
     end
+
+    def self.backups_for(database, remote: false)
+      Pgchief::Database::Backups.for(database, remote: remote)
+    end
   end
 end

data/lib/pgchief/prompt/backup_database.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pgchief
+  module Prompt
+    # Class to prompt for which database to backup
+    class BackupDatabase < Base
+      def call
+        database = prompt.select("Which database needs backing up?", Pgchief::Database.all)
+        result   = Pgchief::Command::DatabaseBackup.call(database)
+
+        prompt.say result
+      end
+    end
+  end
+end

data/lib/pgchief/prompt/database_management.rb

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

data/lib/pgchief/prompt/restore_database.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pgchief
+  module Prompt
+    # 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)
+
+        prompt.say result
+      end
+    end
+  end
+end

data/lib/pgchief/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pgchief
-  VERSION = "0.3.1"
+  VERSION = "0.5.0"
 end

data/lib/pgchief.rb

@@ -3,33 +3,41 @@
 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/start"
+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/user_management"
 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"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pgchief
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Joel Oliveira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-12 00:00:00.000000000 Z
+date: 2024-11-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  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: pg
   requirement: !ruby/object:Gem::Requirement
@@ -89,19 +103,25 @@ files:
 - lib/pgchief/command.rb
 - lib/pgchief/command/base.rb
 - lib/pgchief/command/config_create.rb
+- lib/pgchief/command/database_backup.rb
 - lib/pgchief/command/database_create.rb
 - lib/pgchief/command/database_drop.rb
 - lib/pgchief/command/database_list.rb
 - lib/pgchief/command/database_privileges_grant.rb
+- lib/pgchief/command/database_restore.rb
 - lib/pgchief/command/retrieve_connection_string.rb
+- lib/pgchief/command/s3_upload.rb
 - lib/pgchief/command/store_connection_string.rb
 - lib/pgchief/command/user_create.rb
 - lib/pgchief/command/user_drop.rb
 - lib/pgchief/command/user_list.rb
 - lib/pgchief/config.rb
+- lib/pgchief/config/s3.rb
 - lib/pgchief/connection_string.rb
 - lib/pgchief/database.rb
+- lib/pgchief/database/backups.rb
 - lib/pgchief/prompt.rb
+- lib/pgchief/prompt/backup_database.rb
 - lib/pgchief/prompt/base.rb
 - lib/pgchief/prompt/create_database.rb
 - lib/pgchief/prompt/create_user.rb
@@ -109,6 +129,7 @@ files:
 - lib/pgchief/prompt/drop_database.rb
 - lib/pgchief/prompt/drop_user.rb
 - lib/pgchief/prompt/grant_database_privileges.rb
+- lib/pgchief/prompt/restore_database.rb
 - lib/pgchief/prompt/start.rb
 - lib/pgchief/prompt/user_management.rb
 - lib/pgchief/prompt/view_database_connection_string.rb
@@ -139,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: A simple ruby script to manage postgresql databases and users