kitsune-kit 0.1.0

data/lib/kitsune/kit/commands/setup_user.rb

@@ -0,0 +1,189 @@
+require "thor"
+require "net/ssh"
+require_relative "../defaults"
+require_relative "../options_builder"
+
+module Kitsune
+  module Kit
+    module Commands
+      class SetupUser < Thor
+        namespace "setup_user"
+
+        class_option :server_ip,    aliases: "-s", required: true, desc: "Server IP address or hostname"
+        class_option :ssh_port,     aliases: "-p", desc: "SSH port"
+        class_option :ssh_key_path, aliases: "-k", desc: "Path to your private SSH key"
+
+        desc "create",   "Create and configure 'deploy' user on remote server"
+        def create
+          filled_options = Kitsune::Kit::OptionsBuilder.build(
+            options,
+            required: [:server_ip],
+            defaults: Kitsune::Kit::Defaults.ssh
+          )
+
+          with_ssh_connection(false, filled_options) do |ssh|
+            perform_setup(ssh)
+          end
+        end
+
+        desc "rollback", "Revert configuration and remove 'deploy' user from remote server"
+        def rollback
+          filled_options = Kitsune::Kit::OptionsBuilder.build(
+            options,
+            required: [:server_ip],
+            defaults: Kitsune::Kit::Defaults.ssh
+          )
+
+          server = filled_options[:server_ip]
+          port   = filled_options[:ssh_port]
+          key    = File.expand_path(filled_options[:ssh_key_path])
+
+          # First, attempt SSH config restore as 'deploy'
+          begin
+            with_ssh_connection(true, filled_options) do |ssh|
+              perform_rollback_config(ssh)
+            end
+          rescue StandardError => e
+            say "⚠️ Skipping SSH config restore: #{e.message}", :yellow
+          end
+
+          # Then reconnect as 'root' to remove sudoers and delete user
+          say "🔑 Reconnecting as root@#{server}:#{port}", :green
+          Net::SSH.start(server, 'root', port: port, keys: [key], non_interactive: true) do |ssh|
+            perform_rollback_cleanup(ssh)
+          end
+          say "✅ Rollback completed", :green
+        end
+
+        no_commands do
+          def with_ssh_connection(rollback, filled_options)
+            server = filled_options[:server_ip]
+            port   = filled_options[:ssh_port]
+            key    = File.expand_path(filled_options[:ssh_key_path])
+          
+            user = rollback ? 'deploy' : detect_remote_user(server, port, key)
+            say "🔑 Connecting as #{user}@#{server}:#{port}", :green
+          
+            Net::SSH.start(server, user, port: port, keys: [key], non_interactive: true, timeout: 5) do |ssh|
+              yield ssh
+            end
+          end
+
+          def detect_remote_user(server, port, key)
+            %w[deploy root].each do |u|
+              begin
+                Net::SSH.start(server, u, port: port, keys: [key], non_interactive: true, timeout: 5) { }
+                say "✔️ Able to SSH as #{u}", :green
+                return u
+              rescue
+                next
+              end
+            end
+            abort("❌ Could not connect as deploy or root on #{server}:#{port}")
+          end
+
+          def perform_setup(ssh)
+            output = ssh.exec! <<~'EOH'
+              set -e
+
+              echo "✍🏻 Creating deploy user…"
+              if ! id deploy &>/dev/null; then
+                if command -v adduser &>/dev/null; then
+                  sudo adduser --disabled-password --gecos "" deploy && echo "   - user 'deploy' created"
+                else
+                  sudo useradd -m -s /bin/bash deploy && echo "   - user 'deploy' created"
+                fi
+                sudo usermod -aG sudo deploy && echo "   - 'deploy' added to sudo"
+              else
+                echo "   - user 'deploy' already exists"
+              fi
+
+              echo "✍🏻 Configuring passwordless sudo…"
+              if [ ! -f /etc/sudoers.d/deploy ]; then
+                echo 'deploy ALL=(ALL) NOPASSWD:ALL' | sudo tee /etc/sudoers.d/deploy \
+                  && sudo chmod 440 /etc/sudoers.d/deploy \
+                  && echo "   - sudoers entry created"
+              else
+                echo "   - sudoers entry exists"
+              fi
+
+              echo "✍🏻 Backing up SSH config…"
+              sudo test -f /etc/ssh/sshd_config.bak || sudo cp /etc/ssh/sshd_config /etc/ssh/sshd_config.bak && echo "   - sshd_config backed up"
+
+              echo "✍🏻 Hardening SSH…"
+              grep -q '^PermitRootLogin no' /etc/ssh/sshd_config \
+                || sudo sed -i 's/^#*PermitRootLogin .*/PermitRootLogin no/' /etc/ssh/sshd_config && echo "   - PermitRootLogin no"
+              grep -q '^PasswordAuthentication no' /etc/ssh/sshd_config \
+                || sudo sed -i 's/^#*PasswordAuthentication .*/PasswordAuthentication no/' /etc/ssh/sshd_config && echo "   - PasswordAuthentication no"
+              sudo systemctl restart sshd && echo "   - sshd restarted"
+
+              echo "✍🏻 Installing SSH keys for deploy…"
+              if [ ! -f /home/deploy/.ssh/authorized_keys ]; then
+                sudo mkdir -p /home/deploy/.ssh
+                sudo cp /root/.ssh/authorized_keys /home/deploy/.ssh/authorized_keys
+                sudo chown -R deploy:deploy /home/deploy/.ssh
+                sudo chmod 700 /home/deploy/.ssh
+                sudo chmod 600 /home/deploy/.ssh/authorized_keys
+                echo "   - authorized_keys copied"
+              else
+                echo "   - authorized_keys already present"
+              fi
+            EOH
+            say output
+            say "✅ Setup completed", :green
+          end
+
+          def perform_rollback_config(ssh)
+            output = ssh.exec! <<~'EOH'
+              set -e
+
+              echo "🔁 Backing up SSH config…"
+              sudo test -f /etc/ssh/sshd_config.bak || sudo cp /etc/ssh/sshd_config /etc/ssh/sshd_config.bak && echo "   - sshd_config backed up"
+
+              echo "✍🏻 Restoring SSH config…"
+              grep -q '^PermitRootLogin yes' /etc/ssh/sshd_config \
+                || sudo sed -i 's/^#*PermitRootLogin .*/PermitRootLogin yes/' /etc/ssh/sshd_config && echo "   - PermitRootLogin yes"
+              grep -q '^PasswordAuthentication yes' /etc/ssh/sshd_config \
+                || sudo sed -i 's/^#*PasswordAuthentication .*/PasswordAuthentication yes/' /etc/ssh/sshd_config && echo "   - PasswordAuthentication yes"
+              sudo systemctl restart sshd && echo "   - sshd restarted"
+            EOH
+            say output
+            say "✅ SSH config restored, closing deploy session", :green
+          end
+
+          def perform_rollback_cleanup(ssh)
+            output = ssh.exec! <<~'EOH'
+              set -e
+
+              echo "✍🏻 Removing sudoers file…"
+              if [ -f /etc/sudoers.d/deploy ]; then
+                sudo rm -f /etc/sudoers.d/deploy && echo "   - /etc/sudoers.d/deploy removed"
+              else
+                echo "   - no sudoers file to remove"
+              fi
+
+              echo "✍🏻 Killing remaining processes for deploy…"
+              if id deploy &>/dev/null; then
+                sudo pkill -u deploy && echo "   - processes killed" || echo "   - no processes found"
+              else
+                echo "   - user 'deploy' does not exist, skipping"
+              fi
+
+              echo "✍🏻 Deleting deploy user…"
+              if id deploy &>/dev/null; then
+                if command -v deluser &>/dev/null; then
+                  sudo deluser --remove-home deploy && echo "   - deploy user removed"
+                else
+                  sudo userdel -r deploy && echo "   - deploy user removed"
+                fi
+              else
+                echo "   - deploy user does not exist"
+              fi
+            EOH
+            say output
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitsune/kit/commands/switch_env.rb

