pgchief 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22c8374fdee4a24fde56bb1edd737694551b73288643b93078efa5f73c149a1b
-  data.tar.gz: bbebe5882166def3e96dc08804d695c4c2f9d629735173fbde82dcfcd70aaa1e
+  metadata.gz: 8c695989f5431e21f2c33b016b34a7197fb5cca9ea62592391fab10fcdbfe385
+  data.tar.gz: 195ab95c85943e54d41455ae25b1458aa538d6bc4b6319685b609de7549504f9
 SHA512:
-  metadata.gz: 0fd0d65a33b1370a2dda33e4ecd06710b7140eefe911c4f3f9eadbe2bea81bd272a43b8bf013c472afa0cee035f785bd9336d8521b86210536cef43dffc944a8
-  data.tar.gz: 3314266704ccb6db85feffdd93a104441565bf89f034295f0ce29d4d3f6783e5ccc134964a409c5885066852f27975c062773b77c6a126cc159dbaace3d8bde3
+  metadata.gz: 352d1edab7569b64483b3abf178297cf2a213ff1c24dfdc40f39ecd8548a06acfffd650ae30a7284fba34368c15e7d58c09e9f3153e9cfc8657613fa01fe4da0
+  data.tar.gz: e6e5f42192398383a2b8bc481c6a2b5f37722eef72111a04e2250a84bd1ac4125a9e783123ea1b3d4d64d2c3721a177482b3c83fd1bc656cc4d9b564ac2af4fc

data/CHANGELOG.md

