potluck-nginx 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5dc3bb7d62e4244f719abe5110cdb80a972b10f56f13d35844918a3eaa875df
-  data.tar.gz: b971afa507788f9bf2261df078e7df83df963928dba62dcca2e1cbf80a10cd6a
+  metadata.gz: 4fc8a1ec53a80c8a2914316ea35e955a79851fde0c32b59c2d26b22c573e4d3f
+  data.tar.gz: 1f5beb340d4e719f11f98806a7d96844e9c71b11aef0de8441de516d170c0a24
 SHA512:
-  metadata.gz: d6b3f68bf12bce2e2035689d9c07bd76af04d0f5c8ad596c1dfafb2c5faca4551e9a9d8c64e51fd6fb614f2b7e5dc4746a8f36137b5f416ecd78dffab961c6db
-  data.tar.gz: 3885228d15374b68b7af5d86050aea5bab688e4de24fa4cb18a54599bdece7baa0e6495487b707547be70646eefe4099184b69c60128370151b069153f5b2136
+  metadata.gz: 2852025b7fa30b945c8450b23d9efbd725b5abf3dcc41875dff7a860e85a182074c7e47ea3bf8cf7442e7ebab0a715d56296cea541b5a1c9ad9906369aeaa3fc
+  data.tar.gz: 99cef178c6195136c566f55948b5b64068a56ffaa918f4bdea05c7f193d9161ad05796a7a33a3c4dfc0637d1ecb491a818dac35c36516c6a241b581a119f999e

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2021 Nate Pickens
+Copyright 2021-2022 Nate Pickens
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the Software without restriction, including without

data/VERSION

@@ -0,0 +1 @@
+0.0.7

data/lib/potluck/nginx/ssl.rb

@@ -49,8 +49,7 @@ module Potluck
         @auto_generated = !crt_file && !key_file && !dhparam_file
 
         if !@auto_generated && (!crt_file || !key_file || !dhparam_file)
-          raise(ArgumentError.new('Must supply values for all three or none: crt_file, key_file, '\
-            'dhparam_file'))
+          raise(ArgumentError, 'Must supply values for all three or none: crt_file, key_file, dhparam_file')
         end
 
         @csr_file = File.join(@dir, "#{@host}.csr").freeze
@@ -74,10 +73,10 @@ module Potluck
       #
       def ensure_files
         return if !@auto_generated || (
-          File.exists?(@csr_file) &&
-          File.exists?(@key_file) &&
-          File.exists?(@crt_file) &&
-          File.exists?(@dhparam_file) &&
+          File.exist?(@csr_file) &&
+          File.exist?(@key_file) &&
+          File.exist?(@crt_file) &&
+          File.exist?(@dhparam_file) &&
           (Time.parse(
             @nginx.run("openssl x509 -enddate -noout -in #{@crt_file}").sub('notAfter=', '')
           ) - Time.now) >= CERT_RENEW_DAYS * 24 * 60 * 60
@@ -85,13 +84,13 @@ module Potluck
 
         @nginx.log('Generating SSL files...')
 
-        @nginx.run("openssl genrsa -out #{@key_file} 4096", redirect_stderr: false)
+        @nginx.run("openssl genrsa -out #{@key_file} 4096", capture_stderr: false)
         @nginx.run("openssl req -out #{@csr_file} -key #{@key_file} -new -sha256 -config /dev/stdin <<< "\
-          "'#{openssl_config}'", redirect_stderr: false)
+          "'#{openssl_config}'", capture_stderr: false)
         @nginx.run("openssl x509 -in #{@csr_file} -out #{@crt_file} -signkey #{@key_file} -days "\
           "#{CERT_DAYS} -req -sha256 -extensions req_ext -extfile /dev/stdin <<< '#{openssl_config}'",
-          redirect_stderr: false)
-        @nginx.run("openssl dhparam -out #{@dhparam_file} 2048", redirect_stderr: false)
+          capture_stderr: false)
+        @nginx.run("openssl dhparam -out #{@dhparam_file} 2048", capture_stderr: false)
 
         if IS_MACOS
           @nginx.log('Adding cert to keychain...')

data/lib/potluck/nginx/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Potluck
+  class Nginx < Service
+    VERSION = '0.0.7'
+  end
+end

data/lib/potluck/nginx.rb