@@ -0,0 +1,42 @@
+require "thor"
+require "fileutils"
+
+module Kitsune
+  module Kit
+    module Commands
+      class SwitchEnv < Thor
+        namespace "switch_env"
+
+        desc "to ENV_NAME", "Switch active Kitsune Kit environment (development, production, etc)"
+        def to(env_name)
+          kit_env_path = ".kitsune/kit.env"
+          infra_env_path = ".kitsune/infra.#{env_name}.env"
+          blueprint_path = File.expand_path("../../blueprints/.env.template", __dir__)
+
+          unless File.exist?(kit_env_path)
+            say "❌ No .kitsune/kit.env found. Did you run `kitsune kit init`?", :red
+            exit(1)
+          end
+
+          content = File.read(kit_env_path)
+
+          if content.match?(/^KIT_ENV=/)
+            new_content = content.gsub(/^KIT_ENV=.*/, "KIT_ENV=#{env_name}")
+          else
+            new_content = "KIT_ENV=#{env_name}\n" + content
+          end
+
+          File.write(kit_env_path, new_content)
+          say "🎯 Environment switched to '#{env_name}' in .kitsune/kit.env", :green
+
+          unless File.exist?(infra_env_path)
+            FileUtils.cp(blueprint_path, infra_env_path)
+            say "📝 Created new infra environment file: #{infra_env_path}", :cyan
+          else
+            say "📄 Infra environment file already exists: #{infra_env_path}", :green
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitsune/kit/defaults.rb

