mimas 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 465b5f5dab298e62003b3d43b417dcc13d2c6836cba3ade389fe487d3ee59c9d
-  data.tar.gz: 3bd799075d78069a206a2cafd8b4d4abc3f7b040aa737e42c864704eb041c1ff
+  metadata.gz: ea7a87706ea7f9976b782cb891e446b813c7c866e2a4907f451565e670d194a5
+  data.tar.gz: adde800fcc3df657cc512cfd14b9fe1ef314e3d4f19f903c68259c3d7394ef28
 SHA512:
-  metadata.gz: 4a0da3d7890be014ee7709a47a1ef8c9cba601b55e45fcf9d978f9787e560f4f4aab837f54483801dcc902ce8688d804e7a03484625d1149221a5475ddfbc1dc
-  data.tar.gz: 5d82db21fab21f4146480c509864360396679031b4ec191a43c37bde4d08c2ed8f84f9bbed492acb5a14d3aa984dc005464ca8f68141dfe8c79022bdf526652d
+  metadata.gz: 984c764fc02feeb671c63f33528258abb8ad271811400d27affe7e220fd4eb6d66652b57a3b829fa1bf972aa23a6a2d5fbb42fe6bc7ec290cf1c1155fc352654
+  data.tar.gz: 939fa01df07457e75ecb9b2929757edfa0045cb109ec7f7b33366566397af491aca94df1f4a00125f99bd119ab05fc8cc4b318f3cb6c21e0bdabbc03a1853619

data/lib/mimas/archiver.rb

@@ -2,18 +2,12 @@ require 'zlib'
 require 'rubygems/package'
 
 module Mimas
-  module Archive
-    def archive(root: Dir.pwd, output:, archive_root: "", glob: nil, files: [])
-      Archiver
-        .new(root: root, output: output, archive_root: archive_root, glob: glob, files: files)
-        .package
-    end
-  end
-
   class Archiver
-    def initialize(root:, output:, archive_root:, glob: nil, files: [])
+    DEFAULT_OUTPUT_PATH = Pathname.new(Dir.pwd).join("tmp")
+
+    def initialize(root:, output_path: DEFAULT_OUTPUT_PATH, output_file:, archive_root: nil, glob: nil, files: [])
       @root = root ||  Dir.pwd
-      @output = output
+      @output = Pathname.new(output_path).join(output_file)
       @archive_root = archive_root || ""
       @glob = glob
       @source_files = files
@@ -27,6 +21,8 @@ module Mimas
 
       tar.close
       gz.close
+
+      return @output.to_s
     end
 
     private

data/lib/mimas/cli.rb

@@ -8,6 +8,7 @@ module Mimas
       register "provision", Provision
       register "push", Push
       register "console", Console
+      register "archive", Archive
       register "setup caddy", Setup::Caddy
       register "setup deploy_user", Setup::DeployUser
       register "setup ruby", Setup::Ruby

data/lib/mimas/commands/archive.rb

@@ -0,0 +1,19 @@
+module Mimas
+  module CLI
+    module Commands
+      class Archive < BaseCommand
+        desc "Create your site's archive which will be uploaded to the server"
+
+        argument :site, desc: "The name of the site to archive"
+
+        def call(site: :default)
+          site    = Config.current.sites[site.to_sym]
+
+          site.archive
+
+          say "Your site's archive has been created in #{Archiver::DEFAULT_OUTPUT_PATH}"
+        end
+      end
+    end
+  end
+end

data/lib/mimas/commands/console.rb

@@ -7,7 +7,7 @@ module Mimas
         argument :server_name, required: true,   desc: "The name of the server to run the console on"
         argument :site,                          desc: "The site to run the console for. Uses the default site if unspecified"
 
-        def call(server_name, site: :default)
+        def call(server_name:, site: :default)
           server  = Config.current.servers[server_name.to_sym]
           site    = Config.current.sites[site.to_sym]
 

data/lib/mimas/config.rb

@@ -37,6 +37,17 @@ module Mimas
       end
     end
 
+    class InvalidConfiguration < StandardError
+      attr_reader :message
+      def initialize(message)
+        @message = message
+      end
+
+      def to_s
+        @message.to_s
+      end
+    end
+
     private
 
       class DSL
@@ -56,12 +67,14 @@ module Mimas
           name = name.to_sym
           args = Site.evaluate(&block)
           @config.sites[name] = Mimas::Site.new(name, args)
