kitsune-kit 0.4.0 → 0.5.0

data/lib/kitsune/kit/workflows/support_bundle.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "json"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "time"
+
+module Kitsune
+  module Kit
+    module Workflows
+      class SupportBundle
+        MAX_LOG_FILES = 5
+        MAX_LOG_LINES = 500
+
+        def initialize(root:, config:, state_store:, doctor:, secret_filter: SecretFilter.new,
+                       clock: -> { Time.now.utc })
+          @root = Pathname(root).expand_path
+          @config = config
+          @state_store = state_store
+          @doctor = doctor
+          @secret_filter = secret_filter
+          @clock = clock
+        end
+
+        def call
+          directory = root.join(".kitsune/support")
+          FileUtils.mkdir_p(directory, mode: 0o700)
+          path = directory.join("#{clock.call.strftime('%Y%m%dT%H%M%S')}-#{SecureRandom.hex(4)}.json")
+          path.write(JSON.pretty_generate(secret_filter.filter(payload)) << "\n")
+          File.chmod(0o600, path)
+          path.to_s
+        end
+
+        private
+
+        attr_reader :root, :config, :state_store, :doctor, :secret_filter, :clock
+
+        def payload
+          {
+            schema_version: 1,
+            generated_at: clock.call.iso8601(6),
+            kitsune_version: VERSION,
+            ruby: { version: RUBY_VERSION, platform: RUBY_PLATFORM, host_os: RbConfig::CONFIG["host_os"] },
+            configuration: serialize(config),
+            state: state_store.read(config.environment),
+            doctor: doctor.call.value.map(&:to_h),
+            logs: selected_logs
+          }
+        end
+
+        def selected_logs
+          directory = root.join(".kitsune/logs")
+          return [] unless directory.directory?
+
+          directory.glob("*.jsonl").sort_by(&:mtime).last(MAX_LOG_FILES).map do |path|
+            { file: path.basename.to_s, events: read_log(path) }
+          end
+        end
+
+        def read_log(path)
+          path.readlines.last(MAX_LOG_LINES).filter_map do |line|
+            JSON.parse(line)
+          rescue JSON::ParserError
+            { "type" => "invalid_log_line", "message" => "A local log line could not be parsed." }
+          end
+        rescue SystemCallError => e
+          [{ "type" => "log_read_error", "message" => e.class.name }]
+        end
+
+        def serialize(value)
+          return value.members.to_h { |member| [member, serialize(value.public_send(member))] } if value.is_a?(Data)
+          return value.to_h { |key, item| [key, serialize(item)] } if value.is_a?(Hash)
+          return value.map { |item| serialize(item) } if value.is_a?(Array)
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/kitsune/kit.rb

@@ -1,10 +1,49 @@
 # frozen_string_literal: true
 
 require_relative "kit/version"
+require_relative "kit/errors"
+require_relative "kit/events"
+require_relative "kit/result"
+require_relative "kit/plan"
+require_relative "kit/secret_filter"
+require_relative "kit/secret_store"
+require_relative "kit/clock"
+require_relative "kit/cancellation"
+require_relative "kit/run_logger"
+require_relative "kit/run_journal"
+require_relative "kit/service_compose"
+require_relative "kit/configuration"
+require_relative "kit/state_store"
+require_relative "kit/adapters/fake_state_store"
+require_relative "kit/adapters/fake_reporter"
+require_relative "kit/adapters/fake_secret_store"
+require_relative "kit/adapters/fake_clock"
+require_relative "kit/application"
+require_relative "kit/operations/ensure_dns_records"
+require_relative "kit/operations/remote_script"
+require_relative "kit/operations/ensure_service"
+require_relative "kit/reporters/human"
+require_relative "kit/reporters/json"
+require_relative "kit/workflows/build_plan"
+require_relative "kit/workflows/apply_plan"
+require_relative "kit/workflows/doctor"
+require_relative "kit/workflows/initialize_project"
+require_relative "kit/workflows/inspect_environment"
+require_relative "kit/workflows/rollback"
+require_relative "kit/workflows/destroy_server"
+require_relative "kit/workflows/import_server"
+require_relative "kit/workflows/environment_selection"
+require_relative "kit/workflows/support_bundle"
+require_relative "kit/tui/state"
+require_relative "kit/tui/store"
+require_relative "kit/tui/renderer"
+require_relative "kit/tui/terminal"
+require_relative "kit/tui/actions"
+require_relative "kit/tui/controller"
+require_relative "kit/tui/application"
 
 module Kitsune
   module Kit
