itsi 0.2.2 → 0.2.4

data/gems/server/lib/itsi/server/typed_handlers/source_parser.rb

@@ -2,9 +2,10 @@ module Itsi
   class Server
     module TypedHandlers
       module SourceParser
-        require 'prism'
-
+        require "prism"
 
+        # Source Parser interprets endpoint handlers
+        # and extracts arity and schema information.
         def self.extract_expr_from_source_location(proc)
           source_location = proc.source_location
           source_lines = IO.readlines(source_location.first)
@@ -23,17 +24,19 @@ module Itsi
 
           lines[1..-1].each do |line|
             break if intermediate.success?
+
             token_count = 0
             line.split(/(?=\s|;|\)|\})/).each do |token|
               src_str << token
               token_count += 1
               intermediate = Prism.parse(src_str)
               next unless intermediate.success? && token_count > 1
+
               break
             end
           end
 
-          raise 'Source Extraction Failed' unless intermediate.success?
+          raise "Source Extraction Failed" unless intermediate.success?
 
           src = intermediate.value.statements.body.first.yield_self do |s|
             s.type == :call_node ? s.block : s
@@ -41,14 +44,13 @@ module Itsi
           params = src.parameters
           params = params.parameters if params.respond_to?(:parameters)
           requireds = (params&.requireds || []).map(&:name)
-          optionals = params&.optionals || []
           keywords =  (params&.keywords || []).map do |kw|
-            [kw.name, kw.value.slice.gsub(/^_\./, '$.')]
+            [kw.name, kw.value.slice.gsub(/^_\./, "$.")]
           end.to_h
 
           [requireds.length, keywords]
-        rescue
-          [ proc.parameters.select{|p| p == :req }&.length || 0, {}]
+        rescue StandardError
+          [proc.parameters.select { |p| p == :req }&.length || 0, {}]
         end
       end
     end

data/gems/server/lib/itsi/server/version.rb

@@ -2,6 +2,6 @@
 
 module Itsi
   class Server
-    VERSION = "0.2.2"
+    VERSION = "0.2.4"
   end
 end

data/gems/server/lib/itsi/server.rb

@@ -27,7 +27,6 @@ module Itsi
     extend RouteTester
 
     class << self
-
       def running?
         @running && !@running.empty?
       end
@@ -62,9 +61,8 @@ module Itsi
           server
         end
         background ? [server, Thread.new(&run)] : run[]
-      rescue Exception => e
+      rescue Exception => e # rubocop:disable Lint/RescueException
         Itsi.log_error e.message
-        raise e
       end
 
       def static(cli_params)
@@ -72,7 +70,8 @@ module Itsi
       end
 
       def stop
-        return unless pid = get_pid
+        return unless (pid = get_pid)
+
         Process.kill(:INT, pid)
         i = 0
         while i < 10
@@ -96,7 +95,7 @@ module Itsi
         File.write(Itsi::Server::Config.pid_file_path, Process.pid)
       end
 
-      def get_pid(warn=true)
+      def get_pid(warn = true)
         pid = File.read(Itsi::Server::Config.pid_file_path).to_i
         if Process.kill(0, pid)
           pid
@@ -110,7 +109,7 @@ module Itsi
       end
 
       def test
-        Itsi::Server::Config.test!(cli_params = {})
+        Itsi::Server::Config.test!({})
       end
 
       def init
@@ -118,25 +117,25 @@ module Itsi
       end
 
       def reload
-        return unless pid = get_pid
+        return unless (pid = get_pid)
 
         Process.kill(:HUP, pid)
       end
 
       def restart
-        return unless pid = get_pid
+        return unless (pid = get_pid)
 
         Process.kill(:USR1, pid)
       end
 
       def passfile(options, subcmd)
         filename = options[:passfile]
-        unless filename || subcmd == 'echo'
+        unless filename || subcmd == "echo"
           puts "Error: passfile not set. Use --passfile option to provide a path to a file containing hashed credentials."
           puts "This file contains hashed credentials and should not be included in source control without additional protection."
           exit(1)
         end
