stack_car 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6ed8d5c6219471376a05ccc900ef285e6dd0409c4b6954a115282280fdbfb38
-  data.tar.gz: f87e0c76404381eda7bcf77e08ea24a937f197556cb77ad0e677540db09eba08
+  metadata.gz: 90e88a55ea7a8c0d22d9dbe7a1cd65b090a8c45f14a60608d82e152c993637dd
+  data.tar.gz: d6b2c2278fdc79e14f01c62db89af4a2c393b6a05d1248d4ca7bc04053df6f5e
 SHA512:
-  metadata.gz: 348b12ba0d514385f5b1b1263581e987aae3e2714c8a61aa888305a69fff5ce18b1a83906f04a349054dd4dd275a7df9d7ccbc005ecf3b03be0f0769ab1f25e0
-  data.tar.gz: c83f60d3aadd3b9e8aae2bd2fec26ed27759fdf4a8be6a1ef088f1e76eb841625cc00ce2982aab1f1c6261579f06a06eafe303953092aa90125053da970a3c7e
+  metadata.gz: 7ee954fc6d2646fb4e5056de6397785fc78f87c55529c1b86af5c5d88daaa1af73cf5cfdbc7c7db5e4eaddc34d0a889d875e0ab00381c6aebc05ac64fc88a481
+  data.tar.gz: fd8d7f014fcd1deef882dd9deeefa4886f091ff5ddcad96e7f48a1ee1a06cd296b201bb05b5e419cd6497e4d11082c27396ea6dd11c87047794340c5dfd4ff26

data/.github/workflows/rspec-action.yaml

@@ -1,35 +1,35 @@
 name: Test
-on: 
+on:
   push:
     branches:
       - main
   pull_request:
     branches:
       - main
-jobs: 
+jobs:
   rspec:
     name: Run rspec with ruby
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v3
-    - name: Cache
-      uses: actions/cache@v2.1.3
-      with:
-        path: vendor/bundle
-        key: '2.3'
-    - name: Setup Ruby
-      uses: ruby/setup-ruby@v1.59.1
-      with:
-        ruby-version: '2.3'
-    - name: Dependencies
-      run: |
-        bundle config path vendor/bundle
-        bundle install
-    - name: Rspec
-      run: 'bundle exec rspec'
-    - name: Publish Test Report
-      uses: mikepenz/action-junit-report@v3
-      if: always() # always run even if the previous step fails
-      with:
-        report_paths: '**/build/test-results/test/TEST-*.xml'
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Cache
+        uses: actions/cache@v4.2.3
+        with:
+          path: vendor/bundle
+          key: "2.3"
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1.59.1
+        with:
+          ruby-version: "2.3"
+      - name: Dependencies
+        run: |
+          bundle config path vendor/bundle
+          bundle install
+      - name: Rspec
+        run: "bundle exec rspec"
+      - name: Publish Test Report
+        uses: mikepenz/action-junit-report@v3
+        if: always() # always run even if the previous step fails
+        with:
+          report_paths: "**/build/test-results/test/TEST-*.xml"

data/.gitignore

@@ -8,4 +8,6 @@
 /spec/reports/
 /tmp/
 **/.#*