@@ -4,6 +4,7 @@ require('fileutils')
 require('potluck')
 require_relative('nginx/ssl')
 require_relative('nginx/util')
+require_relative('nginx/version')
 
 module Potluck
   ##
@@ -56,7 +57,7 @@ module Potluck
     def initialize(hosts, port, subdomains: nil, ssl: nil, one_host: false, www: nil, multiple_slashes: nil,
         multiple_question_marks: nil, trailing_slash: nil, trailing_question_mark: nil, config: {},
         ensure_host_entries: false, **args)
-      if args[:manage] && !args[:manage].kind_of?(Hash) && !launchctl?
+      if args[:manage] && !args[:manage].kind_of?(Hash) && !self.class.launchctl?
         args[:manage] = NON_LAUNCHCTL_COMMANDS
       end
 
@@ -138,6 +139,98 @@ module Potluck
       self.class.to_nginx_config(config)
     end
 
+    ##
+    # Content of the launchctl plist file.
+    #
+    def self.plist
+      super(
+        <<~EOS
+          <key>ProgramArguments</key>
+          <array>
+            <string>#{HOMEBREW_PREFIX}/opt/nginx/bin/nginx</string>
+            <string>-g</string>
+            <string>daemon off;</string>
+          </array>
+          <key>StandardOutPath</key>
+          <string>#{HOMEBREW_PREFIX}/var/log/nginx/access.log</string>
+          <key>StandardErrorPath</key>
+          <string>#{HOMEBREW_PREFIX}/var/log/nginx/error.log</string>
+        EOS
+      )
+    end
+
+    ##
+    # Converts a hash to an Nginx configuration file content string. Keys should be strings and values
+    # either strings or hashes. A +nil+ value in a hash will result in that key-value pair being omitted.
+    #
+    # * +hash+ - Hash to convert to the string content of an Nginx configuration file.
+    # * +indent+ - Number of spaces to indent; used when the method is called recursively and should not be
+    #   set explicitly (optional, default: 0).
+    # * +repeat+ - Value to prepend to each entry of the hash; used when the method is called recursively
+    #   and should not be set explicitly (optional).
+    #
+    # Symbol keys in hashes are used as special directives. Including <tt>repeat: true</tt> will cause the
+    # parent hash's key for the child hash to be prefixed to each line of the output. Example:
+    #
+    #   {
+    #     # ...
+    #
+    #     'add_header' => {
+    #       repeat: true,
+    #       'X-Frame-Options' => 'DENY',
+    #       'X-Content-Type-Options' => 'nosniff',
+    #     }
+    #   }
+    #
+    # Result:
+    #
+    #   # ...
+    #
+    #   add_header X-Frame-Options DENY;
+    #   add_header X-Content-Type-Options nosniff;
+    #
+    # A hash containing <tt>raw: '...'</tt> can be used to include a raw chunk of text rather than key-value
+    # pairs. Example:
+    #
+    #   {
+    #     # ...
+    #
+    #     'location /' => {
+    #       raw: """
+    #         if ($scheme = https) { ... }
+    #         if ($host ~ ^www.) { ... }
+    #       """,
+    #     }
+    #   }
+    #
+    # Result:
+    #
+    #   location / {
+    #     if ($scheme = https) { ... }
+    #     if ($host ~ ^www.) { ... }
+    #   }
+    #
+    def self.to_nginx_config(hash, indent: 0, repeat: nil)
+      hash.each_with_object(+'') do |(k, v), config|
+        next if v.nil?
+        next if k == :repeat
+
+        config << (
+          if v.kind_of?(Hash)
+            if v[:repeat]
+              to_nginx_config(v, indent: indent, repeat: k)
+            else
+              "#{' ' * indent}#{k} {\n#{to_nginx_config(v, indent: indent + 2)}#{' ' * indent}}\n"
+            end
+          elsif k == :raw
+            "#{v.gsub(/^(?=.)/, ' ' * indent)}\n\n"
+          else
+            "#{' ' * indent}#{"#{repeat} " if repeat}#{k}#{" #{v}" unless v == true};\n"
+          end
+        )
+      end
+    end
+
     private
 
     ##
@@ -259,9 +352,7 @@ module Potluck
     # Writes the Nginx configuration to the (inactive) configuration file.
     #
     def write_config
