pgchief 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dac74bd646caf6b54ac884174ea91654af3733a4a638b45cf7e690c501c0534a
-  data.tar.gz: b0be173c4090cda9a176f25434318f805f6892324e8b7a148db6ee93a09e24c5
+  metadata.gz: 756ccf173c3d0cbe56bb969e2f7d20e9032e1a7b1c600155e212548fa81f93bb
+  data.tar.gz: c00f369d5e6013bedb955daba82da8c54ad2a77c978b2ead411cae3ef0ca5f0f
 SHA512:
-  metadata.gz: 57135dde1c56aee8a082a36f03b440470a74549bd21ae970167ca5e4c02da91ed254ecf2a670818a712cdd6ad615372cd9a75229ff3f20c61f8ade718f0bf0a0
-  data.tar.gz: 2a70cc3718d84daba51d552c5d7a3ae144567bdb660db57fc4f890ff13ff3b154996f0ae5cae15212e3a433d01e8f2188cb1e62064cd364c51e7c9c0705d4671
+  metadata.gz: 5ec3b0a81250bd7c8b479780ec658adf5a51f7f19db08c0447f1470ba4477cee24c7a00affec84ba5db0cf136a18e02de636e1d2f6701f0b6aa13d3ffee88afa
+  data.tar.gz: 828bf9aebb8235af34a0462f2d2890e5d51245e98841c97644a1d4411ba9147d5f9a1b594c2367f0dd34a96dff47f45201d0d312e8b862e90f27f83b5aad4514

data/.rubocop.yml

@@ -18,5 +18,17 @@ Metrics/BlockLength:
     - 'spec/**/*'
     - '*.gemspec'
 
+Lint/MixedRegexpCaptureTypes:
+  Enabled: false
+
 RSpec/MultipleExpectations:
   Max: 5
+
+RSpec/ExampleLength:
+  Max: 20
+
+Lint/MissingSuper:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false

data/CHANGELOG.md