-        algorithm = options.fetch(:algorithm, 'sha256')
+        algorithm = options.fetch(:algorithm, "sha256")
 
         unless %w[sha256 sha512 bcrypt argon2 none].include?(algorithm)
           puts "Invalid algorithm"
@@ -144,9 +143,9 @@ module Itsi
         end
 
         case subcmd
-        when 'add', 'echo'
+        when "add", "echo"
           Passfile.send(subcmd, filename, algorithm)
-        when 'remove', 'list'
+        when "remove", "list"
           Passfile.send(subcmd, filename)
         else
           puts "Valid subcommands are: add | remove | list"
@@ -165,6 +164,7 @@ module Itsi
           new_name = "#{base}_#{i}#{ext}"
           candidate = File.join(dir, new_name)
           return candidate unless File.exist?(candidate)
+
           i += 1
         end
       end
@@ -189,11 +189,11 @@ module Itsi
 
         case alg
         when /^HS(\d+)$/
-          bits = $1.to_i
+          bits = ::Regexp.last_match(1).to_i
           bytes = bits / 8
           key = SecureRandom.random_bytes(bytes)
           pem = Base64.strict_encode64(key)
-          content =  "=== HMAC #{bits}-bit Secret (base64) ===\n#{pem}\n"
+          content = "=== HMAC #{bits}-bit Secret (base64) ===\n#{pem}\n"
           save_or_print("hmac_#{bits}_secret.txt", content, options)
 
         when /^RS/, /^PS/
@@ -215,32 +215,33 @@ module Itsi
           save_or_print("ecdsa_public.pem",  "=== ECDSA Public Key ===\n#{pub}", options)
 
         else
-          STDERR.puts "Unsupported algorithm: #{alg}"
+          warn "Unsupported algorithm: #{alg}"
           exit 1
         end
       end
 
-
       def add_worker
-        return unless pid = get_pid
+        return unless (pid = get_pid)
 
         Process.kill(:TTIN, pid)
       end
 
       def remove_worker
-        return unless pid = get_pid
+        return unless (pid = get_pid)
 
         Process.kill(:TTOU, pid)
       end
 
       def status
-        return unless pid = get_pid
+        return unless (pid = get_pid)
+
         Itsi.log_info("Itsi running on #{pid}")
         Process.kill(:USR2, pid)
       end
 
       def load_route_middleware_stack(cli_params)
-        middleware, errors = Config.build_config(cli_params, Itsi::Server::Config.config_file_path(cli_params[:config_file_path]))
+        middleware, errors = Config.build_config(cli_params,
+                                                 Itsi::Server::Config.config_file_path(cli_params[:config_file_path]))
         if errors.any?
           puts errors
           []
@@ -261,7 +262,7 @@ module Itsi
       end
 
       def routes(cli_params = {})
-        load_route_middleware_stack(cli_params).each do |stack|
+        load_route_middleware_stack(cli_params).first.each do |stack|
           routes = explode_route_pattern(stack["route"].source)
           routes.each do |route|
             print_route(route, stack)
@@ -271,7 +272,6 @@ module Itsi
       end
 
       alias serve start
-
     end
   end
 end

data/gems/server/lib/itsi/standard_headers.rb

