pgchief 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 756ccf173c3d0cbe56bb969e2f7d20e9032e1a7b1c600155e212548fa81f93bb
-  data.tar.gz: c00f369d5e6013bedb955daba82da8c54ad2a77c978b2ead411cae3ef0ca5f0f
+  metadata.gz: df59b4bbe15540e5d3b587f98c98ef71f2724f028299e88961766e2b6225ac2c
+  data.tar.gz: f5b0f578ac0c0610e2f020f740f207826a1f4cd05de16e27e5da7c1af860a408
 SHA512:
-  metadata.gz: 5ec3b0a81250bd7c8b479780ec658adf5a51f7f19db08c0447f1470ba4477cee24c7a00affec84ba5db0cf136a18e02de636e1d2f6701f0b6aa13d3ffee88afa
-  data.tar.gz: 828bf9aebb8235af34a0462f2d2890e5d51245e98841c97644a1d4411ba9147d5f9a1b594c2367f0dd34a96dff47f45201d0d312e8b862e90f27f83b5aad4514
+  metadata.gz: f2e9611feb5db3d76d8e13ca3b153d1a0a387c90faadd249590c115b94d696da5d0b4d5b712db6d7a739b8f9b933fea1f40f9e6dc102fb064098b6ff3b568f58
+  data.tar.gz: 863b4f71e694fb3e8ebde4d4b020d446d96a582a24b4e457d0d8cd42bc474780956d874a02944ea959ac689a3d33870374565871c19deea2bc31c750349aff8a

data/CHANGELOG.md

@@ -13,6 +13,35 @@ and this project will try its best to adhere to [Semantic Versioning](https://se
 
 ### Fixes
 
+## [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
+
+- The main database url will be accessed via the config class and will prioritize
+  the ENV over the config file, if it is set.
+
+### Fixes
+
+- Do not use the ENV only. Until now that was the only method and it was ignoring
+  what was set in the config file. This fixes the issue where nothing will work
+  if `ENV["DATABASE_URL"]` is not set.
+
 ## [0.3.0]
 
 ### Additions
@@ -62,7 +91,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

@@ -26,19 +26,22 @@ below for the feature check-list and current progress.
 ```sh
 gem install pgchief
 
-# To initialize the config file at `~/.pgchief.toml`:
+# To initialize the config file at `~/.config/pgchief/config.toml`:
 
 pgchief --init
 
-# make sure the DATABASE_URL is set to the connection string for a pg server's superuser
-export DATABASE_URL=postgresql://postgres:password@postgres.local:5432
+# edit the config file and set your main administrative connection string
+# (vim|nano|pico|ed) ~/.config/pgchief/config.toml
+
+# OR ... make sure the DATABASE_URL env is set to the connection string
+# export DATABASE_URL=postgresql://postgres:password@postgres.local:5432
 
 pgchief
 ```
 
 ## Config
 
-Format of `~/.pgchief.toml`
+Format of `~/.config/pgchief/config.toml`
 
 ```toml
 # Connection string to superuser account at your PG instance
@@ -127,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
+* [ ] Restore local database
+* [ ] 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

@@ -12,7 +12,9 @@ module Pgchief
 
       def initialize(*params)
         @params = params
-        @conn = PG.connect(Pgchief::DATABASE_URL)
+        @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_privileges_grant.rb

@@ -25,7 +25,7 @@ module Pgchief
       private
 
       def grant_privs! # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-        conn = PG.connect("#{Pgchief::DATABASE_URL}/#{database}")
+        conn = PG.connect("#{Pgchief::Config.pgurl}/#{database}")
         conn.exec("GRANT CONNECT ON DATABASE #{database} 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};")
@@ -50,7 +50,7 @@ module Pgchief
 
       def connection_string
         ConnectionString.new(
-          Pgchief::DATABASE_URL,
+          Pgchief::Config.pgurl,
           username: username,
           password: password,
           database: database

data/lib/pgchief/command/s3_upload.rb

@@ -0,0 +1,40 @@
+# 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"
+        )
+        FileUtils.rm(local_location)
+      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/command/user_create.rb

@@ -49,7 +49,7 @@ module Pgchief
 
       def connection_string
         ConnectionString.new(
-          Pgchief::DATABASE_URL,
+          Pgchief::Config.pgurl,
           username: username,
           password: password
         ).to_s

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,25 +7,63 @@ module Pgchief
   class Config
     class << self
       attr_accessor \
+        :s3_key,
+        :s3_secret,
+        :s3_region
+
+      attr_writer :pgurl
+
+      attr_reader \
+        :s3_path_prefix,
         :backup_dir,
-        :credentials_file,
-        :pgurl
+        :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
 
-      def load_config!(toml_file = "#{Dir.home}/.config/pgchief/config.toml")
-        config = TomlRB.load_file(toml_file, symbolize_keys: true)
+      def s3
+        @s3 ||= Pgchief::Config::S3.new(self)
+      end
+
+      def pgurl
+        ENV.fetch("DATABASE_URL", @pgurl)
+      end
 
-        @backup_dir = config[:backup_dir].gsub("~", Dir.home)
-        @credentials_file = config[:credentials_file]&.gsub("~", Dir.home)
-        @pgurl = config[:pgurl]
+      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.rb

@@ -6,7 +6,7 @@ module Pgchief
   # Database information and operations
   class Database
     def self.all
-      conn = PG.connect(Pgchief::DATABASE_URL)
+      conn = PG.connect(Pgchief::Config.pgurl)
       result = conn.exec("SELECT datname FROM pg_database WHERE datistemplate = false")
       result
         .map { |row| row["datname"] }

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 drop
+    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,13 @@ 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"
+                               ])
+        scope = result == "Database List" ? "command" : "prompt"
 
         klassify(scope, result).call
       end

data/lib/pgchief/user.rb

@@ -6,7 +6,7 @@ module Pgchief
   # Database information and operations
   class User
     def self.all
-      conn   = PG.connect(Pgchief::DATABASE_URL)
+      conn   = PG.connect(Pgchief::Config.pgurl)
       result = conn.exec("SELECT usename FROM pg_user")
 
       result.map { |row| row["usename"] }.reject { |name| name == "postgres" }

data/lib/pgchief/version.rb

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

data/lib/pgchief.rb

@@ -3,9 +3,11 @@
 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"
@@ -13,6 +15,7 @@ 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"
@@ -25,19 +28,19 @@ 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/retrieve_connection_string"
+require "pgchief/command/s3_upload"
 require "pgchief/command/store_connection_string"
 require "pgchief/command/user_create"
 require "pgchief/command/user_drop"
 require "pgchief/command/user_list"
 
 module Pgchief
-  DATABASE_URL = ENV.fetch("DATABASE_URL")
-
   class Error < StandardError; end
 
   module Errors

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pgchief
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Joel Oliveira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-11 00:00:00.000000000 Z
+date: 2024-11-27 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
@@ -79,7 +93,6 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -90,19 +103,23 @@ 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/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/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

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Joel Oliveira
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.