pgchief 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df59b4bbe15540e5d3b587f98c98ef71f2724f028299e88961766e2b6225ac2c
-  data.tar.gz: f5b0f578ac0c0610e2f020f740f207826a1f4cd05de16e27e5da7c1af860a408
+  metadata.gz: 22c8374fdee4a24fde56bb1edd737694551b73288643b93078efa5f73c149a1b
+  data.tar.gz: bbebe5882166def3e96dc08804d695c4c2f9d629735173fbde82dcfcd70aaa1e
 SHA512:
-  metadata.gz: f2e9611feb5db3d76d8e13ca3b153d1a0a387c90faadd249590c115b94d696da5d0b4d5b712db6d7a739b8f9b933fea1f40f9e6dc102fb064098b6ff3b568f58
-  data.tar.gz: 863b4f71e694fb3e8ebde4d4b020d446d96a582a24b4e457d0d8cd42bc474780956d874a02944ea959ac689a3d33870374565871c19deea2bc31c750349aff8a
+  metadata.gz: 0fd0d65a33b1370a2dda33e4ecd06710b7140eefe911c4f3f9eadbe2bea81bd272a43b8bf013c472afa0cee035f785bd9336d8521b86210536cef43dffc944a8
+  data.tar.gz: 3314266704ccb6db85feffdd93a104441565bf89f034295f0ce29d4d3f6783e5ccc134964a409c5885066852f27975c062773b77c6a126cc159dbaace3d8bde3

data/CHANGELOG.md

@@ -13,6 +13,23 @@ and this project will try its best to adhere to [Semantic Versioning](https://se
 
 ### Fixes
 
+## [0.5.1]
+
+### Changes
+
+* Update README to note that libpq-dev is a required dependency in order to build
+
+### Fixes
+
+* Remove `pry` from being required.
+
+## [0.5.0]
+
+### Additions
+
+* Restore database from local file(s)
+* Restore database from s3
+
 ## [0.4.0]
 
 ### Changes
@@ -91,7 +108,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.4.0...HEAD
+[Unreleased]: https://github.com/jayroh/pgchief/compare/v0.5.1...HEAD
+[0.5.1]: https://github.com/jayroh/pgchief/releases/tag/v0.5.1
+[0.5.0]: https://github.com/jayroh/pgchief/releases/tag/v0.5.0
 [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

data/README.md

@@ -24,6 +24,7 @@ below for the feature check-list and current progress.
 ## Usage
 
 ```sh
+# System dependency `libpq-dev` must be installed
 gem install pgchief
 
 # To initialize the config file at `~/.config/pgchief/config.toml`:
@@ -132,7 +133,7 @@ Give "rando-username" access to database(s):
 * [x] Display connection information
 * [x] Back up database locally
 * [x] Back up database to S3
-* [ ] Restore local database
-* [ ] Restore remote database @ S3
+* [x] Restore local database
+* [x] Restore remote database @ S3
 * [ ] Quickly back up via command line option
 * [ ] Quickly restore via command line option

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

@@ -19,7 +19,6 @@ module Pgchief
           acl: "private",
           content_type: "application/octet-stream"
         )
-        FileUtils.rm(local_location)
       end
 
       def s3_location

data/lib/pgchief/database/backups.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+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

@@ -2,7 +2,7 @@
 
 module Pgchief
   module Prompt
-    # Class to prompt for which database to drop
+    # Class to prompt for which database to backup
     class BackupDatabase < Base
       def call
         database = prompt.select("Which database needs backing up?", Pgchief::Database.all)

data/lib/pgchief/prompt/database_management.rb

@@ -10,7 +10,8 @@ module Pgchief
                                  "Create database",
                                  "Drop database",
                                  "Database List",
-                                 "Backup database"
+                                 "Backup database",
+                                 "Restore database"
                                ])
         scope = result == "Database List" ? "command" : "prompt"
 

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.4.0"
+  VERSION = "0.5.1"
 end

data/lib/pgchief.rb

@@ -11,18 +11,20 @@ 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"
@@ -33,6 +35,7 @@ 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgchief
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Joel Oliveira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2024-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -108,6 +108,7 @@ files:
 - 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
@@ -118,6 +119,7 @@ files:
 - 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
@@ -127,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