rails_caddy_dev 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d16f9c9a33775c67c8b401c336720da85f5f4c4fa339f5d31d49791d099984f9
-  data.tar.gz: 4c271464f5ad808dd8a60ef93d3e6aeafe722270752caaaa62cf635cbddbfe71
+  metadata.gz: a8fe9678c7487626f988b63e3b205916e386179605835d7eed6699ee9be9aff4
+  data.tar.gz: ace04b2d24135e1b3d121a5af921ce68eb1186888b77857d9fecc8c733fbf9df
 SHA512:
-  metadata.gz: bd9c245265f8f913940ac2f593de24ecf9e14293f3328b75c347810b6bb57507e63f0825075a7085184cfc129dbc0866481123ba650db3a4db5f94192c121a9e
-  data.tar.gz: 2c7e83d684ed7cec4e76d9a141b2512af2a7f8876c729a4abc0b5e88f75647b4017985a3305e41978e0487a90ae60e7f4be56a23b74c19aa49f100baf3518014
+  metadata.gz: e7b56f5687870f5e41ff56523508ed1a968068f75b8b6baebd4b75c2c0513feac58e2ea8106893ca67de61f20cc69263d8393b7ceb070e49bf3fec26e472aa85
+  data.tar.gz: cf9046f2aa1d912fb3a37c48ee7a04cc173f164a22088931caf99f7721311fee3b228ff75a66559512212aa664a95617b2692fea84c423f6ddf1501f6f728555

data/README.md

@@ -1,6 +1,6 @@
 # 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.
+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 `<domain>.localhost` proxies to your locally running Rails server with HTTPS.
 
 ## Prerequisites
 
@@ -32,27 +32,31 @@ require "rails/commands"
 with this:
 
 ```ruby
-require "rails_caddy_dev/commands"
+require ENV.key?('RAILS_CADDY_DEV') ? "rails_caddy_dev/commands" : "rails/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:
+Start your Rails server with the `RAILS_CADDY_DEV` environment variable set:
 
 ```bash
-DEVCADDY=1 PROJECT_NAME=myapp rails server
+RAILS_CADDY_DEV=1 rails server
 ```
 
-This will configure Caddy to proxy `myapp.localhost` to your Rails server, accessible over HTTPS.
+This will configure Caddy to proxy `<dirname>.localhost` (where `<dirname>` is the basename of your Rails root) to your Rails server, accessible over HTTPS. To use a different hostname, set `RAILS_CADDY_DEV_DOMAIN`:
+
+```bash
+RAILS_CADDY_DEV=1 RAILS_CADDY_DEV_DOMAIN=myapp rails server
+```
 
 ### Environment Variables
 
 | Variable | Description | Default |
 |---|---|---|
-| `DEVCADDY` | Enables Caddy configuration (must be set) | — |
-| `PROJECT_NAME` | Used to derive the `.localhost` hostname (required) | — |
+| `RAILS_CADDY_DEV` | Enables Caddy configuration (must be set) | — |
+| `RAILS_CADDY_DEV_DOMAIN` | Used to derive the `.localhost` hostname | Basename of the current working directory |
 | `PORT` | Rails server port to proxy to | Auto-detected available port (falls back to `3000`) |
 | `CADDY_HOST` | Caddy admin API host | `localhost` |
 | `CADDY_PORT` | Caddy admin API port | `2019` |
@@ -69,7 +73,17 @@ export PORT=$(bundle exec rails_caddy_dev 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.
+Subdomains are also supported due to a wildcard Caddy route that will be configured. For example, if the resolved domain is `myapp`, then `api.myapp.localhost` will also proxy to your Rails server.
+
+### Removing a Route
+
+To remove the Caddy route for the current project, run:
+
+```bash
+bundle exec rails_caddy_dev delete
+```
+
+This deletes the route registered for `RAILS_CADDY_DEV_DOMAIN` (or the current directory's basename if unset).
 
 ## Development
 

data/bin/rails_caddy_dev

@@ -1,11 +1,55 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-if ARGV[0] == 'port'
-  require 'socket'
+require 'net/http'
+require 'socket'
+
+def resolve_domain
+  domain = ENV.fetch('RAILS_CADDY_DEV_DOMAIN') { File.basename(Dir.pwd) }
+  domain = File.basename(Dir.pwd) if domain.strip.empty?
+  domain.downcase
+end
+
+case ARGV[0]
+when 'port'
   puts(Addrinfo.tcp('', 0).bind { |s| s.local_address.ip_port })
   exit 0
+when 'delete'
+  domain = resolve_domain
+  caddy_host = ENV.fetch('CADDY_HOST', 'localhost')
+  caddy_port = ENV.fetch('CADDY_PORT', '2019').to_i
+
+  if !ARGV[1..].intersect?(%w[-y --yes])
+    print "Delete Caddy route for '#{domain}'? [y/N] "
+    answer = $stdin.gets&.strip&.downcase
+    if !%w[y yes].include?(answer)
+      puts 'Aborted.'
+      exit 1
+    end
+  end
+
+  uri = URI("http://#{caddy_host}:#{caddy_port}/id/#{domain}")
+  begin
+    response = Net::HTTP.start(uri.host, uri.port) do |http|
+      http.request(Net::HTTP::Delete.new(uri.path))
+    end
+  rescue Errno::ECONNREFUSED
+    puts "⚠️  Caddy admin API not available at #{caddy_host}:#{caddy_port}. Is caddy running?"
+    exit 1
+  end
+
+  case response
+  when Net::HTTPSuccess
+    puts "=> Caddy config for '#{domain}' deleted"
+  when Net::HTTPNotFound
+    puts "=> No Caddy config found for '#{domain}'"
+  else
+    puts "=! Failed to delete Caddy config: #{response.body}"
+    exit 1
+  end
 else
-  puts 'Usage: `rails_caddy_dev port` to get an available port number.'
+  puts 'Usage:'
+  puts '  rails_caddy_dev port               # print an available TCP port'
+  puts '  rails_caddy_dev delete [-y|--yes]  # remove the Caddy route'
   exit 1
 end

data/lib/rails_caddy_dev/commands.rb

@@ -1,9 +1,9 @@
 # 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:
+# started in development mode with the RAILS_CADDY_DEV 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
 #
@@ -14,7 +14,7 @@
 #   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') &&
+   ENV.key?('RAILS_CADDY_DEV') &&
    %w[s server].include?(ARGV.first)
   require 'rails_caddy_dev/update_config'
 end

data/lib/rails_caddy_dev/update_config.rb

@@ -3,18 +3,20 @@
 # 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.
+# `<domain>.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.#
+# execute in the development environment, and when the `RAILS_CADDY_DEV` environment variable is
+# set.
 #
 # 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 accepts 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.
