rails_caddy_dev 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6731cf32e6419b5637b8a1764a06e045f6487af31ced9245e61b7c597d560774
+  data.tar.gz: '0898b5cc6acc282a396d581934c9f53a308d9387c1ac6027d3be9517b1ea65ad'
+SHA512:
+  metadata.gz: e1e435b65fd2211860ae00652ea4c5557ae992c490810bcf3975864e965eef2cf98af9d22e8155e74220d8dc6fcfccfc4009eaa24b642bbbc2dca5eb36fc4f4a
+  data.tar.gz: ffffa2e702d9d2b30bb394b95965dc44e80ab134a9682ddefb6aeab39d781ee6168c7077db94c9deab802207aa967e96c546ebccb0a6e2455a70405650b074ec

data/README.md

@@ -0,0 +1,95 @@
+# RailsCaddyDev
+
+Automatically configures [Caddy](https://caddyserver.com/) as a local reverse proxy for Rails development. When you start `rails server`, it registers routes via the Caddy admin API so that `<project_name>.localhost` proxies to your locally running Rails server with HTTPS.
+
+## Prerequisites
+
+- [Caddy](https://caddyserver.com/) installed and running locally
+- Ruby >= 3.1
+
+## Installation
+
+Add it to your application's Gemfile:
+
+```ruby
+gem 'rails_caddy_dev', group: :development
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Setup
+
+In your application's `bin/rails` file,  replace this:
+
+```ruby
+require "rails/commands"
+```
+
+with this:
+
+```ruby
+require "rails_caddy_dev/commands"
+```
+
+This will ensure your Caddy configuration is updated each time you start your Rails server in development.
+
+## Usage
+
+Start your Rails server with the `DEVCADDY` and `PROJECT_NAME` environment variables:
+
+```bash
+DEVCADDY=1 PROJECT_NAME=myapp rails server
+```
+
+This will configure Caddy to proxy `myapp.localhost` to your Rails server, accessible over HTTPS.
+
+### Environment Variables
+
+| Variable | Description | Default |
+|---|---|---|
+| `DEVCADDY` | Enables Caddy configuration (must be set) | — |
+| `PROJECT_NAME` | Used to derive the `.localhost` hostname (required) | — |
+| `PORT` | Rails server port to proxy to | `3000` |
+| `CADDY_HOST` | Caddy admin API host | `localhost` |
+| `CADDY_PORT` | Caddy admin API port | `2019` |
+
+### Dynamic Port Allocation
+
+The gem also provides a CLI command to find an available TCP port, which can be useful if you want to run multiple Rails servers without port conflicts:
+
+```bash
+export PORT=$(bundle exec rails rails_caddy_dev:available_port)
+```
+
+RailsCaddyDev will then configure Caddy to proxy to the dynamically allocated port, and start your Rails server on that port.
+
+### Subdomains
+
+Subdomains are also supported due to a wildcard Caddy route that will be configured. For example, if you set `PROJECT_NAME=myapp`, then `api.myapp.localhost` will also proxy to your Rails server.
+
+### Usage with Mise
+
+If you're using [Mise](https://github.com/joelmoss/mise), you can integrate RailsCaddyDev by setting the `PORT` environment variable dynamically using the CLI command provided by RailsCaddyDev. Add this to your Mise config (eg. `mise.toml`):
+
+```toml
+[env]
+PORT = { value = "${env.PORT:-{{exec(command='bundle exec rails rails_caddy_dev:available_port')}}}", tools = true }
+```
+
+Now the `PORT` environment variable will be set to an available port each time you start your Mise environment, allowing you to run multiple Rails servers without port conflicts.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joelmoss/rails_caddy_dev.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rails_caddy_dev/commands.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# This file is responsible for loading the Caddy configuration update logic when the Rails server is
+# started in development mode with the DEVCADDY environment variable set. It should be required from
+# the application's 'bin/rails' file, as a replacement for the default 'require "rails/commands"'
+# line, making it look something like this:
+#
+#   #!/usr/bin/env ruby
+#
+#   APP_PATH = File.expand_path("../config/application", __dir__)
+#   require_relative "../config/boot"
+#
+#   # require "rails/commands" # <-- This line should be removed, and replaced with the line below.
+#   require "rails_caddy_dev/commands" # <-- This line is added to load the Caddy config logic
+#
+if ENV.fetch('RAILS_ENV', 'development') == 'development' &&
+   ENV.key?('DEVCADDY') &&
+   %w[s server].include?(ARGV.first)
+  require 'rails_caddy_dev/update_config'
+end
+
+require 'rails/commands'

data/lib/rails_caddy_dev/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module RailsCaddyDev
+  class Railtie < ::Rails::Engine
+    isolate_namespace RailsCaddyDev
+
+    rake_tasks do
+      load 'rails_caddy_dev/railties/available_port.rake'
+    end
+  end
+end

data/lib/rails_caddy_dev/railties/available_port.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :rails_caddy_dev do
+  desc 'Find and return an available TCP port on localhost'
+  task available_port: :environment do
+    require 'socket'
+    puts(Addrinfo.tcp('', 0).bind { |s| s.local_address.ip_port })
+  end
+end

data/lib/rails_caddy_dev/update_config.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+# Configures Caddy as a local reverse proxy to your Rails server during development.
+#
+# Uses the Caddy admin API to register a 'route' configuration that proxies requests for
+# `<project_name>.localhost` to the locally running Rails server.
+#
+# This file is intended to be run as part of the `rails server` startup process, and will only
+# execute in the development environment, and when the `DEVCADDY` environment variable is set. It
+# should be required from the application's 'bin/rails' file., making it look something like this:
+#
+#   #!/usr/bin/env ruby
+#
+#   APP_PATH = File.expand_path("../config/application", __dir__)
+#   require_relative "../config/boot"
+#
+#   if ENV['RAILS_ENV'] == 'development' && ENV.key?('DEVCADDY') &&
+#      (ARGV.first == 's' || ARGV.first == 'server')
+#     require 'rails_caddy_dev/update_config'
+#   end
+#
+#   require "rails/commands"
+#
+#
+# The script checks if a Caddy config for the project already exists by querying the admin API. If
+# it does, it sends a PATCH request to update it; if not, it attempts to append a new route to the
+# existing config or initialize a new config structure if necessary.
+#
+# The script expects the following environment variables:
+#   - PROJECT_NAME: Used to derive subdomain hostnames (e.g. "my_project" → my_project.localhost).
+#     This is required to ensure unique routing for each project.
+#   - PORT: Rails server port (default: 3000)
+#   - CADDY_HOST: Caddy admin API host (default: localhost)
+#   - CADDY_PORT: Caddy admin API port (default: 2019)
+#
+# If Caddy is not running or the API request fails, the script will print an error message and exit
+# with status 1.
+
+require 'net/http'
+require 'json'
+
+return if ENV.fetch('RAILS_ENV', 'development') != 'development' || !ENV.key?('DEVCADDY')
+
+PORT = ENV.fetch('PORT', '3000')
+CADDY_HOST = ENV.fetch('CADDY_HOST', 'localhost')
+CADDY_PORT = ENV.fetch('CADDY_PORT', '2019').to_i
+PROJECT_NAME = ENV.fetch('PROJECT_NAME')&.downcase
+
+domains = [
+  "#{PROJECT_NAME}.localhost",
+  "admin.#{PROJECT_NAME}.localhost",
+  "clients.#{PROJECT_NAME}.localhost",
+  "therapists.#{PROJECT_NAME}.localhost"
+]
+
+# Check if config already exists via Caddy API
+uri = URI("http://#{CADDY_HOST}:#{CADDY_PORT}/id/#{PROJECT_NAME}")
+config_exists = false
+begin
+  response = Net::HTTP.get_response(uri)
+  config_exists = response.is_a?(Net::HTTPSuccess)
+rescue Errno::ECONNREFUSED
+  puts "⚠️  Caddy admin API not available at #{CADDY_HOST}:#{CADDY_PORT}. Is caddy running?"
+  exit 1
+end
+
+config = {
+  '@id': PROJECT_NAME,
+  handle: [
+    {
+      handler: 'subroute',
+      routes: [
+        {
+          handle: [
+            {
+              handler: 'reverse_proxy',
+              upstreams: [
+                {
+                  dial: ":#{PORT}"
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  match: [
+    {
+      host: domains
+    }
+  ],
+  terminal: true
+}
+
+# Caddy admin API
+http = Net::HTTP.new(CADDY_HOST, CADDY_PORT)
+
+if config_exists
+  # Update existing config via @id endpoint
+  request = Net::HTTP::Patch.new("/id/#{PROJECT_NAME}", 'Content-Type' => 'application/json')
+  request.body = config.to_json
+  action = 'updated'
+else
+  # Check if routes path exists, if not initialize the full structure
+  routes_uri = URI("http://#{CADDY_HOST}:#{CADDY_PORT}/config/apps/http/servers/srv0/routes")
+  routes_response = Net::HTTP.get_response(routes_uri)
+
+  if routes_response.is_a?(Net::HTTPSuccess)
+    # Routes exist, append to them
+    request = Net::HTTP::Post.new(routes_uri.path, 'Content-Type' => 'application/json')
+    request.body = config.to_json
+  else
+    # Initialize full config structure
+    request = Net::HTTP::Post.new('/config/', 'Content-Type' => 'application/json')
+    request.body = {
+      apps: {
+        http: {
+          servers: {
+            srv0: {
+              listen: [':443'],
+              routes: [config]
+            }
+          }
+        }
+      }
+    }.to_json
+  end
+  action = 'created'
+end
+
+response = http.request(request)
+
+if response.is_a?(Net::HTTPSuccess)
+  puts "=> Caddy config for '#{PROJECT_NAME}:#{PORT}' #{action}"
+else
+  puts "=! Failed to #{action.chomp('d')} Caddy config: #{response.body}"
+  exit 1
+end

data/lib/rails_caddy_dev/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsCaddyDev
+  VERSION = '0.1.0'
+end

data/lib/rails_caddy_dev.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rails_caddy_dev/railtie'
+
+module RailsCaddyDev
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: rails_caddy_dev
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Moss
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+email:
+- joel@developwithstyle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/rails_caddy_dev.rb
+- lib/rails_caddy_dev/commands.rb
+- lib/rails_caddy_dev/railtie.rb
+- lib/rails_caddy_dev/railties/available_port.rake
+- lib/rails_caddy_dev/update_config.rb
+- lib/rails_caddy_dev/version.rb
+homepage: https://github.com/joelmoss/rails_caddy_dev
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Automatic Caddy config for Rails development.
+test_files: []