File: C:/Ruby27-x64/share/doc/ruby/html/WEBrick/Cookie.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class WEBrick::Cookie - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-parse">::parse</a>
<li ><a href="#method-c-parse_set_cookie">::parse_set_cookie</a>
<li ><a href="#method-c-parse_set_cookies">::parse_set_cookies</a>
<li ><a href="#method-i-expires">#expires</a>
<li ><a href="#method-i-expires-3D">#expires=</a>
<li ><a href="#method-i-to_s">#to_s</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-WEBrick::Cookie">
<h1 id="class-WEBrick::Cookie" class="class">
class WEBrick::Cookie
</h1>
<section class="description">
<p>Processes HTTP cookies</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-comment" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">comment</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The cookie comment</p>
</div>
</div>
<div id="attribute-i-domain" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">domain</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The cookie domain</p>
</div>
</div>
<div id="attribute-i-max_age" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">max_age</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The maximum age of the cookie</p>
</div>
</div>
<div id="attribute-i-name" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">name</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The cookie name</p>
</div>
</div>
<div id="attribute-i-path" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">path</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The cookie path</p>
</div>
</div>
<div id="attribute-i-secure" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">secure</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Is this a secure cookie?</p>
</div>
</div>
<div id="attribute-i-value" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">value</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The cookie value</p>
</div>
</div>
<div id="attribute-i-version" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">version</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The cookie version</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(name, value)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new cookie with the given <code>name</code> and <code>value</code></p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/webrick/cookie.rb, line 66</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span>)
<span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
<span class="ruby-ivar">@value</span> = <span class="ruby-identifier">value</span>
<span class="ruby-ivar">@version</span> = <span class="ruby-value">0</span> <span class="ruby-comment"># Netscape Cookie</span>
<span class="ruby-ivar">@domain</span> = <span class="ruby-ivar">@path</span> = <span class="ruby-ivar">@secure</span> = <span class="ruby-ivar">@comment</span> = <span class="ruby-ivar">@max_age</span> =
<span class="ruby-ivar">@expires</span> = <span class="ruby-ivar">@comment_url</span> = <span class="ruby-ivar">@discard</span> = <span class="ruby-ivar">@port</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-parse" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse</span><span
class="method-args">(str)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Parses a <a href="Cookie.html"><code>Cookie</code></a> field sent from the user-agent. Returns an array of cookies.</p>
<div class="method-source-code" id="parse-source">
<pre><span class="ruby-comment"># File lib/webrick/cookie.rb, line 111</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">parse</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">str</span>
<span class="ruby-identifier">ret</span> = []
<span class="ruby-identifier">cookie</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">ver</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/;\s+/</span>).<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span> = <span class="ruby-identifier">x</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/=/</span>,<span class="ruby-value">2</span>)
<span class="ruby-identifier">val</span> = <span class="ruby-identifier">val</span> <span class="ruby-operator">?</span> <span class="ruby-constant">HTTPUtils</span><span class="ruby-operator">::</span><span class="ruby-identifier">dequote</span>(<span class="ruby-identifier">val</span>) <span class="ruby-operator">:</span> <span class="ruby-string">""</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">key</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"$Version"</span>; <span class="ruby-identifier">ver</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_i</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"$Path"</span>; <span class="ruby-identifier">cookie</span>.<span class="ruby-identifier">path</span> = <span class="ruby-identifier">val</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"$Domain"</span>; <span class="ruby-identifier">cookie</span>.<span class="ruby-identifier">domain</span> = <span class="ruby-identifier">val</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"$Port"</span>; <span class="ruby-identifier">cookie</span>.<span class="ruby-identifier">port</span> = <span class="ruby-identifier">val</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">ret</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">cookie</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">cookie</span>
<span class="ruby-identifier">cookie</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span>)
<span class="ruby-identifier">cookie</span>.<span class="ruby-identifier">version</span> = <span class="ruby-identifier">ver</span>
<span class="ruby-keyword">end</span>
}
<span class="ruby-identifier">ret</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">cookie</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">cookie</span>
<span class="ruby-identifier">ret</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-parse_set_cookie" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse_set_cookie</span><span
class="method-args">(str)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Parses the cookie in <code>str</code></p>
<div class="method-source-code" id="parse_set_cookie-source">
<pre><span class="ruby-comment"># File lib/webrick/cookie.rb, line 138</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">parse_set_cookie</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">cookie_elem</span> = <span class="ruby-identifier">str</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/;/</span>)
<span class="ruby-identifier">first_elem</span> = <span class="ruby-identifier">cookie_elem</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-identifier">first_elem</span>.<span class="ruby-identifier">strip!</span>
<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span> = <span class="ruby-identifier">first_elem</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/=/</span>, <span class="ruby-value">2</span>)
<span class="ruby-identifier">cookie</span> = <span class="ruby-identifier">new</span>(<span class="ruby-identifier">key</span>, <span class="ruby-constant">HTTPUtils</span>.<span class="ruby-identifier">dequote</span>(<span class="ruby-identifier">value</span>))
<span class="ruby-identifier">cookie_elem</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">pair</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">pair</span>.<span class="ruby-identifier">strip!</span>
<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span> = <span class="ruby-identifier">pair</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/=/</span>, <span class="ruby-value">2</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>
<span class="ruby-identifier">value</span> = <span class="ruby-constant">HTTPUtils</span>.<span class="ruby-identifier">dequote</span>(<span class="ruby-identifier">value</span>.<span class="ruby-identifier">strip</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">downcase</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"domain"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">cookie</span>.<span class="ruby-identifier">domain</span> = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"path"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">cookie</span>.<span class="ruby-identifier">path</span> = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"expires"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">cookie</span>.<span class="ruby-identifier">expires</span> = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"max-age"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">cookie</span>.<span class="ruby-identifier">max_age</span> = <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">value</span>)
<span class="ruby-keyword">when</span> <span class="ruby-string">"comment"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">cookie</span>.<span class="ruby-identifier">comment</span> = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"version"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">cookie</span>.<span class="ruby-identifier">version</span> = <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">value</span>)
<span class="ruby-keyword">when</span> <span class="ruby-string">"secure"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">cookie</span>.<span class="ruby-identifier">secure</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
}
<span class="ruby-keyword">return</span> <span class="ruby-identifier">cookie</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-parse_set_cookies" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse_set_cookies</span><span
class="method-args">(str)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Parses the cookies in <code>str</code></p>
<div class="method-source-code" id="parse_set_cookies-source">
<pre><span class="ruby-comment"># File lib/webrick/cookie.rb, line 166</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">parse_set_cookies</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/,(?=[^;,]*=)|,$/</span>).<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">parse_set_cookie</span>(<span class="ruby-identifier">c</span>)
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-expires" class="method-detail ">
<div class="method-heading">
<span class="method-name">expires</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Retrieves the expiration time as a <a href="../Time.html"><code>Time</code></a></p>
<div class="method-source-code" id="expires-source">
<pre><span class="ruby-comment"># File lib/webrick/cookie.rb, line 87</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">expires</span>
<span class="ruby-ivar">@expires</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-ivar">@expires</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-expires-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">expires=</span><span
class="method-args">(t)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the cookie expiration to the time <code>t</code>. The expiration time may be a false value to disable expiration or a <a href="../Time.html"><code>Time</code></a> or HTTP format time string to set the expiration date.</p>
<div class="method-source-code" id="expires-3D-source">
<pre><span class="ruby-comment"># File lib/webrick/cookie.rb, line 80</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">expires=</span>(<span class="ruby-identifier">t</span>)
<span class="ruby-ivar">@expires</span> = <span class="ruby-identifier">t</span> <span class="ruby-operator">&&</span> (<span class="ruby-identifier">t</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Time</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">t</span>.<span class="ruby-identifier">httpdate</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">t</span>.<span class="ruby-identifier">to_s</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The cookie string suitable for use in an HTTP header</p>
<div class="method-source-code" id="to_s-source">
<pre><span class="ruby-comment"># File lib/webrick/cookie.rb, line 94</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
<span class="ruby-identifier">ret</span> = <span class="ruby-string">""</span>
<span class="ruby-identifier">ret</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@name</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"="</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@value</span>
<span class="ruby-identifier">ret</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"; "</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"Version="</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@version</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@version</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="ruby-identifier">ret</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"; "</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"Domain="</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@domain</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@domain</span>
<span class="ruby-identifier">ret</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"; "</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"Expires="</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@expires</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@expires</span>
<span class="ruby-identifier">ret</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"; "</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"Max-Age="</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@max_age</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@max_age</span>
<span class="ruby-identifier">ret</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"; "</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"Comment="</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@comment</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@comment</span>
<span class="ruby-identifier">ret</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"; "</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"Path="</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@path</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@path</span>
<span class="ruby-identifier">ret</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"; "</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"Secure"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@secure</span>
<span class="ruby-identifier">ret</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>