RubyGems - webmachine - Versions diffs - 0.4.1 → 0.4.2 - Mend

webmachine 0.4.1 → 0.4.2

Files changed (907) hide show

data/pkg/webmachine-0.3.0/doc/Webmachine/Response.html DELETED Viewed

@@ -1,880 +0,0 @@
-<!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: Webmachine::Response
-    &mdash; Documentation by YARD 0.7.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">
-  relpath = '..';
-  if (relpath != '') relpath += '/';
-</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>
-    <script type="text/javascript" charset="utf-8">
-      if (window.top.frames.main) document.body.className = 'frames';
-    </script>
-    <div id="header">
-      <div id="menu">
-    <a href="../_index.html">Index (R)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../Webmachine.html" title="Webmachine (module)">Webmachine</a></span></span>
-     &raquo;
-    <span class="title">Response</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 id="class_list_link" href="#">Class List</a>
-    <a id="method_list_link" href="#">Method List</a>
-    <a id="file_list_link" href="#">File List</a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Class: Webmachine::Response
-</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">Webmachine::Response</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      </dd>
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/webmachine/response.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    Represents an HTTP response from Webmachine.
-  </div>
-</div>
-<div class="tags">
-</div>
-  <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="#body-instance_method" title="#body (instance method)">- (String, #each) <strong>body</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>The response body.</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#code-instance_method" title="#code (instance method)">- (Fixnum) <strong>code</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>The HTTP status code of the response.</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#end_state-instance_method" title="#end_state (instance method)">- (Symbol) <strong>end_state</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>When an error has occurred, the last state the
-FSM was in.</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#error-instance_method" title="#error (instance method)">- (String) <strong>error</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>The error message when responding with an error
-code.</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#headers-instance_method" title="#headers (instance method)">- (Hash) <strong>headers</strong> </a>
-  </span>
-    <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'>Response headers that will be sent to the client.</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#redirect-instance_method" title="#redirect (instance method)">- (true, false) <strong>redirect</strong> </a>
-      (also: #is_redirect?)
-  </span>
-    <span class="summary_desc"><div class='inline'>Whether the response is a redirect.</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#trace-instance_method" title="#trace (instance method)">- (Array) <strong>trace</strong> </a>
-  </span>
-    <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'>The list of states that were traversed.</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="#do_redirect-instance_method" title="#do_redirect (instance method)">- (Object) <strong>do_redirect</strong>(location = nil) </a>
-      (also: #redirect_to)
-  </span>
-    <span class="summary_desc"><div class='inline'>Indicate that the response should be a redirect.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Response) <strong>initialize</strong> </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-    <span class="summary_desc"><div class='inline'>Creates a new Response object with the appropriate defaults.</div></span>
-</li>
-    </ul>
-<div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <div class="method_details first">
-  <p class="signature first" id="initialize-instance_method">
-    - (<tt><span class='object_link'><a href="" title="Webmachine::Response (class)">Response</a></span></tt>) <strong>initialize</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    Creates a new Response object with the appropriate defaults.
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-28
-29
-30
-31
-32
-33</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/response.rb', line 28</span>
-<span class='kw'>def</span> <span class='id initialize'>initialize</span>
-  <span class='ivar'>@headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
-  <span class='ivar'>@trace</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
-  <span class='kw'>self</span><span class='period'>.</span><span class='id code'>code</span> <span class='op'>=</span> <span class='int'>200</span>
-  <span class='kw'>self</span><span class='period'>.</span><span class='id redirect'>redirect</span> <span class='op'>=</span> <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-</div>
-  <div id="instance_attr_details" class="attr_details">
-    <h2>Instance Attribute Details</h2>
-      <span id="body=-instance_method"></span>
-      <span id="body-instance_method"></span>
-      <div class="method_details first">
-  <p class="signature first" id="body-instance_method">
-    - (<tt>String</tt>, <tt>#each</tt>) <strong>body</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    The response body
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>, <tt>#each</tt>)</span>
-        &mdash;
-        <div class='inline'>The response body</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-11
-12
-13</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/response.rb', line 11</span>
-<span class='kw'>def</span> <span class='id body'>body</span>
-  <span class='ivar'>@body</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id="code=-instance_method"></span>
-      <span id="code-instance_method"></span>
-      <div class="method_details ">
-  <p class="signature " id="code-instance_method">
-    - (<tt>Fixnum</tt>) <strong>code</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    The HTTP status code of the response
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Fixnum</tt>)</span>
-        &mdash;
-        <div class='inline'>The HTTP status code of the response</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-8
-9
-10</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/response.rb', line 8</span>
-<span class='kw'>def</span> <span class='id code'>code</span>
-  <span class='ivar'>@code</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id="end_state=-instance_method"></span>
-      <span id="end_state-instance_method"></span>
-      <div class="method_details ">
-  <p class="signature " id="end_state-instance_method">
-    - (<tt>Symbol</tt>) <strong>end_state</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    When an error has occurred, the last state the
-FSM was in
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Symbol</tt>)</span>
-        &mdash;
-        <div class='inline'>When an error has occurred, the last state the
-FSM was in</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-21
-22
-23</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/response.rb', line 21</span>
-<span class='kw'>def</span> <span class='id end_state'>end_state</span>
-  <span class='ivar'>@end_state</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id="error=-instance_method"></span>
-      <span id="error-instance_method"></span>
-      <div class="method_details ">
-  <p class="signature " id="error-instance_method">
-    - (<tt>String</tt>) <strong>error</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    The error message when responding with an error
-code
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>The error message when responding with an error
-code</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/webmachine/response.rb', line 25</span>
-<span class='kw'>def</span> <span class='id error'>error</span>
-  <span class='ivar'>@error</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id=""></span>
-      <span id="headers-instance_method"></span>
-      <div class="method_details ">
-  <p class="signature " id="headers-instance_method">
-    - (<tt>Hash</tt>) <strong>headers</strong>  <span class="extras">(readonly)</span>
-</p><div class="docstring">
-  <div class="discussion">
-    Response headers that will be sent to the client
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        &mdash;
-        <div class='inline'>Response headers that will be sent to the client</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-5
-6
-7</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/response.rb', line 5</span>
-<span class='kw'>def</span> <span class='id headers'>headers</span>
-  <span class='ivar'>@headers</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id="redirect=-instance_method"></span>
-      <span id="redirect-instance_method"></span>
-      <div class="method_details ">
-  <p class="signature " id="redirect-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>redirect</strong>
-    <span class="aliases">Also known as:
-    <span class="names"><span id='is_redirect?-instance_method'>is_redirect?</span></span>
-    </span>
-</p><div class="docstring">
-  <div class="discussion">
-    Whether the response is a redirect
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether the response is a redirect</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-14
-15
-16</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/response.rb', line 14</span>
-<span class='kw'>def</span> <span class='id redirect'>redirect</span>
-  <span class='ivar'>@redirect</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id=""></span>
-      <span id="trace-instance_method"></span>
-      <div class="method_details ">
-  <p class="signature " id="trace-instance_method">
-    - (<tt>Array</tt>) <strong>trace</strong>  <span class="extras">(readonly)</span>
-</p><div class="docstring">
-  <div class="discussion">
-    The list of states that were traversed
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Array</tt>)</span>
-        &mdash;
-        <div class='inline'>the list of states that were traversed</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-17
-18
-19</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/response.rb', line 17</span>
-<span class='kw'>def</span> <span class='id trace'>trace</span>
-  <span class='ivar'>@trace</span>
-<span class='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">
-  <p class="signature first" id="do_redirect-instance_method">
-    - (<tt>Object</tt>) <strong>do_redirect</strong>(location = nil)
-    <span class="aliases">Also known as:
-    <span class="names"><span id='redirect_to-instance_method'>redirect_to</span></span>
-    </span>
-</p><div class="docstring">
-  <div class="discussion">
-    Indicate that the response should be a redirect. This is only
-used when processing a POST request in
-<span class='object_link'><a href="Resource/Callbacks.html#process_post-instance_method" title="Webmachine::Resource::Callbacks#process_post (method)">Webmachine::Resource::Callbacks#process_post</a></span> to indicate that the client
-should request another resource using GET. Either pass the URI
-of the target resource, or manually set the Location header
-using <span class='object_link'><a href="#headers-instance_method" title="Webmachine::Response#headers (method)">#headers</a></span>.
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>location</span>
-        <span class='type'>(<tt>String</tt>, <tt>URI</tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'>the target of the redirection</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-42
-43
-44
-45</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/response.rb', line 42</span>
-<span class='kw'>def</span> <span class='id do_redirect'>do_redirect</span><span class='lparen'>(</span><span class='id location'>location</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='id headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Location</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id location'>location</span><span class='period'>.</span><span class='id to_s'>to_s</span> <span class='kw'>if</span> <span class='id location'>location</span>
-  <span class='kw'>self</span><span class='period'>.</span><span class='id redirect'>redirect</span> <span class='op'>=</span> <span class='kw'>true</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Wed Jan  4 08:47:39 2012 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.3 (ruby-1.9.3).
-</div>
-  </body>
-</html>