@@ -9,6 +9,37 @@ and this project will try its best to adhere to [Semantic Versioning](https://se
 
 ### Additions
 
+### Changes
+
+### Fixes
+
+## [0.3.0]
+
+### Additions
+
+- 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
+- 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
+
+### Changes
+
+- 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
+
+## [0.2.0] - 2024-08-30
+
+### Additions
+
 - Add `j` and `k` keys as substitutes for `↑` and `↓`.
 - Allow exiting the program with the `esc` key.
 - Add ability to grant access privileges for newly created users.
@@ -17,8 +48,10 @@ and this project will try its best to adhere to [Semantic Versioning](https://se
 ### Fixes
 
 - GitHub now running CI successfully.
-- Newly created databases are no longer open for connection by default. `CONNECT` is revoked by default for them.
-- When dropping users, loop through all the databases they have access to and revoke access before dropping them.
+- Newly created databases are no longer open for connection by default.
+  `CONNECT` is revoked by default for them.
+- When dropping users, loop through all the databases they have access to and
+  revoke access before dropping them.
 
 ## [0.1.0] - 2024-08-30
 
@@ -29,5 +62,7 @@ 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.1.0...HEAD
+[Unreleased]: https://github.com/jayroh/pgchief/compare/v0.3.0...HEAD
+[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

@@ -21,17 +21,38 @@ below for the feature check-list and current progress.
 
 ***
 
-## Usage:
+## Usage
 
-```
+```sh
 gem install pgchief
 
+# To initialize the config file at `~/.pgchief.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
 
 pgchief
 ```
 
+## Config
+
+Format of `~/.pgchief.toml`
+
+```toml
+# Connection string to superuser account at your PG instance
+pgurl = "postgresql://username:password@host:5432"
+
+# Directory where db backups will be placed
+backup_dir = "~/.pgchief/backups"
+
+# ** OPTIONAL **
+
+# Location of encrypted database connection strings
+# credentials_file = "~/.pgchief/credentials"
+```
+
 Note:
 
 1. Prompts accept both `↑` and `↓` arrows, as well as `j` and `k`.
@@ -43,13 +64,15 @@ Note:
 2. `bundle install`
 3. `cp .env.sample .env`
 4. Edit `.env` and change:
-  * `DATABASE_URL` to point to your main pg instance's superuser account with a connection string.
-  * `TEST_DATABASE_URL` to point to your local pg instance where tests can be run against.
+   * `DATABASE_URL` to point to your main pg instance's superuser account with a
+     connection string.
+   * `TEST_DATABASE_URL` to point to your local pg instance where tests can be
+     run against.
 5. `bundle exec rake` to run test suite & rubocop.
 
-## The ideal, aspirational, DX:
+## The ideal, aspirational, DX
 
-```
+```sh
 $ pgchief --init # create the TOML file in your home dir (w/600 permissions)
 $ pgchief
 
@@ -92,27 +115,17 @@ Give "rando-username" access to database(s):
 # ... etc.
 ```
 
-Format of `~/.pgchief.toml`
-
-```toml
-pgurl = "postgres://username:password@host:5432"
-backup_dir = "~/.pg_backups"
-
-# [optional] encryption key (to display hashed passwords)
-# encryption_key = "my-password"
-```
-
 ***
 
 ## Feature Roadmap
 
-- [x] Create database
-- [x] Create user
-- [x] Drop database
-- [x] Drop user
-- [x] List databases
-- [x] Give user permissions to use database
-- [ ] Initialize toml file
-- [ ] Back up database
-- [ ] Restore database
-- [ ] Display connection information
+* [x] Create database
+* [x] Create user
+* [x] Drop database
+* [x] Drop user
+* [x] List databases
+* [x] Give user permissions to use database
+* [x] Initialize toml file
+* [x] Display connection information
+* [ ] Back up database
+* [ ] Restore database

data/config/pgchief.toml

@@ -0,0 +1,10 @@
+# Connection string to superuser account at your PG instance
+pgurl = "postgresql://localhost:5432"
+
+# Directory where db backups will be placed
+backup_dir = "~/.config/pgchief/backups"
+
+# ** OPTIONAL **
+
+# Location of saved database connection strings
+# credentials_file = "~/.config/pgchief/credentials"

data/exe/pgchief

@@ -7,4 +7,6 @@ $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
 require "pgchief"
 
-Pgchief::Prompt::Start.call
+cli = Pgchief::Cli.new
+cli.parse(ARGV)
+cli.run

data/lib/pgchief/cli.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Pgchief
+  # Command line interface and option parsing
+  class Cli
+    include TTY::Option
+
+    option :init do
+      short "-i"
+      long "--init"
+      desc "Initialize the TOML configuration file"
+    end
+
+    def run
+      if params[:init]
+        Pgchief::Command::ConfigCreate.call
+      else
+        Pgchief::Prompt::Start.call
+      end
+    end
+  end
+end

data/lib/pgchief/command/base.rb

@@ -12,7 +12,7 @@ module Pgchief
 
       def initialize(*params)
         @params = params
-        @conn = PG.connect(ENV.fetch("DATABASE_URL"))
+        @conn = PG.connect(Pgchief::DATABASE_URL)
       end
 
       def call

data/lib/pgchief/command/config_create.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module Pgchief
+  module Command
+    # Create a configuration file at $HOME
+    class ConfigCreate < Base
+      def call(dir: "#{Dir.home}/.config/pgchief")
+        return if File.exist?("#{dir}/config.toml")
+
+        template = File.join(__dir__, "..", "..", "..", "config", "pgchief.toml")
+        FileUtils.mkdir_p(dir)
+        FileUtils.cp(template, "#{dir}/config.toml")
+
+        puts "Configuration file created at #{dir}/config.toml"
+      end
+    end
+  end
+end

data/lib/pgchief/command/database_privileges_grant.rb

@@ -4,19 +4,57 @@ module Pgchief
   module Command
     # Class to grant database privileges
     class DatabasePrivilegesGrant < Base
-      def call
-        username = params.first
-        databases = params.last
+      attr_reader :username, :password, :database
+
+      def initialize(*params)
+        @username = params[0]
+        @password = params[1]
+        @databases = params[2]
+      end
 
-        databases.each do |database|
-          conn.exec("GRANT CONNECT ON DATABASE #{database} TO #{username};")
+      def call
+        @databases.each do |database|
+          @database = database
+          grant_privs!
+          store_credentials!
         end
 
-        "Privileges granted to #{username} on #{databases.join(", ")}"
+        "Privileges granted to #{username} on #{@databases.join(", ")}"
+      end
+
+      private
+
+      def grant_privs! # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        conn = PG.connect("#{Pgchief::DATABASE_URL}/#{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};")
+        conn.exec("GRANT USAGE ON SCHEMA public TO #{username};")
+        conn.exec(
+          <<~SQL
+            ALTER DEFAULT PRIVILEGES IN SCHEMA public
+            GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES
+            TO #{username};
+          SQL
+        )
+        conn.close
       rescue PG::Error => e
         "Error: #{e.message}"
       ensure
-        conn.close
+        conn.finished? || conn.close
+      end
+
+      def store_credentials!
+        Pgchief::Command::StoreConnectionString.call(connection_string)
+      end
+
+      def connection_string
+        ConnectionString.new(
+          Pgchief::DATABASE_URL,
+          username: username,
+          password: password,
+          database: database
+        ).to_s
       end
     end
   end

data/lib/pgchief/command/retrieve_connection_string.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Pgchief
+  module Command
+    # Class to view database connection string
+    class RetrieveConnectionString < Base
+      attr_reader :username, :database
+
+      def initialize(username, database = nil)
+        @username = username
+        @database = database
+        @connection_string = nil
+      end
+
+      def call
+        File.foreach(Config.credentials_file) do |line|
+          @connection_string = line if regex.match?(line)
+        end
+
+        @connection_string.nil? ? "No connection string found" : @connection_string
+      end
+
+      private
+
+      def regex
+        if database
+          /#{username}.*#{database}$/
+        else
+          /#{username}.*\d$/
+        end
+      end
+    end
+  end
+end

data/lib/pgchief/command/store_connection_string.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pgchief
+  module Command
+    # Class to store connection string
+    class StoreConnectionString
+      def self.call(connection_string)
+        new(connection_string).call
+      end
+
+      attr_reader :connection_string
+
+      def initialize(connection_string)
+        @connection_string = connection_string
+      end
+
+      def call
+        File.open(Config.credentials_file, "a") do |file|
+          file.puts @connection_string
+        end
+      end
+    end
+  end
+end

data/lib/pgchief/command/user_create.rb

@@ -18,7 +18,8 @@ module Pgchief
         @username, @password = params
         raise Pgchief::Errors::UserExistsError if user_exists?
 
-        conn.exec("CREATE USER #{username} WITH #{user_options} PASSWORD '#{password}'")
+        create_user!
+        save_credentials!
 
         "User '#{username}' created successfully!"
       rescue PG::Error => e
@@ -34,9 +35,25 @@ module Pgchief
         conn.exec(query).any?
       end
 
+      def create_user!
+        conn.exec("CREATE USER #{username} WITH #{user_options} PASSWORD '#{password}'")
+      end
+
+      def save_credentials!
+        Pgchief::Command::StoreConnectionString.call(connection_string)
+      end
+
       def user_options
         USER_OPTIONS.join(" ")
       end
+
+      def connection_string
+        ConnectionString.new(
+          Pgchief::DATABASE_URL,
+          username: username,
+          password: password
+        ).to_s
+      end
     end
   end
 end

data/lib/pgchief/command/user_drop.rb

@@ -30,6 +30,8 @@ module Pgchief
       def revoke_all_privileges
         databases_with_access.each do |database|
           conn.exec("REVOKE ALL PRIVILEGES ON DATABASE #{database} FROM #{username};")
+        rescue PG::Error
+          next
         end
       end
 

data/lib/pgchief/config.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "toml-rb"
+
+module Pgchief
+  # Class to store configuration settings
+  class Config
+    class << self
+      attr_accessor \
+        :backup_dir,
+        :credentials_file,
+        :pgurl
+
+      def load_config!(toml_file = "#{Dir.home}/.config/pgchief/config.toml")
+        config = TomlRB.load_file(toml_file, symbolize_keys: true)
+
+        @backup_dir = config[:backup_dir].gsub("~", Dir.home)
+        @credentials_file = config[:credentials_file]&.gsub("~", Dir.home)
+        @pgurl = config[:pgurl]
+      end
+
+      def set_up_file_structure!
+        FileUtils.mkdir_p(backup_dir)
+
+        return unless credentials_file && !File.exist?(credentials_file)
+
+        FileUtils.touch(credentials_file)
+      end
+    end
+  end
+end

data/lib/pgchief/connection_string.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Pgchief
+  # Class to parse and manipulate connection strings
+  class ConnectionString
+    URL_REGEX = %r{(?x)\A
+      postgres(ql)?://
+      (?<username>[^:@]*)?
+      :?(?<password>[^@]*)?
+      @?(?<host>[^:]*)?
+      :?(?<port>\d+)?
+      /?(?<database>[^\?]*)?
+      \z}
+
+    attr_reader :database_url
+
+    def initialize(
+      database_url,
+      username: nil,
+      password: nil,
+      host: nil,
+      port: nil,
+      database: nil
+    )
+      @database_url = database_url
+      @host = host
+      @username = username
+      @password = password
+      @port = port
+      @database = database
+    end
+
+    def to_s
+      "postgresql://#{username}:#{password}@#{host}:#{port}/#{database}"
+    end
+
+    def host
+      @host || (matched[:username] if matched[:host].empty?) || matched[:host]
+    end
+
+    def username
+      @username || ("" if matched[:host].empty? && !matched[:username].empty?) || matched[:username] || ""
+    end
+
+    def password
+      @password || matched[:password] || ""
+    end
+
+    def port
+      @port || matched[:port] || "5432"
+    end
+
+    def database
+      @database || matched[:database] || ""
+    end
+
+    private
+
+    def matched
+      @matched ||= database_url.match(URL_REGEX) || {}
+    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(ENV.fetch("DATABASE_URL"))
+      conn = PG.connect(Pgchief::DATABASE_URL)
       result = conn.exec("SELECT datname FROM pg_database WHERE datistemplate = false")
       result
         .map { |row| row["datname"] }

data/lib/pgchief/prompt/create_user.rb

@@ -13,7 +13,7 @@ module Pgchief
 
         yes_or_no(
           "Give \"#{username}\" access to database(s)?",
-          yes: -> { Pgchief::Prompt::GrantDatabasePrivileges.call(username) }
+          yes: -> { Pgchief::Prompt::GrantDatabasePrivileges.call(username, password) }
         )
       end
     end

data/lib/pgchief/prompt/grant_database_privileges.rb

@@ -5,16 +5,22 @@ module Pgchief
     # Class to ask for database names, in order to create it
     class GrantDatabasePrivileges < Base
       def call
-        username  = params.first || select_user
-        databases = prompt.multi_select("Give \"#{username}\" access to database(s):", Pgchief::Database.all)
-        result    = Pgchief::Command::DatabasePrivilegesGrant.call(username, databases)
+        username  = params[0] || select_user
+        password  = params[1] || ask_for_password
+        databases = params[2] || prompt.multi_select("Give \"#{username}\" access to database(s):",
+                                                     Pgchief::Database.all)
 
+        result = Pgchief::Command::DatabasePrivilegesGrant.call(username, password, databases)
         prompt.say result
       end
 
       def select_user
         prompt.select("Select user to update:", Pgchief::User.all)
       end
+
+      def ask_for_password
+        prompt.mask("Password:")
+      end
     end
   end
 end

data/lib/pgchief/prompt/start.rb

@@ -5,6 +5,8 @@ module Pgchief
     # Kicks off the CLI with an initial prompt
     class Start < Base
       def call
+        manage_config!
+
         result = prompt.select(
           "Welcome! How can I help?",
           [
@@ -15,6 +17,13 @@ module Pgchief
 
         klassify("prompt", result).call
       end
+
+      private
+
+      def manage_config!
+        Pgchief::Config.load_config!
+        Pgchief::Config.set_up_file_structure!
+      end
     end
   end
 end

data/lib/pgchief/prompt/user_management.rb

@@ -9,7 +9,8 @@ module Pgchief
                                  "Create user",
                                  "Drop user",
                                  "User list",
-                                 "Grant database privileges"
+                                 "Grant database privileges",
+                                 "View database connection string"
                                ])
 
         scope = result == "User list" ? "command" : "prompt"

data/lib/pgchief/prompt/view_database_connection_string.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Pgchief
+  module Prompt
+    # Class to ask for database names, in order to create it
+    class ViewDatabaseConnectionString < Base
+      def call
+        username = params.first || select_user
+        database = prompt.select("Database you're connecting to:", Pgchief::Database.all + ["None"])
+        database = nil if database == "None"
+        result   = Pgchief::Command::RetrieveConnectionString.call(username, database)
+
+        prompt.say result
+      end
+
+      def select_user
+        prompt.select("Select user to update:", Pgchief::User.all)
+      end
+    end
+  end
+end

data/lib/pgchief/user.rb

@@ -6,7 +6,7 @@ module Pgchief
   # Database information and operations
   class User
     def self.all
-      conn   = PG.connect(ENV.fetch("DATABASE_URL"))
+      conn   = PG.connect(Pgchief::DATABASE_URL)
       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.2.0"
+  VERSION = "0.3.0"
 end

data/lib/pgchief.rb

@@ -2,10 +2,15 @@
 
 require "pg"
 require "tty-prompt"
-require "pgchief/version"
+require "tty-option"
 
+require "pgchief/cli"
+require "pgchief/config"
+require "pgchief/connection_string"
+require "pgchief/version"
 require "pgchief/database"
 require "pgchief/user"
+
 require "pgchief/prompt/base"
 require "pgchief/prompt/start"
 require "pgchief/prompt/create_database"
@@ -15,17 +20,24 @@ require "pgchief/prompt/drop_database"
 require "pgchief/prompt/drop_user"
 require "pgchief/prompt/user_management"
 require "pgchief/prompt/grant_database_privileges"
+require "pgchief/prompt/view_database_connection_string"
 
+require "pgchief/command"
 require "pgchief/command/base"
+require "pgchief/command/config_create"
 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/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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgchief
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Joel Oliveira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-31 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -83,17 +83,24 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- config/pgchief.toml
 - exe/pgchief
 - lib/pgchief.rb
+- lib/pgchief/cli.rb
 - lib/pgchief/command.rb
 - lib/pgchief/command/base.rb
+- lib/pgchief/command/config_create.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/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/connection_string.rb
 - lib/pgchief/database.rb
 - lib/pgchief/prompt.rb
 - lib/pgchief/prompt/base.rb
@@ -105,9 +112,11 @@ files:
 - lib/pgchief/prompt/grant_database_privileges.rb
 - lib/pgchief/prompt/start.rb
 - lib/pgchief/prompt/user_management.rb
+- lib/pgchief/prompt/view_database_connection_string.rb
 - lib/pgchief/user.rb
 - lib/pgchief/version.rb
 - sig/pgchief.rbs
+- tmp/.gitkeep
 homepage: https://github.com/jayroh/pgchief
 licenses:
 - MIT
@@ -131,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: A simple ruby script to manage postgresql databases and users