pgchief 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72ba9fb5a28f3128a49fa7944b30154be2de8b785a24295bae9c3b4544c29c3d
-  data.tar.gz: b049ed99e5365e1fd78d727947950aa99e3e5426d9aa76bb4fd77ffdea091d73
+  metadata.gz: dac74bd646caf6b54ac884174ea91654af3733a4a638b45cf7e690c501c0534a
+  data.tar.gz: b0be173c4090cda9a176f25434318f805f6892324e8b7a148db6ee93a09e24c5
 SHA512:
-  metadata.gz: b8cfe8f92033c986892e551b8cdc6ff1f7847ed91010ec38ffdd73d2283000b02ae70b9669a79eb4509d5c69c2449fd8f8891d2a5d7a75ccf2372ab141f83087
-  data.tar.gz: d8ee3dadb057da4338ab8467040f286c4de2f4383a62a162204de8a686da42734aab4ccfe7e768dc53ef94962b432c3e4be8269129f2ce10bde727bd31129318
+  metadata.gz: 57135dde1c56aee8a082a36f03b440470a74549bd21ae970167ca5e4c02da91ed254ecf2a670818a712cdd6ad615372cd9a75229ff3f20c61f8ade718f0bf0a0
+  data.tar.gz: 2a70cc3718d84daba51d552c5d7a3ae144567bdb660db57fc4f890ff13ff3b154996f0ae5cae15212e3a433d01e8f2188cb1e62064cd364c51e7c9c0705d4671

data/CHANGELOG.md

@@ -1,6 +1,26 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project will try its best to adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
 ## [Unreleased]
 
-## [0.1.0] - 2024-07-20
+### 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.
+- Or grant privileges for existing users to database(s).
+
+### 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.
+
+## [0.1.0] - 2024-08-30
 
 - Initial release
 - Create database ✅
@@ -8,3 +28,6 @@
 - Drop database ✅
 - Drop user ✅
 - List databases ✅
+
+[Unreleased]: https://github.com/jayroh/pgchief/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/jayroh/pgchief/releases/tag/v0.1.0

data/README.md

