Methods
H
N
P
R
S
T
Attributes
[RW] domain
[RW] expires
[R] http_only
[RW] name
[RW] path
[R] secure
[RW] value
Class Public methods
new(name = '', *value)

Creates a new CGI::Cookie object.

The contents of the cookie can be specified as a nameand one or more valuearguments. Alternatively, the contents can be specified as a single hash argument. The possible keywords of this hash are as follows:

  • :name- The name of the cookie. Required.

  • :value- The cookie's value or list of values.

  • :path- The path for which this cookie applies. Defaults to the base directory of the CGI script.

  • :domain- The domain for which this cookie applies.

  • :expires- The time at which this cookie expires, as a Time object.

  • :secure- Whether this cookie is a secure cookie or not (defaults to false). Secure cookies are only transmitted to HTTPS servers.

  • :http_only- Whether this cookie can be accessed by client side scripts (e.g. document.cookie) or only over HTTP. More details in msdn2.microsoft.com/en-us/library/system.web.httpcookie.httponly.aspx. Defaults to false.

These keywords correspond to attributes of the cookie object.

# File actionpack/lib/action_controller/cgi_ext/cookie.rb, line 30
def initialize(name = '', *value)
  if name.kind_of?(String)
    @name = name
    @value = Array(value)
    @domain = nil
    @expires = nil
    @secure = false
    @http_only = false
    @path = nil
  else
    @name = name['name']
    @value = (name['value'].kind_of?(String) ? [name['value']] : Array(name['value'])).delete_if(&:blank?)
    @domain = name['domain']
    @expires = name['expires']
    @secure = name['secure'] || false
    @http_only = name['http_only'] || false
    @path = name['path']
  end
  raise ArgumentError, "`name' required" unless @name
  # simple support for IE
  unless @path
    %r^(.*/)|.match(ENV['SCRIPT_NAME'])
    @path = ($1 or '')
  end
  super(@value)
end
parse(raw_cookie)

Parses a raw cookie string into a hash of cookie-name => cookie-object pairs.

cookies = CGI::Cookie::parse("raw_cookie_string")
  # => { "name1" => cookie1, "name2" => cookie2, ... }
# File actionpack/lib/action_controller/cgi_ext/cookie.rb, line 95
def self.parse(raw_cookie)
  cookies = Hash.new([])
  if raw_cookie
    raw_cookie.split(/;\s?/).each do |pairs|
      name, value = pairs.split('=',2)
      next unless name and value
      name = CGI::unescape(name)
      unless cookies.has_key?(name)
        cookies[name] = new(name, CGI::unescape(value))
      end
    end
  end
  cookies
end
Instance Public methods
http_only=(val)

Sets whether the Cookie is an HTTP only cookie or not.

# File actionpack/lib/action_controller/cgi_ext/cookie.rb, line 66
def http_only=(val)
  @http_only = val == true
end
respond_to?(method, include_private = false)

FIXME: work around broken 1.8.7 DelegateClass#respond_to?

# File actionpack/lib/action_controller/cgi_ext/cookie.rb, line 84
def respond_to?(method, include_private = false)
  return true if super(method)
  return __getobj__.respond_to?(method, include_private)
end
secure=(val)

Sets whether the Cookie is a secure cookie or not.

# File actionpack/lib/action_controller/cgi_ext/cookie.rb, line 61
def secure=(val)
  @secure = val == true
end
to_s()

Converts the Cookie to its string representation.

# File actionpack/lib/action_controller/cgi_ext/cookie.rb, line 71
def to_s
  buf = ''
  buf << @name << '='
  buf << (@value.kind_of?(String) ? CGI::escape(@value) : @value.collect{|v| CGI::escape(v) }.join("&"))
  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 @http_only
  buf
end