@@ -1,86 +1,86 @@
 module Itsi
   module StandardHeaders
     ALL = [
-      ACCEPT = "accept",
-      ACCEPT_CHARSET = "accept-charset",
-      ACCEPT_ENCODING = "accept-encoding",
-      ACCEPT_LANGUAGE = "accept-language",
-      ACCEPT_RANGES = "accept-ranges",
-      ACCESS_CONTROL_ALLOW_CREDENTIALS = "access-control-allow-credentials",
-      ACCESS_CONTROL_ALLOW_HEADERS = "access-control-allow-headers",
-      ACCESS_CONTROL_ALLOW_METHODS = "access-control-allow-methods",
-      ACCESS_CONTROL_ALLOW_ORIGIN = "access-control-allow-origin",
-      ACCESS_CONTROL_EXPOSE_HEADERS = "access-control-expose-headers",
-      ACCESS_CONTROL_MAX_AGE = "access-control-max-age",
-      ACCESS_CONTROL_REQUEST_HEADERS = "access-control-request-headers",
-      ACCESS_CONTROL_REQUEST_METHOD = "access-control-request-method",
-      AGE = "age",
-      ALLOW = "allow",
-      ALT_SVC = "alt-svc",
-      AUTHORIZATION = "authorization",
-      CACHE_CONTROL = "cache-control",
-      CACHE_STATUS = "cache-status",
-      CDN_CACHE_CONTROL = "cdn-cache-control",
-      CONNECTION = "connection",
-      CONTENT_DISPOSITION = "content-disposition",
-      CONTENT_ENCODING = "content-encoding",
-      CONTENT_LANGUAGE = "content-language",
-      CONTENT_LENGTH = "content-length",
-      CONTENT_LOCATION = "content-location",
-      CONTENT_RANGE = "content-range",
-      CONTENT_SECURITY_POLICY_REPORT_ONLY = "content-security-policy-report-only",
-      CONTENT_TYPE = "content-type",
-      COOKIE = "cookie",
-      DNT = "dnt",
-      DATE = "date",
-      ETAG = "etag",
-      EXPECT = "expect",
-      EXPIRES = "expires",
-      FORWARDED = "forwarded",
-      FROM = "from",
-      HOST = "host",
-      IF_MATCH = "if-match",
-      IF_MODIFIED_SINCE = "if-modified-since",
-      IF_NONE_MATCH = "if-none-match",
-      IF_RANGE = "if-range",
-      IF_UNMODIFIED_SINCE = "if-unmodified-since",
-      LAST_MODIFIED = "last-modified",
-      LINK = "link",
-      LOCATION = "location",
-      MAX_FORWARDS = "max-forwards",
-      ORIGIN = "origin",
-      PRAGMA = "pragma",
-      PROXY_AUTHENTICATE = "proxy-authenticate",
-      PROXY_AUTHORIZATION = "proxy-authorization",
-      PUBLIC_KEY_PINS = "public-key-pins",
-      PUBLIC_KEY_PINS_REPORT_ONLY = "public-key-pins-report-only",
-      RANGE = "range",
-      REFERER = "referer",
-      REFERRER_POLICY = "referrer-policy",
-      REFRESH = "refresh",
-      RETRY_AFTER = "retry-after",
-      SEC_WEBSOCKET_ACCEPT = "sec-websocket-accept",
-      SEC_WEBSOCKET_EXTENSIONS = "sec-websocket-extensions",
-      SEC_WEBSOCKET_KEY = "sec-websocket-key",
-      SEC_WEBSOCKET_PROTOCOL = "sec-websocket-protocol",
-      SEC_WEBSOCKET_VERSION = "sec-websocket-version",
-      SERVER = "server",
-      SET_COOKIE = "set-cookie",
-      STRICT_TRANSPORT_SECURITY = "strict-transport-security",
-      TE = "te",
-      TRAILER = "trailer",
-      TRANSFER_ENCODING = "transfer-encoding",
-      USER_AGENT = "user-agent",
-      UPGRADE = "upgrade",
-      UPGRADE_INSECURE_REQUESTS = "upgrade-insecure-requests",
-      VARY = "vary",
-      VIA = "via",
-      WARNING = "warning",
-      WWW_AUTHENTICATE = "www-authenticate",
-      X_CONTENT_TYPE_OPTIONS = "x-content-type-options",
-      X_DNS_PREFETCH_CONTROL = "x-dns-prefetch-control",
-      X_FRAME_OPTIONS = "x-frame-options",
-      X_XSS_PROTECTION = "x-xss-protection",
+      ACCEPT = "accept".freeze,
+      ACCEPT_CHARSET = "accept-charset".freeze,
+      ACCEPT_ENCODING = "accept-encoding".freeze,
+      ACCEPT_LANGUAGE = "accept-language".freeze,
+      ACCEPT_RANGES = "accept-ranges".freeze,
+      ACCESS_CONTROL_ALLOW_CREDENTIALS = "access-control-allow-credentials".freeze,
+      ACCESS_CONTROL_ALLOW_HEADERS = "access-control-allow-headers".freeze,
+      ACCESS_CONTROL_ALLOW_METHODS = "access-control-allow-methods".freeze,
+      ACCESS_CONTROL_ALLOW_ORIGIN = "access-control-allow-origin".freeze,
+      ACCESS_CONTROL_EXPOSE_HEADERS = "access-control-expose-headers".freeze,
+      ACCESS_CONTROL_MAX_AGE = "access-control-max-age".freeze,
+      ACCESS_CONTROL_REQUEST_HEADERS = "access-control-request-headers".freeze,
+      ACCESS_CONTROL_REQUEST_METHOD = "access-control-request-method".freeze,
+      AGE = "age".freeze,
+      ALLOW = "allow".freeze,
+      ALT_SVC = "alt-svc".freeze,
+      AUTHORIZATION = "authorization".freeze,
+      CACHE_CONTROL = "cache-control".freeze,
+      CACHE_STATUS = "cache-status".freeze,
+      CDN_CACHE_CONTROL = "cdn-cache-control".freeze,
+      CONNECTION = "connection".freeze,
+      CONTENT_DISPOSITION = "content-disposition".freeze,
+      CONTENT_ENCODING = "content-encoding".freeze,
+      CONTENT_LANGUAGE = "content-language".freeze,
+      CONTENT_LENGTH = "content-length".freeze,
+      CONTENT_LOCATION = "content-location".freeze,
+      CONTENT_RANGE = "content-range".freeze,
+      CONTENT_SECURITY_POLICY_REPORT_ONLY = "content-security-policy-report-only".freeze,
+      CONTENT_TYPE = "content-type".freeze,
+      COOKIE = "cookie".freeze,
+      DNT = "dnt".freeze,
+      DATE = "date".freeze,
+      ETAG = "etag".freeze,
+      EXPECT = "expect".freeze,
+      EXPIRES = "expires".freeze,
+      FORWARDED = "forwarded".freeze,
+      FROM = "from".freeze,
+      HOST = "host".freeze,
+      IF_MATCH = "if-match".freeze,
+      IF_MODIFIED_SINCE = "if-modified-since".freeze,
+      IF_NONE_MATCH = "if-none-match".freeze,
+      IF_RANGE = "if-range".freeze,
+      IF_UNMODIFIED_SINCE = "if-unmodified-since".freeze,
+      LAST_MODIFIED = "last-modified".freeze,
+      LINK = "link".freeze,
+      LOCATION = "location".freeze,
+      MAX_FORWARDS = "max-forwards".freeze,
+      ORIGIN = "origin".freeze,
+      PRAGMA = "pragma".freeze,
+      PROXY_AUTHENTICATE = "proxy-authenticate".freeze,
+      PROXY_AUTHORIZATION = "proxy-authorization".freeze,
+      PUBLIC_KEY_PINS = "public-key-pins".freeze,
+      PUBLIC_KEY_PINS_REPORT_ONLY = "public-key-pins-report-only".freeze,
+      RANGE = "range".freeze,
+      REFERER = "referer".freeze,
+      REFERRER_POLICY = "referrer-policy".freeze,
+      REFRESH = "refresh".freeze,
+      RETRY_AFTER = "retry-after".freeze,
+      SEC_WEBSOCKET_ACCEPT = "sec-websocket-accept".freeze,
+      SEC_WEBSOCKET_EXTENSIONS = "sec-websocket-extensions".freeze,
+      SEC_WEBSOCKET_KEY = "sec-websocket-key".freeze,
+      SEC_WEBSOCKET_PROTOCOL = "sec-websocket-protocol".freeze,
+      SEC_WEBSOCKET_VERSION = "sec-websocket-version".freeze,
+      SERVER = "server".freeze,
+      SET_COOKIE = "set-cookie".freeze,
+      STRICT_TRANSPORT_SECURITY = "strict-transport-security".freeze,
+      TE = "te".freeze,
+      TRAILER = "trailer".freeze,
+      TRANSFER_ENCODING = "transfer-encoding".freeze,
+      USER_AGENT = "user-agent".freeze,
+      UPGRADE = "upgrade".freeze,
+      UPGRADE_INSECURE_REQUESTS = "upgrade-insecure-requests".freeze,
+      VARY = "vary".freeze,
+      VIA = "via".freeze,
+      WARNING = "warning".freeze,
+      WWW_AUTHENTICATE = "www-authenticate".freeze,
+      X_CONTENT_TYPE_OPTIONS = "x-content-type-options".freeze,
+      X_DNS_PREFETCH_CONTROL = "x-dns-prefetch-control".freeze,
+      X_FRAME_OPTIONS = "x-frame-options".freeze,
+      X_XSS_PROTECTION = "x-xss-protection".freeze
     ]
   end
 end