@@ -32,6 +32,11 @@ export DATABASE_URL=postgresql://postgres:password@postgres.local:5432
 pgchief
 ```
 
+Note:
+
+1. Prompts accept both `↑` and `↓` arrows, as well as `j` and `k`.
+2. Pressing the `esc` key at any point amidst a prompt will exit out of the program.
+
 ## Development of the gem
 
 1. Clone this repo.
@@ -106,7 +111,8 @@ backup_dir = "~/.pg_backups"
 - [x] Drop database
 - [x] Drop user
 - [x] List databases
-- [ ] Give user permissions to use database
+- [x] Give user permissions to use database
+- [ ] Initialize toml file
 - [ ] Back up database
 - [ ] Restore database
-- [ ] Initialize toml file
+- [ ] Display connection information

data/lib/pgchief/command/database_create.rb

@@ -11,6 +11,7 @@ module Pgchief
         raise Pgchief::Errors::DatabaseExistsError if db_exists?
 
         conn.exec("CREATE DATABASE #{database}")
+        conn.exec("REVOKE CONNECT ON DATABASE #{database} FROM PUBLIC")
 
         "Database '#{database}' created successfully!"
       rescue PG::Error => e

data/lib/pgchief/command/database_privileges_grant.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pgchief
+  module Command
+    # Class to grant database privileges
+    class DatabasePrivilegesGrant < Base
+      def call
+        username = params.first
+        databases = params.last
+
+        databases.each do |database|
+          conn.exec("GRANT CONNECT ON DATABASE #{database} TO #{username};")
+        end
+
+        "Privileges granted to #{username} on #{databases.join(", ")}"
+      rescue PG::Error => e
+        "Error: #{e.message}"
+      ensure
+        conn.close
+      end
+    end
+  end
+end

data/lib/pgchief/command/user_drop.rb

@@ -10,7 +10,8 @@ module Pgchief
         @username = params.first
         raise Pgchief::Errors::UserExistsError unless user_exists?
 
-        conn.exec("DROP USER #{username}")
+        revoke_all_privileges
+        drop_user
 
         "User '#{username}' dropped successfully!"
       rescue PG::Error => e
@@ -19,10 +20,35 @@ module Pgchief
         conn.close
       end
 
+      private
+
       def user_exists?
         query = "SELECT 1 FROM pg_user WHERE usename = '#{username}'"
         conn.exec(query).any?
       end
+
+      def revoke_all_privileges
+        databases_with_access.each do |database|
+          conn.exec("REVOKE ALL PRIVILEGES ON DATABASE #{database} FROM #{username};")
+        end
+      end
+
+      def drop_user
+        conn.exec("DROP USER #{username}")
+      end
+
+      def databases_with_access
+        @databases_with_access ||= begin
+          results = conn.exec <<~SQL
+            SELECT datname
+            FROM pg_database
+            WHERE has_database_privilege('#{username}', datname, 'CONNECT')
+              AND datname NOT IN ('postgres', 'template1', 'template0')
+          SQL
+
+          results.map { |row| row["datname"] }
+        end
+      end
     end
   end
 end

data/lib/pgchief/prompt/base.rb

@@ -4,16 +4,45 @@ module Pgchief
   module Prompt
     # Base class for prompt classes
     class Base
-      def self.class
-        raise "Method not defined"
+      def self.call(*params)
+        new(*params).call
       end
 
-      def self.klassify(scope, words)
+      attr_reader :params
+
+      def initialize(*params)
+        @params = params
+      end
+
+      def call
+        raise NotImplementedError
+      end
+
+      def klassify(scope, words)
         Object.const_get([
           "Pgchief", "::", scope.capitalize, "::",
           words.split.map(&:capitalize)
         ].flatten.join)
       end
+
+      def yes_or_no(question, yes: nil, no: nil) # rubocop:disable Naming/MethodParameterName
+        response = prompt.yes?(question)
+        response ? yes&.call : no&.call
+      end
+
+      def prompt
+        @prompt ||= TTY::Prompt.new.tap do |p|
+          p.on(:keypress) do |event|
+            p.trigger(:keydown) if event.value == "j"
+            p.trigger(:keyup) if event.value == "k"
+          end
+
+          p.on(:keyescape) do
+            p.say "\n\nExiting...bye-bye 👋\n\n"
+            exit
+          end
+        end
+      end
     end
   end
 end

data/lib/pgchief/prompt/create_database.rb

@@ -4,8 +4,7 @@ module Pgchief
   module Prompt
     # Class to ask for database name, in order to create it
     class CreateDatabase < Base
-      def self.call
-        prompt   = TTY::Prompt.new
+      def call
         database = prompt.ask("Database name:")
         result   = Pgchief::Command::DatabaseCreate.call(database)
 

data/lib/pgchief/prompt/create_user.rb

@@ -4,13 +4,17 @@ module Pgchief
   module Prompt
     # Class to prompt for user creation details
     class CreateUser < Base
-      def self.call
-        prompt   = TTY::Prompt.new
+      def call
         username = prompt.ask("Username:")
         password = prompt.mask("Password:")
         result   = Pgchief::Command::UserCreate.call(username, password)
 
         prompt.say result
+
+        yes_or_no(
+          "Give \"#{username}\" access to database(s)?",
+          yes: -> { Pgchief::Prompt::GrantDatabasePrivileges.call(username) }
+        )
       end
     end
   end

data/lib/pgchief/prompt/database_management.rb

@@ -4,7 +4,7 @@ module Pgchief
   module Prompt
     # Class to manage database operations
     class DatabaseManagement < Base
-      def self.call
+      def call
         prompt = TTY::Prompt.new
         result = prompt.select("Database management", ["Create database", "Drop database", "Database List"])
         scope  = result == "Database List" ? "command" : "prompt"

data/lib/pgchief/prompt/drop_database.rb

@@ -4,8 +4,7 @@ module Pgchief
   module Prompt
     # Class to prompt for which database to drop
     class DropDatabase < Base
-      def self.call
-        prompt   = TTY::Prompt.new
+      def call
         database = prompt.select("Which database needs to be dropped?", Pgchief::Database.all)
         result   = Pgchief::Command::DatabaseDrop.call(database)
 

data/lib/pgchief/prompt/drop_user.rb

@@ -4,8 +4,7 @@ module Pgchief
   module Prompt
     # Class to prompt for which user to drop
     class DropUser < Base
-      def self.call
-        prompt = TTY::Prompt.new
+      def call
         user   = prompt.select("Which user needs to be deleted?", Pgchief::User.all)
         result = Pgchief::Command::UserDrop.call(user)
 

data/lib/pgchief/prompt/grant_database_privileges.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pgchief
+  module Prompt
+    # 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)
+
+        prompt.say result
+      end
+
+      def select_user
+        prompt.select("Select user to update:", Pgchief::User.all)
+      end
+    end
+  end
+end

data/lib/pgchief/prompt/start.rb

@@ -4,8 +4,7 @@ module Pgchief
   module Prompt
     # Kicks off the CLI with an initial prompt
     class Start < Base
-      def self.call
-        prompt = TTY::Prompt.new
+      def call
         result = prompt.select(
           "Welcome! How can I help?",
           [

data/lib/pgchief/prompt/user_management.rb

@@ -4,9 +4,13 @@ module Pgchief
   module Prompt
     # Class to manage users
     class UserManagement < Base
-      def self.call
-        prompt = TTY::Prompt.new
-        result = prompt.select("User management", ["Create user", "Drop user", "User list"])
+      def call
+        result = prompt.select("User management", [
+                                 "Create user",
+                                 "Drop user",
+                                 "User list",
+                                 "Grant database privileges"
+                               ])
 
         scope = result == "User list" ? "command" : "prompt"
         klassify(scope, result).call

data/lib/pgchief/version.rb

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

data/lib/pgchief.rb

@@ -14,11 +14,13 @@ 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/command/base"
 require "pgchief/command/database_create"
 require "pgchief/command/database_drop"
 require "pgchief/command/database_list"
+require "pgchief/command/database_privileges_grant"
 require "pgchief/command/user_create"
 require "pgchief/command/user_drop"
 require "pgchief/command/user_list"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgchief
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joel Oliveira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-30 00:00:00.000000000 Z
+date: 2024-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -90,6 +90,7 @@ files:
 - 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/user_create.rb
 - lib/pgchief/command/user_drop.rb
 - lib/pgchief/command/user_list.rb
@@ -101,7 +102,7 @@ files:
 - lib/pgchief/prompt/database_management.rb
 - lib/pgchief/prompt/drop_database.rb
 - lib/pgchief/prompt/drop_user.rb
-- lib/pgchief/prompt/grant_database_priveleges.rb
+- lib/pgchief/prompt/grant_database_privileges.rb
 - lib/pgchief/prompt/start.rb
 - lib/pgchief/prompt/user_management.rb
 - lib/pgchief/user.rb

data/lib/pgchief/prompt/grant_database_priveleges.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Pgchief
-  module Prompt
-    # Class to ask for database names, in order to create it
-    class GrantDatabasePrivileges
-      def self.call(username)
-        databases = Pgchief::Database.all
-        prompt = TTY::Prompt.new
-        databases = prompt.select("Select database:", databases, multiselect: true)
-        Pgchief::Command::GrantDatabasePrivileges.call(username, databases)
-      end
-    end
-  end
-end