@@ -13,11 +13,40 @@ and this project will try its best to adhere to [Semantic Versioning](https://se
 
 ### Fixes
 
+## [0.5.3]
+
+### Additions
+
+* Add spec for database backup command class.
+* Add check on the resulting db dump file. Make sure it's > 0 bytes.
+
+### Changes
+
+* Allow created users the proper permissions to add PG extensions to a database.
+
+### Fixes
+
+* Fix typo in backup command class description.
+* Fix backup command to use full database connection string to the database when
+  executing the pg_dump command.
+* Reset s3 config in db backup spec to prevent config leaks from other test runs.
+
+## [0.5.2]
+
+### Changes
+
+* Change S3 config option `s3_path_prefix` to `s3_objects_path`.
+* Above change retains backwards compatibility with the old `s3_path_prefix` option.
+
+### Fixes
+
+* Fix S3 regex to allow `-` in the path.
+
 ## [0.5.1]
 
 ### Changes
 
-* Update README to note that libpq-dev is a required dependency in order to build
+* Update README to note that libpq-dev is a required dependency in order to build.
 
 ### Fixes
 
@@ -27,14 +56,14 @@ and this project will try its best to adhere to [Semantic Versioning](https://se
 
 ### Additions
 
-* Restore database from local file(s)
-* Restore database from s3
+* Restore database from local file(s).
+* Restore database from s3.
 
 ## [0.4.0]
 
 ### Changes
 
-* Clean up the config object
+* Clean up the config object.
 
 ### Additions
 
@@ -43,7 +72,7 @@ and this project will try its best to adhere to [Semantic Versioning](https://se
 ### Fixes
 
 * Capture error where the config file does not exist and provide some guidance.
-* Make a `PG::ConnectionBad` error a little less scary(?)
+* 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]
@@ -63,24 +92,24 @@ and this project will try its best to adhere to [Semantic Versioning](https://se
 
 ### Additions
 
-- Refactor `exe/pgchief` to utilize `TTY::Option` for kicking off config initialization
-- `pgchief --init` now creates a toml config file in your `$HOME`
+- Refactor `exe/pgchief` to utilize `TTY::Option` for kicking off config initialization.
+- `pgchief --init` now creates a toml config file in your `$HOME`.
 - Added ability to store credentials if your config sets `credentials_file`
-  when db's and users are created
+  when db's and users are created.
 - Added `ConnectionString` class that abstracts the base db connection,
-  allowing for additions of users and db's
-- Load everything in the config file to the Config attributes
+  allowing for additions of users and db's.
+- Load everything in the config file to the Config attributes.
 
 ### Changes
 
-- Default location of config changed from `~/.pgchief.toml` to `~/.config/pgchief/config.toml`
-- Automatically require 'pry' in the test suite
+- Default location of config changed from `~/.pgchief.toml` to `~/.config/pgchief/config.toml`.
+- Automatically require 'pry' in the test suite.
 
 ### Fixes
 
 - When dropping user, ignore whenever a database has no privileges for the
-  selected user
-- Retroactive addition of tests to cover any regressions
+  selected user.
+- Retroactive addition of tests to cover any regressions.
 
 ## [0.2.0] - 2024-08-30
 
@@ -108,7 +137,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.5.1...HEAD
+[Unreleased]: https://github.com/jayroh/pgchief/compare/v0.5.3...HEAD
+[0.5.3]: https://github.com/jayroh/pgchief/releases/tag/v0.5.3
+[0.5.2]: https://github.com/jayroh/pgchief/releases/tag/v0.5.2
 [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

data/README.md

@@ -137,3 +137,5 @@ Give "rando-username" access to database(s):
 * [x] Restore remote database @ S3
 * [ ] Quickly back up via command line option
 * [ ] Quickly restore via command line option
+* [ ] Task for inclusion in a Rakefile
+* [ ] Support environment variables in config

data/config/pgchief.toml

@@ -13,4 +13,4 @@ backup_dir = "~/.config/pgchief/backups"
 # s3_key = ""
 # s3_secret = ""
 # s3_region = "us-east-1"
-# s3_path_prefix = "s3://bucket-name/database-backups/"
+# s3_objects_path = "s3://bucket-name/database-backups/"

data/lib/pgchief/command/database_backup.rb

@@ -4,7 +4,7 @@ require "forwardable"
 
 module Pgchief
   module Command
-    # Command object to drop a database
+    # Command object to back up a database
     class DatabaseBackup < Base
       extend Forwardable
 
@@ -12,12 +12,17 @@ module Pgchief
 
       attr_reader :database
 
-      def call
+      def initialize(*params)
+        super
         @database = params.first
         @uploader = Pgchief::Command::S3Upload.new(local_location)
+      end
+
+      def call
         raise Pgchief::Errors::DatabaseMissingError unless db_exists?
 
         backup!
+        check_backup!
         upload! if configured?
 
         "Database '#{database}' backed up to #{location}"
@@ -30,7 +35,11 @@ module Pgchief
       private
 
       def backup!
-        `pg_dump -Fc #{database} -f #{local_location}`
+        `pg_dump -Fc #{Pgchief::Config.pgurl}/#{database} -f #{local_location}`
+      end
+
+      def check_backup!
+        raise Pgchief::Errors::BackupError, "Backup file has 0 bytes" unless File.size?(local_location)
       end
 
       def db_exists?

data/lib/pgchief/command/database_privileges_grant.rb

@@ -27,6 +27,9 @@ module Pgchief
       def grant_privs! # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         conn = PG.connect("#{Pgchief::Config.pgurl}/#{database}")
         conn.exec("GRANT CONNECT ON DATABASE #{database} TO #{username};")
+        conn.exec("GRANT CREATE ON DATABASE #{database} TO #{username};")
+        conn.exec("GRANT USAGE ON SCHEMA pg_catalog TO #{username};")
+        conn.exec("GRANT CREATE ON SCHEMA pg_catalog TO #{username};")
         conn.exec("GRANT CREATE ON SCHEMA public TO #{username};")
         conn.exec("GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA public TO #{username};")
         conn.exec("GRANT USAGE ON SCHEMA public TO #{username};")

data/lib/pgchief/config/s3.rb

@@ -13,9 +13,9 @@ module Pgchief
         :s3_key,
         :s3_secret,
         :s3_region,
-        :s3_path_prefix
+        :s3_objects_path
 
-      PREFIX_REGEX = %r{\As3://(?<bucket>(\w|-)*)/(?<path>(\w|/)*/)\z}
+      PREFIX_REGEX = %r{\As3://(?<bucket>(\w|-)*)/(?<path>(\w|/|-)*/)\z}
 
       attr_reader :config
 
@@ -44,14 +44,14 @@ module Pgchief
           s3_key,
           s3_secret,
           s3_region,
-          s3_path_prefix
+          s3_objects_path
         ].none?(&:nil?)
       end
 
       private
 
       def s3_match
-        @s3_match ||= s3_path_prefix.match(PREFIX_REGEX)
+        @s3_match ||= s3_objects_path.match(PREFIX_REGEX)
       end
     end
   end

data/lib/pgchief/config.rb

@@ -14,7 +14,7 @@ module Pgchief
       attr_writer :pgurl
 
       attr_reader \
-        :s3_path_prefix,
+        :s3_objects_path,
         :backup_dir,
         :credentials_file
 
@@ -26,7 +26,7 @@ module Pgchief
         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]
+        self.s3_objects_path  = config[:s3_objects_path] || config[:s3_path_prefix]
       rescue Errno::ENOENT
         puts config_missing_error(toml_file)
       end
@@ -43,8 +43,8 @@ module Pgchief
         @backup_dir = value ? "#{value.chomp("/")}/".gsub("~", Dir.home) : "/tmp/"
       end
 
-      def s3_path_prefix=(value)
-        @s3_path_prefix = value ? "#{value.chomp("/")}/" : nil
+      def s3_objects_path=(value)
+        @s3_objects_path = value ? "#{value.chomp("/")}/" : nil
       end
 
       def credentials_file=(value)

data/lib/pgchief/version.rb

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

data/lib/pgchief.rb

@@ -50,5 +50,6 @@ module Pgchief
     class UserExistsError < Error; end
     class DatabaseExistsError < Error; end
     class DatabaseMissingError < Error; end
+    class BackupError < Error; end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgchief
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.3
 platform: ruby
 authors:
 - Joel Oliveira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-28 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: A simple ruby script to manage postgresql databases and users