data/gems/server/test/helpers/test_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 ENV["ITSI_LOG"] = "off"
 
 require "minitest/reporters"
@@ -8,14 +9,13 @@ require "socket"
 require "net/http"
 require "minitest/autorun"
 
-
 Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
 
-def free_bind(protocol="http", unix_socket: false)
+def free_bind(protocol = "http", unix_socket: false)
   if unix_socket
     socket_path = "/tmp/itsi_socket_#{Process.pid}_#{rand(1000)}.sock"
     UNIXServer.new(socket_path).close
-    protocol == 'https' ? "tls://#{socket_path}" : "unix://#{socket_path}"
+    protocol == "https" ? "tls://#{socket_path}" : "unix://#{socket_path}"
   else
     server = TCPServer.new("0.0.0.0", 0)
     port = server.addr[1]
@@ -24,7 +24,6 @@ def free_bind(protocol="http", unix_socket: false)
   end
 end
 
-
 def server(app: nil, protocol: "http", bind: free_bind(protocol), itsi_rb: nil, cleanup: true, timeout: 5, &blk)
   itsi_rb ||= lambda do
     # Inline Itsi.rb
@@ -49,7 +48,7 @@ def server(app: nil, protocol: "http", bind: free_bind(protocol), itsi_rb: nil,
   sync.pop
   uri = URI(bind)
   # Timeout.timeout(timeout) do
-    RequestContext.new(uri, self).instance_exec(uri, &blk)
+  RequestContext.new(uri, self).instance_exec(uri, &blk)
   # end
 rescue StandardError => e
   puts e
@@ -60,9 +59,9 @@ ensure
   Itsi::Server.stop_background_threads if cleanup
 end
 
-require 'net/http'
-require 'net_http_unix'
-require 'uri'
+require "net/http"
+require "net_http_unix"
+require "uri"
 
 class RequestContext
   def initialize(uri, binding)
@@ -74,7 +73,7 @@ class RequestContext
     @binding.send(method_name, *args, &block)
   end
 
-  def post(path, data="", headers = {})
+  def post(path, data = "", headers = {})
     client.post(uri_for(path), data, headers)
   end
 
@@ -101,7 +100,7 @@ class RequestContext
     client.request(request)
   end
 
-  def put(path, data="", headers = {})
+  def put(path, data = "", headers = {})
     request = Net::HTTP::Put.new(uri_for(path))
     request.body = data
     headers.each { |k, v| request[k] = v }
@@ -114,7 +113,7 @@ class RequestContext
     client.request(request)
   end
 
-  def patch(path, data="", headers = {})
+  def patch(path, data = "", headers = {})
     request = Net::HTTP::Patch.new(uri_for(path))
     request.body = data
     client.request(request)
@@ -127,21 +126,23 @@ class RequestContext
       read_timeout: 1,
       open_timeout: 1
     }
