pgai 0.2.4 → 1.0.0

data/lib/pgai/resources/remote/db_object.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+module Pgai
+  module Resources
+    module Remote
+      class DbObject < BaseRecord
+        attribute :username, :string, default: -> { SecureRandom.hex(8) }
+        attribute :password, :string, default: -> { SecureRandom.hex(16) }
+        attribute :restricted, :boolean, default: false
+        attribute :host, :string
+        attribute :port, :integer
+        attribute :db_name, :string
+        attribute :conn_str, :string
+
+        def refresh_attributes(data)
+          super(data.except(:username, :password))
+        end
+      end
+    end
+  end
+end

data/lib/pgai/resources/remote/snapshot.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Pgai
+  module Resources
+    module Remote
+      class Snapshot < BaseRecord
+        attribute :id, :string
+        attribute :created_at, :datetime
+        attribute :data_state_at, :datetime
+        attribute :physical_size, :integer
+        attribute :logical_size, :integer
+        attribute :pool, :string
+        attribute :num_clones, :integer
+
+        class << self
+          def all
+            client.get(path).map { new(_1) }
+          end
+
+          def latest
+            all.max_by(&:created_at)
+          end
+
+          def path
+            "snapshots"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pgai/store.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "pstore"
+require "fileutils"
+
+module Pgai
+  class Store
+    STORE_PATH = "~/.config/pgai/config.pstore"
+
+    def all(record_type)
+      store.transaction(true) do
+        store[record_type]&.values || {}
+      end
+    end
+
+    def find(record_type, id)
+      store.transaction(true) do
+        (store[record_type] || {})[id]
+      end
+    end
+
+    def delete(record_type, id)
+      store.transaction do
+        store[record_type] ||= {}
+        store[record_type] = store[record_type].except(id)
+      end
+    end
+
+    def save(record_type, attributes, key: :id)
+      store.transaction do
+        store[record_type] ||= {}
+        store[record_type].merge!(attributes[key] => attributes)
+      end
+    end
+
+    private
+
+    def store
+      @store ||= PStore.new(store_path)
+    end
+
+    def store_path
+      @store_path ||= Pathname(STORE_PATH).expand_path.tap do |path|
+        FileUtils.mkdir_p File.dirname(path)
+      end
+    end
+  end
+end

data/lib/pgai/version.rb

@@ -1,3 +1,3 @@
 module Pgai
-  VERSION = "0.2.4"
+  VERSION = "1.0.0"
 end

data/lib/pgai.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "pgai/version"
-require_relative "pgai/config"
-require_relative "pgai/dblab"
-require_relative "pgai/port_forward"
-require_relative "pgai/clone_manager"
-require_relative "pgai/cli/base"
-require_relative "pgai/cli/env"
-require_relative "pgai/cli/main"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
 
 module Pgai
   class Error < StandardError; end
 
-  class CloneNotFount < Error; end
+  class ResourceNotFound < Error; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgai
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Marius Bobin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-29 00:00:00.000000000 Z
+date: 2024-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -30,6 +30,148 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.13
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.109.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.109.0
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.1
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+- !ruby/object:Gem::Dependency
+  name: tty-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +214,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
 description:
 email:
 - mbobin@gitlab.com
@@ -87,10 +243,27 @@ files:
 - lib/pgai/cli/base.rb
 - lib/pgai/cli/env.rb
 - lib/pgai/cli/main.rb
+- lib/pgai/client.rb
 - lib/pgai/clone_manager.rb
