ferryboat 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa70498d8da44c4794ae00a29448c7d601ff41e81da201c782708145ae00accb
-  data.tar.gz: d5c44d72d8a1e96b07e1b6c29414c3575aaa4bbbd87d6c0ede793f5a38b12507
+  metadata.gz: fdc6d5593bb5c8e80755aa06380ddd8f3096d1569d7a7fc5561f9c943e9c9fc3
+  data.tar.gz: cdbb2b13faabcd143ba1c38b2a0571c6bb384a7b582cc7f7a72239b74b0c69ce
 SHA512:
-  metadata.gz: ac33e17fb7b363c51e728cec591618c42145acbac25122685a3d3ddb02a8cc8f564c8d213eaa79a365002658c70577749734120dbeb70b114f931c15bfefc69b
-  data.tar.gz: d9cc8fc64f0d03a93a920d99f29eb6682d34f472edef567e7c19640c6833a47963f0a0377252e29588075c8f8aa97fa68b6da17ac57c77ceb3ac87a4ec98a078
+  metadata.gz: 349532f647384780b9c39d9753589139aeec49067399b507b0d20b72574afdca1e2a46a8bd878d676027bb87f0ce7f7b8e4fed8c883882bd4cc86384d75636ee
+  data.tar.gz: 705168fb7067e2cb0a6cb942fe8d558aa8026459f48c2f4c2f66e47d46d40da94418aa41802e08f25ca09da4ce2950734450ae8351ec124f8766ac54fceac635

data/README.md

@@ -1,6 +1,6 @@
 # Ferryboat ⚓️
 
-**Ferryboat** is a lightweight deployment tool built by **21tycoons** for teams who want **zero-downtime deployments** without the complexity of Kubernetes or heavyweight DevOps stacks.  
+**Ferryboat** is a lightweight deployment tool built by **21tycoons** for teams who want **zero-downtime deployments** for marketing/static sites without the complexity of Kubernetes or heavyweight DevOps stacks.  
 
 It’s designed for marketing sites, micro-apps, and fast-moving projects that need **confidence in production** while staying **simple, portable, and developer-friendly**.
 
@@ -12,7 +12,7 @@ It’s designed for marketing sites, micro-apps, and fast-moving projects that n
 - **Staging environments baked in**
 - **Lightweight backups** of container volumes
 - **GitHub integration** for pulling and building images