+          @config.sites[name].validate!
         end
 
         def server(name, &block)
           name = name.to_sym
           args = Options.evaluate(&block)
           @config.servers[name] = Mimas::Server.new(name, args)
+          @config.servers[name].validate!
         end
 
         def hooks(&block)

data/lib/mimas/deployment/paths.rb

@@ -10,7 +10,7 @@ module Mimas
       end
 
       def archive_path
-        @archive_path ||= File.join(Dir.pwd, "tmp", archive_name)
+        @archive_path
       end
 
       def site_root

data/lib/mimas/deployment/ruby_app.rb

@@ -4,27 +4,14 @@ module Mimas
       def deploy_ruby_app
         say "Starting deployment for #{site.domain}"
 
-        archive(output: archive_path, files: site.files)
+        @archive_path = site.archive(filename: archive_name)
 
         ssh(server) do |session|
-          begin
-            session.run "test -d ~/.rubies/ruby-#{ruby_version}"
-            say "Ruby #{ruby_version} found on the server..."
-          rescue SSH::Session::NonZeroExitCode
-            raise "Ruby version not installed on server"
-          end
+          validate_server_ruby_version(session)
 
-          # Create the release folder
-          session.run "mkdir -p #{releases_path}"
+          create_directory_skeleton(session)
 
-          # Get expired releases. Mimas will only retain the last 5 releases.
-          releases = session.run "ls #{releases_path}", capture: true
-          expired_releases = releases.split("\n").sort.reverse.drop(5)
-
-          if expired_releases.any?
-            say "Deleting versions: #{expired_releases.join(", ")}"
-            session.run "cd #{releases_path} && rm -rf #{expired_releases.join(" ")}"
-          end
+          expire_old_releases(session)
 
           # Check `current` symlink to get currently live version
           remote_current_path = session.run("readlink #{current_path}", capture: true, silent: true).chomp
@@ -32,12 +19,9 @@ module Mimas
 
           say "Current live version is #{remote_current_version}" if remote_current_version.size > 0
 
-          # Make systemd path and the site's mimas folder
-          session.run "mkdir -p #{server.user_systemd_path}"
-          session.run "mkdir -p #{mimas_path}"
-
           refreshing_caddy(session) do
             # Upload the mimas.env and touch an `.env` file in the site's root
+            session.run "cp #{mimas_path.join("mimas.env")} #{mimas_path.join("mimas.env.backup")}"
             session.upload StringIO.new(mimas_env), mimas_path.join("mimas.env")
             session.run "touch #{site_root.join(".env")}"
 
@@ -78,30 +62,40 @@ module Mimas
           rescue Exception => e
             say "Error raised during deploy: #{e}".red.bold
 
-            # Revert symlink if there's an existing live release, otherwise delete it
-            if remote_current_path.size > 0
-              say "Reverting symlink ..."
-              session.run "ln -sfn #{remote_current_path} #{current_path}"
-            else
-              say "Deleting symlink ..."
-              session.run "rm -f #{current_path}"
-            end
+            revert_files_after_failed_deployment(session, remote_current_path: remote_current_path)
+            exit 1
+          end
 
-            say "Deleting released files ..."
 
-            site.services.each do |_, service|
-              systemd_service_name = systemd_service_name(service)
-              session.run "systemctl --user stop #{systemd_service_name}", silent: true, capture: true
-              session.run "systemctl --user disable #{systemd_service_name}", silent: true, capture: true
-              session.run "rm #{server.user_systemd_path.join("#{systemd_service_name}.service")}", silent: true
-            end
+          cleanup_successful_deployment(session, remote_current_version: remote_current_version)
+          say "\n"
+          say "Deployment complete! #{version} is now live.".bold.white
+        end
+      end
 
-            session.run "rm -f #{unix_socket(version: version)}"
-            session.run "rm -f #{site_root.join("Caddyfile.new")}"
-            session.run "rm -rf #{remote_destination}"
+      private
 