-- lib/pgai/config.rb
-- lib/pgai/dblab.rb
-- lib/pgai/port_forward.rb
+- lib/pgai/commander.rb
+- lib/pgai/create_clone_service.rb
+- lib/pgai/external_command_manager.rb
+- lib/pgai/port/allocator.rb
+- lib/pgai/port/forwarder.rb
+- lib/pgai/port/manager.rb
+- lib/pgai/psql_manager.rb
+- lib/pgai/resources/attributes.rb
+- lib/pgai/resources/local/base_record.rb
+- lib/pgai/resources/local/clone.rb
+- lib/pgai/resources/local/configuration.rb
+- lib/pgai/resources/local/environment.rb
+- lib/pgai/resources/remote/base_record.rb
+- lib/pgai/resources/remote/clone.rb
+- lib/pgai/resources/remote/clone_metadata.rb
+- lib/pgai/resources/remote/clone_status.rb
+- lib/pgai/resources/remote/db_object.rb
+- lib/pgai/resources/remote/snapshot.rb
+- lib/pgai/store.rb
 - lib/pgai/version.rb
 homepage: https://gitlab.com/mbobin/pgai
 licenses:
@@ -111,7 +284,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.11
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: CLI wrapper for postgres.ai thin clones

data/lib/pgai/config.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-require "pstore"
-require "fileutils"
-
-module Pgai
-  class Config
-    Clone = Struct.new(:host, :port, :password, :user, :dbname, :created_at, :data_state_at, keyword_init: true) do
-      def connection_string
-        "'host=#{host} port=#{port} user=#{user} dbname=#{dbname} password=#{password}'"
-      end
-
-      def database_url
-        "postgresql://#{user}:#{password}@#{host}:#{port}/#{dbname}"
-      end
-    end
-
-    attr_accessor :clone_prefix
-    attr_accessor :dbname
-    attr_accessor :access_token
-    attr_accessor :proxy
-    attr_accessor :path
-
-    def self.load
-      new { |config| config.load_from_store }
-    end
-
-    def self.persist(data)
-      new { |config| config.write(data) }
-    end
-
-    def initialize
-      yield self if block_given?
-    end
-
-    def load_from_store
-      store.transaction(true) do
-        self.clone_prefix = store[:clone_prefix]
-        self.dbname = store[:dbname]
-        self.access_token = store[:access_token]
-        self.proxy = store[:proxy]
-        self.path = store[:path]
-      end
-    end
-
-    def write(options)
-      store.transaction do
-        store[:clone_prefix] = options[:prefix]
-        store[:dbname] = options[:dbname]
-        store[:access_token] = options[:token]
-        store[:proxy] = options[:proxy]
-        store[:path] = options[:path]
-        store[:clones] = {}
-      end
-    end
-
-    def find_clone(id)
-      store.transaction(true) do
-        clones = store[:clones] || {}
-
-        Clone.new(clones[id]) if clones[id]
-      end
-    end
-
-    def remove_clone(id)
-      store.transaction do
-        store[:clones] ||= {}
-        store[:clones] = store[:clones].except(id)
-      end
-    end
-
-    def persist_clone(id, attributes = {})
-      store.transaction do
-        store[:clones] ||= {}
-        store[:clones].merge!(id => attributes)
-      end
-
-      Clone.new(attributes)
-    end
-
-    def add_env(options = {})
-      store.transaction do
-        store[:environments] ||= {}
-        store[:environments].merge!(options[:alias] => options)
-      end
-    end
-
-    def remove_env(env_alias)
-      store.transaction do
-        store[:environments] ||= {}
-        store[:environments] = store[:environments].except(env_alias)
-      end
-    end
-
-    def enviroments
-      store.transaction(true) do
-        store[:environments] || {}
-      end
-    end
-
-    private
-
-    def store
-      @store ||= PStore.new(store_path)
-    end
-
-    def store_path
-      @store_path ||= Pathname("~/.config/pgai/config.pstore").expand_path.tap do |path|
-        FileUtils.mkdir_p File.dirname(path)
-      end
-    end
-  end
-end