-    class Error < StandardError; end
-    # Your code goes here...
+    Error = Errors::Error
   end
 end

metadata

@@ -1,43 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: kitsune-kit
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Omar Herrera
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: net-ssh
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.2'
-- !ruby/object:Gem::Dependency
-  name: ed25519
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +38,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: droplet_kit
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.17'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: ed25519
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -95,64 +80,63 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
+        version: '7.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
-  name: pry-stack_explorer
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
+        version: '0.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: public_suffix
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
+        version: '6.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :development
+        version: '1.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
-description: Kitsune Kit is a CLI toolkit that automates the provisioning, configuration,
-  and Docker setup of remote servers, especially tailored for Ruby developers using
-  Kamal. Includes rollback features and multi-environment support.
+        version: '1.3'
+description: Kitsune Kit is an inspectable infrastructure CLI for provisioning DigitalOcean
+  servers, configuring Ubuntu and Docker, and managing private application services.
 email:
 - contact@omarherrera.me
 executables:
@@ -160,44 +144,101 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
-- Rakefile
+- SECURITY.md
 - bin/kit
-- kitsune-kit-logo.jpg
-- lib/kitsune/blueprints/.env.template
-- lib/kitsune/blueprints/docker/postgres.yml
-- lib/kitsune/blueprints/docker/redis.yml
-- lib/kitsune/blueprints/kit.env.template
+- docs/architecture.md
+- docs/architecture/decisions/0001-product-boundary.md
+- docs/architecture/decisions/0002-core-and-interfaces.md
+- docs/architecture/decisions/0003-configuration-state-and-secrets.md
+- docs/architecture/decisions/0004-supported-platforms.md
+- docs/architecture/decisions/0005-operation-semantics.md
+- docs/architecture/decisions/0006-tui-backend.md
+- docs/architecture/provider-adapters.md
+- docs/commands.md
+- docs/configuration.md
+- docs/getting-started.md
+- docs/providers/digitalocean.md
+- docs/releasing.md
+- docs/roadmap.md
+- docs/security-audit.md
+- docs/security.md
+- docs/services/postgres.md
+- docs/services/redis.md
+- docs/testing.md
+- docs/troubleshooting.md
+- docs/tui.md
 - lib/kitsune/kit.rb
-- lib/kitsune/kit/ansi_color.rb
+- lib/kitsune/kit/adapters/confirming_host_key_verifier.rb
+- lib/kitsune/kit/adapters/digitalocean_provider.rb
+- lib/kitsune/kit/adapters/fake_clock.rb
+- lib/kitsune/kit/adapters/fake_provider.rb
+- lib/kitsune/kit/adapters/fake_reporter.rb
+- lib/kitsune/kit/adapters/fake_secret_store.rb
+- lib/kitsune/kit/adapters/fake_state_store.rb
+- lib/kitsune/kit/adapters/fake_transport.rb
+- lib/kitsune/kit/adapters/net_ssh_transport.rb
+- lib/kitsune/kit/adapters/provider.rb
+- lib/kitsune/kit/adapters/transport.rb
+- lib/kitsune/kit/adapters/transport_factory.rb
+- lib/kitsune/kit/application.rb
+- lib/kitsune/kit/cancellation.rb
 - lib/kitsune/kit/cli.rb
