An enum that provides additional support around HTTP status codes.
Based on Hypertext Transfer Protocol (HTTP) Status Code Registry
It provides constants for the defined HTTP status codes as well as helper
methods to easily identify the type of response.
NOTE: To use Status, you must explicitly import it with require "http/status"
Constants
SWITCHING_PROTOCOLS = 101
NON_AUTHORITATIVE_INFORMATION = 203
PROXY_AUTHENTICATION_REQUIRED = 407
PRECONDITION_FAILED = 412
UNSUPPORTED_MEDIA_TYPE = 415
RANGE_NOT_SATISFIABLE = 416
MISDIRECTED_REQUEST = 421
UNPROCESSABLE_ENTITY = 422
PRECONDITION_REQUIRED = 428
REQUEST_HEADER_FIELDS_TOO_LARGE = 431
UNAVAILABLE_FOR_LEGAL_REASONS = 451
INTERNAL_SERVER_ERROR = 500
SERVICE_UNAVAILABLE = 503
HTTP_VERSION_NOT_SUPPORTED = 505
VARIANT_ALSO_NEGOTIATES = 506
INSUFFICIENT_STORAGE = 507
NETWORK_AUTHENTICATION_REQUIRED = 511
Constructors
new(status_code :
Int32) : self
Create a new status instance with the given status code, or raise an
error if the status code given is not inside 100..999.
require "http/status"
HTTP::Status.new(100) # => HTTP::Status::CONTINUE
HTTP::Status.new(202) # => HTTP::Status::ACCEPTED
HTTP::Status.new(123) # => 123
HTTP::Status.new(1000) # raises ArgumentError
Instance methods
accepted?
Returns true if this enum value equals ACCEPTED
already_reported?
Returns true if this enum value equals ALREADY_REPORTED
bad_gateway?
Returns true if this enum value equals BAD_GATEWAY
bad_request?
Returns true if this enum value equals BAD_REQUEST
client_error?
Returns true if the response status code is between 400 and 499.
require "http/status"
HTTP::Status::METHOD_NOT_ALLOWED.client_error? # => true
HTTP::Status::INTERNAL_SERVER_ERROR.client_error? # => false
code
Returns the number that represents the HTTP status code.
require "http/status"
status = HTTP::Status::NO_CONTENT
status.code # => 204
conflict?
Returns true if this enum value equals CONFLICT
continue?
Returns true if this enum value equals CONTINUE
created?
Returns true if this enum value equals CREATED
description
Returns the default status description of the given HTTP status code.
require "http/status"
HTTP::Status.new(123).description # => nil
HTTP::Status::NO_CONTENT.description # => "No Content"
HTTP::Status::METHOD_NOT_ALLOWED.description # => "Method Not Allowed"
HTTP::Status::INTERNAL_SERVER_ERROR.description # => "Internal Server Error"
early_hints?
Returns true if this enum value equals EARLY_HINTS
expectation_failed?
Returns true if this enum value equals EXPECTATION_FAILED
failed_dependency?
Returns true if this enum value equals FAILED_DEPENDENCY
forbidden?
Returns true if this enum value equals FORBIDDEN
found?
Returns true if this enum value equals FOUND
gateway_timeout?
Returns true if this enum value equals GATEWAY_TIMEOUT
gone?
Returns true if this enum value equals GONE
http_version_not_supported?
Returns true if this enum value equals HTTP_VERSION_NOT_SUPPORTED
im_a_teapot?
Returns true if this enum value equals IM_A_TEAPOT
im_used?
Returns true if this enum value equals IM_USED
insufficient_storage?
Returns true if this enum value equals INSUFFICIENT_STORAGE
internal_server_error?
Returns true if this enum value equals INTERNAL_SERVER_ERROR
length_required?
Returns true if this enum value equals LENGTH_REQUIRED
locked?
Returns true if this enum value equals LOCKED
loop_detected?
Returns true if this enum value equals LOOP_DETECTED
method_not_allowed?
Returns true if this enum value equals METHOD_NOT_ALLOWED
misdirected_request?
Returns true if this enum value equals MISDIRECTED_REQUEST
moved_permanently?
Returns true if this enum value equals MOVED_PERMANENTLY
multi_status?
Returns true if this enum value equals MULTI_STATUS
multiple_choices?
Returns true if this enum value equals MULTIPLE_CHOICES
network_authentication_required?
Returns true if this enum value equals NETWORK_AUTHENTICATION_REQUIRED
no_content?
Returns true if this enum value equals NO_CONTENT
not_acceptable?
Returns true if this enum value equals NOT_ACCEPTABLE
not_extended?
Returns true if this enum value equals NOT_EXTENDED
not_found?
Returns true if this enum value equals NOT_FOUND
not_implemented?
Returns true if this enum value equals NOT_IMPLEMENTED
not_modified?
Returns true if this enum value equals NOT_MODIFIED
ok?
Returns true if this enum value equals OK
partial_content?
Returns true if this enum value equals PARTIAL_CONTENT
payload_too_large?
Returns true if this enum value equals PAYLOAD_TOO_LARGE
payment_required?
Returns true if this enum value equals PAYMENT_REQUIRED
permanent_redirect?
Returns true if this enum value equals PERMANENT_REDIRECT
precondition_failed?
Returns true if this enum value equals PRECONDITION_FAILED
precondition_required?
Returns true if this enum value equals PRECONDITION_REQUIRED
processing?
Returns true if this enum value equals PROCESSING
proxy_authentication_required?
Returns true if this enum value equals PROXY_AUTHENTICATION_REQUIRED
range_not_satisfiable?
Returns true if this enum value equals RANGE_NOT_SATISFIABLE
redirection?
Returns true if the response status code is between 300 and 399.
require "http/status"
HTTP::Status::SWITCH_PROXY.redirection? # => true
HTTP::Status::INTERNAL_SERVER_ERROR.redirection? # => false
request_timeout?
Returns true if this enum value equals REQUEST_TIMEOUT
reset_content?
Returns true if this enum value equals RESET_CONTENT
see_other?
Returns true if this enum value equals SEE_OTHER
server_error?
Returns true if the response status code is between 500 and 599.
require "http/status"
HTTP::Status::INTERNAL_SERVER_ERROR.server_error? # => true
HTTP::Status::METHOD_NOT_ALLOWED.server_error? # => false
service_unavailable?
Returns true if this enum value equals SERVICE_UNAVAILABLE
success?
Returns true if the response status code is between 200 and 299.
require "http/status"
HTTP::Status::NO_CONTENT.success? # => true
HTTP::Status::INTERNAL_SERVER_ERROR.success? # => false
switch_proxy?
Returns true if this enum value equals SWITCH_PROXY
switching_protocols?
Returns true if this enum value equals SWITCHING_PROTOCOLS
temporary_redirect?
Returns true if this enum value equals TEMPORARY_REDIRECT
too_many_requests?
Returns true if this enum value equals TOO_MANY_REQUESTS
unauthorized?
Returns true if this enum value equals UNAUTHORIZED
unavailable_for_legal_reasons?
Returns true if this enum value equals UNAVAILABLE_FOR_LEGAL_REASONS
unprocessable_entity?
Returns true if this enum value equals UNPROCESSABLE_ENTITY
upgrade_required?
Returns true if this enum value equals UPGRADE_REQUIRED
uri_too_long?
Returns true if this enum value equals URI_TOO_LONG
use_proxy?
Returns true if this enum value equals USE_PROXY
variant_also_negotiates?
Returns true if this enum value equals VARIANT_ALSO_NEGOTIATES