@@ -0,0 +1,56 @@
+module Kitsune
+  module Kit
+    module Defaults
+      DROPLET = {
+        droplet_name: "app-prod",
+        region: "sfo3",
+        size: "s-1vcpu-1gb",
+        image: "ubuntu-22-04-x64",
+        tag: "rails-prod"
+      }.freeze
+
+      SSH = {
+        ssh_port: "22",
+        ssh_key_path: "~/.ssh/id_rsa"
+      }.freeze
+
+      POSTGRES = {
+        db_prefix: "myapp_db",
+        user: "postgres",
+        password: "secret",
+        port: "5432",
+        image: "postgres:15"
+      }.freeze
+
+      def self.infra
+        {
+          droplet_name: ENV.fetch('DROPLET_NAME', DROPLET[:droplet_name]),
+          region: ENV.fetch('REGION', DROPLET[:region]),
+          size: ENV.fetch('SIZE', DROPLET[:size]),
+          image: ENV.fetch('IMAGE', DROPLET[:image]),
+          tag: ENV.fetch('TAG_NAME', DROPLET[:tag]),
+          ssh_key_id: ENV.fetch('SSH_KEY_ID') { abort "❌ Missing SSH_KEY_ID" }
+        }
+      end
+
+      def self.ssh
+        {
+          ssh_port: ENV.fetch('SSH_PORT', SSH[:ssh_port]),
+          ssh_key_path: ENV.fetch('SSH_KEY_PATH', SSH[:ssh_key_path])
+        }
+      end
+
+      def self.postgres
+        env = ENV.fetch('KIT_ENV', 'development')
+
+        {
+          postgres_db: ENV.fetch('POSTGRES_DB') { "#{POSTGRES[:db_prefix]}_#{env}" },
+          postgres_user: ENV.fetch('POSTGRES_USER', POSTGRES[:user]),
+          postgres_password: ENV.fetch('POSTGRES_PASSWORD', POSTGRES[:password]),
+          postgres_port: ENV.fetch('POSTGRES_PORT', POSTGRES[:port]),
+          postgres_image: ENV.fetch('POSTGRES_IMAGE', POSTGRES[:image])
+        }
+      end
+    end
+  end
+end

data/lib/kitsune/kit/env_loader.rb

@@ -0,0 +1,41 @@
+require "dotenv"
+
+module Kitsune
+  module Kit
+    class EnvLoader
+      @loaded = false
+
+      def self.load!
+        return if @loaded
+
+        env = ENV["KIT_ENV"] || read_kit_env || "development"
+
+        possible_paths = [
+          ".kitsune/infra.#{env}.env",
+          ".kitsune/infra.env"
+        ]
+
+        found = possible_paths.find { |path| File.exist?(path) }
+
+        if found
+          Dotenv.load(found)
+          puts "🧪 Loaded Kitsune environment from #{found}"
+        else
+          puts "⚠️  No Kitsune infra config found for environment '#{env}' (looked for infra.#{env}.env and infra.env)"
+        end
+
+        @loaded = true
+      end
+
+      def self.read_kit_env
+        path = ".kitsune/kit.env"
+        if File.exist?(path)
+          vars = Dotenv.parse(path)
+          vars["KIT_ENV"]
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/kitsune/kit/options_builder.rb

@@ -0,0 +1,26 @@
+module Kitsune
+  module Kit
+    class OptionsBuilder
+      def self.build(current_options, required: [], defaults: {})
+        current = current_options.transform_keys(&:to_sym)
+
+        filled = defaults.dup
+
+        defaults.keys.each do |key|
+          env_key = key.to_s.upcase
+          filled[key] = ENV[env_key] if ENV[env_key]
+        end
+
+        filled.merge!(current)
+
+        missing = required.select { |key| filled[key].nil? }
+
+        unless missing.empty?
+          abort "❌ Missing required options: #{missing.join(', ')}"
+        end
+
+        filled
+      end
+    end
+  end
+end

data/lib/kitsune/kit/provisioner.rb