-    if @uri.scheme == 'unix'
+    if @uri.scheme == "unix"
       NetX::HTTPUnix.new(
         @uri.to_s,
-        **opts)
+        **opts
+      )
     else
       Net::HTTP.start(
         @uri.host,
         @uri.port,
-        use_ssl: @uri.scheme == 'https',
-        **opts)
+        use_ssl: @uri.scheme == "https",
+        **opts
+      )
     end
   end
 
   def uri_for(path)
-    if @uri.scheme == 'unix'
+    if @uri.scheme == "unix"
       URI::HTTP.build(path: path, host: "localhost")
     else
       URI.join(@uri.to_s, path)

data/gems/server/test/middleware/static_assets.rb

@@ -133,6 +133,7 @@ class TestStaticAssets < Minitest::Test
       end
     end
   end
+
   def test_relative_path_true
     Dir.mktmpdir do |dir|
       # Create file "test.txt" in root_dir.
@@ -141,18 +142,19 @@ class TestStaticAssets < Minitest::Test
       File.write(file_path, "relative true")
       server(
         itsi_rb: lambda do
-          location "foo/bar/baz" do
+          location "foo/bar/baz/*" do
             static_assets \
               root_dir: "#{dir}",
               not_found_behavior: "fallthrough",
               allowed_extensions: ["txt"],
               relative_path: true
 
-            get("/foo/bar/baz/test.txt") { |r| r.ok "fallback" }
+            get("/test.txt") { |r| r.not_found }
           end
         end
       ) do
         res = get_resp("/foo/bar/baz/test.txt")
