ruby-nginx 1.0.0.pre.alpha → 1.0.0.pre.beta.1

data/lib/ruby/nginx/commands/start_nginx.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "terminal_command"
+
+module Ruby
+  module Nginx
+    module Commands
+      class StartNginx < TerminalCommand
+        def initialize(sudo: false)
+          @sudo = sudo
+          sudo_reason = "Allow sudo elevation to start NGINX?"
+          cmd = sudoify("nginx", sudo, sudo_reason)
+
+          super(cmd:, raise: Ruby::Nginx::StartError)
+        end
+
+        def run
+          super
+        rescue Ruby::Nginx::StartError
+          raise if @sudo
+
+          # Elevate to sudo and try again.
+          self.class.new(sudo: true).run
+        end
+      end
+    end
+  end
+end

data/lib/ruby/nginx/commands/stop_nginx.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "terminal_command"
+
+module Ruby
+  module Nginx
+    module Commands
+      class StopNginx < TerminalCommand
+        def initialize(sudo: false)
+          @sudo = sudo
+          sudo_reason = "Allow sudo elevation to stop NGINX?"
+          cmd = sudoify("nginx -s stop", sudo, sudo_reason)
+
+          super(cmd:, raise: Ruby::Nginx::StopError)
+        end
+
+        def run
+          super
+        rescue Ruby::Nginx::StopError => e
+          if @sudo
+            # Nginx is not running - ignore.
+            raise unless e.message.include?("invalid PID number")
+          else
+            # Elevate to sudo and try again.
+            self.class.new(sudo: true).run
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby/nginx/commands/terminal_command.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "tty/command"
+require "tty/prompt"
+
+module Ruby
+  module Nginx
+    module Commands
+      class TerminalCommand
+        attr_reader :cmd, :user, :error_type, :printer, :result
+
+        def initialize(cmd:, user: nil, raise: nil, printer: :null)
+          @cmd = cmd
+          @user = user
+          @error_type = raise
+          @printer = ENV["DEBUG"] ? :pretty : printer
+          @result = nil
+        end
+
+        def run
+          @result = TTY::Command.new(printer: printer).run!(cmd, user: user)
+          raise @error_type, @result.err if error_type && @result.failure?
+
+          @result
+        end
+
+        protected
+
+        def yes?(question)
+          ENV["SKIP_PROMPT"] || TTY::Prompt.new.yes?("[Ruby::Nginx] #{question}")
+        end
+
+        def sudoify(cmd, sudo, reason)
+          return cmd unless sudo
+
+          if sudo_access? || yes?(reason)
+            "sudo #{cmd}"
+          else
+            raise Ruby::Nginx::AbortError, "Operation aborted"
+          end
+        end
+
+        private
+
+        def sudo_access?
+          TerminalCommand.new(cmd: "sudo -n true").run.success?
+        end
+      end
+    end
+  end
+end

data/lib/ruby/nginx/commands/validate_nginx_config.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "terminal_command"
+
+module Ruby
+  module Nginx
+    module Commands
+      class ValidateNginxConfig < TerminalCommand
+        def initialize(sudo: false)
+          @sudo = sudo
+          sudo_reason = "Allow sudo elevation to validate NGINX config?"
+          cmd = sudoify("nginx -t", sudo, sudo_reason)
+
+          super(cmd:, raise: Ruby::Nginx::ConfigError)
+        end
+
+        def run
+          super
+        rescue Ruby::Nginx::ConfigError
+          raise if @sudo
+
+          # Elevate to sudo and try again.
+          self.class.new(sudo: true).run
+        end
+      end
+    end
+  end
+end

data/lib/ruby/nginx/configuration.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
 require "erb"
-require_relative "utils/mkcert"
-require_relative "utils/safe_file"
+require_relative "constants"
+require_relative "system/mkcert"
+require_relative "system/nginx"
+require_relative "system/safe_file"
 
 module Ruby
   module Nginx
     class Configuration
