class HTTP::Cookies
Overview
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"
Defined in:
http/cookie.crConstructors
-
.from_client_headers(headers) : self
Creates a new instance by parsing the
Cookie
headers in the givenHTTP::Headers
. -
.from_headers(headers) : self
Creates a new instance by parsing the
Cookie
andSet-Cookie
headers in the givenHTTP::Headers
.DEPRECATED Use
.from_client_headers
or.from_server_headers
instead. -
.from_server_headers(headers) : self
Creates a new instance by parsing the
Set-Cookie
headers in the givenHTTP::Headers
. -
.new
Creates a new empty instance.
Instance Method Summary
-
#<<(cookie : Cookie)
Adds the given cookie to this collection, overrides an existing cookie with the same name if present.
-
#[](key) : Cookie
Gets the current
HTTP::Cookie
for the given key. -
#[]=(key, value : String)
Sets a new cookie in the collection with a string value.
-
#[]=(key, value : Cookie)
Sets a new cookie in the collection to the given
HTTP::Cookie
instance. -
#[]?(key) : Cookie | Nil
Gets the current
HTTP::Cookie
for the given key ornil
if none is set. -
#add_request_headers(headers)
Adds
Cookie
headers for the cookies in this collection to the givenHTTP::Headers
instance and returns it. -
#add_response_headers(headers)
Adds
Set-Cookie
headers for the cookies in this collection to the givenHTTP::Headers
instance and returns it. -
#clear : Hash(String, HTTP::Cookie)
Clears the collection, removing all cookies.
-
#delete(key) : Cookie | Nil
Deletes and returns the
HTTP::Cookie
for the specified key, or returnsnil
if key cannot be found in the collection. -
#each(& : Cookie -> )
Yields each
HTTP::Cookie
in the collection. -
#each
Returns an iterator over the cookies of this collection.
-
#empty? : Bool
Whether the collection contains any cookies.
-
#fill_from_client_headers(headers) : self
Filling cookies by parsing the
Cookie
headers in the givenHTTP::Headers
. -
#fill_from_headers(headers)
Filling cookies by parsing the
Cookie
andSet-Cookie
headers in the givenHTTP::Headers
.DEPRECATED Use
#fill_from_client_headers
or#fill_from_server_headers
instead. -
#fill_from_server_headers(headers) : self
Filling cookies by parsing the
Set-Cookie
headers in the givenHTTP::Headers
. -
#has_key?(key) : Bool
Returns
true
if a cookie with the given key exists. -
#size : Int32
Returns the number of cookies contained in this collection.
-
#to_h : Hash(String, Cookie)
Returns this collection as a plain
Hash
.
Instance methods inherited from class Reference
==(other : self)==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, initialize initialize, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference) : Bool
same?(other : Nil) same?, to_s(io : IO) : Nil to_s
Constructor methods inherited from class Reference
new
new,
unsafe_construct(address : Pointer, *args, **opts) : self
unsafe_construct
Class methods inherited from class Reference
pre_initialize(address : Pointer)
pre_initialize
Instance methods inherited from class Object
! : Bool
!,
!=(other)
!=,
!~(other)
!~,
==(other)
==,
===(other : JSON::Any)===(other : YAML::Any)
===(other) ===, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash(hasher)
hash hash, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?, inspect(io : IO) : Nil
inspect : String inspect, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil!(message)
not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO) : Nil
to_json : String to_json, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json, to_s(io : IO) : Nil
to_s : String to_s, to_yaml(io : IO) : Nil
to_yaml : String to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as
Class methods inherited from class Object
from_json(string_or_io, root : String)from_json(string_or_io) from_json, from_yaml(string_or_io : String | IO) from_yaml
Macros inherited from class Object
class_getter(*names, &block)
class_getter,
class_getter!(*names)
class_getter!,
class_getter?(*names, &block)
class_getter?,
class_property(*names, &block)
class_property,
class_property!(*names)
class_property!,
class_property?(*names, &block)
class_property?,
class_setter(*names)
class_setter,
def_clone
def_clone,
def_equals(*fields)
def_equals,
def_equals_and_hash(*fields)
def_equals_and_hash,
def_hash(*fields)
def_hash,
delegate(*methods, to object)
delegate,
forward_missing_to(delegate)
forward_missing_to,
getter(*names, &block)
getter,
getter!(*names)
getter!,
getter?(*names, &block)
getter?,
property(*names, &block)
property,
property!(*names)
property!,
property?(*names, &block)
property?,
setter(*names)
setter
Constructor Detail
Creates a new instance by parsing the Cookie
headers in the given HTTP::Headers
.
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
.
DEPRECATED Use .from_client_headers
or .from_server_headers
instead.
Creates a new instance by parsing the Set-Cookie
headers in the given HTTP::Headers
.
Instance Method Detail
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)
Gets the current HTTP::Cookie
for the given key.
request.cookies["foo"].value # => "bar"
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"
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)
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"
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.
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.
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
.
Filling cookies by parsing the Cookie
headers in the given HTTP::Headers
.
Filling cookies by parsing the Cookie
and Set-Cookie
headers in the given HTTP::Headers
.
DEPRECATED Use #fill_from_client_headers
or #fill_from_server_headers
instead.
Filling cookies by parsing the Set-Cookie
headers in the given HTTP::Headers
.
Returns true
if a cookie with the given key exists.
request.cookies.has_key?("foo") # => true