-            exit 1
-          end
+        def validate_server_ruby_version(session)
+          session.run "test -d ~/.rubies/ruby-#{ruby_version}"
+          say "Ruby #{ruby_version} found on the server..."
+        rescue SSH::Session::NonZeroExitCode
+          raise "Ruby version not installed on server"
+        end
+
+        def create_directory_skeleton(session)
+          # Create the release folder
+          session.run "mkdir -p #{releases_path}"
+
+          # Make systemd path and the site's mimas folder
+          session.run "mkdir -p #{server.user_systemd_path}"
+          session.run "mkdir -p #{mimas_path}"
+
+          # Create empty .env file
+          session.run "touch #{mimas_path.join("mimas.env")}"
+        end
+
+        def cleanup_successful_deployment(session, remote_current_version:)
+          session.run "rm -f #{mimas_path.join("mimas.env.backup")}"
 
           # Delete the old service if one exists, and the new service started up
           if remote_current_version.size > 0
@@ -109,18 +103,52 @@ module Mimas
               systemd_service_name = systemd_service_name(service, version: remote_current_version)
 
               say "Stopping old service: #{systemd_service_name}"
-              session.run "systemctl --user stop #{systemd_service_name}"
-              session.run "systemctl --user disable #{systemd_service_name}"
+              session.run "systemctl --user stop #{systemd_service_name}", capture: true, silent: true
+              session.run "systemctl --user disable #{systemd_service_name}", capture: true, silent: true
               session.run "rm #{server.user_systemd_path.join("#{systemd_service_name}.service")}"
               say "#{systemd_service_name} stopped and deleted."
               session.run "rm -f #{unix_socket(version: remote_current_version)}"
             end
           end
+        end
 
-          say "\n"
-          say "Deployment complete! #{version} is now live.".bold.white
+        def revert_files_after_failed_deployment(session, remote_current_path:)
+          # Revert symlink if there's an existing live release, otherwise delete it
+          if remote_current_path.size > 0
+            say "Reverting symlink ..."
+            session.run "ln -sfn #{remote_current_path} #{current_path}"
+          else
+            say "Deleting symlink ..."
+            session.run "rm -f #{current_path}"
+          end
+
+          # Restore the previous mimas environment
+          session.run "mv #{mimas_path.join("mimas.env.backup")} #{mimas_path.join("mimas.env")}"
+
+          say "Deleting released files ..."
+
+          site.services.each do |_, service|
+            systemd_service_name = systemd_service_name(service)
+            session.run "systemctl --user stop #{systemd_service_name}", capture: true, silent: true
+            session.run "systemctl --user disable #{systemd_service_name}", capture: true, silent: true
+            session.run "rm #{server.user_systemd_path.join("#{systemd_service_name}.service")}", silent: true
+          end
+
+          session.run "rm -f #{unix_socket(version: version)}"
+          session.run "rm -f #{site_root.join("Caddyfile.new")}"
+          session.run "rm -rf #{remote_destination}"
+        end
+
+        def expire_old_releases(session)
+          # Get expired releases. Mimas will only retain the last 5 releases.
+          releases = session.run "ls #{releases_path}", capture: true
+          expired_releases = releases.split("\n").sort.reverse.drop(5)
+
+          if expired_releases.any?
+            say "Deleting versions: #{expired_releases.join(", ")}"
+            session.run "cd #{releases_path} && rm -rf #{expired_releases.join(" ")}"
+          end
         end
-      end
     end
   end
 end

data/lib/mimas/deployment/static_site.rb

@@ -4,7 +4,7 @@ module Mimas
       def deploy_static_site
         say "Starting deployment for #{site.domain}"
 
-        archive(root: site.root_dir, output: archive_path, archive_root: "root", glob: site.glob)
+        @archive_path = site.archive(filename: archive_name)
 
         ssh(server) do |session|
           refreshing_caddy(session) do

data/lib/mimas/deployment.rb

@@ -1,6 +1,6 @@
 module Mimas
   class Deployment
-    include Terminal::Printer, Template, Archive, SSH
+    include Terminal::Printer, Template, SSH
 
     include Paths, Files
     include StaticSite, RubyApp, Caddy

data/lib/mimas/scripts/create_deploy_user.sh

@@ -7,7 +7,9 @@ DEPLOY_USER="${DEPLOY_USER:-deploy}"
 
 if ! id $DEPLOY_USER >/dev/null 2>&1; then
   printf "Creating the $DEPLOY_USER user\n\n"
-  useradd $DEPLOY_USER -s /bin/bash -m
+  getent group $DEPLOY_USER >/dev/null || groupadd $DEPLOY_USER
+  useradd $DEPLOY_USER -g $DEPLOY_USER -s /bin/bash -m
+
   printf "$DEPLOY_USER user created\n\n"
 else
   printf "$DEPLOY_USER user exists. Configuring the user..."

