diff options
| author | Gibheer <gibheer@gmail.com> | 2012-11-26 21:40:21 +0100 |
|---|---|---|
| committer | Gibheer <gibheer@gmail.com> | 2012-11-26 21:40:21 +0100 |
| commit | 37a4a28deec224f7cd9a5a124e22258e868913e4 (patch) | |
| tree | 23f8ce9b940ff1a357336344388cbcd46aa57ee7 /doc/Zero/Request | |
| parent | 77a2cbe6d4e8752a9450e945724522d10cfb5f09 (diff) | |
added the first set of documentation
Diffstat (limited to 'doc/Zero/Request')
| -rw-r--r-- | doc/Zero/Request/Accept.html | 612 | ||||
| -rw-r--r-- | doc/Zero/Request/AcceptType.html | 403 | ||||
| -rw-r--r-- | doc/Zero/Request/Client.html | 579 | ||||
| -rw-r--r-- | doc/Zero/Request/Parameter.html | 489 | ||||
| -rw-r--r-- | doc/Zero/Request/Server.html | 687 |
5 files changed, 2770 insertions, 0 deletions
diff --git a/doc/Zero/Request/Accept.html b/doc/Zero/Request/Accept.html new file mode 100644 index 0000000..8a45ae0 --- /dev/null +++ b/doc/Zero/Request/Accept.html @@ -0,0 +1,612 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title> + Class: Zero::Request::Accept + + — Documentation by YARD 0.8.3 + +</title> + + <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + hasFrames = window.top.frames.main ? true : false; + relpath = '../../'; + framesUrl = "../../frames.html#!" + escape(window.location.href); +</script> + + + <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> + + + </head> + <body> + <div id="header"> + <div id="menu"> + + <a href="../../_index.html">Index (A)</a> » + <span class='title'><span class='object_link'><a href="../../Zero.html" title="Zero (module)">Zero</a></span></span> » <span class='title'><span class='object_link'><a href="../Request.html" title="Zero::Request (class)">Request</a></span></span> + » + <span class="title">Accept</span> + + + <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> +</div> + + <div id="search"> + + <a class="full_list_link" id="class_list_link" + href="../../class_list.html"> + Class List + </a> + + <a class="full_list_link" id="method_list_link" + href="../../method_list.html"> + Method List + </a> + + <a class="full_list_link" id="file_list_link" + href="../../file_list.html"> + File List + </a> + +</div> + <div class="clear"></div> + </div> + + <iframe id="search_frame"></iframe> + + <div id="content"><h1>Class: Zero::Request::Accept + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName">Object</span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next">Zero::Request::Accept</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/zero/request/accept.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + +<p>encapsulates the accept header to easier work with this is partly copied +from sinatra</p> + + + </div> +</div> +<div class="tags"> + + +</div> + <h2>Constant Summary</h2> + + <dl class="constants"> + + <dt id="MEDIA_TYPE_SEPERATOR-constant" class="">MEDIA_TYPE_SEPERATOR = + + </dt> + <dd><pre class="code"><span class='string val'>','</span> +</pre></dd> + + <dt id="MEDIA_PARAM_SEPERATOR-constant" class="">MEDIA_PARAM_SEPERATOR = + + </dt> + <dd><pre class="code"><span class='string val'>';'</span> +</pre></dd> + + <dt id="MEDIA_QUALITY_REGEX-constant" class="">MEDIA_QUALITY_REGEX = + + </dt> + <dd><pre class="code"><span class='regexp val'>/q=[01]\./</span> +</pre></dd> + + <dt id="KEY_HTTP_ACCEPT-constant" class="">KEY_HTTP_ACCEPT = + + </dt> + <dd><pre class="code"><span class='string val'>'HTTP_ACCEPT'</span> +</pre></dd> + + <dt id="KEY_HTTP_ACCEPT_LANGUAGE-constant" class="">KEY_HTTP_ACCEPT_LANGUAGE = + + </dt> + <dd><pre class="code"><span class='string val'>'HTTP_ACCEPT_LANGUAGE'</span> +</pre></dd> + + <dt id="KEY_HTTP_ACCEPT_ENCODING-constant" class="">KEY_HTTP_ACCEPT_ENCODING = + + </dt> + <dd><pre class="code"><span class='string val'>'HTTP_ACCEPT_ENCODING'</span> +</pre></dd> + + </dl> + + + + + + <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2> + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#encoding-instance_method" title="#encoding (instance method)">- (Object) <strong>encoding</strong> </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Returns the value of attribute encoding.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#language-instance_method" title="#language (instance method)">- (Object) <strong>language</strong> </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Returns the value of attribute language.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#types-instance_method" title="#types (instance method)">- (Object) <strong>types</strong> </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Returns the value of attribute types.</p> +</div></span> + +</li> + + + </ul> + + + + + + <h2> + Class Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#map-class_method" title="map (class method)">+ (Object) <strong>map</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#map%3D-class_method" title="map= (class method)">+ (Object) <strong>map=</strong>(map) </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + + </ul> + + <h2> + Instance Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Accept) <strong>initialize</strong>(environment) </a> + + + + </span> + + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>create a new accept object.</p> +</div></span> + +</li> + + + </ul> + + +<div id="constructor_details" class="method_details_list"> + <h2>Constructor Details</h2> + + <div class="method_details first"> + <h3 class="signature first" id="initialize-instance_method"> + + - (<tt><span class='object_link'><a href="" title="Zero::Request::Accept (class)">Accept</a></span></tt>) <strong>initialize</strong>(environment) + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>create a new accept object</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +25 +26 +27 +28 +29</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 25</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='rparen token'>)</span> + <span class='rubyid_@types ivar id'>@types</span> <span class='assign token'>=</span> <span class='rubyid_AcceptType constant id'>AcceptType</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_HTTP_ACCEPT constant id'>KEY_HTTP_ACCEPT</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> + <span class='rubyid_@language ivar id'>@language</span> <span class='assign token'>=</span> <span class='rubyid_AcceptType constant id'>AcceptType</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_HTTP_ACCEPT_LANGUAGE constant id'>KEY_HTTP_ACCEPT_LANGUAGE</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> + <span class='rubyid_@encoding ivar id'>@encoding</span> <span class='assign token'>=</span> <span class='rubyid_AcceptType constant id'>AcceptType</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_HTTP_ACCEPT_ENCODING constant id'>KEY_HTTP_ACCEPT_ENCODING</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id=""></span> + <div class="method_details first"> + <h3 class="signature first" id="encoding-instance_method"> + + - (<tt>Object</tt>) <strong>encoding</strong> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Returns the value of attribute encoding</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +33 +34 +35</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 33</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_encoding identifier id'>encoding</span> + <span class='rubyid_@encoding ivar id'>@encoding</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="language-instance_method"> + + - (<tt>Object</tt>) <strong>language</strong> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Returns the value of attribute language</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +32 +33 +34</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 32</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_language identifier id'>language</span> + <span class='rubyid_@language ivar id'>@language</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="types-instance_method"> + + - (<tt>Object</tt>) <strong>types</strong> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Returns the value of attribute types</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +31 +32 +33</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 31</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_types identifier id'>types</span> + <span class='rubyid_@types ivar id'>@types</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + + + <div id="class_method_details" class="method_details_list"> + <h2>Class Method Details</h2> + + + <div class="method_details first"> + <h3 class="signature first" id="map-class_method"> + + + (<tt>Object</tt>) <strong>map</strong> + + + + + +</h3><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +20 +21 +22</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 20</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span> + <span class='rubyid_@@map ivar id'>@@map</span> <span class='opasgn op'>||=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="map=-class_method"> + + + (<tt>Object</tt>) <strong>map=</strong>(map) + + + + + +</h3><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +16 +17 +18</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 16</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span><span class='assign token'>=</span><span class='lparen token'>(</span><span class='rubyid_map identifier id'>map</span><span class='rparen token'>)</span> + <span class='rubyid_@@map ivar id'>@@map</span> <span class='assign token'>=</span> <span class='rubyid_map identifier id'>map</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Mon Nov 26 21:40:01 2012 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.8.3 (ruby-1.9.3). +</div> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Zero/Request/AcceptType.html b/doc/Zero/Request/AcceptType.html new file mode 100644 index 0000000..603d3d3 --- /dev/null +++ b/doc/Zero/Request/AcceptType.html @@ -0,0 +1,403 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title> + Class: Zero::Request::AcceptType + + — Documentation by YARD 0.8.3 + +</title> + + <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + hasFrames = window.top.frames.main ? true : false; + relpath = '../../'; + framesUrl = "../../frames.html#!" + escape(window.location.href); +</script> + + + <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> + + + </head> + <body> + <div id="header"> + <div id="menu"> + + <a href="../../_index.html">Index (A)</a> » + <span class='title'><span class='object_link'><a href="../../Zero.html" title="Zero (module)">Zero</a></span></span> » <span class='title'><span class='object_link'><a href="../Request.html" title="Zero::Request (class)">Request</a></span></span> + » + <span class="title">AcceptType</span> + + + <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> +</div> + + <div id="search"> + + <a class="full_list_link" id="class_list_link" + href="../../class_list.html"> + Class List + </a> + + <a class="full_list_link" id="method_list_link" + href="../../method_list.html"> + Method List + </a> + + <a class="full_list_link" id="file_list_link" + href="../../file_list.html"> + File List + </a> + +</div> + <div class="clear"></div> + </div> + + <iframe id="search_frame"></iframe> + + <div id="content"><h1>Class: Zero::Request::AcceptType + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName">Object</span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next">Zero::Request::AcceptType</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/zero/request/accept_type.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + +<p>This class provides an interface to access information of accept schemas.</p> + + + </div> +</div> +<div class="tags"> + + +</div> + <h2>Constant Summary</h2> + + <dl class="constants"> + + <dt id="MEDIA_TYPE_SEPERATOR-constant" class="">MEDIA_TYPE_SEPERATOR = + + </dt> + <dd><pre class="code"><span class='string val'>','</span> +</pre></dd> + + <dt id="MEDIA_PARAM_SEPERATOR-constant" class="">MEDIA_PARAM_SEPERATOR = + + </dt> + <dd><pre class="code"><span class='string val'>';'</span> +</pre></dd> + + <dt id="MEDIA_QUALITY_REGEX-constant" class="">MEDIA_QUALITY_REGEX = + + </dt> + <dd><pre class="code"><span class='regexp val'>/q=[01]\./</span> +</pre></dd> + + </dl> + + + + + + + + + + <h2> + Instance Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#each-instance_method" title="#each (instance method)">- (Object) <strong>each</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>iterate over all media types.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (AcceptType) <strong>initialize</strong>(string) </a> + + + + </span> + + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>create a new instance of AcceptType.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#preferred-instance_method" title="#preferred (instance method)">- (Object) <strong>preferred</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>return the preferred type.</p> +</div></span> + +</li> + + + </ul> + + +<div id="constructor_details" class="method_details_list"> + <h2>Constructor Details</h2> + + <div class="method_details first"> + <h3 class="signature first" id="initialize-instance_method"> + + - (<tt><span class='object_link'><a href="" title="Zero::Request::AcceptType (class)">AcceptType</a></span></tt>) <strong>initialize</strong>(string) + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>create a new instance of AcceptType</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +10 +11 +12 +13 +14 +15 +16</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/accept_type.rb', line 10</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_string identifier id'>string</span><span class='rparen token'>)</span> + <span class='rubyid_if if kw'>if</span> <span class='rubyid_string identifier id'>string</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span> + <span class='rubyid_@elements ivar id'>@elements</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span> + <span class='rubyid_else else kw'>else</span> + <span class='rubyid_@elements ivar id'>@elements</span> <span class='assign token'>=</span> <span class='rubyid_parse_elements identifier id'>parse_elements</span><span class='lparen token'>(</span><span class='rubyid_string identifier id'>string</span><span class='rparen token'>)</span> + <span class='rubyid_end end kw'>end</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + + <div id="instance_method_details" class="method_details_list"> + <h2>Instance Method Details</h2> + + + <div class="method_details first"> + <h3 class="signature first" id="each-instance_method"> + + - (<tt>Object</tt>) <strong>each</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>iterate over all media types</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +25 +26 +27</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/accept_type.rb', line 25</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_each identifier id'>each</span> + <span class='rubyid_@elements ivar id'>@elements</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='rubyid_element identifier id'>element</span><span class='bitor op'>|</span> <span class='rubyid_yield yield kw'>yield</span> <span class='rubyid_element identifier id'>element</span><span class='rbrace token'>}</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="preferred-instance_method"> + + - (<tt>Object</tt>) <strong>preferred</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>return the preferred type</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'></span> + + + + + <div class='inline'> +<p>String the preferred media type</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +20 +21 +22</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/accept_type.rb', line 20</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_preferred identifier id'>preferred</span> + <span class='rubyid_@elements ivar id'>@elements</span><span class='dot token'>.</span><span class='rubyid_first identifier id'>first</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Mon Nov 26 21:40:02 2012 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.8.3 (ruby-1.9.3). +</div> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Zero/Request/Client.html b/doc/Zero/Request/Client.html new file mode 100644 index 0000000..f2e733d --- /dev/null +++ b/doc/Zero/Request/Client.html @@ -0,0 +1,579 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title> + Class: Zero::Request::Client + + — Documentation by YARD 0.8.3 + +</title> + + <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + hasFrames = window.top.frames.main ? true : false; + relpath = '../../'; + framesUrl = "../../frames.html#!" + escape(window.location.href); +</script> + + + <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> + + + </head> + <body> + <div id="header"> + <div id="menu"> + + <a href="../../_index.html">Index (C)</a> » + <span class='title'><span class='object_link'><a href="../../Zero.html" title="Zero (module)">Zero</a></span></span> » <span class='title'><span class='object_link'><a href="../Request.html" title="Zero::Request (class)">Request</a></span></span> + » + <span class="title">Client</span> + + + <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> +</div> + + <div id="search"> + + <a class="full_list_link" id="class_list_link" + href="../../class_list.html"> + Class List + </a> + + <a class="full_list_link" id="method_list_link" + href="../../method_list.html"> + Method List + </a> + + <a class="full_list_link" id="file_list_link" + href="../../file_list.html"> + File List + </a> + +</div> + <div class="clear"></div> + </div> + + <iframe id="search_frame"></iframe> + + <div id="content"><h1>Class: Zero::Request::Client + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName">Object</span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next">Zero::Request::Client</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/zero/request/client.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + +<p>This class represents all information about the client of a request.</p> + + + </div> +</div> +<div class="tags"> + + +</div> + <h2>Constant Summary</h2> + + <dl class="constants"> + + <dt id="KEY_REMOTE_ADDR-constant" class="">KEY_REMOTE_ADDR = + <div class="docstring"> + <div class="discussion"> + +<p>the key for the ip of the client</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>'REMOTE_ADDR'</span> +</pre></dd> + + <dt id="KEY_REMOTE_HOST-constant" class="">KEY_REMOTE_HOST = + <div class="docstring"> + <div class="discussion"> + +<p>the key for the hostname</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>'REMOTE_HOST'</span> +</pre></dd> + + <dt id="KEY_USER_AGENT-constant" class="">KEY_USER_AGENT = + <div class="docstring"> + <div class="discussion"> + +<p>the key for the user agent</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>'HTTP_USER_AGENT'</span> +</pre></dd> + + </dl> + + + + + + <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2> + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#address-instance_method" title="#address (instance method)">- (String) <strong>address</strong> </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>the ip address of the client.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#hostname-instance_method" title="#hostname (instance method)">- (String) <strong>hostname</strong> </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>the hostname of the client.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#user_agent-instance_method" title="#user_agent (instance method)">- (String) <strong>user_agent</strong> </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>the user agent of the client.</p> +</div></span> + +</li> + + + </ul> + + + + + + <h2> + Instance Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Client) <strong>initialize</strong>(environment) </a> + + + + </span> + + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>creates a new client with the data of the request environment.</p> +</div></span> + +</li> + + + </ul> + + +<div id="constructor_details" class="method_details_list"> + <h2>Constructor Details</h2> + + <div class="method_details first"> + <h3 class="signature first" id="initialize-instance_method"> + + - (<tt><span class='object_link'><a href="" title="Zero::Request::Client (class)">Client</a></span></tt>) <strong>initialize</strong>(environment) + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>creates a new client with the data of the request environment</p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>environment</span> + + + <span class='type'></span> + + + + — + <div class='inline'> +<p>a hash representation of the request</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +14 +15 +16 +17 +18</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/client.rb', line 14</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='rparen token'>)</span> + <span class='rubyid_@address ivar id'>@address</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_REMOTE_ADDR constant id'>KEY_REMOTE_ADDR</span><span class='rbrack token'>]</span> + <span class='rubyid_@hostname ivar id'>@hostname</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_REMOTE_HOST constant id'>KEY_REMOTE_HOST</span><span class='rbrack token'>]</span> + <span class='rubyid_@user_agent ivar id'>@user_agent</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_USER_AGENT constant id'>KEY_USER_AGENT</span><span class='rbrack token'>]</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id=""></span> + <div class="method_details first"> + <h3 class="signature first" id="address-instance_method"> + + - (<tt>String</tt>) <strong>address</strong> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>the ip address of the client</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'> +<p>the address of the client</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +22 +23 +24</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/client.rb', line 22</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_address identifier id'>address</span> + <span class='rubyid_@address ivar id'>@address</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="hostname-instance_method"> + + - (<tt>String</tt>) <strong>hostname</strong> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>the hostname of the client</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'> +<p>the hostname of the client</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +25 +26 +27</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/client.rb', line 25</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_hostname identifier id'>hostname</span> + <span class='rubyid_@hostname ivar id'>@hostname</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="user_agent-instance_method"> + + - (<tt>String</tt>) <strong>user_agent</strong> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>the user agent of the client</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'> +<p>the user agent of the client</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +28 +29 +30</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/client.rb', line 28</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_user_agent identifier id'>user_agent</span> + <span class='rubyid_@user_agent ivar id'>@user_agent</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + + +</div> + + <div id="footer"> + Generated on Mon Nov 26 21:40:01 2012 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.8.3 (ruby-1.9.3). +</div> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Zero/Request/Parameter.html b/doc/Zero/Request/Parameter.html new file mode 100644 index 0000000..e8c170c --- /dev/null +++ b/doc/Zero/Request/Parameter.html @@ -0,0 +1,489 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title> + Class: Zero::Request::Parameter + + — Documentation by YARD 0.8.3 + +</title> + + <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + hasFrames = window.top.frames.main ? true : false; + relpath = '../../'; + framesUrl = "../../frames.html#!" + escape(window.location.href); +</script> + + + <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> + + + </head> + <body> + <div id="header"> + <div id="menu"> + + <a href="../../_index.html">Index (P)</a> » + <span class='title'><span class='object_link'><a href="../../Zero.html" title="Zero (module)">Zero</a></span></span> » <span class='title'><span class='object_link'><a href="../Request.html" title="Zero::Request (class)">Request</a></span></span> + » + <span class="title">Parameter</span> + + + <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> +</div> + + <div id="search"> + + <a class="full_list_link" id="class_list_link" + href="../../class_list.html"> + Class List + </a> + + <a class="full_list_link" id="method_list_link" + href="../../method_list.html"> + Method List + </a> + + <a class="full_list_link" id="file_list_link" + href="../../file_list.html"> + File List + </a> + +</div> + <div class="clear"></div> + </div> + + <iframe id="search_frame"></iframe> + + <div id="content"><h1>Class: Zero::Request::Parameter + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName">Object</span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next">Zero::Request::Parameter</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/zero/request/parameter.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + +<p>represents all parameter set in a session</p> + +<p>This class holds all parameters available in the rack environment, split on +query and payload parameters.</p> + + + </div> +</div> +<div class="tags"> + + +</div> + <h2>Constant Summary</h2> + + <dl class="constants"> + + <dt id="ENV_KEY_QUERY-constant" class="">ENV_KEY_QUERY = + <div class="docstring"> + <div class="discussion"> + +<p>they key for the query string</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>'QUERY_STRING'</span> +</pre></dd> + + <dt id="ENV_KEY_PAYLOAD-constant" class="">ENV_KEY_PAYLOAD = + <div class="docstring"> + <div class="discussion"> + +<p>the key for the payload</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>'rack.input'</span> +</pre></dd> + + <dt id="ENV_KEY_CONTENT_TYPE-constant" class="">ENV_KEY_CONTENT_TYPE = + <div class="docstring"> + <div class="discussion"> + +<p>the key for the content type</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>'CONTENT_TYPE'</span> +</pre></dd> + + <dt id="PAYLOAD_CONTENT_TYPES-constant" class="">PAYLOAD_CONTENT_TYPES = + <div class="docstring"> + <div class="discussion"> + +<p>all content types which used for using the body as a parameter input</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='lbrack token'>[</span> + <span class='string val'>'application/x-www-form-urlencoded'</span><span class='comma token'>,</span> + <span class='string val'>'multipart/form-data'</span> +<span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_set identifier id'>to_set</span> +</pre></dd> + + </dl> + + + + + + <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2> + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#payload-instance_method" title="#payload (instance method)">- (Object) <strong>payload</strong> </a> + + + + (also: #post) + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>get the payload or form data parameters.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#query-instance_method" title="#query (instance method)">- (Object) <strong>query</strong> </a> + + + + (also: #get) + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>get the query parameters.</p> +</div></span> + +</li> + + + </ul> + + + + + + <h2> + Instance Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Parameter) <strong>initialize</strong>(environment) </a> + + + + </span> + + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>creates a new parameter instance.</p> +</div></span> + +</li> + + + </ul> + + +<div id="constructor_details" class="method_details_list"> + <h2>Constructor Details</h2> + + <div class="method_details first"> + <h3 class="signature first" id="initialize-instance_method"> + + - (<tt><span class='object_link'><a href="" title="Zero::Request::Parameter (class)">Parameter</a></span></tt>) <strong>initialize</strong>(environment) + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>creates a new parameter instance</p> + +<p>This should never be called directly, as it will be generated for you. This +instance gives you the options to get query parameters (mostly called GET +parameters) and payload parameters (or POST parameters).</p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>environment</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + — + <div class='inline'> +<p>the rack environment</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +37 +38 +39 +40</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/parameter.rb', line 37</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='rparen token'>)</span> + <span class='rubyid_@query ivar id'>@query</span> <span class='assign token'>=</span> <span class='rubyid_extract_query_params identifier id'>extract_query_params</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='rparen token'>)</span> + <span class='rubyid_@payload ivar id'>@payload</span> <span class='assign token'>=</span> <span class='rubyid_extract_payload_params identifier id'>extract_payload_params</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='rparen token'>)</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id=""></span> + <div class="method_details first"> + <h3 class="signature first" id="payload-instance_method"> + + - (<tt>Object</tt>) <strong>payload</strong> <span class="extras">(readonly)</span> + + + + <span class="aliases">Also known as: + <span class="names"><span id='post-instance_method'>post</span></span> + </span> + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>get the payload or form data parameters</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +28 +29 +30</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/parameter.rb', line 28</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_payload identifier id'>payload</span> + <span class='rubyid_@payload ivar id'>@payload</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="query-instance_method"> + + - (<tt>Object</tt>) <strong>query</strong> <span class="extras">(readonly)</span> + + + + <span class="aliases">Also known as: + <span class="names"><span id='get-instance_method'>get</span></span> + </span> + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>get the query parameters</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +24 +25 +26</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/parameter.rb', line 24</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_query identifier id'>query</span> + <span class='rubyid_@query ivar id'>@query</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + + +</div> + + <div id="footer"> + Generated on Mon Nov 26 21:40:01 2012 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.8.3 (ruby-1.9.3). +</div> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Zero/Request/Server.html b/doc/Zero/Request/Server.html new file mode 100644 index 0000000..2a187d8 --- /dev/null +++ b/doc/Zero/Request/Server.html @@ -0,0 +1,687 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title> + Class: Zero::Request::Server + + — Documentation by YARD 0.8.3 + +</title> + + <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + hasFrames = window.top.frames.main ? true : false; + relpath = '../../'; + framesUrl = "../../frames.html#!" + escape(window.location.href); +</script> + + + <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> + + + </head> + <body> + <div id="header"> + <div id="menu"> + + <a href="../../_index.html">Index (S)</a> » + <span class='title'><span class='object_link'><a href="../../Zero.html" title="Zero (module)">Zero</a></span></span> » <span class='title'><span class='object_link'><a href="../Request.html" title="Zero::Request (class)">Request</a></span></span> + » + <span class="title">Server</span> + + + <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> +</div> + + <div id="search"> + + <a class="full_list_link" id="class_list_link" + href="../../class_list.html"> + Class List + </a> + + <a class="full_list_link" id="method_list_link" + href="../../method_list.html"> + Method List + </a> + + <a class="full_list_link" id="file_list_link" + href="../../file_list.html"> + File List + </a> + +</div> + <div class="clear"></div> + </div> + + <iframe id="search_frame"></iframe> + + <div id="content"><h1>Class: Zero::Request::Server + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName">Object</span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next">Zero::Request::Server</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/zero/request/server.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + +<p>This class represents all server related information of a request.</p> + + + </div> +</div> +<div class="tags"> + + +</div> + <h2>Constant Summary</h2> + + <dl class="constants"> + + <dt id="KEY_SERVER_NAME-constant" class="">KEY_SERVER_NAME = + <div class="docstring"> + <div class="discussion"> + <p class="note private"> + <strong>This constant is part of a private API.</strong> + You should avoid using this constant if possible, as it may be removed or be changed in the future. +</p> + +<p>the key for the server name</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>'SERVER_NAME'</span> +</pre></dd> + + <dt id="KEY_SERVER_PORT-constant" class="">KEY_SERVER_PORT = + <div class="docstring"> + <div class="discussion"> + <p class="note private"> + <strong>This constant is part of a private API.</strong> + You should avoid using this constant if possible, as it may be removed or be changed in the future. +</p> + +<p>the key for the server port</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>'SERVER_PORT'</span> +</pre></dd> + + <dt id="KEY_SERVER_PROTOCOL-constant" class="">KEY_SERVER_PROTOCOL = + <div class="docstring"> + <div class="discussion"> + <p class="note private"> + <strong>This constant is part of a private API.</strong> + You should avoid using this constant if possible, as it may be removed or be changed in the future. +</p> + +<p>the key for the server protocol</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>'SERVER_PROTOCOL'</span> +</pre></dd> + + <dt id="KEY_SERVER_SOFTWARE-constant" class="">KEY_SERVER_SOFTWARE = + <div class="docstring"> + <div class="discussion"> + <p class="note private"> + <strong>This constant is part of a private API.</strong> + You should avoid using this constant if possible, as it may be removed or be changed in the future. +</p> + +<p>the key for the server software</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>'SERVER_SOFTWARE'</span> +</pre></dd> + + </dl> + + + + + + <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2> + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#hostname-instance_method" title="#hostname (instance method)">- (String) <strong>hostname</strong> </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>get the hostname of the server.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#port-instance_method" title="#port (instance method)">- (Numeric) <strong>port</strong> </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>get the port.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#protocol-instance_method" title="#protocol (instance method)">- (String) <strong>protocol</strong> </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>get the protocol of the server (normally it should be HTTP/1.1).</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#software-instance_method" title="#software (instance method)">- (String) <strong>software</strong> </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>get the server software.</p> +</div></span> + +</li> + + + </ul> + + + + + + <h2> + Instance Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Server) <strong>initialize</strong>(environment) </a> + + + + </span> + + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>This creates a new server instance extracting all server related.</p> +</div></span> + +</li> + + + </ul> + + +<div id="constructor_details" class="method_details_list"> + <h2>Constructor Details</h2> + + <div class="method_details first"> + <h3 class="signature first" id="initialize-instance_method"> + + - (<tt><span class='object_link'><a href="" title="Zero::Request::Server (class)">Server</a></span></tt>) <strong>initialize</strong>(environment) + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>This creates a new server instance extracting all server related</p> + +<pre class="code ruby18"><code>information from the environment.</code></pre> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +20 +21 +22 +23 +24 +25</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/server.rb', line 20</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='rparen token'>)</span> + <span class='rubyid_@hostname ivar id'>@hostname</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_SERVER_NAME constant id'>KEY_SERVER_NAME</span><span class='rbrack token'>]</span> + <span class='rubyid_@port ivar id'>@port</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_SERVER_PORT constant id'>KEY_SERVER_PORT</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span> + <span class='rubyid_@protocol ivar id'>@protocol</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_SERVER_PROTOCOL constant id'>KEY_SERVER_PROTOCOL</span><span class='rbrack token'>]</span> + <span class='rubyid_@software ivar id'>@software</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_SERVER_SOFTWARE constant id'>KEY_SERVER_SOFTWARE</span><span class='rbrack token'>]</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id=""></span> + <div class="method_details first"> + <h3 class="signature first" id="hostname-instance_method"> + + - (<tt>String</tt>) <strong>hostname</strong> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>get the hostname of the server</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'> +<p>the hostname</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +32 +33 +34</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/server.rb', line 32</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_hostname identifier id'>hostname</span> + <span class='rubyid_@hostname ivar id'>@hostname</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="port-instance_method"> + + - (<tt>Numeric</tt>) <strong>port</strong> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>get the port</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Numeric</tt>)</span> + + + + — + <div class='inline'> +<p>the port</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +29 +30 +31</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/server.rb', line 29</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_port identifier id'>port</span> + <span class='rubyid_@port ivar id'>@port</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="protocol-instance_method"> + + - (<tt>String</tt>) <strong>protocol</strong> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>get the protocol of the server (normally it should be HTTP/1.1)</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'> +<p>the protocol</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +35 +36 +37</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/server.rb', line 35</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_protocol identifier id'>protocol</span> + <span class='rubyid_@protocol ivar id'>@protocol</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="software-instance_method"> + + - (<tt>String</tt>) <strong>software</strong> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>get the server software</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'> +<p>the server software name</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +38 +39 +40</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/zero/request/server.rb', line 38</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_software identifier id'>software</span> + <span class='rubyid_@software ivar id'>@software</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + + +</div> + + <div id="footer"> + Generated on Mon Nov 26 21:40:01 2012 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.8.3 (ruby-1.9.3). +</div> + + </body> +</html>
\ No newline at end of file |