class CGI::Cookie

cookie1.httponly = true
cookie1.secure = true
cookie1.expires = Time.now + 30
cookie1.domain = ‘domain’
cookie1.path = ‘path’
cookie1.value = [‘value1’, ‘value2’, …]
cookie1.name = ‘name’
httponly = cookie1.httponly
secure = cookie1.secure
expires = cookie1.expires
domain = cookie1.domain
path = cookie1.path
values = cookie1.value
name = cookie1.name
cgi.out(“cookie” => [cookie1, cookie2]) { “string” }
)
‘httponly’ => true # optional
’secure’ => true, # optional
’expires’ => Time.now, # optional
’domain’ => ‘domain’, # optional
’path’ => ‘path’, # optional
’value’ => [‘value1’, ‘value2’, …],
cookie1 = CGI::Cookie.new(‘name’ => ‘name’,
cookie1 = CGI::Cookie.new(“name” => “name”, “value” => “value”)
cookie1 = CGI::Cookie.new(“name”, “value1”, “value2”, …)
== Examples of use
See RFC 2965.
is a delegator to the array of its values.
In addition to its specific fields and methods, a Cookie instance
Class representing an HTTP cookie.

def self.parse(raw_cookie)

# { "name1" => cookie1, "name2" => cookie2, ... }
cookies = CGI::Cookie.parse("raw_cookie_string")

pairs.
Parse a raw cookie string into a hash of cookie-name=>Cookie

def self.parse(raw_cookie)
  cookies = Hash.new([])
  return cookies unless raw_cookie
  raw_cookie.split(/;\s?/).each do |pairs|
    name, values = pairs.split('=',2)
    next unless name and values
    values ||= ""
    values = values.split('&').collect{|v| CGI.unescape(v,@@accept_charset) }
    if cookies.has_key?(name)
      cookies[name].concat(values)
    else
      cookies[name] = Cookie.new(name, *values)
    end
  end
  cookies
end

def domain=(str)

Set domain for which this cookie applies

def domain=(str)
  if str and ((str = str.b).bytesize > 255 or !DOMAIN_VALUE_RE.match?(str))
    raise ArgumentError, "invalid domain: #{str.dump}"
  end
  @domain = str
end

def httponly=(val)

+val+ must be a boolean.

Set whether the Cookie is a httponly cookie or not.

def httponly=(val)
  @httponly = !!val
end

def initialize(name = "", *value)

These keywords correspond to attributes of the cookie object.

false). HttpOnly cookies are not available to javascript.
httponly:: whether this cookie is a HttpOnly cookie or not (default to
servers.
false). Secure cookies are only transmitted to HTTPS
secure:: whether this cookie is a secure cookie or not (default to
expires:: the time at which this cookie expires, as a +Time+ object.
domain:: the domain for which this cookie applies.
the value of the +SCRIPT_NAME+ environment variable.
path:: the path for which this cookie applies. Defaults to
value:: the cookie's value or list of values.
name:: the name of the cookie. Required.

A Hash of options to initialize this Cookie. Possible options are:
+options_hash+::
value or list of values of the cookie
*value::
variable, and #secure is false.
#expiration. The #path is gleaned from the +SCRIPT_NAME+ environment
The name of the cookie; in this form, there is no #domain or
+name_string+::

Cookie.new(options_hash)
Cookie.new(name_string,*value)
:call-seq:

Create a new CGI::Cookie object.

def initialize(name = "", *value)
  @domain = nil
  @expires = nil
  if name.kind_of?(String)
    self.name = name
    self.path = (%r|\A(.*/)| =~ ENV["SCRIPT_NAME"] ? $1 : "")
    @secure = false
    @httponly = false
    return super(value)
  end
  options = name
  unless options.has_key?("name")
    raise ArgumentError, "`name' required"
  end
  self.name = options["name"]
  value = Array(options["value"])
  # simple support for IE
  self.path = options["path"] || (%r|\A(.*/)| =~ ENV["SCRIPT_NAME"] ? $1 : "")
  self.domain = options["domain"]
  @expires = options["expires"]
  @secure = options["secure"] == true
  @httponly = options["httponly"] == true
  super(value)
end

def inspect

A summary of cookie string.

def inspect
  "#<CGI::Cookie: #{self.to_s.inspect}>"
end

def name=(str)

Set name of this cookie

def name=(str)
  if str and !TOKEN_RE.match?(str)
    raise ArgumentError, "invalid name: #{str.dump}"
  end
  @name = str
end

def path=(str)

Set path for which this cookie applies

def path=(str)
  if str and !PATH_VALUE_RE.match?(str)
    raise ArgumentError, "invalid path: #{str.dump}"
  end
  @path = str
end

def secure=(val)

+val+ must be a boolean.

Set whether the Cookie is a secure cookie or not.

def secure=(val)
  @secure = val if val == true or val == false
  @secure
end

def to_s

Convert the Cookie to its string representation.

def to_s
  val = collect{|v| CGI.escape(v) }.join("&")
  buf = "#{@name}=#{val}".dup
  buf << "; domain=#{@domain}" if @domain
  buf << "; path=#{@path}"     if @path
  buf << "; expires=#{CGI.rfc1123_date(@expires)}" if @expires
  buf << "; secure"            if @secure
  buf << "; HttpOnly"          if @httponly
  buf
end

def value

Returns the value or list of values for this cookie.

def value
  self
end

def value=(val)

Replaces the value of this cookie with a new value or list of values.

def value=(val)
  replace(Array(val))
end

Modules

Classes