-/public/*
+/public/*
+/proxy/localhost*
+.tool-versions

data/README.md

@@ -17,28 +17,76 @@ Stack Car is an opinionated set of tools around Docker and Rails.  It provides c
 Because stack_car will be used to run your application in side of Docker, you want to install stack car in to your system Ruby instead of putting in your applications Gemfile
 
 ```bash
-gem install stack_car 
+gem install stack_car
 ```
 
 ## Usage
 
-Commands are accesible via the "sc" short cut. Note: this will need to be in your command path in front of the spreadsheet command (sc), which is a fairly archaiac unix spreadsheet tool. We're guessing you don't edit a lot of spreadsheets in your terminal, but if you do, we also figure you can override your path order pretty easily.  Many of these commands have short versions or alias to make remembering them easier.  If there are obvious aliases missing, PRs are welcome.
+Commands are accessible via the "sc" short cut. Note: this will need to be in your command path in front of the spreadsheet command (sc), which is a fairly archaiac unix spreadsheet tool. We're guessing you don't edit a lot of spreadsheets in your terminal, but if you do, we also figure you can override your path order pretty easily.  Many of these commands have short versions or alias to make remembering them easier.  If there are obvious aliases missing, PRs are welcome.
 
 ```ruby
 Commands:
   stack_car bundle_exec ARGS  # wraps docker compose exec web bundle exec unless --service is used to specify (sc be ARGS)
   stack_car console ARGS      # shortcut to start rails console
-  stack_car dockerize DIR     # Will copy the docker tempates in to your project, see options for supported dependencies
+  stack_car dockerize DIR     # Will copy the docker templates in to your project, see options for supported dependencies
   stack_car exec ARGS         # wraps docker compose exec web unless --service is used to specify
   stack_car help [COMMAND]    # Describe available commands or one specific command
   stack_car stop              # starts docker compose with rebuild and orphan removal, defaults to all
   stack_car up                # starts docker compose with rebuild and orphan removal, defaults to web
   stack_car walk ARGS         # wraps docker compose run web unless --service is used to specify
+  stack_car proxy up          # starts proxy container for SSL termination
+  stack_car proxy down        # stops running proxy container
+  stack_car proxy cert        # generates SSL certificates for local development, uses *.localhost.direct
 ```
 
+## Proxy
+StackCar has a built-in proxy designed to simplify local SSL development. The proxy provides SSL termination for your web services, allowing you to run your applications with HTTPS locally.
+
+### Getting Started with the Proxy
+
+To use the StackCar proxy:
+1. **Download and Install the SSL certificates** for local development:
+   ```bash
+   sc proxy cert
+   ```
+   This will download the SSL certificates for `*.localhost.direct`. This only needs to be done once per version of stack_car.
+
+2. **Start the proxy**:
+   ```bash
+   sc proxy up
+   ```
+
+3. If you application is running in Docker, make sure you application has labels:
+   ```yaml
+   labels:
+     - "traefik.enable=true"
+     - "traefik.http.routers.my-app.tls=true"
+     - "traefik.http.routers.my-app.entrypoints=websecure"
+     - "traefik.http.routers.my-app.rule=HostRegexp(`my-app.localhost.direct`)"
+     - "traefik.http.services.my-app.loadbalancer.server.port=3000"
+   ```
+
+4. **Access your application** using `https://my-app.localhost.direct`
+
+### Proxy Configuration
+
+The proxy configuration can be customized in your `docker-compose.yml` file. By default, it's configured to handle SSL termination on port 443 and forward traffic to your application services.
+
+### Stopping the Proxy
+
+When you're done working with SSL, you can stop the proxy:
+```bash
+sc proxy down
+```
+
+### Troubleshooting
+
+- **Certificate issues**: If your browser doesn't trust the certificate, you may need to add the generated certificate to your system's trust store.
+- **Port conflicts**: Ensure port 443 is available on your local machine.
+
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can run `bin/test_sc` to run the command but from your local check out. 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`
@@ -79,7 +127,7 @@ Alternatively, set it in your shell's `rc` file (`~/.bashrc`, `~/.zshrc`, etc.)
 
 With `THOR_MERGE` set, you can enter `m` at the command prompt when there is a conflict between app and `sc` template files.
 
-*Note*: For best experience, set `THOR_MERGE` to **GUI text editor** (ie. `code` or `atom`). 
+*Note*: For best experience, set `THOR_MERGE` to **GUI text editor** (ie. `code` or `atom`).
 
 Initiating a merge pulls 2 versions of the file to the editor. One is what is proposed by stack_car, the other is the original. **Add what you need from the template version to the original file and save the changes**.
 
@@ -107,7 +155,7 @@ stack_car will have provided sensible defaults for your services but customizati
 - Do a text search to find and replace any instances `CHANGEME` in the generated files
 - Add any **general environment variables** to `.env`
   - This sets defaults for all docker compose environments
-- Add any **development environment variables** to `.env.development` 
+- Add any **development environment variables** to `.env.development`
   - These set up any new values or overrides specific to your development env
 - Run `sc build` to build your image
   - On failed build, browse the terminal output to track down and squash any misconfigurations. Rebuild

data/bin/test_sc

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+ENV['STACK_CAR_DEBUG'] = 'true'
+load "#{File.dirname(__FILE__)}/../lib/stack_car.rb"
+
+StackCar::HammerOfTheGods.start(ARGV)

data/lib/stack_car/cli.rb

@@ -2,6 +2,7 @@ require 'thor'
 require 'erb'
 require 'dotenv'
 require 'json'
+require 'byebug' if ENV['STACK_CAR_DEBUG']
 
 module StackCar
   class HammerOfTheGods < Thor
@@ -11,10 +12,17 @@ module StackCar
       File.join(File.dirname(__FILE__), '..', '..', 'templates')
     end
 
+    def self.gem_root
+      File.join(File.dirname(__FILE__), '..', '..')
+    end
+
     def self.exit_on_failure?
       true
     end
 
+    desc 'proxy COMMAND', 'Manage the traefik proxy for local development'
+    subcommand 'proxy', Proxy
+
     method_option :service, default: 'web', type: :string, aliases: '-s'
     method_option :build, default: false, type: :boolean, aliases: '-b'
     method_option :logs, default: true, type: :boolean
@@ -330,6 +338,7 @@ module StackCar
     end
 
     protected
+
     def compose_depends(*excludes)
       @compose_depends = []
       services = [:fcrepo, :postgres, :mysql, :elasticsearch, :sidekiq, :solr, :redis, :mongodb, :memcached] - excludes
@@ -370,6 +379,7 @@ module StackCar
       if !result
         exit(1)
       end
+      result
     end
 
     def file_config

data/lib/stack_car/os.rb

@@ -0,0 +1,64 @@
+# From Dory https://github.com/FreedomBen/dory/blob/master/lib/dory/os.rb
+module StackCar
+  module Os
+    def self.bash(command)
+      system("bash -c '#{command}'")
+    end
+
+    def self.ubuntu?
+      self.bash(self.ubuntu_cmd)
+    end
+
+    def self.fedora?
+      self.bash(self.fedora_cmd)
+    end
+
+    def self.arch?
+      self.bash(self.arch_cmd)
+    end
+
+    def self.macos?
+      self.bash('uname -a | grep "Darwin" > /dev/null')
+    end
+
+    def self.wsl?
+      self.bash(self.wsl_cmd)
+    end
+
+    def self.wsl_cmd
+      %q(
+        grep -i "microsoft\|wsl" /proc/version > /dev/null 2>&1
+      )
+    end
+
+    def self.ubuntu_cmd
+      %q(
+        if $(which lsb_release >/dev/null 2>&1); then
+            lsb_release -d | grep --color=auto "Ubuntu" > /dev/null
+        else
+            uname -a | grep --color=auto "Ubuntu" > /dev/null
+        fi
+      )
+    end
+
+    def self.fedora_cmd
+     %q(
+        if $(which lsb_release >/dev/null 2>&1); then
+            lsb_release -d | grep --color=auto "Fedora" > /dev/null
+        else
+            uname -r | grep --color=auto "fc" > /dev/null
+        fi
+      )
+    end
+
+    def self.arch_cmd
+     %q(
+        if $(which lsb_release >/dev/null 2>&1); then
+            lsb_release -d | grep --color=auto "Arch" > /dev/null
+        else
+            uname -a | grep --color=auto "ARCH" > /dev/null
+        fi
+      )
+    end
+  end
+end

data/lib/stack_car/proxy.rb

@@ -0,0 +1,83 @@
+require 'thor'
+require 'open-uri'
+require 'fileutils'
+require 'archive/zip'
+
+module StackCar
+  class Proxy < Thor
+    include Thor::Actions
+
+    desc 'up', 'Launch traefik proxy for local development, assumes localhost.direct is the domain'
+    def up
+      #find the socket
+      set_proxy_env
+      run("docker compose -f #{HammerOfTheGods.gem_root}/proxy/compose.yaml up -d")
+    end
+
+    desc 'down', 'Stop traefik proxy for local development'
+    def down
+      set_proxy_env
+      run("docker compose -f #{HammerOfTheGods.gem_root}/proxy/compose.yaml down")
+    end
+
+    desc 'cert', 'Add a self-signed certificate for localhost.direct to the system'
+    def cert
+      say("Downloading certificate package...")
+
+      IO.copy_stream(URI.open(download_url), output_file)
+      say("Download complete.")
+      unzip_file
+
+      if Os.macos?
+        run("sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain #{proxy_dir}/localhost.direct.SS.crt")
+      elsif Os.ubuntu?
+        run("sudo cp #{proxy_dir}/localhost.direct.SS.crt /usr/local/share/ca-certificates/localhost.direct.SS.crt")
+        run("sudo update-ca-certificates")
+      elsif Os.wsl?
+        say("\n\n\nFor WSL, you need to add the certificate to Windows certificate store:\n")
+        say("1. Copy the certificate to a Windows-accessible location:\n")
+        run("cp #{proxy_dir}/localhost.direct.SS.crt /mnt/c/temp/localhost.direct.SS.crt")
+        say("\n2. Now run this Windows command to import the certificate (requires admin rights):\n")
+        run("powershell.exe -Command \"Start-Process powershell -Verb RunAs -ArgumentList '-Command Import-Certificate -FilePath C:\\temp\\localhost.direct.SS.crt -CertStoreLocation Cert:\\LocalMachine\\Root'\"")
+        say("\n3. Then restart your browser to apply the changes\n\n")
+      else
+        say("\n\n\nPlease figure out how to add a certificate to your system, then open a PR for your OS/Distro")
+        say("Files are located #{ENV['PWD']}/proxy/localhost.direct.SS.crt and #{ENV['PWD']}/proxy/localhost.direct.SS.key\n\n\n")
+        exit(1)
+      end
+    end
+
+    protected
+
+    def unzip_file
+      say("\n\n\nEnter the password found https://github.com/Upinel/localhost.direct?tab=readme-ov-file#a-non-public-ca-certificate-if-you-have-admin-right-on-your-development-environment-you-can-use-the-following-10-years-long-pre-generated-self-signed-certificate\n\n\n")
+      password = ask('[Required] Enter the unzip password::')
+      zip_file = "#{proxy_dir}/localhost-ss"
+      Archive::Zip.extract(zip_file, proxy_dir, :password => password)
+      say("Successfully unzipped certificate files.")
+    rescue Zlib::DataError
+      say("Incorrect password. Please try again.")
+      exit(1)
+    end
+
+    def set_proxy_env
+      ENV['DOCKER_SOCKET'] ||= "/var/run/docker.sock"
+      unless File.exist?("#{HammerOfTheGods.gem_root}/proxy/localhost.direct.SS.crt")
+        say("you must run proxy cert once after installing this gem before using the proxy")
+        exit(1)
+      end
+    end
+
+    def proxy_dir
+       @proxy_dir ||= "#{HammerOfTheGods.gem_root}/proxy"
+    end
+
+    def download_url
+      @download_url ||= "https://aka.re/localhost-ss"
+    end
+
+    def output_file
+      @output_file ||= File.join(proxy_dir, "localhost-ss")
+    end
+  end
+end

data/lib/stack_car/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StackCar
-  VERSION = '0.18.0'
+  VERSION = '0.19.0'
 end

data/lib/stack_car.rb

@@ -1,6 +1,8 @@
-require "stack_car/version"
-require "stack_car/cli"
-require "stack_car/dot_rc"
+require_relative './stack_car/version'
+require_relative './stack_car/os'
+require_relative './stack_car/proxy'
+require_relative './stack_car/cli'
+require_relative './stack_car/dot_rc'
 
 ##
 # Ruby 3.x removed {File.exists?} in favor of {File.exist?}.  This shim ensures that we can run

data/proxy/compose.yaml

@@ -0,0 +1,56 @@
+services:
+  traefik:
+    image: "traefik"
+    ports:
+      - "80:80"
+      - "443:443"
+      - "3333:3333"
+    volumes:
+      - "${DOCKER_SOCKET}:/var/run/docker.sock:ro"
+      - ./traefik.yml:/etc/traefik/traefik.yml
+      - ./localhost.direct.SS.crt:/etc/traefik/cert.pem
+      - ./localhost.direct.SS.key:/etc/traefik/key.pem
+    labels:
+      - traefik.enable=true
+      - traefik.http.routers.router.rule=Host(`traefik.localhost.direct`)
+      - traefik.http.routers.router.entrypoints=websecure
+      - traefik.http.services.router.loadbalancer.server.port=8080
+      - traefik.http.routers.router.tls=true
+    healthcheck:
+      test: ["CMD-SHELL", "traefik healthcheck --ping"]
+      interval: 4s
+      timeout: 4s
+      retries: 8
+      start_period: 4s
+
+  whoami:
+    image: traefik/whoami
+    ports:
+      - "80"
+    labels:
+      - "traefik.enable=true"
+      - "traefik.http.routers.whoami.tls=true"
+      - "traefik.http.routers.whoami.entrypoints=websecure"
+      - "traefik.http.routers.whoami.rule=Host(`whoami.localhost.direct`)"
+      - "traefik.http.services.whoami.loadbalancer.server.port=80"
+
+  # dnsmasq:
+  #   image: joweisberg/dnsmasq
+  #   restart: always
+  #   ports:
+  #     - ${DNSMASQ_PORT}:53
+  #     - 5380:8080
+  #   environment:
+  #     HTTP_USER: ${DNSMASQ_USER}
+  #     HTTP_PASS: ${DNSMASQ_PASSWORD}
+  #   labels:
+  #     - "traefik.enable=true"
+  #     - "traefik.http.routers.dnsmasq.rule=Host(`dnsmasq.${DOMAIN}`)"
+  #     - "traefik.http.services.dnsmasq.loadbalancer.server.port=8080"
+  #     - "traefik.http.routers.dnsmasq.entrypoints=web"
+  #   volumes:
+  #     - ./dnsmasq/dnsmasq.conf:/etc/dnsmasq.conf
+  #     - ./dnsmasq/dnsmasq.d/:/etc/dnsmasq.d
+networks:
+  default:
+    name: stackcar

data/proxy/traefik.yml

@@ -0,0 +1,49 @@
+---
+global:
+  sendAnonymousUsage: false
+
+providers:
+  docker:
+    exposedByDefault: false
+    endpoint: "unix:///var/run/docker.sock"
+  file:
+    directory: /etc/traefik
+    watch: true
+
+api:
+  insecure: true
+  dashboard: true
+
+serversTransport:
+  insecureSkipVerify: true
+
+entryPoints:
+  web:
+    address: ":80"
+    http:
+      redirections:
+        entryPoint:
+          to: websecure
+          scheme: https
+
+  websecure:
+    address: ":443"
+
+  tcp:
+    address: ":3333"
+
+tls:
+  certificates:
+    - certFile: /etc/traefik/cert.pem
+      keyFile: /etc/traefik/key.pem
+  stores:
+    default:
+      defaultCertificate:
+        certFile: /etc/traefik/cert.pem
+        keyFile: /etc/traefik/key.pem
+
+ping:
+  entryPoint: "web"
+
+log:
+  level: DEBUG

data/stack_car.gemspec

@@ -25,7 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard"
   spec.add_development_dependency "yard-thor"
   spec.add_development_dependency "pry"
+  spec.add_runtime_dependency "archive-zip"
   spec.add_runtime_dependency "dotenv"
   spec.add_runtime_dependency "json", "~> 2.3"
-  spec.add_runtime_dependency "thor", "~> 0.19"
+  spec.add_runtime_dependency "thor", "~> 0.20"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stack_car
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Rob Kaufman
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-19 00:00:00.000000000 Z
+date: 2025-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: archive-zip
+  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
@@ -128,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.20'
 description:
 email:
 - rob@notch8.com
@@ -157,13 +171,18 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/test_sc
 - exe/sc
 - exe/stack_car
 - lib/stack_car.rb
 - lib/stack_car/cli.rb
 - lib/stack_car/dot_rc.rb
+- lib/stack_car/os.rb
+- lib/stack_car/proxy.rb
 - lib/stack_car/version.rb
 - logo.jpg
+- proxy/compose.yaml
+- proxy/traefik.yml
 - public/.gitkeep
 - public/logo.jpg
 - public/logo.pxm