+
         assert_equal "200", res.code, "Expected 200 OK with relative_path: true"
         assert_equal "relative true", res.body
       end
@@ -169,14 +171,14 @@ class TestStaticAssets < Minitest::Test
       server(
         itsi_rb: lambda do
 
-          location "/foo/bar/baz/" do
+          location "/foo/bar/baz/*" do
             static_assets \
               root_dir: "#{dir}",
               not_found_behavior: "fallthrough",
               allowed_extensions: ["txt"],
               relative_path: false
 
-            get("/foo/bar/baz/test.txt") { |r| r.ok "fallback" }
+            get("/test.txt") { |r| r.ok "fallback" }
           end
         end
       ) do

data/gems/server/test/middleware/string_rewrite.rb

@@ -109,4 +109,58 @@ class TestStringRewrite < Minitest::Test
       assert_equal "https://example.com/{unknown}", res["Location"]
     end
   end
+
+  def test_strip_prefix
+    server(
+      itsi_rb: lambda do
+        redirect to: "https://example.com{path|strip_prefix:/rails}", type: "temporary"
+        get("/rails/foo") { |r| r.ok }
+      end
+    ) do
+      res = get_resp("/rails/foo")
+      assert_equal "307", res.code
+      assert_equal "https://example.com/foo", res["Location"]
+    end
+  end
+
+  def test_strip_suffix
+    server(
+      itsi_rb: lambda do
+        redirect to: "{path_and_query|strip_suffix:.json}", type: "found"
+        get("/data.json") { |r| r.ok }
+      end
+    ) do
+      res = get_resp("/data.json")
+      assert_equal "302", res.code
+      # .json is removed from end of "/data.json"
+      assert_equal "/data", res["Location"]
+    end
+  end
+
+  def test_replace
+    server(
+      itsi_rb: lambda do
+        redirect to: "https://{host|replace:localhost,api.example.com}", type: "permanent"
+        get("/foo") { |r| r.ok }
+      end
+    ) do
+      res = get_resp("/foo")
+      assert_equal "308", res.code
+      assert_equal "https://api.example.com", res["Location"]
+    end
+  end
+
+  def test_chain_modifiers
+    server(
+      itsi_rb: lambda do
+        redirect to: "https://example.com{path|strip_prefix:/v1|replace:api,service}", type: "temporary"
+        get("/v1/api/users") { |r| r.ok }
+      end
+    ) do
+      res = get_resp("/v1/api/users")
+      assert_equal "307", res.code
+      # after strip_prefix: "/api/users", then replace "api"→"service"
+      assert_equal "https://example.com/service/users", res["Location"]
+    end
+  end
 end