-- lib/kitsune/kit/commands/bootstrap.rb
-- lib/kitsune/kit/commands/bootstrap_docker.rb
-- lib/kitsune/kit/commands/dns.rb
-- lib/kitsune/kit/commands/init.rb
-- lib/kitsune/kit/commands/install_docker_engine.rb
-- lib/kitsune/kit/commands/postinstall_docker.rb
-- lib/kitsune/kit/commands/provision.rb
-- lib/kitsune/kit/commands/setup_do_metrics.rb
-- lib/kitsune/kit/commands/setup_docker_prereqs.rb
-- lib/kitsune/kit/commands/setup_firewall.rb
-- lib/kitsune/kit/commands/setup_postgres_docker.rb
-- lib/kitsune/kit/commands/setup_redis_docker.rb
-- lib/kitsune/kit/commands/setup_swap.rb
-- lib/kitsune/kit/commands/setup_unattended.rb
-- lib/kitsune/kit/commands/setup_user.rb
-- lib/kitsune/kit/commands/ssh.rb
-- lib/kitsune/kit/commands/switch_env.rb
-- lib/kitsune/kit/defaults.rb
-- lib/kitsune/kit/env_loader.rb
-- lib/kitsune/kit/options_builder.rb
-- lib/kitsune/kit/provisioner.rb
+- lib/kitsune/kit/clock.rb
+- lib/kitsune/kit/configuration.rb
+- lib/kitsune/kit/errors.rb
+- lib/kitsune/kit/events.rb
+- lib/kitsune/kit/operations/ensure_dns_records.rb
+- lib/kitsune/kit/operations/ensure_server.rb
+- lib/kitsune/kit/operations/ensure_service.rb
+- lib/kitsune/kit/operations/remote_script.rb
+- lib/kitsune/kit/operations/service_backup.rb
+- lib/kitsune/kit/operations/service_files.rb
+- lib/kitsune/kit/operations/service_firewall.rb
+- lib/kitsune/kit/operations/service_state.rb
+- lib/kitsune/kit/plan.rb
+- lib/kitsune/kit/reporters/human.rb
+- lib/kitsune/kit/reporters/json.rb
+- lib/kitsune/kit/reporters/reporter.rb
+- lib/kitsune/kit/result.rb
+- lib/kitsune/kit/run_journal.rb
+- lib/kitsune/kit/run_logger.rb
+- lib/kitsune/kit/scripts/docker.sh
+- lib/kitsune/kit/scripts/firewall.sh
+- lib/kitsune/kit/scripts/metrics.sh
+- lib/kitsune/kit/scripts/ssh.sh
+- lib/kitsune/kit/scripts/swap.sh
+- lib/kitsune/kit/scripts/unattended.sh
+- lib/kitsune/kit/scripts/user.sh
+- lib/kitsune/kit/secret_filter.rb
+- lib/kitsune/kit/secret_store.rb
+- lib/kitsune/kit/secret_stores/store.rb
+- lib/kitsune/kit/service_compose.rb
+- lib/kitsune/kit/state_store.rb
+- lib/kitsune/kit/state_stores/store.rb
+- lib/kitsune/kit/tui/actions.rb
+- lib/kitsune/kit/tui/application.rb
+- lib/kitsune/kit/tui/controller.rb
+- lib/kitsune/kit/tui/renderer.rb
+- lib/kitsune/kit/tui/state.rb
+- lib/kitsune/kit/tui/store.rb
+- lib/kitsune/kit/tui/terminal.rb
 - lib/kitsune/kit/version.rb
-- sig/kitsune/kit.rbs
+- lib/kitsune/kit/workflows/apply_plan.rb
+- lib/kitsune/kit/workflows/base.rb
+- lib/kitsune/kit/workflows/build_plan.rb
+- lib/kitsune/kit/workflows/destroy_server.rb
+- lib/kitsune/kit/workflows/doctor.rb
+- lib/kitsune/kit/workflows/environment_selection.rb
+- lib/kitsune/kit/workflows/import_server.rb
+- lib/kitsune/kit/workflows/initialize_project.rb
+- lib/kitsune/kit/workflows/inspect_environment.rb
+- lib/kitsune/kit/workflows/rollback.rb
+- lib/kitsune/kit/workflows/support_bundle.rb
 homepage: https://github.com/omarhrra/kitsune-kit
 licenses:
 - MIT
@@ -206,7 +247,8 @@ metadata:
   homepage_uri: https://github.com/omarhrra/kitsune-kit
   source_code_uri: https://github.com/omarhrra/kitsune-kit
   changelog_uri: https://github.com/omarhrra/kitsune-kit/blob/main/CHANGELOG.md
-post_install_message:
+  bug_tracker_uri: https://github.com/omarhrra/kitsune-kit/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -214,16 +256,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Provision and setup DigitalOcean VPSs with Docker and PostgreSQL, ideal for
-  Kamal deployments.
+summary: Plan, provision, and configure secure Ubuntu servers for Docker and Kamal.
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/lib/kitsune/blueprints/.env.template

