module HTTP

Overview

The HTTP module contains HTTP::Client, HTTP::Server and HTTP::WebSocket implementations.

Defined in:

http/client.cr
http/common.cr
http/params.cr
http/content.cr
http/cookie.cr
http.cr

Constant Summary

SUPPORTED_VERSIONS = {"HTTP/1.0", "HTTP/1.1"}

Class Method Summary

Class Method Detail

def self.default_status_message_for(status_code : Int) : String #

Returns the default status message of the given HTTP status code.

Based on Hypertext Transfer Protocol (HTTP) Status Code Registry

Last Updated 2017-04-14

HTTP Status Codes (source: http-status-codes-1.csv)

  • 1xx: Informational - Request received, continuing process
  • 2xx: Success - The action was successfully received, understood, and accepted
  • 3xx: Redirection - Further action must be taken in order to complete the request
  • 4xx: Client Error - The request contains bad syntax or cannot be fulfilled
  • 5xx: Server Error - The server failed to fulfill an apparently valid request

[View source]
def self.dequote_string(str) #

Dequotes an RFC 2616 quoted-string.

quoted = %q(\"foo\\bar\")
HTTP.dequote_string(quoted) # => %q("foo\bar")

[View source]
def self.expect_continue?(headers) #

[View source]
def self.format_time(time : Time) : String #

Format a Time object as a String using the format specified as sane-cookie-date by RFC 6265 which is according to RFC 2616 a RFC 1123 format with explicit timezone GMT (interpreted as UTC).

HTTP.format_time(Time.utc(2016, 2, 15)) # => "Mon, 15 Feb 2016 00:00:00 GMT"

Uses Time::Format::HTTP_DATE as formatter.


[View source]
def self.parse_time(time_str : String) : Time? #

Parse a time string using the formats specified by RFC 2616

HTTP.parse_time("Sun, 14 Feb 2016 21:00:00 GMT")  # => "2016-02-14 21:00:00 UTC"
HTTP.parse_time("Sunday, 14-Feb-16 21:00:00 GMT") # => "2016-02-14 21:00:00 UTC"
HTTP.parse_time("Sun Feb 14 21:00:00 2016")       # => "2016-02-14 21:00:00 UTC"

Uses Time::Format::HTTP_DATE as parser.


[View source]
def self.quote_string(string, io) #

Encodes a string to an RFC 2616 quoted-string. Encoded string is written to io. May raise when string contains an invalid character.

string = %q("foo\ bar")
io = IO::Memory.new
HTTP.quote_string(string, io)
io.rewind
io.gets_to_end # => %q(\"foo\\\ bar\")

[View source]
def self.quote_string(string) #

Encodes a string to an RFC 2616 quoted-string. May raise when string contains an invalid character.

string = %q("foo\ bar")
HTTP.quote_string(string) # => %q(\"foo\\\ bar\")

[View source]
def self.serialize_chunked_body(io, body) #

[View source]
def self.serialize_headers(io, headers) #

[View source]
def self.serialize_headers_and_string_body(io, headers, body) #

[View source]