shippy 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99b3140852a1c73552885b9c220f42211a2c86dd8500cf85ef0f0a7c30d88bec
+  data.tar.gz: 54f94d8901dd3b79e9ce150ae1caa5972d48061f0532d73fb51d1c6ecbcc806c
+SHA512:
+  metadata.gz: efc12fd0b68d4cdad42c4cef32cb2e82674cd9a0f2e62d2c31964da77b010fefd3792088f19d204be109a1222198cdfabdc3d1ac66d0d677e30f8612bf47a7a7
+  data.tar.gz: 0d49e7f3a32c6a16175bce6ea75e60553a418ebe2a06742858488459085701b94b01ab141e023b8cdcc49cb37ba1d30c878769350cb0eadda365c38c65e61a1e

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Marius Bobin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Shippy
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/shippy`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/shippy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/shippy/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Shippy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/shippy/blob/master/CODE_OF_CONDUCT.md).

data/bin/shippy

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/shippy"
+
+Shippy::Cli::Main.start(ARGV)

data/lib/shippy/cli/app.rb

@@ -0,0 +1,207 @@
+class Shippy::Cli::App < Shippy::Cli::Base
+  argument :app_name, type: :string
+
+  def initialize(...)
+    super(...)
+    load_app
+  end
+
+  desc "deploy", "Deploy application"
+  def deploy
+    say "Deploying #{app_name} on #{SHIPPY.host}...", :magenta
+
+    SHIPPY.compile
+    archive
+    backup
+    upload
+    create_network
+    refresh
+    stop_old
+    pre_start_hooks
+    start
+    cleanup
+    status
+  end
+
+  desc "refresh", "Pull new images"
+  def refresh
+    say "Pulling images for #{app_name} on #{SHIPPY.host}...", :magenta
+
+    within_app do
+      execute :docker_compose, "pull"
+    end
+  end
+
+  desc "start", "Start application"
+  def start
+    say "Starting #{app_name} on #{SHIPPY.host}...", :magenta
+
+    within_app do
+      execute :docker_compose, "up", "-d", SHIPPY.app&.deploy_flags
+    end
+  end
+
+  desc "stop", "Stop application"
+  def stop
+    say "Stopping #{app_name} on #{SHIPPY.host}...", :magenta
+
+    within_app do
+      execute :docker_compose, "down", "--remove-orphans"
+    end
+  end
+
+  desc "logs", "Show app logs"
+  def logs
+    within_app do
+      puts capture(:docker_compose, "logs", verbosity: Logger::INFO)
+    end
+  end
+
+  desc "status", "Show app status"
+  def status
+    say "Status for #{app_name} on #{SHIPPY.host}...", :magenta
+
+    within_app do
+      puts capture(:docker_compose, "ps", "-a")
+    end
+  end
+
+  private
+
+  def load_app
+    with_app do
+      SHIPPY.app = Shippy::Repo.load_app(app_name)
+    end
+  end
+
+  def archive
+    FileUtils.cd("builds/apps") do
+      Minitar.pack(app_name, Zlib::GzipWriter.new(File.open(archive_path, "wb")))
+    end
+  end
+
+  def prepare_directory
+    on(SHIPPY.host) do
+      execute :mkdir, "-p", SHIPPY.current_app_path
+    end
+  end
+
+  def backup
+    backups_path = self.backups_path
+
+    on(SHIPPY.host) do
+      if test("[ -d #{SHIPPY.current_app_path} ]")
+        execute :mkdir, "-p", backups_path
+        execute :mv, SHIPPY.current_app_path, backups_path
+      end
+    end
+  end
+
+  def stop_old
+    backup_path = backups_path.join(app_name)
+
+    on(SHIPPY.host) do
+      if test("[ -f #{backup_path.join("docker-compose.yml")} ]")
+        within backup_path do
+          execute :docker_compose, "down", "--remove-orphans"
+        end
+      end
+    end
+  end
+
+  def upload
+    source_path = SHIPPY.current_app_path.join("..").expand_path
+    archive_path = self.archive_path
+    prepare_directory
+
+    on(SHIPPY.host) do
+      tmp = capture "mktemp"
+      upload! archive_path, tmp
+
+      execute :tar, "-xzpf", tmp, "-C", source_path
+      execute :rm, tmp
+    end
+  end
+
+  def cleanup
+    remove_archive
+    remove_old_releases
+  end
+
+  def remove_archive
+    archive_path = self.archive_path
+
+    run_locally do
+      execute :rm, archive_path
+    end
+  end
+
+  def remove_old_releases
+    app_backups_paths = backups_path.join("..").expand_path
+
+    on(SHIPPY.host) do
+      if test("[ -d #{app_backups_paths} ]")
+        releases = capture(:ls, "-x", app_backups_paths).split
+        directories = (releases - releases.last(SHIPPY.config.keep_releases)).map do |release|
+          app_backups_paths.join(release).to_s
+        end
+
+        if directories.any?
+          directories.each_slice(100) do |directories_batch|
+            execute :rm, "-rf", *directories_batch
+          end
+        end
+      end
+    end
+  end
+
+  def pre_start_hooks
+    say "Running #{app_name} hooks on #{SHIPPY.host}...", :magenta
+
+    within_app do
+      SHIPPY.app.each_hook do |service, options, command|
+        execute :docker_compose, "run", "--rm", options, service, command
+      end
+    end
+  end
+
+  def create_network
+    on(SHIPPY.host) do
+      result = capture("docker", "network", "ls", "-q", "-f", "'name=lan_access'")
+
+      if result.empty?
+        execute :docker, "network", "create", "lan_access"
+      end
+    end
+  end
+
+  def archive_path
+    @archive_path ||= "/tmp/v#{Time.now.to_i}.tar.gz"
+  end
+
+  def backups_path
+    @backups_path ||= SHIPPY.deploy_path.join("backups", app_name, Time.now.to_i.to_s)
+  end
+
+  def with_app
+    path = Pathname.new("apps").join(app_name)
+
+    if path.exist?
+      yield
+    else
+      error_on_missing_app
+    end
+  end
+
+  def error_on_missing_app
+    raise "No app by the name of '#{app_name}'"
+  end
+
+  def within_app(&block)
+    on(SHIPPY.host) do
+      within(SHIPPY.current_app_path) do
+        instance_eval(&block)
+      end
+    end
+  end
+end

data/lib/shippy/cli/base.rb

@@ -0,0 +1,47 @@
+require "thor"
+require "sshkit"
+
+module Shippy::Cli
+  class Base < Thor
+    include SSHKit::DSL
+
+    def self.exit_on_failure?
+      true
+    end
+
+    class_option :config_file, aliases: "-c", default: "config/shippy.yml", desc: "Path to config file"
+    class_option :verbose, type: :boolean, aliases: "-v", desc: "Detailed logging"
+    class_option :quiet, type: :boolean, aliases: "-q", desc: "Minimal logging"
+
+    def initialize(*)
+      super
+      initialize_commander(options)
+    end
+
+    private
+
+    def initialize_commander(options)
+      SHIPPY.tap do |commander|
+        commander.config_file = Pathname.new(File.expand_path(options[:config_file]))
+
+        if options[:verbose]
+          ENV["VERBOSE"] = "1" # For backtraces via cli/start
+          commander.verbosity = :debug
+        end
+
+        if options[:quiet]
+          commander.verbosity = :error
+        end
+      end
+    end
+
+    def print_runtime
+      started_at = Time.now
+      yield
+      Time.now - started_at
+    ensure
+      runtime = Time.now - started_at
+      puts "  Finished all in #{sprintf("%.1f seconds", runtime)}"
+    end
+  end
+end

data/lib/shippy/cli/main.rb

@@ -0,0 +1,76 @@
+require "thor"
+
+class Shippy::Cli::Main < Shippy::Cli::Base
+  desc "init", "Create config stub in config/shippy.yml"
+  option :bundle, type: :boolean, default: false, desc: "Add SHIPPY to the Gemfile and create a bin/shippy binstub"
+  def init
+    require "fileutils"
+
+    if (config_file = Pathname.new(File.expand_path("config/shippy.yml"))).exist?
+      puts "Config file already exists in config/shippy.yml (remove first to create a new one)"
+    else
+      FileUtils.mkdir_p config_file.dirname
+      FileUtils.cp_r Pathname.new(File.expand_path("templates/shippy.yml", __dir__)), config_file
+      puts "Created configuration file in config/shippy.yml"
+    end
+
+    if Pathname.new(File.expand_path("apps")).exist?
+      puts "Apps directory already exists in ./apps (remove first to create a new one)"
+    else
+      FileUtils.mkdir_p "apps"
+      puts "Created apps directory in ./apps"
+    end
+
+    if options[:bundle]
+      if Pathname.new(File.expand_path("bin/shippy")).exist?
+        puts "Binstub already exists in bin/shippy (remove first to create a new one)"
+      else
+        puts "Adding SHIPPY to Gemfile and bundle..."
+        run_locally do
+          execute :bundle, :add, :shippy
+          execute :bundle, :binstubs, :shippy
+        end
+        puts "Created binstub file in bin/shippy"
+      end
+    end
+  end
+
+  desc "version", "Show SHIPPY version"
+  def version
+    puts Shippy::VERSION
+  end
+
+  desc "setup", "Setup all accessories and deploy apps to server"
+  def setup
+    invoke "shippy:cli:server:bootstrap"
+    invoke "shippy:cli:server:setup"
+    deploy
+  end
+
+  desc "deploy", "Deploy all apps to server"
+  def deploy
+    print_runtime do
+      Dir.glob("*", base: "apps").each do |name|
+        Shippy::Cli::App.send :dispatch, :deploy, [name], {}, {}
+      end
+    end
+  end
+
+  desc "stop", "Stop all apps on server"
+  def stop
+    print_runtime do
+      Dir.glob("*", base: "apps").each do |name|
+        Shippy::Cli::App.send :dispatch, :stop, [name], {}, {}
+      end
+    end
+  end
+
+  desc "app", "Manage application"
+  subcommand "app", Shippy::Cli::App
+
+  desc "server", "Bootstrap servers with curl and Docker"
+  subcommand "server", Shippy::Cli::Server
+
+  desc "prune", "Prune old application images and containers"
+  subcommand "prune", Shippy::Cli::Prune
+end

data/lib/shippy/cli/prune.rb

@@ -0,0 +1,21 @@
+class Shippy::Cli::Prune < Shippy::Cli::Base
+  desc "all", "Prune unused images and stopped containers"
+  def all
+    containers
+    images
+  end
+
+  desc "images", "Prune unused images older than 7 days"
+  def images
+    on(SHIPPY.host) do
+      execute :docker, :image, :prune, "--all", "--force", "--filter", "until=#{7.days.in_hours}h"
+    end
+  end
+
+  desc "containers", "Prune stopped containers older than 3 days"
+  def containers
+    on(SHIPPY.host) do
+      execute :docker, :container, :prune, "--force", "--filter", "until=#{3.days.in_hours}h"
+    end
+  end
+end

data/lib/shippy/cli/server.rb

@@ -0,0 +1,24 @@
+class Shippy::Cli::Server < Shippy::Cli::Base
+  desc "bootstrap", "Ensure curl and Docker are installed on server"
+  def bootstrap
+    on(SHIPPY.host) do
+      dependencies_to_install = [].tap do |dependencies|
+        dependencies << "curl" unless execute "which curl", raise_on_non_zero_exit: false
+        dependencies << "docker.io" unless execute "which docker", raise_on_non_zero_exit: false
+        dependencies << "docker-compose" unless execute "which docker-compose", raise_on_non_zero_exit: false
+      end
+
+      if dependencies_to_install.any?
+        execute "apt-get update -y && apt-get install #{dependencies_to_install.join(" ")} -y"
+      end
+    end
+  end
+
+  desc "setup", "Generate directories structure"
+  def setup
+    on(SHIPPY.host) do
+      execute(:mkdir, "-p", SHIPPY.config.deploy_to + "/apps")
+      execute(:mkdir, "-p", SHIPPY.config.deploy_to + "/backups")
+    end
+  end
+end

data/lib/shippy/cli/templates/shippy.yml

@@ -0,0 +1,8 @@
+host: 'homelab.local'
+ssh:
+  user: root
+wildcard_domain: 'local.homelab.com'
+local_domain: local
+secrets:
+  proxy:
+    token: TOKEN

data/lib/shippy/cli.rb

@@ -0,0 +1,10 @@
+require_relative "cli/base"
+require_relative "cli/server"
+require_relative "cli/app"
+require_relative "cli/prune"
+require_relative "cli/main"
+
+module Shippy::Cli
+end
+
+SHIPPY = Shippy::Commander.new

data/lib/shippy/commander.rb

@@ -0,0 +1,45 @@
+module Shippy
+  class Commander
+    attr_accessor :config_file, :verbosity, :repo, :app
+    delegate :host, :deploy_path, to: :config
+
+    def initialize(config_file: nil, verbosity: :info)
+      @config_file, @verbosity = config_file, verbosity
+    end
+
+    def config
+      @config ||= Shippy::Config
+        .new(config_file)
+        .tap { |config| configure_sshkit_with(config) }
+    end
+
+    def with_verbosity(level)
+      old_level = verbosity
+
+      self.verbosity = level
+      SSHKit.config.output_verbosity = level
+
+      yield
+    ensure
+      self.verbosity = old_level
+      SSHKit.config.output_verbosity = old_level
+    end
+
+    def compile
+      Shippy::Compiler.new(app, config: config).compile
+    end
+
+    def current_app_path
+      deploy_path.join("apps", app.name)
+    end
+
+    private
+
+    def configure_sshkit_with(config)
+      SSHKit::Backend::Netssh.configure { |ssh| ssh.ssh_options = config.ssh_options }
+      SSHKit.config.command_map[:docker] = "docker"
+      SSHKit.config.command_map[:docker_compose] = "docker-compose"
+      SSHKit.config.output_verbosity = verbosity
+    end
+  end
+end

data/lib/shippy/compiler.rb

@@ -0,0 +1,68 @@
+module Shippy
+  class Compiler
+    attr_reader :config, :app
+
+    def initialize(app, config:)
+      @app = app
+      @config = config
+    end
+
+    def compile
+      prep_build_dir
+      write_compose_file
+      write_configuration_files
+
+      true
+    end
+
+    private
+
+    def build_dir
+      @build_dir ||= Pathname.pwd.join("builds", "apps", app.name).expand_path
+    end
+
+    def prep_build_dir
+      FileUtils.rm_rf(build_dir)
+      FileUtils.mkdir_p(build_dir)
+    end
+
+    def write_compose_file
+      path = build_dir.join("docker-compose.yml")
+      File.binwrite(path, app.to_yaml)
+    end
+
+    def write_configuration_files
+      Dir.glob("apps/#{app.name}/**/*", File::FNM_DOTMATCH)
+        .reject { |file| File.directory?(file) }
+        .reject { |file| file.match?(/docker-compose\.(rb)?(yml)?/) }
+        .each { |file| create_directory(file) }
+        .each { |file| copy_file(file) }
+    end
+
+    def create_directory(file)
+      path = build_dest(file)
+      directory = File.dirname(path)
+      FileUtils.mkdir_p(directory)
+    end
+
+    def copy_file(file)
+      if file.ends_with?(".erb")
+        copy_template_files(file)
+      else
+        FileUtils.cp(file, build_dest(file))
+      end
+    end
+
+    def copy_template_files(file)
+      new_path = build_dest(file.gsub(".erb", ""))
+      mode = File.stat(file).mode
+      template = ERB.new(File.read(file))
+      result = template.result(app.get_binding)
+      File.open(new_path, "wb", mode) { |f| f.write(result) }
+    end
+
+    def build_dest(path)
+      build_dir.join("..", "..", path).expand_path
+    end
+  end
+end

data/lib/shippy/compose.rb

@@ -0,0 +1,88 @@
+module Shippy
+  class Compose
+    attr_reader :services, :name
+
+    def initialize(name, &block)
+      @name = name
+      @services = []
+      instance_eval(&block)
+    end
+
+    def service(name, &block)
+      service = Service.new(name, app: self, &block)
+      @services << service
+    end
+
+    def xservice(name, &block)
+      puts "Service #{name} is disabled"
+    end
+
+    def deploy_flags
+      if block_given?
+        @deploy_flags = yield
+      else
+        @deploy_flags
+      end
+    end
+
+    def to_hash
+      data = {}
+      data[:version] = "3"
+      data[:services] = services.map(&:to_hash).reduce(:merge)
+      data[:volumes] = volumes_hash.presence
+      data[:networks] = networks_hash.presence
+      data.compact
+    end
+
+    def to_yaml
+      to_hash.deep_stringify_keys.to_yaml
+    end
+
+    def each_hook(&block)
+      @services
+        .flat_map(&:hooks)
+        .each(&block)
+    end
+
+    def secrets(secret_name)
+      Shippy.x.secrets(name, secret_name)
+    end
+
+    def get_binding
+      binding
+    end
+
+    def local_domains
+      @services.flat_map(&:local_domains).uniq
+    end
+
+    delegate :x, to: Shippy
+    delegate :wildcard_domain, :local_domain, to: :x
+
+    private
+
+    def networks
+      services.flat_map(&:networks).uniq.compact
+    end
+
+    def networks_hash
+      data = networks.reduce({}) { |acc, net| acc.merge(net => nil) }
+      data.deep_symbolize_keys!
+      data[:lan_access] = {external: true} if data.key?(:lan_access)
+      data
+    end
+
+    def volumes
+      services
+        .flat_map(&:volumes)
+        .uniq
+        .compact
+        .select { |v| v.start_with?(/[a-z]/) }
+        .map { |v| v.split(":", 2).first }
+    end
+
+    def volumes_hash
+      volumes.reduce({}) { |acc, v| acc.merge(v => nil) }
+    end
+  end
+end

data/lib/shippy/config.rb

@@ -0,0 +1,44 @@
+module Shippy
+  class Config
+    attr_reader :data
+
+    def initialize(file)
+      @data = YAML.load_file(file).deep_symbolize_keys
+    end
+
+    def secrets(app, name)
+      @data
+        .fetch(:secrets)
+        .fetch(app.to_sym)
+        .fetch(name.to_sym)
+    end
+
+    def ssh_options
+      {user: ssh_user, auth_methods: ["publickey"]}.compact
+    end
+
+    def ssh_user
+      if data[:ssh].present?
+        data.dig(:ssh, :user) || "root"
+      else
+        "root"
+      end
+    end
+
+    def deploy_path
+      Pathname.new(deploy_to)
+    end
+
+    def method_missing(name, *args)
+      if @data.key?(name)
+        @data.fetch(name)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      @data.key?(name) || super
+    end
+  end
+end

data/lib/shippy/repo.rb

@@ -0,0 +1,70 @@
+module Shippy
+  class Repo
+    attr_reader :data
+
+    class << self
+      def current
+        Thread.current[:repo]
+      end
+
+      def current=(repo)
+        Thread.current[:repo] = repo
+      end
+
+      def with(repo)
+        old_repo = current
+
+        self.current = repo
+        yield
+      ensure
+        self.current = old_repo
+      end
+
+      def define(&block)
+        current.define(&block)
+      end
+
+      def load_app(name)
+        repo = new
+        repo.load_definitions(pattern: name)
+        repo.data.fetch(name)
+      end
+    end
+
+    def initialize
+      @data = {}
+    end
+
+    def define(&block)
+      name = caller
+        .reject { |path| path.match(/lib\/shippy/) }
+        .find { |path| path.match(/docker-compose\.rb/) }.split(":", 2).first
+      name = File.basename(File.dirname(name))
+      data[name] = Compose.new(name, &block)
+    end
+
+    def load_definitions(pattern: "**")
+      self.class.with(self) do
+        Pathname.glob("apps/#{pattern}/docker-compose.rb")
+          .map(&:expand_path)
+          .each { |path| load path }
+      end
+    end
+
+    def hooks_for(app)
+      data.fetch(app).hooks
+    end
+
+    def each(&block)
+      data.each(&block)
+    end
+
+    def each_app(&block)
+      data.values.each(&block)
+    end
+
+    def app_names
+      data.keys
+    end
+  end
+end

data/lib/shippy/service.rb

@@ -0,0 +1,132 @@
+module Shippy
+  class Service
+    ATTRIBUTES = %i[
+      build command depends_on devices entrypoint environment hostname image
+      labels logging networks ports restart volumes volumes_from working_dir
+      security_opt
+    ].freeze
+
+    attr_reader :name, :app
+
+    ATTRIBUTES.each do |name|
+      define_method(name) do |&block|
+        if block
+          @data.merge!({name => block.call}.compact)
+        else
+          @data[name]
+        end
+      end
+    end
+
+    def initialize(name, app:, &block)
+      @name = name
+      @app = app
+      @data = {}
+
+      instance_eval(&block)
+    end
+
+    def to_hash
+      {@name => @data}
+    end
+
+    def use_default_options
+      use_default_restart
+      use_default_networks
+      use_default_logging
+    end
+
+    def use_default_restart
+      restart { "unless-stopped" }
+    end
+
+    def use_default_logging
+      logging do
+        {
+          driver: "json-file",
+          options: {
+            "max-size": "10m",
+            "max-file": "5"
+          }
+        }
+      end
+    end
+
+    def use_default_networks
+      networks { ["lan_access"] }
+    end
+
+    def use_traefik(name:, alt: nil, port: nil, healthcheck: nil)
+      labels do
+        all_labels = ["traefik.enable=true"]
+        all_labels += build_traefik_labels(name: name, port: port, healthcheck: healthcheck)
+        all_labels += build_traefik_labels(name: alt, port: port, healthcheck: healthcheck) if alt
+
+        all_labels
+      end
+    end
+
+    def build_traefik_labels(name:, port: nil, healthcheck: nil)
+      [
+        "traefik.http.routers.websecure-#{name}.rule=Host(`#{name}.#{wildcard_domain}`)",
+        "traefik.http.routers.websecure-#{name}.entrypoints=websecure",
+        "traefik.http.routers.websecure-#{name}.tls=true",
+        "traefik.http.routers.websecure-#{name}.tls.certresolver=ssl-resolver",
+        "traefik.http.routers.websecure-#{name}.tls.domains[0].main=#{wildcard_domain}",
+        "traefik.http.routers.websecure-#{name}.tls.domains[0].sans=*.#{wildcard_domain}",
+
+        "traefik.http.routers.web-#{name}.rule=Host(`#{name}.#{wildcard_domain}`)",
+        "traefik.http.routers.web-#{name}.entrypoints=web",
+        "traefik.http.routers.web-#{name}.middlewares=secure-redirect-scheme@file",
+
+        "traefik.http.routers.#{name}-local.rule=Host(`#{name}.#{local_domain}`)",
+        "traefik.http.routers.#{name}-local.entrypoints=web",
+        "traefik.http.middlewares.#{name}-local.redirectregex.regex=^http://#{name}.#{local_domain}",
+        "traefik.http.middlewares.#{name}-local.redirectregex.replacement=https://#{name}.#{wildcard_domain}",
+        "traefik.http.middlewares.#{name}-local.redirectregex.permanent=true",
+        "traefik.http.routers.#{name}-local.middlewares=#{name}-local@docker"
+      ].tap do |labels|
+        if port
+          labels << "traefik.http.services.#{name}.loadbalancer.server.port=#{port}"
+          labels << "traefik.http.routers.websecure-#{name}.service=#{name}"
+          labels << "traefik.http.routers.web-#{name}.service=#{name}"
+          labels << "traefik.http.routers.#{name}-local.service=#{name}"
+        end
+
+        if healthcheck
+          labels << "traefik.http.services.#{name}.loadbalancer.healthcheck.path=#{healthcheck}"
+          labels << "traefik.http.services.#{name}.loadbalancer.healthcheck.interval=5s"
+        end
+      end
+    end
+
+    def secrets(name)
+      @app.secrets(name)
+    end
+
+    delegate :x, to: Shippy
+    delegate :wildcard_domain, :local_domain, to: :x
+
+    def hooks
+      if block_given?
+        @hooks = normalize_hooks(yield)
+      else
+        @hooks.to_a.map { |data| [name, data[:options], data[:cmd]] }
+      end
+    end
+
+    def local_domains
+      labels.to_a.filter_map do |label|
+        label.match(/Host\(`(\w+\.#{local_domain})`\)/).to_a[1]
+      end
+    end
+
+    private
+
+    def normalize_hooks(data)
+      Array
+        .wrap(data)
+        .map { |data| data.is_a?(String) ? {cmd: data} : data }
+    end
+  end
+end

