class

HTTP::Cookies

Inherits Enumerable / Reference / Object

Represents a collection of cookies as it can be present inside a HTTP request or response.

NOTE: To use Cookies, you must explicitly import it with require "http/cookie"

Constructors

from_client_headers(headers : HTTP::Headers) : self

Creates a new instance by parsing the Cookie headers in the given HTTP::Headers.

See HTTP::Client::Response#cookies.

Source
from_headers(headers) : self

Creates a new instance by parsing the Cookie and Set-Cookie headers in the given HTTP::Headers.

See HTTP::Request#cookies and HTTP::Client::Response#cookies.

Source
from_server_headers(headers : HTTP::Headers) : self

Creates a new instance by parsing the Set-Cookie headers in the given HTTP::Headers.

See HTTP::Request#cookies.

Source
new

Creates a new empty instance.

Source

Instance methods

<<(cookie : Cookie) : Cookie

Adds the given cookie to this collection, overrides an existing cookie with the same name if present.

response.cookies << HTTP::Cookie.new("foo", "bar", http_only: true)
Source
==(other : self)

Returns true if this reference is the same as other. Invokes same?.

[](key : String) : Cookie

Gets the current HTTP::Cookie for the given key.

request.cookies["foo"].value # => "bar"
Source
[]=(key : String, value : String) : Cookie

Sets a new cookie in the collection with a string value. This creates a never expiring, insecure, not HTTP-only cookie with no explicit domain restriction and no path.

require "http/client"

request = HTTP::Request.new "GET", "/"
request.cookies["foo"] = "bar"
Source
[]=(key : String, value : Cookie) : Cookie

Sets a new cookie in the collection to the given HTTP::Cookie instance. The name attribute must match the given key, else ArgumentError is raised.

require "http/client"

response = HTTP::Client::Response.new(200)
response.cookies["foo"] = HTTP::Cookie.new("foo", "bar", "/admin", Time.utc + 12.hours, secure: true)
Source
[]?(key : String) : Cookie | Nil

Gets the current HTTP::Cookie for the given key or nil if none is set.

require "http/client"

request = HTTP::Request.new "GET", "/"
request.cookies["foo"]? # => nil
request.cookies["foo"] = "bar"
request.cookies["foo"]?.try &.value # > "bar"
Source
add_request_headers(headers : HTTP::Headers) : HTTP::Headers

Adds Cookie headers for the cookies in this collection to the given HTTP::Headers instance and returns it. Removes any existing Cookie headers in it.

Source
add_response_headers(headers : HTTP::Headers) : HTTP::Headers

Adds Set-Cookie headers for the cookies in this collection to the given HTTP::Headers instance and returns it. Removes any existing Set-Cookie headers in it.

Source
clear

Clears the collection, removing all cookies.

Source
delete(key : String) : Cookie | Nil

Deletes and returns the HTTP::Cookie for the specified key, or returns nil if key cannot be found in the collection. Note that key should match the name attribute of the desired HTTP::Cookie.

Source
each

Yields each HTTP::Cookie in the collection.

Source
each

Returns an iterator over the cookies of this collection.

Source
empty?

Whether the collection contains any cookies.

Source
fill_from_client_headers(headers : HTTP::Headers) : self

Filling cookies by parsing the Cookie headers in the given HTTP::Headers.

Source
fill_from_headers(headers)

Filling cookies by parsing the Cookie and Set-Cookie headers in the given HTTP::Headers.

Source
fill_from_server_headers(headers : HTTP::Headers) : self

Filling cookies by parsing the Set-Cookie headers in the given HTTP::Headers.

Source
has_key?(key : String) : Bool

Returns true if a cookie with the given key exists.

request.cookies.has_key?("foo") # => true
Source
hash(hasher)

See Object#hash(hasher)

inspect(io : IO)

Returns a string representation of this cookies list.

It uses the Set-Cookie serialization from Cookie#to_set_cookie_header which represents the full state of the cookie.

HTTP::Cookies{
  HTTP::Cookie.new("foo", "bar"),
  HTTP::Cookie.new("foo", "bar", domain: "example.com"),
}.to_s # => "HTTP::Cookies{\"foo=bar\", \"foo=bar; domain=example.com\"}"
Source
pretty_print(pp) : Nil

Returns a string representation of this cookies list.

It uses the Set-Cookie serialization from Cookie#to_set_cookie_header which represents the full state of the cookie.

HTTP::Cookies{
  HTTP::Cookie.new("foo", "bar"),
  HTTP::Cookie.new("foo", "bar", domain: "example.com"),
}.to_s # => "HTTP::Cookies{\"foo=bar\", \"foo=bar; domain=example.com\"}"
Source
size

Returns the number of cookies contained in this collection.

Source
to_h

Returns this collection as a plain Hash.

Source
to_s(io : IO)

Returns a string representation of this cookies list.

It uses the Set-Cookie serialization from Cookie#to_set_cookie_header which represents the full state of the cookie.

HTTP::Cookies{
  HTTP::Cookie.new("foo", "bar"),
  HTTP::Cookie.new("foo", "bar", domain: "example.com"),
}.to_s # => "HTTP::Cookies{\"foo=bar\", \"foo=bar; domain=example.com\"}"
Source