-      File.open(@config_file_inactive, 'w') do |file|
-        file.write(config_file_content)
-      end
+      File.write(@config_file_inactive, config_file_content)
     end
 
     ##
@@ -275,7 +366,7 @@ module Potluck
     # Renames the active Nginx configuration file to its inactive name.
     #
     def deactivate_config
-      FileUtils.mv(@config_file_active, @config_file_inactive) if File.exists?(@config_file_active)
+      FileUtils.mv(@config_file_active, @config_file_inactive) if File.exist?(@config_file_active)
     end
 
     ##
@@ -315,97 +406,5 @@ module Potluck
           "\\1\\2\\3include #{ACTIVE_CONFIG_PATTERN};\n\n\\3"))
       end
     end
-
-    ##
-    # Converts a hash to an Nginx configuration file content string. Keys should be strings and values
-    # either strings or hashes. A +nil+ value in a hash will result in that key-value pair being omitted.
-    #
-    # * +hash+ - Hash to convert to the string content of an Nginx configuration file.
-    # * +indent+ - Number of spaces to indent; used when the method is called recursively and should not be
-    #   set explicitly (optional, default: 0).
-    # * +repeat+ - Value to prepend to each entry of the hash; used when the method is called recursively
-    #   and should not be set explicitly (optional).
-    #
-    # Symbol keys in hashes are used as special directives. Including <tt>repeat: true</tt> will cause the
-    # parent hash's key for the child hash to be prefixed to each line of the output. Example:
-    #
-    #   {
-    #     # ...
-    #
-    #     'add_header' => {
-    #       repeat: true,
-    #       'X-Frame-Options' => 'DENY',
-    #       'X-Content-Type-Options' => 'nosniff',
-    #     }
-    #   }
-    #
-    # Result:
-    #
-    #   # ...
-    #
-    #   add_header X-Frame-Options DENY;
-    #   add_header X-Content-Type-Options nosniff;
-    #
-    # A hash containing <tt>raw: '...'</tt> can be used to include a raw chunk of text rather than key-value
-    # pairs. Example:
-    #
-    #   {
-    #     # ...
-    #
-    #     'location /' => {
-    #       raw: """
-    #         if ($scheme = https) { ... }
-    #         if ($host ~ ^www.) { ... }
-    #       """,
-    #     }
-    #   }
-    #
-    # Result:
-    #
-    #   location / {
-    #     if ($scheme = https) { ... }
-    #     if ($host ~ ^www.) { ... }
-    #   }
-    #
-    def self.to_nginx_config(hash, indent: 0, repeat: nil)
-      hash.each_with_object(+'') do |(k, v), config|
-        next if v.nil?
-        next if k == :repeat
-
-        config << (
-          if v.kind_of?(Hash)
-            if v[:repeat]
-              to_nginx_config(v, indent: indent, repeat: k)
-            else
-              "#{' ' * indent}#{k} {\n#{to_nginx_config(v, indent: indent + 2)}#{' ' * indent}}\n"
-            end
-          elsif k == :raw
-            "#{v.gsub(/^(?=.)/, ' ' * indent)}\n\n"
-          else
-            "#{' ' * indent}#{"#{repeat} " if repeat}#{k}#{" #{v}" unless v == true};\n"
-          end
-        )
-      end
-    end
-
-    ##
-    # Content of the launchctl plist file.
-    #
-    def self.plist
-      super(
-        <<~EOS
-          <key>ProgramArguments</key>
-          <array>
-            <string>/usr/local/opt/nginx/bin/nginx</string>
-            <string>-g</string>
-            <string>daemon off;</string>
-          </array>
-          <key>StandardOutPath</key>
-          <string>/usr/local/var/log/nginx/access.log</string>
-          <key>StandardErrorPath</key>
-          <string>/usr/local/var/log/nginx/error.log</string>
-        EOS
-      )
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: potluck-nginx
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Nate Pickens
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-31 00:00:00.000000000 Z
+date: 2023-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: potluck
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -67,9 +67,11 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- VERSION
 - lib/potluck/nginx.rb
 - lib/potluck/nginx/ssl.rb
 - lib/potluck/nginx/util.rb
+- lib/potluck/nginx/version.rb
 homepage: https://github.com/npickens/potluck/tree/master/potluck-nginx
 licenses:
 - MIT
@@ -92,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A Ruby manager for Nginx.