class HTTP::Cookies
Overview
Represents a collection of cookies as it can be present inside a HTTP request or response.
Included Modules
Defined in:
http/cookie.crConstructors
-
.from_headers(headers) : self
Creates a new instance by parsing the
Cookie
andSet-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)
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)
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::Header
instance and returns it. - #add_response_headers(headers)
-
#each(&block : Cookie -> )
Yields each
HTTP::Cookie
in the collection. -
#each
Returns an iterator over the cookies of this collection.
-
#empty?
Whether the collection contains any cookies.
-
#fill_from_headers(headers)
Filling cookies by parsing the
Cookie
andSet-Cookie
headers in the givenHTTP::Headers
. -
#has_key?(key)
Returns
true
if a cookie with the given key exists. -
#to_h
Returns this collection as a plain
Hash
.
Instance methods inherited from module Enumerable(HTTP::Cookie)
all?(&block)all?(pattern)
all? all?, any?(&block)
any?(pattern)
any? any?, chunks(&block : T -> U) forall U chunks, compact_map(&block) compact_map, count(item)
count(&block) count, cycle(&block)
cycle(n, &block) cycle, each(&block : T -> UNDERSCORE) each, each_cons(count : Int, reuse = false, &block) each_cons, each_slice(count : Int, reuse = false, &block) each_slice, each_with_index(offset = 0, &block) each_with_index, each_with_object(obj, &block) each_with_object, find(if_none = nil, &block) find, first(count : Int)
first first, first? first?, flat_map(&block : T -> Array(U) | Iterator(U) | U) forall U flat_map, grep(pattern) grep, group_by(&block : T -> U) forall U group_by, in_groups_of(size : Int, filled_up_with : U = nil) forall U
in_groups_of(size : Int, filled_up_with : U = nil, reuse = false, &block) forall U in_groups_of, includes?(obj) includes?, index(&block)
index(obj) index, index_by(&block : T -> U) forall U index_by, join(separator, io)
join(separator = "")
join(separator, io, &block)
join(separator = "", &block) join, map(&block : T -> U) forall U map, map_with_index(&block : T, Int32 -> U) forall U map_with_index, max max, max? max?, max_by(&block : T -> U) forall U max_by, max_by?(&block : T -> U) forall U max_by?, max_of(&block : T -> U) forall U max_of, max_of?(&block : T -> U) forall U max_of?, min min, min? min?, min_by(&block : T -> U) forall U min_by, min_by?(&block : T -> U) forall U min_by?, min_of(&block : T -> U) forall U min_of, min_of?(&block : T -> U) forall U min_of?, minmax minmax, minmax? minmax?, minmax_by(&block : T -> U) forall U minmax_by, minmax_by?(&block : T -> U) forall U minmax_by?, minmax_of(&block : T -> U) forall U minmax_of, minmax_of?(&block : T -> U) forall U minmax_of?, none?(&block)
none?(pattern)
none? none?, one?(&block)
one?(pattern)
one? one?, partition(&block) partition, product
product(initial : Number, &block)
product(&block)
product(initial : Number) product, reduce(memo, &block)
reduce(&block) reduce, reject(&block : T -> )
reject(type : U.class) forall U
reject(pattern) reject, select(type : U.class) forall U
select(&block : T -> )
select(pattern) select, size size, skip(count : Int) skip, skip_while(&block) skip_while, sum(initial)
sum
sum(initial, &block)
sum(&block) sum, take_while(&block) take_while, to_a to_a, to_h
to_h(&block : T -> Tuple(K, V)) forall K, V to_h, to_set to_set
Instance methods inherited from class Reference
==(other : self)==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference)
same?(other : Nil) same?, to_s(io : IO) : Nil to_s
Constructor methods inherited from class Reference
new
new
Instance methods inherited from class Object
!=(other)
!=,
!~(other)
!~,
==(other)
==,
===(other : JSON::Any)===(other : YAML::Any)
===(other) ===, =~(other) =~, class class, dup dup, hash(hasher)
hash hash, inspect(io : IO)
inspect inspect, itself itself, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, tap(&block) tap, to_json(io : IO)
to_json to_json, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ") to_pretty_json, to_s
to_s(io : IO) to_s, to_yaml(io : IO)
to_yaml to_yaml, try(&block) try, unsafe_as(type : T.class) forall T unsafe_as
Constructor methods inherited from class Object
from_json(string_or_io, root : String) : selffrom_json(string_or_io) : self from_json, from_yaml(string_or_io : String | IO) : self from_yaml
Constructor Detail
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
.
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 the path /
.
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.
response = HTTP::Client::Response.new(200)
response.cookies["foo"] = HTTP::Cookie.new("foo", "bar", "/admin", Time.now + 12.hours, secure: true)
Gets the current HTTP::Cookie
for the given key or nil
if none is set.
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::Header
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::Header
instance and returns it. Removes any existing
Set-Cookie
headers in it.
Filling cookies by parsing the Cookie
and Set-Cookie
headers in the given HTTP::Headers
.
Returns true
if a cookie with the given key exists.
request.cookies.has_key?("foo") # => true