contained 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9d111821a77162f94e56e4cc1258985969916bfc0e2398ba1e6d73a63041ab9
-  data.tar.gz: adc0d243873960da0980552d4ee3078d01d89469a0f2c0af2b865e24f6e57419
+  metadata.gz: 25079cf5b856681f7a7c5ab9118cbe7a8249857b156dc8b201521abcb1613465
+  data.tar.gz: f2f555e13d1b9d9828c0d9b54289a06e141ba5a5b15f91774dcb5d6678f8e3ad
 SHA512:
-  metadata.gz: 04a7220627e3313d08dec0b056e6695e33ed32f60bf5b4f28ed0e26d1dc843464d3fdbcf9ae5248b9bf9d34f5d77d4d3e385903882f127be76a7db57265c928e
-  data.tar.gz: 7af0e9f1cc1f8f5193f0ce00a76aa192aebcd8b9d08abb3cd12dde56dfa28e8adb9dad65b581e604649960e1c66de2790aea5b9643e868eae2b4069812d563db
+  metadata.gz: ff042e1bbb56c069d3fc1b55cd8f97ca68fab3d24ab8d731d3e2d90b50f2b9a1c2bc5192edef5a764c89726e8b6e8716c978ffe22feb9ea8546da9dfedd0e23e
+  data.tar.gz: 0aa327a38c19aaa4b1c91cd890f7e1db2a2fc6615223fa882ef46c6426607553aefbc3136c33fe6232003c28bc4547912d0e7879725e950c99a277bcf5023ca0

data/Gemfile

@@ -2,12 +2,10 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in contained.gemspec
 gemspec
 
 gem "irb"
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-basic"

data/README.md

@@ -1,39 +1,107 @@
 # Contained
 
-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/contained`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_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:
+## Example
+
+**config/deploy.yml**
+
+```yaml
+stack: example
+
+environments:
+  production:
+    servers:
+      - 1.2.3.4
+      - 5.6.7.8
+  test:
+    servers:
+      - 4.3.2.1
+      - 8.7.6.5
+
+config:
+  services:
+    caddy:
+      image: demo/caddy
+      ports:
+        - "80:80"
+      volumes:
+        - caddy_data:/data
+        - caddy_config:/config
+      healthcheck:
+        test: ["CMD", "curl", "-f", "http://localhost:80/up"]
+        interval: 30s
+        timeout: 10s
+        retries: 3
+    backend:
+      build: demo/backend
+      healthcheck:
+        test: ["CMD", "curl", "-f", "http://localhost:3000/up"]
+        interval: 30s
+        timeout: 10s
+        retries: 3
+    frontend:
+      build: demo/frontend
+      healthcheck:
+        test: ["CMD", "curl", "-f", "http://localhost:3000/up"]
+        interval: 30s
+        timeout: 10s
+        retries: 3
+  volumes:
+    caddy_data:
+    caddy_config:
+```
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install contained
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
-
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+contained setup
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+### w/ Caddy
 
-## Development
+**Dockerfile**
 
-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.
+```dockerfile
+# syntax = docker/dockerfile:1
 
-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).
+ARG CADDY_VERSION=2.9.1
 