-- **Simple CLI** powered by Thor
+- **Simple CLI**
 - **Config-driven** via `ferryboat.yml`
 
 ---

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ferryboat"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/ferryboat

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$stdout.sync = true
+
+# Quiet thread exceptions
+Thread.report_on_exception = false
+
+# Be nice on Ctrl-C and TERM
+Signal.trap("INT")  { exit 0 }
+Signal.trap("TERM") { exit 0 }
+Signal.trap("PIPE") { exit 0 } rescue nil
+
+begin
+  require "ferryboat"
+  require "ferryboat/cli" # explicit for reliability
+rescue LoadError => e
+  warn "ferryboat: failed to load library: #{e.message}"
+  warn e.backtrace.join("\n") if ENV["FERRY_DEBUG"] == "1"
+  exit 1
+end
+
+begin
+	Ferryboat::Cli.start(ARGV)
+rescue SystemExit => e
+  # Respect Thor's exit codes
+  exit e.status
+rescue => e
+	warn "ferryboat: #{e.message}"
+  warn e.backtrace.join("\n") if ENV["FERRY_DEBUG"] == "1"
+	exit 1
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ferryboat/config.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module Ferryboat
+  class Config
+    attr_reader :env, :service, :image_repo, :domain, :host,
+                :provider, :git_url, :git_branch,
+                :health_path, :health_timeout, :detect_timeout,
+                :auto_backup
+
+    REQUIRED_KEYS = %i[service image_repo domain].freeze
+
+    def self.from_env(env: ENV.fetch("FERRY_ENV", "production"))
+      new(
+        env:          env,
+        service:      ENV.fetch("FERRY_SERVICE", nil),
+        image_repo:   ENV.fetch("FERRY_IMAGE",  nil),
+        domain:       ENV.fetch("FERRY_DOMAIN", nil),
+        host:         ENV.fetch("FERRY_HOST", "localhost"),
+        provider:     ENV.fetch("FERRY_PROVIDER", "docker"), # docker|kamal
+        git_url:      ENV["GIT_URL"],
+        git_branch:   ENV.fetch("GIT_BRANCH", "main"),
+        health_path:  ENV.fetch("FERRY_HEALTH_PATH", "/up"),
+        health_timeout: Integer(ENV.fetch("FERRY_HEALTH_TIMEOUT", "120")),
+        detect_timeout: Integer(ENV.fetch("FERRY_TRAEFIK_DETECT_TIMEOUT", "60")),
+        auto_backup:  ENV["FERRY_AUTO_BACKUP"] == "true"
+      )
+    end
+
+    # Optional YAML loader (keeps env override semantics)
+    def self.from_file(path, env: "production")
+      data = YAML.load_file(path)
+      cfg  = (data[env] || {})
+      new(
+        env:            env,
+        service:        ENV["FERRY_SERVICE"]     || cfg["service"],
+        image_repo:     ENV["FERRY_IMAGE"]       || cfg["image_repo"] || cfg["docker_registry"],
+        domain:         ENV["FERRY_DOMAIN"]      || cfg["domain"],
+        host:           ENV["FERRY_HOST"]        || cfg["host"] || "localhost",
+        provider:       ENV["FERRY_PROVIDER"]    || cfg["provider"] || "docker",
+        git_url:        ENV["GIT_URL"]           || cfg["git_url"],
+        git_branch:     ENV["GIT_BRANCH"]        || cfg["git_branch"] || "main",
+        health_path:    ENV["FERRY_HEALTH_PATH"] || cfg["health_path"] || "/up",
+        health_timeout: Integer(ENV["FERRY_HEALTH_TIMEOUT"] || cfg["health_timeout"] || 120),
+        detect_timeout: Integer(ENV["FERRY_TRAEFIK_DETECT_TIMEOUT"] || cfg["detect_timeout"] || 60),
+        auto_backup:    (ENV["FERRY_AUTO_BACKUP"] || cfg["auto_backup"]).to_s == "true"
+      )
+    end
+
+    def initialize(env:, service:, image_repo:, domain:, host:, provider:, git_url:, git_branch:, health_path:, health_timeout:, detect_timeout:, auto_backup:)
+      @env, @service, @image_repo, @domain = env, service, image_repo, domain
+      @host, @provider = host, provider
+      @git_url, @git_branch = git_url, git_branch
+      @health_path, @health_timeout, @detect_timeout = health_path, health_timeout, detect_timeout
+      @auto_backup = auto_backup
+      validate!
+    end
+
+    def validate!
+      missing = []
+      missing << :service   if blank?(service)
+      missing << :image_repo if blank?(image_repo)
+      missing << :domain    if blank?(domain)
+      return true if missing.empty?
+      raise ArgumentError, "Missing required config: #{missing.join(', ')}"
+    end
+
+    def provider_runner
+      case provider
+      when "kamal"  then Ferryboat::Deployer::KamalRunner.new
+      when "docker" then Ferryboat::Deployer::DockerRunner.new
+      else raise ArgumentError, "Unknown provider: #{provider.inspect}"
+      end
+    end
+
+    def to_h
+      {
+        env: env, service: service, image_repo: image_repo, domain: domain,
+        host: host, provider: provider, git_url: git_url, git_branch: git_branch,
+        health_path: health_path, health_timeout: health_timeout,
+        detect_timeout: detect_timeout, auto_backup: auto_backup
+      }
+    end
+
+    private
+
+    def blank?(s) = s.nil? || s.to_s.strip.empty?
+  end
+end

data/lib/ferryboat/kamal.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Ferryboat
+  # Wraps Kamal CLI commands for remote execution
+  class Kamal
+    def initialize(app: nil, reuse: true)
+      @app   = app || ENV.fetch("FERRY_SERVICE")
+      @reuse = reuse
+    end
+
+    # run a raw kamal command
+    def run(*args)
+      cmd = ["kamal"]
+      cmd << "app" << "exec"
+      cmd << "--reuse" if @reuse
+      cmd << "--app" << @app if @app
+      cmd << "--" << "/bin/sh" << "-lc" << %("#{args.join(' ')}")
+      sh cmd.join(" ")
+    end
+
+    # convenience: docker subcommand
+    def docker(*args)
+      run("docker", *args)
+    end
+
+    private
+
+    def sh(cmd)
+      puts "→ #{cmd}"
+      system(cmd)
+    end
+  end
+end

data/lib/ferryboat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ferryboat
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/ferryboat.rb

@@ -3,6 +3,4 @@
 require_relative "ferryboat/version"
 
 module Ferryboat
-  class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ferryboat
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - 21tycoons
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2025-08-17 00:00:00.000000000 Z
+date: 2025-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -38,18 +38,26 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 description: |
-  Ferryboat is a deployment solution focused on simplicity and reliability.
+  Ferryboat is a deployment solution for marketing/static sites focused on simplicity and reliability.
   It supports zero-downtime rollouts, staging environments, and basic volume
   backups. Designed to work with Docker and SSH, it helps teams deliver code
   safely to production without unnecessary complexity.
 email:
 - liroy@tycooncrm.com
-executables: []
+executables:
+- ferryboat
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- bin/console
+- bin/ferryboat
+- bin/setup
 - lib/ferryboat.rb
+- lib/ferryboat/cli.rb
+- lib/ferryboat/config.rb
+- lib/ferryboat/deployer.rb
+- lib/ferryboat/kamal.rb
 - lib/ferryboat/version.rb
 homepage: https://github.com/21tycoons/ferryboat
 licenses:
@@ -71,5 +79,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.5
 specification_version: 4
-summary: Lightweight zero-downtime deployment tool.
+summary: Lightweight zero-downtime deployment tool for marketing/static sites.
 test_files: []