+#   - RAILS_CADDY_DEV_DOMAIN: Used to derive subdomain hostnames (e.g. "my_project" →
+#     my_project.localhost). Defaults to the basename of the current working directory when unset
+#     or blank.
 #   - PORT: Rails server port (defaults to an available port if not set, or 3000 if port detection
 #     fails)
 #   - CADDY_HOST: Caddy admin API host (default: localhost)
@@ -27,7 +29,7 @@ require 'net/http'
 require 'json'
 require 'socket'
 
-return if ENV.fetch('RAILS_ENV', 'development') != 'development' || !ENV.key?('DEVCADDY')
+return if ENV.fetch('RAILS_ENV', 'development') != 'development' || !ENV.key?('RAILS_CADDY_DEV')
 
 PORT = ENV['PORT'] = ENV.fetch('PORT') do
   Addrinfo.tcp('', 0).bind { |s| s.local_address.ip_port }&.to_s || '3000'
@@ -35,15 +37,17 @@ end
 
 CADDY_HOST = ENV.fetch('CADDY_HOST', 'localhost')
 CADDY_PORT = ENV.fetch('CADDY_PORT', '2019').to_i
-PROJECT_NAME = ENV.fetch('PROJECT_NAME')&.downcase
+domain = ENV.fetch('RAILS_CADDY_DEV_DOMAIN') { File.basename(Dir.pwd) }
+domain = File.basename(Dir.pwd) if domain.strip.empty?
+DOMAIN = ENV['RAILS_CADDY_DEV_DOMAIN'] = domain.downcase
 
 domains = [
-  "#{PROJECT_NAME}.localhost",
-  "*.#{PROJECT_NAME}.localhost"
+  "#{DOMAIN}.localhost",
+  "*.#{DOMAIN}.localhost"
 ]
 
 # Check if config already exists via Caddy API
-uri = URI("http://#{CADDY_HOST}:#{CADDY_PORT}/id/#{PROJECT_NAME}")
+uri = URI("http://#{CADDY_HOST}:#{CADDY_PORT}/id/#{DOMAIN}")
 config_exists = false
 begin
   response = Net::HTTP.get_response(uri)
@@ -54,7 +58,7 @@ rescue Errno::ECONNREFUSED
 end
 
 config = {
-  '@id': PROJECT_NAME,
+  '@id': DOMAIN,
   handle: [
     {
       handler: 'subroute',
@@ -87,7 +91,7 @@ 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 = Net::HTTP::Patch.new("/id/#{DOMAIN}", 'Content-Type' => 'application/json')
   request.body = config.to_json
   action = 'updated'
 else
@@ -121,7 +125,7 @@ end
 response = http.request(request)
 
 if response.is_a?(Net::HTTPSuccess)
-  puts "=> Caddy config for '#{PROJECT_NAME}:#{PORT}' #{action}"
+  puts "=> Caddy config for '#{DOMAIN}:#{PORT}' #{action}"
 else
   puts "=! Failed to #{action.chomp('d')} Caddy config: #{response.body}"
   exit 1

data/lib/rails_caddy_dev/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_caddy_dev
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Joel Moss
@@ -62,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Automatic Caddy config for Rails development.
 test_files: []