data/lib/shippy/version.rb

@@ -0,0 +1,3 @@
+module Shippy
+  VERSION = "0.1.1"
+end

data/lib/shippy.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "active_support/all"
+require "fileutils"
+require "erb"
+require "thor"
+require "minitar"
+require "zlib"
+
+require_relative "shippy/version"
+require_relative "shippy/config"
+require_relative "shippy/commander"
+require_relative "shippy/cli"
+require_relative "shippy/compose"
+require_relative "shippy/service"
+require_relative "shippy/repo"
+require_relative "shippy/compiler"
+
+module Shippy
+  class Error < StandardError; end
+
+  class << self
+    def define(&block)
+      Shippy::Repo.define(&block)
+    end
+
+    def x
+      SHIPPY.config
+    end
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: shippy
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Marius Bobin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.2
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.17'
+- !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: minitar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !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: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description:
+email:
+- marius@mbobin.me
+executables:
+- shippy
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/shippy
+- lib/shippy.rb
+- lib/shippy/cli.rb
+- lib/shippy/cli/app.rb
+- lib/shippy/cli/base.rb
+- lib/shippy/cli/main.rb
+- lib/shippy/cli/prune.rb
+- lib/shippy/cli/server.rb
+- lib/shippy/cli/templates/shippy.yml
+- lib/shippy/commander.rb
+- lib/shippy/compiler.rb
+- lib/shippy/compose.rb
+- lib/shippy/config.rb
+- lib/shippy/repo.rb
+- lib/shippy/service.rb
+- lib/shippy/version.rb
+homepage: https://mbobin.me/shippy
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://mbobin.me/shippy
+  source_code_uri: https://mbobin.me/shippy
+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.4.6
+signing_key:
+specification_version: 4
+summary: Deployment wrapper around docker-compose and SSH Kit
+test_files: []