Class CookieJar::Cookie
In: lib/cookiejar/cookie.rb
Parent: Object

Cookie is an immutable object which defines the data model of a HTTP Cookie. The data values within the cookie may be different from the values described in the literal cookie declaration. Specifically, the ‘domain’ and ‘path’ values may be set to defaults based on the requested resource that resulted in the cookie being set.

Methods

Attributes

comment  [R] 
String
RFC 2965 field for indicating comment (or a location)
describing the cookie to a usesr agent.
comment_url  [R] 
String
RFC 2965 field for indicating comment (or a location)
describing the cookie to a usesr agent.
created_at  [R] 
Time
Time when this cookie was first evaluated and created.
discard  [R] 
Boolean
RFC 2965 field for indicating session lifetime for a cookie
domain  [R] 
String
The domain scope of the cookie. Follows the RFC 2965
‘effective host’ rules. A ‘dot’ prefix indicates that it applies both to the non-dotted domain and child domains, while no prefix indicates that only exact matches of the domain are in scope.
http_only  [R] 
Boolean
Popular browser extension to mark a cookie as invisible
to code running within the browser, such as JavaScript
name  [R] 
String
The name of the cookie.
path  [R] 
String
The path scope of the cookie. The cookie applies to URI paths
that prefix match this value.
ports  [R] 
Array<FixNum>, nil
RFC 2965 port scope for the cookie. If not nil,
indicates specific ports on the HTTP server which should receive this cookie if contacted.
secure  [R] 
Boolean
The secure flag is set to indicate that the cookie should
only be sent securely. Nearly all HTTP User Agent implementations assume this to mean that the cookie should only be sent over a SSL/TLS-protected connection
value  [R] 
String
The value of the cookie, without any attempts at decoding.
version  [R] 
Fixnum
Version indicator, currently either
  • 0 for netscape cookies
  • 1 for RFC 2965 cookies

Public Class methods

Compute the cookie search domains for a given request URI This will be the effective host of the request uri, along with any possibly matching dot-prefixed domains

@param request_uri [String, URI] address being requested @return [Array<String>] String domain matches

Create a cookie based on an absolute URI and the string value of a ‘Set-Cookie’ header.

@param request_uri [String, URI] HTTP/HTTPS absolute URI of request. This is used to fill in domain and port if missing from the cookie, and to perform appropriate validation. @param set_cookie_value [String] HTTP value for the Set-Cookie header. @return [Cookie] created from the header string and request URI @raise [InvalidCookieError] on validation failure(s)

Create a cookie based on an absolute URI and the string value of a ‘Set-Cookie2’ header.

@param request_uri [String, URI] HTTP/HTTPS absolute URI of request. This is used to fill in domain and port if missing from the cookie, and to perform appropriate validation. @param set_cookie_value [String] HTTP value for the Set-Cookie2 header. @return [Cookie] created from the header string and request URI @raise [InvalidCookieError] on validation failure(s)

Given a Hash representation of a JSON document, create a local cookie from the included data.

@param [Hash] o JSON object of array data @return [Cookie] cookie formed from JSON data

Call {from_set_cookie} to create a new Cookie instance

Public Instance methods

Indicates whether the cookie is currently considered valid

@param [Time] time to compare against, or ‘now’ if omitted @return [Boolean]

Evaluate when this cookie will expire. Uses the original cookie fields for a max age or expires

@return [Time, nil] Time of expiry, if this cookie has an expiry set

Indicates whether the cookie will be considered invalid after the end of the current user session @return [Boolean]

Determine if a cookie should be sent given a request URI along with other options.

This currently ignores domain.

@param uri [String, URI] the requested page which may need to receive this cookie @param script [Boolean] indicates that cookies with the ‘httponly’ extension should be ignored @return [Boolean] whether this cookie should be sent to the server

Return a JSON ‘object’ for the various data values. Allows for persistence of the cookie information

@param [Array] a options controlling output JSON text

  (usually a State and a depth)

@return [String] JSON representation of object data

Returns cookie in a format appropriate to send to a server.

@param [FixNum] 0 version, 0 for Netscape-style cookies, 1 for

  RFC2965-style.

@param [Boolean] true prefix, for RFC2965, whether to prefix with "$Version=<version>;". Ignored for Netscape-style cookies

[Validate]