webrick 1.8.1 → 1.9.1

data/sig/https.rbs

@@ -0,0 +1,49 @@
+module WEBrick
+  class HTTPRequest
+    @client_cert_chain: Array[OpenSSL::X509::Certificate]
+
+    attr_reader cipher: [String, String, Integer, Integer]?
+
+    attr_reader server_cert: OpenSSL::X509::Certificate
+
+    attr_reader client_cert: OpenSSL::X509::Certificate?
+
+    alias orig_parse parse
+
+    def parse: (?(TCPSocket | OpenSSL::SSL::SSLSocket)? socket) -> void
+             | ...
+
+    alias orig_parse_uri parse_uri
+
+    private
+
+    def parse_uri: (String str, ?::String scheme) -> URI::Generic
+                 | ...
+
+    public
+
+    alias orig_meta_vars meta_vars
+
+    def meta_vars: () -> Hash[String, String]
+                 | ...
+  end
+
+  class SNIRequest
+    attr_reader host: String?
+
+    attr_reader addr: [String, Integer, String, String]
+
+    attr_reader port: Integer
+
+    def initialize: (OpenSSL::SSL::SSLSocket sslsocket, ?String? hostname) -> void
+  end
+
+  class HTTPServer < ::WEBrick::GenericServer
+    def ssl_servername_callback: (OpenSSL::SSL::SSLSocket sslsocket, ?String? hostname) -> OpenSSL::SSL::SSLContext?
+
+    alias orig_virtual_host virtual_host
+
+    def virtual_host: (instance server) -> void
+                    | ...
+  end
+end

data/sig/httpserver.rbs

@@ -0,0 +1,71 @@
+module WEBrick
+  class HTTPServerError < ServerError
+  end
+
+  class HTTPServer < ::WEBrick::GenericServer
+    @http_version: HTTPVersion
+
+    @mount_tab: MountTable
+
+    @virtual_hosts: Array[untyped]
+
+    def initialize: (?Hash[Symbol, untyped] config, ?Hash[Symbol, untyped] default) -> void
+
+    def run: (TCPSocket sock) -> void
+
+    def service: (HTTPRequest req, HTTPResponse res) -> void
+
+    def do_OPTIONS: (HTTPRequest req, HTTPResponse res) -> void
+
+    def mount: (String dir, singleton(HTTPServlet::AbstractServlet) servlet, *untyped options) -> void
+
+    def mount_proc: (String dir, ?HTTPServlet::ProcHandler::_Callable proc) -> void
+                  | (String dir, ?nil proc) { (HTTPRequest, HTTPResponse) -> void } -> void
+
+    def unmount: (String dir) -> MountTable::value_type
+
+    alias umount unmount
+
+    def search_servlet: (String path) -> [singleton(HTTPServlet::AbstractServlet), Array[untyped], String, String]?
+
+    def virtual_host: (instance server) -> void
+
+    def lookup_server: (HTTPRequest req) -> instance?
+
+    def access_log: (Hash[Symbol, untyped] config, HTTPRequest req, HTTPResponse res) -> void
+
+    #
+    # Creates the HTTPRequest used when handling the HTTP
+    # request. Can be overridden by subclasses.
+    def create_request: (Hash[Symbol, untyped] with_webrick_config) -> HTTPRequest
+
+    #
+    # Creates the HTTPResponse used when handling the HTTP
+    # request. Can be overridden by subclasses.
+    def create_response: (Hash[Symbol, untyped] with_webrick_config) -> HTTPResponse
+
+    class MountTable
+      type value_type = [singleton(HTTPServlet::AbstractServlet), Array[untyped]]
+
+      @tab: Hash[String, value_type]
+
+      @scanner: Regexp
+
+      def initialize: () -> void
+
+      def []: (String dir) -> value_type
+
+      def []=: (String dir, value_type val) -> value_type
+
+      def delete: (String dir) -> value_type
+
+      def scan: (String path) -> [String, String]
+
+      private
+
+      def compile: () -> void
+
+      def normalize: (String dir) -> String
+    end
+  end
+end

data/sig/httpservlet/abstract.rbs

@@ -0,0 +1,36 @@
+module WEBrick
+  module HTTPServlet
+    class HTTPServletError < StandardError
+    end
+
+    class AbstractServlet
+      @server: HTTPServer
+
+      interface _Config
+        def []: (Symbol) -> untyped
+      end
+
+      @config: _Config
+
+      @logger: Log
+
+      @options: untyped # Array[untyped] causes RBS::InstanceVariableTypeError
+
+      def self.get_instance: (HTTPServer server, *untyped options) -> instance
+
+      def initialize: (HTTPServer server, *untyped options) -> void
+
+      def service: (HTTPRequest req, HTTPResponse res) -> void
+
+      def do_GET: (HTTPRequest req, HTTPResponse res) -> bot
+
+      def do_HEAD: (HTTPRequest req, HTTPResponse res) -> bot
+
+      def do_OPTIONS: (HTTPRequest req, HTTPResponse res) -> void
+
+      private
+
+      def redirect_to_directory_uri: (HTTPRequest req, HTTPResponse res) -> void
+    end
+  end
+end

data/sig/httpservlet/cgi_runner.rbs

@@ -0,0 +1,3 @@
+class Object
+  def sysread: (IO io, Integer size) -> String
+end

data/sig/httpservlet/cgihandler.rbs

@@ -0,0 +1,23 @@
+module WEBrick
+  module HTTPServlet
+    class CGIHandler < AbstractServlet
+      @script_filename: String
+
+      @tempdir: String?
+
+      @cgicmd: Array[String] | String
+
+      Ruby: String
+
+      CGIRunner: String
+
+      CGIRunnerArray: [String, String]
+
+      def initialize: (HTTPServer server, String name) -> void
+
+      def do_GET: (HTTPRequest req, HTTPResponse res) -> void
+
+      alias do_POST do_GET
+    end
+  end
+end

data/sig/httpservlet/erbhandler.rbs

@@ -0,0 +1,17 @@
+module WEBrick
+  module HTTPServlet
+    class ERBHandler < AbstractServlet
+      @script_filename: String
+
+      def initialize: (HTTPServer server, String name) -> void
+
+      def do_GET: (HTTPRequest req, HTTPResponse res) -> void
+
+      alias do_POST do_GET
+
+      private
+
+      def evaluate: (ERB erb, HTTPRequest servlet_request, HTTPResponse servlet_response) -> String
+    end
+  end
+end

data/sig/httpservlet/filehandler.rbs

@@ -0,0 +1,76 @@
+module WEBrick
+  module HTTPServlet
+    class DefaultFileHandler < AbstractServlet
+      @local_path: String
+
+      def initialize: (HTTPServer server, String local_path) -> void
+
+      def do_GET: (HTTPRequest req, HTTPResponse res) -> void
+
+      def not_modified?: (HTTPRequest req, HTTPResponse res, Time mtime, String etag) -> bool
+
+      # returns a lambda for webrick/httpresponse.rb send_body_proc
+      def multipart_body: (File body, Array[[Numeric, Numeric]] parts, String boundary, String mtype, Integer filesize) -> HTTPResponse::_CallableBody
+
+      def make_partial_content: (HTTPRequest req, HTTPResponse res, String filename, Integer filesize) -> void
+
+      def prepare_range: (Range[Integer] range, Integer filesize) -> [Numeric, Numeric]
+    end
+
+    class FileHandler < AbstractServlet
+      @config: AbstractServlet::_Config
+
+      @logger: Log
+
+      @root: String
+
+      @options: Hash[Symbol, untyped]
+
+      HandlerTable: Hash[String, singleton(AbstractServlet)]
+
+      def self.add_handler: (String suffix, singleton(AbstractServlet) handler) -> singleton(AbstractServlet)
+
+      def self.remove_handler: (String suffix) -> singleton(AbstractServlet)
+
+      def initialize: (HTTPServer server, String root, ?Hash[Symbol, untyped] options, ?Hash[Symbol, untyped] default) -> void
+
+      def set_filesystem_encoding: (String str) -> String
+
+      def service: (HTTPRequest req, HTTPResponse res) -> void
+
+      def do_GET: (HTTPRequest req, HTTPResponse res) -> void
+
+      def do_POST: (HTTPRequest req, HTTPResponse res) -> void
+
+      def do_OPTIONS: (HTTPRequest req, HTTPResponse res) -> void
+
+      private
+
+      def trailing_pathsep?: (String path) -> bool
+
+      def prevent_directory_traversal: (HTTPRequest req, HTTPResponse res) -> void
+
+      def exec_handler: (HTTPRequest req, HTTPResponse res) -> bool
+
+      def get_handler: (HTTPRequest req, HTTPResponse res) -> singleton(AbstractServlet)
+
+      def set_filename: (HTTPRequest req, HTTPResponse res) -> bool
+
+      def check_filename: (HTTPRequest req, HTTPResponse res, String name) -> void
+
+      def shift_path_info: (HTTPRequest req, HTTPResponse res, String path_info, ?String? base) -> void
+
+      def search_index_file: (HTTPRequest req, HTTPResponse res) -> String?
+
+      def search_file: (HTTPRequest req, HTTPResponse res, String basename) -> String?
+
+      def call_callback: (Symbol callback_name, HTTPRequest req, HTTPResponse res) -> void
+
+      def windows_ambiguous_name?: (String name) -> bool
+
+      def nondisclosure_name?: (String name) -> bool
+
+      def set_dir_list: (HTTPRequest req, HTTPResponse res) -> void
+    end
+  end
+end

data/sig/httpservlet/prochandler.rbs

@@ -0,0 +1,21 @@
+module WEBrick
+  module HTTPServlet
+    class ProcHandler < AbstractServlet
+      interface _Callable
+        def call: (WEBrick::HTTPRequest, WEBrick::HTTPResponse) -> void
+      end
+
+      @proc: _Callable
+
+      def get_instance: (HTTPServer server, *untyped options) -> self
+
+      def initialize: (_Callable proc) -> void
+
+      def do_GET: (HTTPRequest request, HTTPResponse response) -> void
+
+      alias do_POST do_GET
+
+      alias do_PUT do_GET
+    end
+  end
+end

data/sig/httpservlet.rbs

@@ -0,0 +1,4 @@
+module WEBrick
+  module HTTPServlet
+  end
+end

data/sig/httpstatus.rbs

@@ -0,0 +1,255 @@
+module WEBrick
+  #
+  # This module is used to manager HTTP status codes.
+  #
+  # See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more
+  # information.
+  module HTTPStatus
+    #
+    # Root of the HTTP status class hierarchy
+    class Status < StandardError
+      attr_reader self.code: Integer
+
+      attr_reader self.reason_phrase: String
+
+      # Returns the HTTP status code
+      def code: () -> Integer
+
+      # Returns the HTTP status description
+      def reason_phrase: () -> String
+
+      alias to_i code
+    end
+
+    # Root of the HTTP info statuses
+    class Info < Status
+    end
+
+    # Root of the HTTP success statuses
+    class Success < Status
+    end
+
+    # Root of the HTTP redirect statuses
+    class Redirect < Status
+    end
+
+    # Root of the HTTP error statuses
+    class Error < Status
+    end
+
+    # Root of the HTTP client error statuses
+    class ClientError < Error
+    end
+
+    # Root of the HTTP server error statuses
+    class ServerError < Error
+    end
+
+    class EOFError < StandardError
+    end
+
+    # HTTP status codes and descriptions
+    StatusMessage: Hash[Integer, String]
+
+    # Maps a status code to the corresponding Status class
+    CodeToError: Hash[Integer, singleton(Status)]
+
+    # WEBrick::HTTPStatus::constants.grep(/\ARC_/).map{"#{_1}: #{WEBrick::HTTPStatus.const_get(_1)}"}
+
+    RC_CONTINUE: 100
+    RC_SWITCHING_PROTOCOLS: 101
+    RC_OK: 200
+    RC_CREATED: 201
+    RC_ACCEPTED: 202
+    RC_NON_AUTHORITATIVE_INFORMATION: 203
+    RC_NO_CONTENT: 204
+    RC_RESET_CONTENT: 205
+    RC_PARTIAL_CONTENT: 206
+    RC_MULTI_STATUS: 207
+    RC_MULTIPLE_CHOICES: 300
+    RC_MOVED_PERMANENTLY: 301
+    RC_FOUND: 302
+    RC_SEE_OTHER: 303
+    RC_NOT_MODIFIED: 304
+    RC_USE_PROXY: 305
+    RC_TEMPORARY_REDIRECT: 307
+    RC_BAD_REQUEST: 400
+    RC_UNAUTHORIZED: 401
+    RC_PAYMENT_REQUIRED: 402
+    RC_FORBIDDEN: 403
+    RC_NOT_FOUND: 404
+    RC_METHOD_NOT_ALLOWED: 405
+    RC_NOT_ACCEPTABLE: 406
+    RC_PROXY_AUTHENTICATION_REQUIRED: 407
+    RC_REQUEST_TIMEOUT: 408
+    RC_CONFLICT: 409
+    RC_GONE: 410
+    RC_PRECONDITION_FAILED: 412
+    RC_LENGTH_REQUIRED: 411
+    RC_REQUEST_ENTITY_TOO_LARGE: 413
+    RC_REQUEST_URI_TOO_LARGE: 414
+    RC_UNSUPPORTED_MEDIA_TYPE: 415
+    RC_EXPECTATION_FAILED: 417
+    RC_UNPROCESSABLE_ENTITY: 422
+    RC_LOCKED: 423
+    RC_FAILED_DEPENDENCY: 424
+    RC_REQUEST_RANGE_NOT_SATISFIABLE: 416
+    RC_UPGRADE_REQUIRED: 426
+    RC_PRECONDITION_REQUIRED: 428
+    RC_TOO_MANY_REQUESTS: 429
+    RC_REQUEST_HEADER_FIELDS_TOO_LARGE: 431
+    RC_UNAVAILABLE_FOR_LEGAL_REASONS: 451
+    RC_INTERNAL_SERVER_ERROR: 500
+    RC_NOT_IMPLEMENTED: 501
+    RC_BAD_GATEWAY: 502
+    RC_SERVICE_UNAVAILABLE: 503
+    RC_GATEWAY_TIMEOUT: 504
+    RC_HTTP_VERSION_NOT_SUPPORTED: 505
+    RC_INSUFFICIENT_STORAGE: 507
+    RC_NETWORK_AUTHENTICATION_REQUIRED: 511
+
+    # WEBrick::HTTPStatus::CodeToError.each_value.map{"class #{_1.name.split(/::/).last} < #{_1.superclass.name.split(/::/).last}\nend"}
+
+    class Continue < Info
+    end
+    class SwitchingProtocols < Info
+    end
+    class OK < Success
+    end
+    class Created < Success
+    end
+    class Accepted < Success
+    end
+    class NonAuthoritativeInformation < Success
+    end
+    class NoContent < Success
+    end
+    class ResetContent < Success
+    end
+    class PartialContent < Success
+    end
+    class MultiStatus < Success
+    end
+    class MultipleChoices < Redirect
+    end
+    class MovedPermanently < Redirect
+    end
+    class Found < Redirect
+    end
+    class SeeOther < Redirect
+    end
+    class NotModified < Redirect
+    end
+    class UseProxy < Redirect
+    end
+    class TemporaryRedirect < Redirect
+    end
+    class BadRequest < ClientError
+    end
+    class Unauthorized < ClientError
+    end
+    class PaymentRequired < ClientError
+    end
+    class Forbidden < ClientError
+    end
+    class NotFound < ClientError
+    end
+    class MethodNotAllowed < ClientError
+    end
+    class NotAcceptable < ClientError
+    end
+    class ProxyAuthenticationRequired < ClientError
+    end
+    class RequestTimeout < ClientError
+    end
+    class Conflict < ClientError
+    end
+    class Gone < ClientError
+    end
+    class LengthRequired < ClientError
+    end
+    class PreconditionFailed < ClientError
+    end
+    class RequestEntityTooLarge < ClientError
+    end
+    class RequestURITooLarge < ClientError
+    end
+    class UnsupportedMediaType < ClientError
+    end
+    class RequestRangeNotSatisfiable < ClientError
+    end
+    class ExpectationFailed < ClientError
+    end
+    class UnprocessableEntity < ClientError
+    end
+    class Locked < ClientError
+    end
+    class FailedDependency < ClientError
+    end
+    class UpgradeRequired < ClientError
+    end
+    class PreconditionRequired < ClientError
+    end
+    class TooManyRequests < ClientError
+    end
+    class RequestHeaderFieldsTooLarge < ClientError
+    end
+    class UnavailableForLegalReasons < ClientError
+    end
+    class InternalServerError < ServerError
+    end
+    class NotImplemented < ServerError
+    end
+    class BadGateway < ServerError
+    end
+    class ServiceUnavailable < ServerError
+    end
+    class GatewayTimeout < ServerError
+    end
+    class HTTPVersionNotSupported < ServerError
+    end
+    class InsufficientStorage < ServerError
+    end
+    class NetworkAuthenticationRequired < ServerError
+    end
+
+    #
+    # Returns the description corresponding to the HTTP status +code+
+    #
+    #   WEBrick::HTTPStatus.reason_phrase 404
+    #   => "Not Found"
+    def self?.reason_phrase: (Integer code) -> String
+
+    #
+    # Is +code+ an informational status?
+    def self?.info?: (Integer code) -> bool
+
+    #
+    # Is +code+ a successful status?
+    def self?.success?: (Integer code) -> bool
+
+    #
+    # Is +code+ a redirection status?
+    def self?.redirect?: (Integer code) -> bool
+
+    #
+    # Is +code+ an error status?
+    def self?.error?: (Integer code) -> bool
+
+    #
+    # Is +code+ a client error status?
+    def self?.client_error?: (Integer code) -> bool
+
+    #
+    # Is +code+ a server error status?
+    def self?.server_error?: (Integer code) -> bool
+
+    #
+    # Returns the status class corresponding to +code+
+    #
+    #   WEBrick::HTTPStatus[302]
+    #   => WEBrick::HTTPStatus::NotFound
+    #
+    def self.[]: (Integer code) -> singleton(Status)
+  end
+end