-      DEFAULT_PATH = "~/.ruby-nginx"
+      include Ruby::Nginx::Constants
 
       attr_accessor :options
 
@@ -15,6 +17,14 @@ module Ruby
         @options = defaults.merge(options)
       end
 
+      def domain
+        options[:domain]
+      end
+
+      def host
+        options[:host]
+      end
+
       def name
         "ruby_nginx_#{options[:domain].gsub(/\W/, "_")}"
       end
@@ -48,14 +58,18 @@ module Ruby
         }
       end
 
+      def nginx_version
+        @nginx_version ||= System::Nginx.version
+      end
+
       private
 
       def default_path(path)
-        "~/.ruby-nginx/#{path}"
+        "#{CONFIG_PATH}/#{path}"
       end
 
       def realize_option_path!(option)
-        options[option] = Utils::SafeFile.touch(options[option])
+        options[option] = System::SafeFile.touch(options[option])
       end
 
       def validate!
@@ -69,8 +83,7 @@ module Ruby
       end
 
       def create_ssl_certs!
-        Utils::Mkcert.setup!
-        Utils::Mkcert.create!(
+        System::Mkcert.create!(
           options[:domain],
           realize_option_path!(:ssl_certificate_path),
           realize_option_path!(:ssl_certificate_key_path)

data/lib/ruby/nginx/constants.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Ruby
+  module Nginx
+    module Constants
+      CONFIG_PATH = "~/.ruby-nginx"
+      SERVERS_PATH = "#{CONFIG_PATH}/servers"
+    end
+  end
+end

data/lib/ruby/nginx/exceptions.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Ruby
+  module Nginx
+    module Exceptions
+      Error = Class.new(StandardError)
+      AbortError = Class.new(Error)
+      InstallError = Class.new(Error)
+      SetupError = Class.new(Error)
+      CreateError = Class.new(Error)
+      ConfigError = Class.new(Error)
+      StartError = Class.new(Error)
+      StopError = Class.new(Error)
+    end
+  end
+end

data/lib/ruby/nginx/system/hosts.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "../commands/add_host_mapping"
+require_relative "../commands/remove_host_mapping"
+
+module Ruby
+  module Nginx
+    module System
+      class Hosts
+        class << self
+          def add(host, ip)
+            remove(host)
+            Commands::AddHostMapping.new(host, ip).run.success?
+          end
+
+          def remove(host)
+            Commands::RemoveHostMapping.new(host).run.success?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby/nginx/system/mkcert.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "../commands/install_mkcert"
+require_relative "../commands/setup_mkcert"
+require_relative "../commands/create_mkcert_certificate"
+
+module Ruby
+  module Nginx
+    module System
+      class Mkcert
+        class << self
+          def install!
+            Commands::InstallMkcert.new.run
+          end
+
+          def setup!
+            Commands::SetupMkcert.new.run
+          end
+
+          def create!(domain, cert_file_path, key_file_path)
+            Commands::CreateMkcertCertificate.new(domain, cert_file_path, key_file_path).run
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby/nginx/system/nginx.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "../commands/add_nginx_config"
+require_relative "../commands/install_nginx"
+require_relative "../commands/nginx_options"
+require_relative "../commands/nginx_version"
+require_relative "../commands/remove_nginx_config"
+require_relative "../commands/setup_nginx"
+require_relative "../commands/start_nginx"
+require_relative "../commands/stop_nginx"
+require_relative "../commands/validate_nginx_config"
+
+module Ruby
+  module Nginx
+    module System
+      class Nginx
+        class << self
+          def version
+            Commands::NginxVersion.new.run
+          end
+
+          def options
+            Commands::NginxOptions.new.run
+          end
+
+          def install!
+            Commands::InstallNginx.new.run
+          end
+
+          def setup!
+            Commands::SetupNginx.new.run
+          end
+
+          def add_server_config(name, config)
+            Commands::AddNginxConfig.new.run(name, config)
+          end
+
+          def remove_server_config(name)
+            Commands::RemoveNginxConfig.new.run(name)
+          end
+
+          def validate_config!
+            Commands::ValidateNginxConfig.new.run
+          end
+
+          def start!
+            Commands::StartNginx.new.run
+          end
+
+          def stop!
+            Commands::StopNginx.new.run
+          end
+
+          def restart!
+            stop!
+            start!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby/nginx/system/os.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "singleton"
+require "tty/command"
+
+module Ruby
+  module Nginx
+    module System
+      class OS
+        include Singleton
+
+        def initialize
+          @semaphore = Mutex.new
+        end
+
+        def darwin?
+          RbConfig::CONFIG["host_os"] =~ /darwin/
+        end
+
+        def package_manager
+          @package_manager ||=
+            if darwin?
+              :brew if package_with?("brew")
+            elsif package_with?("apt-get")
+              :apt_get
+            elsif package_with?("pacman")
+              :pacman
+            elsif package_with?("yum")
+              :yum
+            elsif package_with?("zypper")
+              :zypper
+            end
+
+          return @package_manager if @package_manager
+          raise Ruby::Nginx::Error, "Could not determine package manager"
+        end
+
+        private
+
+        def package_with?(package_manager)
+          @semaphore.synchronize do
+            TTY::Command.new(printer: :null).run!("which #{package_manager}").success?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby/nginx/{utils → system}/safe_file.rb

@@ -4,7 +4,7 @@ require "fileutils"
 
 module Ruby
   module Nginx
-    module Utils
+    module System
       class SafeFile
         class << self
           def touch(file_path)
@@ -16,6 +16,12 @@ module Ruby
             safe_path
           end
 
+          def read(file_path)
+            safe_path = File.expand_path(file_path)
+
+            File.read(safe_path)
+          end
+
           def write(file_path, content)
             safe_path = touch(file_path)
 
@@ -24,10 +30,10 @@ module Ruby
             safe_path
           end
 
-          private
+          def rm(file_path)
+            safe_path = File.expand_path(file_path)
 
-          def safe_path(file_path)
-            File.expand_path(file_path)
+            FileUtils.rm_f(safe_path)
           end
         end
       end

data/lib/ruby/nginx/templates/nginx.conf.erb

@@ -38,8 +38,12 @@ server {
 
   <% if options[:ssl] %>
   # ssl
+  <% if nginx_version >= Ruby::Nginx::Version.new("1.25.1") %>
   listen                      443 ssl;
   http2                       on;
+  <% else %>
+  listen                      443 ssl http2;
+  <% end %>
   ssl_certificate             <%= options[:ssl_certificate_path] %>;
   ssl_certificate_key         <%= options[:ssl_certificate_key_path] %>;
   <% end %>

data/lib/ruby/nginx/version.rb

@@ -2,6 +2,8 @@
 
 module Ruby
   module Nginx
-    VERSION = "1.0.0-alpha"
+    VERSION = "1.0.0-beta.1"
+
+    Version = Gem::Version
   end
 end

data/lib/ruby/nginx.rb

@@ -1,37 +1,52 @@
 # frozen_string_literal: true
 
 require_relative "nginx/configuration"
-require_relative "nginx/utils/nginx"
+require_relative "nginx/exceptions"
+require_relative "nginx/system/hosts"
+require_relative "nginx/system/nginx"
 require_relative "nginx/version"
 
 module Ruby
   module Nginx
-    class Error < StandardError; end
+    include Ruby::Nginx::Exceptions
 
     def self.add!(options = {}, &block)
+      setup!
       conf = config(options, &block)
 
-      Utils::Nginx.add_server_config(conf.name, conf.generate!)
-      Utils::Nginx.validate_config!
-      Utils::Nginx.restart!
+      System::Nginx.add_server_config(conf.name, conf.generate!)
+      System::Nginx.validate_config!
+      System::Nginx.restart!
+      System::Hosts.add(conf.domain, conf.host)
 
       conf
-    rescue Utils::Nginx::Error
-      remove!
+    rescue Ruby::Nginx::AbortError
+      raise
+    rescue Ruby::Nginx::Error
+      remove!(options)
       raise
     end
 
     def self.remove!(options = {}, &block)
       conf = config(options, &block)
 
-      Utils::Nginx.remove_server_config(conf.name)
-      Utils::Nginx.restart!
+      System::Nginx.remove_server_config(conf.name)
+      System::Nginx.restart!
+      System::Hosts.remove(conf.domain)
 
       conf
     end
 
     private
 
+    def self.setup!
+      System::Nginx.install!
+      System::Nginx.setup!
+      System::Mkcert.install!
+      System::Mkcert.setup!
+    end
+    private_class_method :setup!
+
     def self.config(options = {})
       conf = Configuration.new(options)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-nginx
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha
+  version: 1.0.0.pre.beta.1
 platform: ruby
 authors:
 - Bert McCutchen
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-22 00:00:00.000000000 Z
+date: 2025-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: open3
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,19 +39,45 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: tty-command
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.23.1
 description: Utility gem with an added CLI for configuring NGINX with SSL.
 email:
 - mail@bertm.dev
@@ -66,12 +92,30 @@ files:
 - exe/ruby-nginx
 - lib/ruby/nginx.rb
 - lib/ruby/nginx/cli.rb
+- lib/ruby/nginx/commands/add_host_mapping.rb
+- lib/ruby/nginx/commands/add_nginx_config.rb
+- lib/ruby/nginx/commands/create_mkcert_certificate.rb
+- lib/ruby/nginx/commands/install_mkcert.rb
+- lib/ruby/nginx/commands/install_nginx.rb
+- lib/ruby/nginx/commands/nginx_options.rb
+- lib/ruby/nginx/commands/nginx_version.rb
+- lib/ruby/nginx/commands/remove_host_mapping.rb
+- lib/ruby/nginx/commands/remove_nginx_config.rb
+- lib/ruby/nginx/commands/setup_mkcert.rb
+- lib/ruby/nginx/commands/setup_nginx.rb
+- lib/ruby/nginx/commands/start_nginx.rb
+- lib/ruby/nginx/commands/stop_nginx.rb
+- lib/ruby/nginx/commands/terminal_command.rb
+- lib/ruby/nginx/commands/validate_nginx_config.rb
 - lib/ruby/nginx/configuration.rb
+- lib/ruby/nginx/constants.rb
+- lib/ruby/nginx/exceptions.rb
+- lib/ruby/nginx/system/hosts.rb
+- lib/ruby/nginx/system/mkcert.rb
+- lib/ruby/nginx/system/nginx.rb
+- lib/ruby/nginx/system/os.rb
+- lib/ruby/nginx/system/safe_file.rb
 - lib/ruby/nginx/templates/nginx.conf.erb
-- lib/ruby/nginx/utils/command.rb
-- lib/ruby/nginx/utils/mkcert.rb
-- lib/ruby/nginx/utils/nginx.rb
-- lib/ruby/nginx/utils/safe_file.rb
 - lib/ruby/nginx/version.rb
 homepage: https://github.com/bert-mccutchen/ruby-nginx
 licenses:
@@ -81,7 +125,7 @@ metadata:
   source_code_uri: https://github.com/bert-mccutchen/ruby-nginx
   changelog_uri: https://github.com/bert-mccutchen/ruby-nginx/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.22
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Utility for configuring NGINX with SSL.
 test_files: []

data/lib/ruby/nginx/utils/command.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Ruby
-  module Nginx
-    module Utils
-      class Command
-        attr_reader :stdout, :stderr, :status
-
-        def initialize(raise: nil)
-          @error_type = raise
-          @stdout = nil
-          @stderr = nil
-          @status = nil
-        end
-
-        def run(cmd)
-          @stdout, @stderr, @status = Open3.capture3(cmd)
-          raise @error_type, @stderr if @error_type && !@status.success?
-
-          self
-        end
-
-        def self.run(cmd)
-          new.run(cmd)
-        end
-      end
-    end
-  end
-end