-## Contributing
+FROM docker.io/library/caddy:${CADDY_VERSION}-alpine
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/contained.
+COPY Caddyfile /etc/caddy/Caddyfile
+```
 
-## License
+**Caddyfile**
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```caddyfile
+demo.com {
+  encode
+
+  handle /up {
+    respond "OK" 200 {
+      close
+    }
+  }
+
+  handle /backend/up {
+    uri replace /backend/ /
+    reverse_proxy backend:3000
+  }
+
+  handle /frontend/up {
+    uri replace /frontend/ /
+    reverse_proxy frontend:3000
+  }
+
+  handle /api/* {
+    reverse_proxy backend:3000
+  }
+
+  handle /* {
+    reverse_proxy frontend:3000
+  }
+}
+```

data/exe/contained

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "contained"
+
+cli = Contained::CLI.new
+cli.parse

data/lib/contained/cli/base.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Contained
+  class CLI
+    # @abstract
+    class Base
+      # @param stdin [IO]
+      # @param stdout [IO]
+      # @param argv [Array<String>]
+      def self.handle!(stdin:, stdout:, argv:)
+        new(stdin: stdin, stdout: stdout, argv: argv).handle!
+      end
+
+      # @param stdin [IO]
+      # @param stdout [IO]
+      # @param argv [Array<String>]
+      def initialize(stdin:, stdout:, argv:)
+        @stdin = stdin
+        @stdout = stdout
+        @argv = argv
+      end
+
+      def handle!
+        raise NotImplementedError, "#handle! undefined"
+      end
+    end
+  end
+end

data/lib/contained/cli/deploy.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Contained
+  class CLI
+    # @example
+    #   Contained::CLI::Deploy.handle!(stdout: $stdout, stderr: $stderr, argv: %i[--environment demo])
+    class Deploy < Contained::CLI::Base
+      def handle!
+        arguments = arguments!
+
+        config = Contained::Config.load_file(path: arguments.fetch(:config))
+        environment = arguments.fetch(:environment)
+
+        Contained::Command::Deploy.execute!(stdin: @stdin, stdout: @stdout, environment:, config:)
+      end
+
+    private
+
+      # @return [Hash]
+      def arguments!
+        { config: "./config/deploy.yml", environment: "default" }.tap do |arguments|
+          parser(into: arguments).parse!
+        end
+      end
+
+      # @param into [Hash]
+      # @return [OptionParser]
+      def parser(into:)
+        OptionParser.new do |options|
+          options.banner = "usage: contained deploy [options] "
+
+          options.on("-h", "--help", "help") do
+            @stdout.puts(options)
+            exit
+          end
+
+          options.on("-c", "--config=CONFIG", "config") do |config|
+            into[:config] = config
+          end
+          options.on("-e", "--environment=ENVIRONMENT", "environment") do |environment|
+            into[:environment] = environment
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contained/cli/init.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Contained
+  class CLI
+    # @example
+    #   Contained::CLI::Init.handle!(stdout: $stdout, stderr: $stderr, argv: %i[--image example/app --stack app])
+    class Init < Base
+      Arguments = Data.define(:image, :stack)
+
+      TEMPLATE = <<~YAML
+        stack: example
+
+        registry:
+          server: hub.docker.com
+          username:
+            - DOCKER_REGISTRY_TOKEN
+          password:
+            - DOCKER_REGISTRY_TOKEN
+
+        environments:
+          production:
+            servers:
+              - 1.2.3.4
+              - 5.6.7.8
+          test:
+            servers:
+              - 4.3.2.1
+              - 8.7.6.5
+
+        config:
+          services:
+            app:
+              image: example/app
+              ports:
+                - "80:80"
+              healthcheck:
+                test: ["CMD", "curl", "-f", "http://localhost/up"]
+                interval: 30s
+                timeout: 10s
+                retries: 3
+      YAML
+
+      def handle!
+        if File.exist?("./config/deploy.yml")
+          @stdout.puts("overwrite 'config/deploy.yml' (yes/no)?")
+          @stdin.gets { |response| return unless response.strip.eql?("yes") }
+        end
+
+        Dir.mkdir("./config") unless Dir.exist?("./config")
+        File.write("./config/deploy.yml", TEMPLATE)
+
+        @stdout.puts("setup 'config/deploy.yml'")
+      end
+
+    private
+
+      # @return [Arguments]
+      def arguments!
+        Arguments.new(DEFAULT_IMAGE, DEFAULT_STACK).tap do |arguments|
+          parser(into: arguments).parse!(@argv)
+        end
+      end
+
+      # @param into [Arguments]
+      # @return [OptionParser]
+      def parser(into:)
+        OptionParser.new do |options|
+          options.banner = "usage: contained init [options]"
+
+          options.on("-h", "--help", "help") do
+            @stdout.puts(options)
+            exit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contained/cli/setup.rb

@@ -0,0 +1,5 @@
+class Contained::CLI::Deploy Contained::CLI::Base
+  def handle!
+    # TODO
+  end
+end

data/lib/contained/cli.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Contained
+  # @example
+  #
+  #   cli = Contained::CLI.new
+  #   cli.parse
+  class CLI
+    # @param input [IO]
+    # @param output [IO]
+    # @param argv [Array<String>] the arguments (e.g. ['deploy', '--help'])
+    def initialize(stdin: $stdin, stdout: $stdout, argv: ARGV)
+      @stdin = stdin
+      @stdout = stdout
+      @argv = argv
+    end
+
+    def parse
+      parser.order!(@argv)
+      command = @argv.shift
+      return if command.nil?
+
+      handler =
+        case command
+        when "init" then ::Contained::CLI::Init
+        when "setup" then ::Contained::CLI::Setup
+        when "deploy" then ::Contained::CLI::Deploy
+        else raise ::Contained::Error, "unsupported command=#{command.inspect}"
+        end
+
+      handler.handle!(stdin: @stdin, stdout: @stdout, argv: @argv)
+    end
+
+    private
+
+    # @return [OptionParser]
+    def parser
+      @parser ||= OptionParser.new do |options|
+        options.banner = "usage: contained [options] <command> [<args>]"
+
+        options.on("-h", "--help", "help") do
+          @stdout.puts(options)
+          exit
+        end
+
+        options.on("-v", "--version", "version") do
+          @stdout.puts(Contained::VERSION)
+          exit
+        end
+
+        options.separator <<~COMMANDS
+          commands:
+            init
+            setup
+            deploy
+        COMMANDS
+      end
+    end
+  end
+end

data/lib/contained/command/base.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "sshkit"
+
+module Contained
+  module Command
+    # @abstract
+    class Base
+      include SSHKit::DSL
+
+      def self.execute!(...)
+        new(...).execute!
+      end
+
+      # @param stdin [IO]
+      # @param stdout [IO]
+      # @environment [String]
+      # @config [Contained::Config]
+      def initialize(stdin:, stdout:, environment:, config:)
+        @stdin = stdin
+        @stdout = stdout
+        @environment = environment
+        @config = config
+      end
+
+      def execute!
+        raise NotImplementedError, "#execute! undefined"
+      end
+
+    protected
+
+      def servers
+        @config.dig("environments", @environment, "servers")
+      end
+    end
+  end
+end

data/lib/contained/command/deploy.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# .contained/itva/compose.yml
+# .contained/itva/.env
+module Contained
+  module Command
+    # @example
+    #   Contained::Command::Deploy.execute(environment: "production", config: {})
+    class Deploy < Base
+      def execute!
+        stack = @config.fetch("stack")
+
+        @stdout.puts("[deploying] stack=#{stack} environment=#{@environment}")
+
+        on servers, in: :sequence do |host|
+          puts("[starting] host=#{host.hostname}")
+          within "~/.contained/#{stack}" do
+            execute("source .env")
+            execute("docker stack deploy -c ./compose.yml #{stack} --with-registry-auth")
+          end
+          puts("[done] host=#{host.hostname}")
+        end
+      end
+    end
+  end
+end

data/lib/contained/command/login.rb

@@ -0,0 +1,24 @@
+class Contained::Command::Login
+  # @param stdin [IO]
+  # @param stdout [IO]
+  # @param argv [Array<String>]
+  def initialize(stdin:, stdout:, argv:)
+    @stdin = stdin
+    @stdout = stdout
+    @argv = argv
+  end
+
+  def execute!
+    raise NotImplementedError, "#handle! undefined"
+  end
+
+  # @return [String]
+  def username!
+    @options.fetch(:username)
+  end
+
+  # @return [String]
+  def password
+    @options.fetch(:password)
+  end
+end

data/lib/contained/command.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Contained
+  module Command
+  end
+end

data/lib/contained/config.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module Contained
+  # @example
+  #
+  #  Contained::Config.load_file(path: "./config/deploy.yml")
+  class Config
+    # @param path [String]
+    #
+    # @return [Contained::Config]
+    def self.load_file(path: "./config/deploy.yml")
+      YAML.load_file(path)
+    end
+
+    # # @param data [Hash]
+
+    # # @return [Contained::Config]
+    # def self.parse!(data:)
+    #   new(
+    #     stack: data.fetch("stack"),
+    #     registry: data.fetch("registry"),
+    #     environments: data.fetch("environments"),
+    #     config: data.fetch("config")
+    #   )
+    # end
+
+    # # @!attribute [rw] stack
+    # #   @return [String]
+    # attr_accessor :stack
+
+    # # @!attribute [rw] registry
+    # #   @return [Hash]
+    # attr_accessor :registry
+
+    # # @!attribute [rw] environments
+    # #   @return [Hash]
+    # attr_accessor :environments
+
+    # # @!attribute [rw] config
+    # #   @return [Hash]
+    # attr_accessor :config
+
+    # # @param stack [String]
+    # # @param registry [Hash]
+    # # @param environments [Hash]
+    # # @param config [Hash]
+    # def initialize(stack:, registry:, environments:, config:)
+    #   @stack = stack
+    #   @registry = registry
+    #   @environments = environments
+    #   @config = config
+    # end
+  end
+end

data/lib/contained/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Contained
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/contained.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "contained/version"
+require 'zeitwerk'
+require 'optparse'
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect "cli" => "CLI"
+loader.setup
 
 module Contained
   class Error < StandardError; end

metadata

@@ -1,18 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: contained
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 bindir: exe
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
-dependencies: []
+date: 2025-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erb
+  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: optparse
+  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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  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: zeitwerk
+  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'
 description: Makes releasing docker based containers via SSH using swarm a breeze
 email:
 - kevin@ksylvest.com
-executables: []
+executables:
+- contained
 extensions: []
 extra_rdoc_files: []
 files:
@@ -20,7 +91,19 @@ files:
 - README.md
 - bin/console
 - bin/setup
+- exe/contained
 - lib/contained.rb
+- lib/contained/cli.rb
+- lib/contained/cli/base.rb
+- lib/contained/cli/deploy.rb
+- lib/contained/cli/init.rb
+- lib/contained/cli/setup.rb
+- lib/contained/command.rb
+- lib/contained/command/base.rb
+- lib/contained/command/deploy.rb
+- lib/contained/command/login.rb
+- lib/contained/config.rb
+- lib/contained/config/registry.rb
 - lib/contained/version.rb
 homepage: https://github.com/ksylvest/contained
 licenses:
@@ -29,6 +112,7 @@ metadata:
   homepage_uri: https://github.com/ksylvest/contained
   source_code_uri: https://github.com/ksylvest/contained
   changelog_uri: https://github.com/ksylvest/contained
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib