webrick 1.8.2 → 1.9.0

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

data/sig/log.rbs

@@ -0,0 +1,93 @@
+module WEBrick
+  class BasicLog
+    @log: IO?
+
+    @opened: TrueClass?
+
+    FATAL: 1
+
+    ERROR: 2
+
+    WARN: 3
+
+    INFO: 4
+
+    DEBUG: 5
+
+    # log-level, messages above this level will be logged
+    attr_accessor level: Integer
+
+    type log_file = (IO | String)?
+
+    def initialize: (?log_file log_file, ?Integer? level) -> void
+
+    #
+    # Closes the logger (also closes the log device associated to the logger)
+    def close: () -> void
+
+    def log: (Integer level, String data) -> IO?
+
+    #
+    # Synonym for log(INFO, obj.to_s)
+    def <<: (_ToS obj) -> IO?
+
+    type message = Exception | _ToStr | Object
+
+    # Shortcut for logging a FATAL message
+    def fatal: (message msg) -> IO?
+
+    # Shortcut for logging an ERROR message
+    def error: (message msg) -> IO?
+
+    # Shortcut for logging a WARN message
+    def warn: (message msg) -> IO?
+
+    # Shortcut for logging an INFO message
+    def info: (message msg) -> IO?
+
+    # Shortcut for logging a DEBUG message
+    def debug: (message msg) -> IO?
+
+    # Will the logger output FATAL messages?
+    def fatal?: () -> bool
+
+    # Will the logger output ERROR messages?
+    def error?: () -> bool
+
+    # Will the logger output WARN messages?
+    def warn?: () -> bool
+
+    # Will the logger output INFO messages?
+    def info?: () -> bool
+
+    # Will the logger output DEBUG messages?
+    def debug?: () -> bool
+
+    private
+
+    #
+    # Formats +arg+ for the logger
+    #
+    # * If +arg+ is an Exception, it will format the error message and
+    #   the back trace.
+    # * If +arg+ responds to #to_str, it will return it.
+    # * Otherwise it will return +arg+.inspect.
+    def format: (message arg) -> String
+  end
+
+  class Log < BasicLog
+    # Format of the timestamp which is applied to each logged line.  The
+    # default is <tt>"[%Y-%m-%d %H:%M:%S]"</tt>
+    attr_accessor time_format: String
+
+    #
+    # Same as BasicLog#initialize
+    #
+    # You can set the timestamp format through #time_format
+    def initialize: (?BasicLog::log_file log_file, ?Integer? level) -> void
+
+    #
+    # Same as BasicLog#log
+    def log: (Integer level, String data) -> IO?
+  end
+end

data/sig/manifest.yaml

@@ -0,0 +1,8 @@
+dependencies:
+  - name: digest
+  - name: erb
+  - name: openssl
+  - name: singleton
+  - name: socket
+  - name: tempfile
+  - name: uri

data/sig/server.rbs

@@ -0,0 +1,57 @@
+module WEBrick
+  class ServerError < StandardError
+  end
+
+  class SimpleServer
+    def self.start: [T] () { () -> T } -> T
+  end
+
+  class Daemon
+    def self.start: ()  -> void
+                  | [T] () { () -> T } -> T
+  end
+
+  class GenericServer
+    @shutdown_pipe: [IO, IO]?
+
+    attr_reader status: :Stop | :Running | :Shutdown
+
+    attr_reader config: Hash[Symbol, untyped]
+
+    attr_reader logger: BasicLog
+
+    attr_reader tokens: Thread::SizedQueue
+
+    attr_reader listeners: Array[TCPServer| OpenSSL::SSL::SSLServer]
+
+    def initialize: (?Hash[Symbol, untyped] config, ?Hash[Symbol, untyped] default) -> void
+
+    def []: (Symbol key) -> untyped
+
+    def listen: (String address, Integer port) -> void
+
+    def start: () { (TCPSocket) -> void } -> void
+
+    def stop: () -> void
+
+    def shutdown: () -> void
+
+    def run: (TCPSocket sock) -> void
+
+    private
+
+    def accept_client: (TCPServer svr) -> TCPSocket?
+
+    def start_thread: (TCPSocket sock) { (TCPSocket) -> void } -> Thread
+
+    def call_callback: (Symbol callback_name, *untyped args) -> untyped
+
+    def setup_shutdown_pipe: () -> [IO, IO]
+
+    def cleanup_shutdown_pipe: ([IO, IO]? shutdown_pipe) -> void
+
+    def alarm_shutdown_pipe: [T] () { (IO) -> T } -> T?
+
+    def cleanup_listener: () -> void
+  end
+end

data/sig/ssl.rbs

@@ -0,0 +1,19 @@
+module WEBrick
+  module Config
+    SSL: Hash[Symbol, untyped]
+  end
+
+  module Utils
+    def self?.create_self_signed_cert: (untyped bits, untyped cn, untyped comment) -> ::Array[untyped]
+  end
+
+  class GenericServer
+    @ssl_context: OpenSSL::SSL::SSLContext?
+
+    def ssl_context: () -> OpenSSL::SSL::SSLContext?
+
+    def setup_ssl_context: (Hash[Symbol, untyped] config) -> OpenSSL::SSL::SSLContext
+
+    def ssl_servername_callback: (untyped sslsocket, ?untyped? hostname) -> untyped
+  end
+end

data/sig/utils.rbs

@@ -0,0 +1,122 @@
+module WEBrick
+  module Utils
+    #
+    # Sets IO operations on +io+ to be non-blocking
+    def self?.set_non_blocking: (IO io) -> void
+
+    #
+    # Sets the close on exec flag for +io+
+    def self?.set_close_on_exec: (IO io) -> void
+
+    #
+    # Changes the process's uid and gid to the ones of +user+
+    def self?.su: (String user) -> void
+
+    #
+    # The server hostname
+    def self?.getservername: () -> String
+
+    #
+    # Creates TCP server sockets bound to +address+:+port+ and returns them.
+    #
+    # It will create IPV4 and IPV6 sockets on all interfaces.
+    def self?.create_listeners: (String host, Integer port) -> Array[TCPServer]
+
+    #
+    # Characters used to generate random strings
+    RAND_CHARS: String
+
+    #
+    # Generates a random string of length +len+
+    def self?.random_string: (Integer len) -> String
+
+    #
+    # Class used to manage timeout handlers across multiple threads.
+    #
+    # Timeout handlers should be managed by using the class methods which are
+    # synchronized.
+    #
+    #   id = TimeoutHandler.register(10, Timeout::Error)
+    #   begin
+    #     sleep 20
+    #     puts 'foo'
+    #   ensure
+    #     TimeoutHandler.cancel(id)
+    #   end
+    #
+    # will raise Timeout::Error
+    #
+    #   id = TimeoutHandler.register(10, Timeout::Error)
+    #   begin
+    #     sleep 5
+    #     puts 'foo'
+    #   ensure
+    #     TimeoutHandler.cancel(id)
+    #   end
+    #
+    # will print 'foo'
+    #
+    class TimeoutHandler
+      @queue: Thread::Queue
+
+      @watcher: Thread?
+
+      include Singleton
+
+      #
+      # Mutex used to synchronize access across threads
+      TimeoutMutex: Thread::Mutex
+
+      #
+      # Registers a new timeout handler
+      #
+      # +time+:: Timeout in seconds
+      # +exception+:: Exception to raise when timeout elapsed
+      def self.register: (Numeric seconds, singleton(Exception) exception) -> Integer
+
+      #
+      # Cancels the timeout handler +id+
+      def self.cancel: (Integer id) -> bool
+
+      def self.terminate: () -> Thread?
+
+      #
+      # Creates a new TimeoutHandler.  You should use ::register and ::cancel
+      # instead of creating the timeout handler directly.
+      def initialize: () -> void
+
+      private
+
+      def watch: () -> bot
+
+      def watcher: () -> Thread
+
+      public
+
+      #
+      # Interrupts the timeout handler +id+ and raises +exception+
+      def interrupt: (Thread thread, Integer id, singleton(Exception) exception) -> nil
+
+      #
+      # Registers a new timeout handler
+      #
+      # +time+:: Timeout in seconds
+      # +exception+:: Exception to raise when timeout elapsed
+      def register: (Thread thread, Numeric time, singleton(Exception) exception) -> Integer
+
+      #
+      # Cancels the timeout handler +id+
+      def cancel: (Thread thread, Integer id) -> bool
+
+      #
+      def terminate: () -> Thread?
+    end
+
+    #
+    # Executes the passed block and raises +exception+ if execution takes more
+    # than +seconds+.
+    #
+    # If +seconds+ is zero or nil, simply executes the block
+    def self?.timeout: [T] (Numeric? seconds, ?singleton(Exception) exception) { (?Numeric) -> T } -> T
+  end
+end

data/sig/version.rbs

@@ -0,0 +1,3 @@
+module WEBrick
+  VERSION: String
+end