@@ -1,31 +0,0 @@
-# DigitalOcean Droplet
-DO_API_TOKEN=
-DROPLET_NAME=
-REGION=
-SIZE=
-IMAGE=
-SSH_KEY_ID=
-TAG_NAME=
-ENABLE_DO_METRICS=true
-# If you want DNS records to be created automatically, set the following variables:
-# DOMAIN_NAMES=example.com,test.example.org # (optional, comma-separated list of domain names to add to the droplet)
-# DNS_TTL=3600 # (optional, time-to-live for DNS records in seconds, default is 3600)
-# Check the DigitalOcean documentation for more information on domain names:
-# https://docs.digitalocean.com/products/networking/dns/getting-started/dns-registrars/
-
-# SSH
-SSH_KEY_PATH=
-# SSH_PORT=22 (optional)
-
-# System
-SWAP_SIZE_GB=2
-DISABLE_SWAP=false
-
-# PostgreSQL Docker
-POSTGRES_DB=myapp_db
-POSTGRES_USER=postgres
-POSTGRES_PASSWORD=secret
-
-# Redis Docker
-REDIS_PORT=6379
-REDIS_PASSWORD=secret

data/lib/kitsune/blueprints/docker/postgres.yml

@@ -1,27 +0,0 @@
-services:
-  postgres:
-    image: postgres:17
-    restart: always
-    environment:
-      POSTGRES_DB: ${POSTGRES_DB}
-      POSTGRES_USER: ${POSTGRES_USER}
-      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
-    ports:
-      - "${POSTGRES_PORT:-5432}:5432"
-    command: postgres -c listen_addresses='*'
-    networks:
-      - private
-    volumes:
-      - pgdata:/var/lib/postgresql/data
-    healthcheck:
-      test: ["CMD-SHELL", "pg_isready -U $${POSTGRES_USER}"]
-      interval: 30s
-      timeout: 10s
-      retries: 5
-
-volumes:
-  pgdata:
-
-networks:
-  private:
-    driver: bridge

data/lib/kitsune/blueprints/docker/redis.yml

@@ -1,23 +0,0 @@
-services:
-  redis:
-    image: redis:7.2
-    restart: always
-    ports:
-      - "${REDIS_PORT:-6379}:6379"
-    command: redis-server --requirepass ${REDIS_PASSWORD}
-    networks:
-      - private
-    volumes:
-      - redisdata:/data
-    healthcheck:
-      test: ["CMD", "redis-cli", "-a", "${REDIS_PASSWORD}", "ping"]
-      interval: 30s
-      timeout: 10s
-      retries: 5
-
-volumes:
-  redisdata:
-
-networks:
-  private:
-    driver: bridge

data/lib/kitsune/blueprints/kit.env.template

@@ -1 +0,0 @@
-KIT_ENV=development

data/lib/kitsune/kit/ansi_color.rb

@@ -1,78 +0,0 @@
-module AnsiColor
-  COLORS = {
-    black:   30,
-    red:     31,
-    green:   32,
-    yellow:  33,
-    blue:    34,
-    magenta: 35,
-    cyan:    36,
-    white:   37,
-
-    light_black:   90,
-    light_red:     91,
-    light_green:   92,
-    light_yellow:  93,
-    light_blue:    94,
-    light_magenta: 95,
-    light_cyan:    96,
-    light_white:   97
-  }
-
-  BACKGROUNDS = {
-    black:   40,
-    red:     41,
-    green:   42,
-    yellow:  43,
-    blue:    44,
-    magenta: 45,
-    cyan:    46,
-    white:   47,
-
-    light_black:   100,
-    light_red:     101,
-    light_green:   102,
-    light_yellow:  103,
-    light_blue:    104,
-    light_magenta: 105,
-    light_cyan:    106,
-    light_white:   107
-  }
-
-  STYLES = {
-    bold:      1,
-    italic:    3,
-    underline: 4
-  }
-
-  def self.colorize(text, color: nil, background: nil, style: nil)
-    codes = []
-    codes << COLORS[color] if color
-    codes << BACKGROUNDS[background] if background
-    codes << STYLES[style] if style
-
-    raise ArgumentError, "No valid formatting options given" if codes.empty?
-
-    "\e[#{codes.join(';')}m#{text}\e[0m"
-  end
-
-  def self.demo
-    puts "Text Colors:"
-    COLORS.each_key do |color|
-      puts colorize("  #{color.to_s.ljust(15)}", color: color)
-    end
-  
-    puts "\nBackground Colors:"
-    BACKGROUNDS.each_key do |bg|
-      puts colorize("  #{bg.to_s.ljust(15)}", background: bg)
-    end
-  
-    puts "\nStyles:"
-    STYLES.each_key do |style|
-      puts colorize("  #{style.to_s.ljust(15)}", color: :white, style: style)
-    end
-  
-    puts "\nCombined Example:"
-    puts colorize("  bold green on light_black  ", color: :green, background: :light_black, style: :bold)
-  end
-end