pgchief 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adccab6ee77468761bf0d05d12954f7b0360547b95f5295797b911ed80f731e2
-  data.tar.gz: 2a4ae39f43e0da9913f252e70e0583d0e21dd45e48931e94a62c309298d287f8
+  metadata.gz: 613ce14b91c64d69a6fa16449f8ea8aa2a3dfcab054684efaefe978eaae0f564
+  data.tar.gz: 7116499bc9a4ea6e30b850bbe07e953e7068b7c2b8c03b32daef87dde6fe0061
 SHA512:
-  metadata.gz: 7dea359e077b5c473c7df21e53067954dee0c426df76b8a375a026a3976593dbdd4024c6582650a2fbe1404a34affb1030fe0065842065ad594119cd3f757ace
-  data.tar.gz: 3b16494cea09736f6b2c16e55d2c5054898a6f023bf06b8862585313617104dc858e98750397baf6b606126aaf2f5bb109f9f02fbf11699b281bdeefd6c41c38
+  metadata.gz: 3725ab140a34f5e8c41fb13e9c737835a96ca440d2519ee377991921af672109321984e8d089813be6042af732642a4c94127da2d8873d1214f32c0073583299
+  data.tar.gz: f560244827039f3258151f2e8e573b5d4584847cd5ddccf84e085b00104f21b45fa77af1c6a85df54d8ee2ace45a5915d4240ef06ee24ae5714625072eb5ec46

data/CHANGELOG.md

@@ -13,18 +13,39 @@ and this project will try its best to adhere to [Semantic Versioning](https://se
 
 ### Fixes
 
+## [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.
+
+### Fixes
+
+* Remove `pry` from being required.
+
 ## [0.5.0]
 
 ### 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
 
@@ -33,7 +54,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]
@@ -53,24 +74,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
 
@@ -98,7 +119,10 @@ 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.2...HEAD
+[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
 [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`:
@@ -136,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/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/database/backups.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "forwardable"
-require "pry"
 
 module Pgchief
   class Database

data/lib/pgchief/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgchief
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Joel Oliveira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-28 00:00:00.000000000 Z
+date: 2024-12-17 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