data/lib/mimas/scripts/harden.sh

@@ -18,8 +18,10 @@ printf "UFW enabled\n\n"
 printf "Creating the admin user\n\n"
 
 if ! id admin >/dev/null 2>&1; then
+  # Create an admin group
+  getent group admin >/dev/null || groupadd admin
   # Add a new user, set the default shell, and create a home directory
-  useradd admin -s /bin/bash -m
+  useradd admin -g admin -s /bin/bash -m
 fi
 
 # Disable password login

data/lib/mimas/server.rb

@@ -33,5 +33,15 @@ module Mimas
     def current_path(site)
       site_root(site).join("current")
     end
+
+    def validate!
+      raise Config::InvalidConfiguration.new("`server` requires a `host`") \
+        unless self.host && self.host.size > 0
+
+      raise Config::InvalidConfiguration.new("`server` requires a `user`") \
+        unless self.user && self.user.size > 0
+
+      true
+    end
   end
 end

data/lib/mimas/site/archive.rb

@@ -0,0 +1,13 @@
+module Mimas
+  class Site
+    module Archive
+      def archive(filename: "#{name}.tar.gz")
+        if self.ruby_app?
+          Archiver.new(output_file: filename, files: files).package
+        else
+          Archiver.new(root: root_dir, output_file: filename, archive_root: "root", glob: glob, files: files).package
+        end
+      end
+    end
+  end
+end

data/lib/mimas/site.rb

@@ -1,5 +1,7 @@
 module Mimas
   class Site
+    include Archive
+
     attr_reader :name
     def initialize(name, args)
       @name = name
@@ -20,5 +22,38 @@ module Mimas
     def ruby_app?
       services.any?
     end
+
+    # Placeholder, will be overwritten by the config file if defined
+    def glob
+      nil
+    end
+
+    # Placeholder, will be overwritten by the config file if defined
+    def files
+      nil
+    end
+
+    def validate!
+      raise Config::InvalidConfiguration.new("`site` requires a `domain`") \
+        unless self.respond_to?(:domain)
+
+      if ruby_app?
+        raise Config::InvalidConfiguration.new("`site` requires a `files` directive") \
+          unless self.files != nil
+
+        services.values.each do |service|
+          raise Config::InvalidConfiguration.new("#{service[:name]} service requires a `command` directive") \
+            unless service[:command]
+        end
+      else
+        raise Config::InvalidConfiguration.new("`site` requires a `root_dir` directive") \
+          unless self.respond_to?(:root_dir)
+
+        raise Config::InvalidConfiguration.new("`site` requires a `files` or `glob` directive") \
+          unless self.glob != nil || self.files != nil
+      end
+
+      true
+    end
   end
 end

data/lib/mimas/version.rb

@@ -1,3 +1,3 @@
 module Mimas
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/mimas.rb

@@ -16,6 +16,7 @@ require_relative "mimas/hooks"
 
 require_relative "mimas/config"
 
+require_relative "mimas/site/archive"
 require_relative "mimas/site"
 
 require_relative "mimas/server/prerequisites"
@@ -35,6 +36,7 @@ require_relative "mimas/deployment"
 require_relative "mimas/plugins"
 
 require_relative "mimas/base_command"
+require_relative "mimas/commands/archive"
 require_relative "mimas/commands/console"
 require_relative "mimas/commands/init"
 require_relative "mimas/commands/install"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: mimas
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Ayush Newatia
 bindir: bin
 cert_chain: []
-date: 2026-07-23 00:00:00.000000000 Z
+date: 2026-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -104,6 +104,7 @@ files:
 - lib/mimas/archiver.rb
 - lib/mimas/base_command.rb
 - lib/mimas/cli.rb
+- lib/mimas/commands/archive.rb
 - lib/mimas/commands/console.rb
 - lib/mimas/commands/init.rb
 - lib/mimas/commands/install.rb
@@ -135,6 +136,7 @@ files:
 - lib/mimas/server/prerequisites.rb
 - lib/mimas/server/ruby.rb
 - lib/mimas/site.rb
+- lib/mimas/site/archive.rb
 - lib/mimas/ssh.rb
 - lib/mimas/template.rb
 - lib/mimas/templates/Caddyfile.ruby.erb