data/lib/pgai/dblab.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-require "shellwords"
-require "json"
-require "net/http"
-require "pathname"
-require "fileutils"
-
-module Pgai
-  class Dblab
-    DEFAULT_DBLAB = Pathname.new("~/.dblab/dblab").expand_path
-    DBLAB_RELEASE_CHANNEL = "master"
-    DBLAB_BINARY_URL = "https://storage.googleapis.com/database-lab-cli/#{DBLAB_RELEASE_CHANNEL}/dblab-%{os}-%{cpu}"
-
-    def initialize(config:, hostname:)
-      @config = config
-      @hostname = hostname
-    end
-
-    def configure_env(port:, token:, id:)
-      dblab("init", "--url", "http://#{hostname}:#{port}", "--token", token, "--environment-id", id, silence: true, raw: true)
-      dblab("config", "switch", id, raw: true)
-    end
-
-    def list_clones
-      Array(dblab("clone", "list"))
-    end
-
-    def create_clone(id:, user:, password:)
-      data = dblab("clone", "create", "--id", id, "--username", user, "--password", password)
-      raise "Could not create clone" unless data
-
-      data
-    end
-
-    def destroy_clone(id:)
-      dblab("clone", "destroy", id, raw: true)
-    end
-
-    def reset_clone(id:)
-      dblab("clone", "reset", id, raw: true)
-    end
-
-    private
-
-    attr_reader :config, :hostname
-
-    def dblab(*args, raw: false, silence: false)
-      redirect = "2>/dev/null" if silence
-
-      output = `#{args.unshift(dblab_path).shelljoin} #{redirect}`
-      return output if raw
-
-      JSON.parse(output) unless output.empty?
-    end
-
-    def dblab_path
-      return config.path unless config.path.to_s.empty?
-      return "dblab" unless `which dblab`.to_s.empty?
-      return DEFAULT_DBLAB.to_s if DEFAULT_DBLAB.exist?
-
-      download_dblab_to(DEFAULT_DBLAB)
-      File.chmod(0o755, DEFAULT_DBLAB)
-
-      DEFAULT_DBLAB
-    end
-
-    def download_dblab_to(location)
-      uri = URI(DBLAB_BINARY_URL % {os: platform.os, cpu: cpu_platform})
-
-      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request Net::HTTP::Get.new(uri) do |response|
-          FileUtils.mkdir_p File.dirname(location)
-          File.open(location, "w") do |io|
-            response.read_body { |chunk| io.write chunk }
-          end
-        end
-      end
-    end
-
-    def platform
-      Gem::Platform.local
-    end
-
-    def cpu_platform
-      cpu = platform.cpu
-      return "arm64" if cpu == "aarch64"
-      cpu
-    end
-  end
-end

data/lib/pgai/port_forward.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require "shellwords"
-require "socket"
-
-module Pgai
-  class PortForward
-    def initialize(config:, hostname:)
-      @config = config
-      @hostname = hostname
-    end
-
-    def start(port)
-      return if ready?(port)
-
-      system("ssh -fNTML #{port.to_i}:#{escape hostname}:#{port.to_i} #{escape config.proxy}")
-      wait_until_ready(port)
-    end
-
-    def stop(port = nil)
-      port_forward_pids(port).each do |pid|
-        Process.kill("HUP", pid.to_i)
-      end
-    end
-
-    def conditionally_stop(port, ignored_pids = [])
-      pids = lsof(port, ignored_pids + [Process.pid])
-      pf_pids = port_forward_pids(port)
-
-      stop(port) if (pids - pf_pids).empty?
-    end
-
-    private
-
-    attr_reader :config, :hostname
-
-    def ready?(port)
-      !!TCPSocket.new(hostname, port)
-    rescue Errno::ECONNREFUSED
-      false
-    end
-
-    def wait_until_ready(port)
-      until ready?(port)
-        sleep 0.02
-      end
-    end
-
-    def port_forward_pids(port_filter = nil)
-      ssh_filter = escape "ssh -fNTML #{port_filter&.to_i}".strip
-      host_filter = escape config.proxy
-
-      `ps ax | grep #{ssh_filter} | grep #{host_filter} | grep -v grep | awk '{ print $1 }'`.split.map(&:to_i)
-    end
-
-    def lsof(port, exclude_pids = [])
-      ignored_pids = exclude_pids.map { |pid| "-p^#{pid.to_i}" }.join(" ")
-
-      `lsof -i:#{port.to_i} #{ignored_pids} -t`.split.map(&:to_i)
-    end
-
-    def escape(...)
-      Shellwords.escape(...)
-    end
-  end
-end