data/sig/httputils.rbs

@@ -0,0 +1,116 @@
+module WEBrick
+  CR: String
+
+  LF: String
+
+  CRLF: String
+
+  module HTTPUtils
+    def self?.normalize_path: (String path) -> String
+
+    type mime_types = Hash[String, String]
+
+    DefaultMimeTypes: mime_types
+
+    def self?.load_mime_types: (string | _ToPath file) -> mime_types
+
+    def self?.mime_type: (String filename, mime_types mime_tab) -> String
+
+    class SplitHeader < Array[String]
+      def join: (?String separator) -> String
+    end
+
+    class CookieHeader < Array[String]
+      def join: (?String separator) -> String
+    end
+
+    HEADER_CLASSES: Hash[String, untyped]
+
+    def self?.parse_header: (String raw) -> Hash[String, Array[String]]
+
+    def self?.split_header_value: (String str) -> Array[String]
+
+    def self?.parse_range_header: (String? ranges_specifier) -> Array[Range[Integer]]?
+
+    def self?.parse_qvalues: (String? value) -> Array[String]
+
+    def self?.dequote: (String str) -> String
+
+    def self?.quote: (String str) -> String
+
+    class FormData < String
+      @raw_header: Array[String]
+
+      @header: Hash[String, Array[String]]
+
+      EmptyRawHeader: Array[String]
+
+      EmptyHeader: Hash[String, Array[String]]
+
+      attr_accessor name: String?
+
+      attr_accessor filename: String?
+
+      attr_accessor next_data: instance?
+
+      def initialize: (*String args) -> void
+
+      def []: (*String key) -> String
+            # following is as same as String#[]
+            | (int start, ?int length) -> String?
+            | (range[int?] range) -> String?
+            | (Regexp regexp, ?MatchData::capture backref) -> String?
+            | (String substring) -> String?
+
+      def <<: (String str) -> self
+
+      def append_data: (instance data) -> self
+
+      def each_data: () { (instance) -> void } -> void
+
+      def list: () -> Array[String]
+
+      alias to_ary list
+
+      def to_s: () -> String
+    end
+
+    def self?.parse_query: (String? str) -> Hash[String, FormData]
+
+    interface _EachLine
+      def each_line: () { (String) -> void } -> void
+    end
+
+    def self?.parse_form_data: (_EachLine? io, interned boundary) -> Hash[String, FormData]
+
+    def self?._make_regex: (String str) -> Regexp
+
+    def self?._make_regex!: (String str) -> Regexp
+
+    def self?._escape: (String str, Regexp regex) -> String
+
+    def self?._unescape: (String str, Regexp regex) -> String
+
+    UNESCAPED: Regexp
+
+    UNESCAPED_FORM: Regexp
+
+    NONASCII: Regexp
+
+    ESCAPED: Regexp
+
+    UNESCAPED_PCHAR: Regexp
+
+    def self?.escape: (String str) -> String
+
+    def self?.unescape: (String str) -> String
+
+    def self?.escape_form: (String str) -> String
+
+    def self?.unescape_form: (String str) -> String
+
+    def self?.escape_path: (String str) -> String
+
+    def self?.escape8bit: (String str) -> String
+  end
+end

data/sig/httpversion.rbs

@@ -0,0 +1,17 @@
+module WEBrick
+  class HTTPVersion
+    include Comparable
+
+    attr_accessor major: Integer
+
+    attr_accessor minor: Integer
+
+    def self.convert: (HTTPVersion | String version) -> instance
+
+    def initialize: (HTTPVersion | String version) -> void
+
+    def <=>: (HTTPVersion | String other) -> Integer?
+
+    def to_s: () -> String
+  end
+end