Class: CGI::Cookie
- Inherits:
-
Array
- Object
- Array
- CGI::Cookie
- Defined in:
- lib/cgi.rb
Overview
Class representing an HTTP cookie.
In addition to its specific fields and methods, a Cookie instance is a delegator to the array of its values.
See RFC 2965.
Examples of use
cookie1 = CGI::Cookie::new("name", "value1", "value2", ...)
cookie1 = CGI::Cookie::new("name" => "name", "value" => "value")
cookie1 = CGI::Cookie::new('name' => 'name',
'value' => ['value1', 'value2', ...],
'path' => 'path', # optional
'domain' => 'domain', # optional
'expires' => Time.now, # optional
'secure' => true # optional
)
cgi.out("cookie" => [cookie1, cookie2]) { "string" }
name = cookie1.name
values = cookie1.value
path = cookie1.path
domain = cookie1.domain
expires = cookie1.expires
secure = cookie1.secure
cookie1.name = 'name'
cookie1.value = ['value1', 'value2', ...]
cookie1.path = 'path'
cookie1.domain = 'domain'
cookie1.expires = Time.now + 30
cookie1.secure = true
Instance Attribute Summary collapse
-
#domain ⇒ Object
Returns the value of attribute domain.
-
#expires ⇒ Object
Returns the value of attribute expires.
-
#name ⇒ Object
Returns the value of attribute name.
-
#path ⇒ Object
Returns the value of attribute path.
-
#secure ⇒ Object
Returns the value of attribute secure.
-
#value ⇒ Object
Returns the value of attribute value.
Class Method Summary collapse
-
.parse(raw_cookie) ⇒ Object
Parse a raw cookie string into a hash of cookie-name=>Cookie pairs.
Instance Method Summary collapse
-
#initialize(name = "",, *value) ⇒ Cookie
constructor
Create a new CGI::Cookie object.
-
#to_s ⇒ Object
Convert the Cookie to its string representation.
Constructor Details
#initialize(name = "",, *value) ⇒ Cookie
Create a new CGI::Cookie object.
The contents of the cookie can be specified as a name
and one or more value
arguments. 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 (default to false). Secure cookies are only transmitted to HTTPS servers.
These keywords correspond to attributes of the cookie object.
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 |
# File 'lib/cgi.rb', line 794 def initialize(name = "", *value) = if name.kind_of?(String) { "name" => name, "value" => value } else name end unless .has_key?("name") raise ArgumentError, "`name' required" end @name = ["name"] @value = Array(["value"]) # simple support for IE if ["path"] @path = ["path"] else %r|^(.*/)|.match(ENV["SCRIPT_NAME"]) @path = ($1 or "") end @domain = ["domain"] @expires = ["expires"] @secure = ["secure"] == true ? true : false super(@value) end |
Instance Attribute Details
#domain ⇒ Object
Returns the value of attribute domain
820 821 822 |
# File 'lib/cgi.rb', line 820 def domain @domain end |
#expires ⇒ Object
Returns the value of attribute expires
820 821 822 |
# File 'lib/cgi.rb', line 820 def expires @expires end |
#name ⇒ Object
Returns the value of attribute name
820 821 822 |
# File 'lib/cgi.rb', line 820 def name @name end |
#path ⇒ Object
Returns the value of attribute path
820 821 822 |
# File 'lib/cgi.rb', line 820 def path @path end |
#secure ⇒ Object
Returns the value of attribute secure
821 822 823 |
# File 'lib/cgi.rb', line 821 def secure @secure end |
#value ⇒ Object
Returns the value of attribute value
821 822 823 |
# File 'lib/cgi.rb', line 821 def value @value end |
Class Method Details
.parse(raw_cookie) ⇒ Object
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 |
# File 'lib/cgi.rb', line 871 def Cookie::parse() = Hash.new([]) return unless .split(/[;,]\s?/).each do |pairs| name, values = pairs.split('=',2) next unless name and values name = CGI::unescape(name) values ||= "" values = values.split('&').collect{|v| CGI::unescape(v) } if .has_key?(name) values = [name].value + values end [name] = Cookie::new({ "name" => name, "value" => values }) end end |
Instance Method Details
#to_s ⇒ Object
Convert the Cookie to its string representation.
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 |
# File 'lib/cgi.rb', line 837 def to_s buf = "" buf += @name + '=' buf += @value.map { |v| CGI::escape(v.to_s) }.join("&") if @domain buf += '; domain=' + @domain end if @path buf += '; path=' + @path end if @expires buf += '; expires=' + CGI::rfc1123_date(@expires) end if @secure == true buf += '; secure' end buf end |