@@ -0,0 +1,109 @@
+require "droplet_kit"
+
+module Kitsune
+  module Kit
+    class Provisioner
+      def initialize(opts)
+        @droplet_name = opts[:droplet_name]
+        @region       = opts[:region]
+        @size         = opts[:size]
+        @image        = opts[:image]
+        @tag          = opts[:tag]
+        @ssh_key_id   = opts[:ssh_key_id] do
+          abort "❌ You must export SSH_KEY_ID or use --ssh_key_id"
+        end
+
+        @client       = DropletKit::Client.new(access_token: ENV.fetch("DO_API_TOKEN"))
+      end
+  
+      # Find an existing droplet by name
+      def find_droplet
+        @client.droplets.all(tag_name: @tag).detect { |d| d.name == @droplet_name }
+      end
+  
+      # Create command: shows if it exists or creates a new one
+      def create_or_show
+        if (d = find_droplet)
+          ip = public_ip(d)
+          puts "✅ Droplet '#{@droplet_name}' already exists (ID: #{d.id}, IP: #{ip})"
+        else
+          puts "✍🏻 Creating Droplet '#{@droplet_name}'..."
+          spec = DropletKit::Droplet.new(
+            name:       @droplet_name,
+            region:     @region,
+            size:       @size,
+            image:      @image,
+            ssh_keys:   [@ssh_key_id],
+            tags:       [@tag]
+          )
+          created = @client.droplets.create(spec)
+          wait_for_status(created.id)
+          ip = wait_for_public_ip(created.id)
+
+          wait_for_ssh(ip)
+  
+          puts "✅ Droplet created: ID=#{created.id}, IP=#{ip}"
+        end
+      end
+  
+      # Rollback command: deletes it if it exists
+      def rollback
+        if (d = find_droplet)
+          puts "🔁 Deleting Droplet '#{@droplet_name}' (ID: #{d.id})..."
+          @client.droplets.delete(id: d.id)
+          puts "✅ Droplet deleted 💥"
+        else
+          puts "✅ Nothing to delete: '#{@droplet_name}' does not exist"
+        end
+      end
+  
+      private
+  
+      # Extracts the public IP from a DropletKit::Droplet
+      def public_ip(droplet)
+        v4 = droplet.networks.v4.find { |n| n.type == "public" }
+        v4 ? v4.ip_address : "(no public IP yet)"
+      end
+
+      # Waits until the droplet reaches the 'active' status
+      def wait_for_status(droplet_id, interval: 5, max_attempts: 24)
+        max_attempts.times do |i|
+          droplet = @client.droplets.find(id: droplet_id)
+          estado = droplet.status
+          puts "⏳ Droplet status: #{estado} (#{i + 1}/#{max_attempts})"
+          return if estado == "active"
+          sleep interval
+        end
+        abort "❌ Timeout: the Droplet did not reach 'active' status after #{interval * max_attempts} seconds"
+      end
+
+      # Waits until obtaining the public IP
+      def wait_for_public_ip(droplet_id, interval: 5, max_attempts: 24)
+        max_attempts.times do |i|
+          droplet = @client.droplets.find(id: droplet_id)
+          if (v4 = droplet.networks.v4.find { |n| n.type == "public" })
+            return v4.ip_address
+          end
+          puts "⏳ Waiting for public IP... (#{i + 1}/#{max_attempts})"
+          sleep interval
+        end
+        abort "❌ Timeout: the Droplet did not obtain a public IP after #{interval * max_attempts} seconds"
+      end
+
+      # Waits for the SSH port to become accessible
+      def wait_for_ssh(ip, interval: 5, max_attempts: 24)
+        max_attempts.times do |i|
+          begin
+            puts "🔐 Waiting for SSH connection to #{ip}... (#{i + 1}/#{max_attempts})"
+            TCPSocket.new(ip, 22).close
+            puts "🔓 SSH connection to #{ip} established"
+            return
+          rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT, SocketError
+            sleep interval
+          end
+        end
+        abort "❌ Could not connect via SSH to #{ip} after #{interval * max_attempts} seconds"
+      end
+    end
+  end
+end

data/lib/kitsune/kit/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Kitsune
+  module Kit
+    VERSION = "0.1.0"
+  end
+end

data/lib/kitsune/kit.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "kit/version"
+
+module Kitsune
+  module Kit
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/sig/kitsune/kit.rbs

@@ -0,0 +1,6 @@
+module Kitsune
+  module Kit
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: kitsune-kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Omar Herrera
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  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: ed25519
+  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: bcrypt_pbkdf
+  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: dotenv
+  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: droplet_kit
+  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: thor
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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.
+email:
+- contact@omarherrera.me
+executables:
+- kit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/kit
+- kitsune-kit-logo.jpg
+- lib/kitsune/blueprints/.env.template
+- lib/kitsune/blueprints/docker/postgres.yml
+- lib/kitsune/blueprints/kit.env.template
+- lib/kitsune/kit.rb
+- lib/kitsune/kit/cli.rb
+- lib/kitsune/kit/commands/bootstrap.rb
+- lib/kitsune/kit/commands/bootstrap_docker.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_docker_prereqs.rb
+- lib/kitsune/kit/commands/setup_firewall.rb
+- lib/kitsune/kit/commands/setup_postgres_docker.rb
+- lib/kitsune/kit/commands/setup_unattended.rb
+- lib/kitsune/kit/commands/setup_user.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/version.rb
+- sig/kitsune/kit.rbs
+homepage: https://github.com/omarhrra/kitsune-kit
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Provision and setup DigitalOcean VPSs with Docker and PostgreSQL, ideal for
+  Kamal deployments.
+test_files: []