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

webmachine 0.4.1 → 0.4.2

Files changed (907) hide show

data/doc/Webmachine/Resource.html CHANGED Viewed

@@ -6,7 +6,7 @@
 <title>
   Class: Webmachine::Resource
-    &mdash; Documentation by YARD 0.7.3
+    &mdash; Documentation by YARD 0.7.5
 </title>
@@ -92,7 +92,7 @@
     <dt class="r1 last">Defined in:</dt>
     <dd class="r1 last">lib/webmachine/resource.rb<span class="defines">,<br />
-  lib/webmachine/resource/callbacks.rb,<br /> lib/webmachine/resource/encodings.rb,<br /> lib/webmachine/resource/authentication.rb</span>
+  lib/webmachine/resource/encodings.rb,<br /> lib/webmachine/resource/callbacks.rb,<br /> lib/webmachine/resource/authentication.rb</span>
 </dd>
 </dl>
@@ -100,28 +100,29 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    Resource is the primary building block of Webmachine applications,
+    <p>Resource is the primary building block of Webmachine applications,
 and describes families of HTTP resources. It includes all of the
 methods you might want to override to customize the behavior of
 the resource.  The simplest resource family you can implement
-looks like this:<br/>   class HelloWorldResource &lt; Webmachine::Resource
+looks like this:</p>
+<p>class HelloWorldResource &lt; Webmachine::Resource
      def to_html
-       &quot;&lt;html&gt;&lt;body&gt;Hello, world!&lt;/body&gt;&lt;/html&gt;&quot;
+       &quot;<html><body>Hello, world!</body></html>&quot;
      end
-   end<br/>For more information about how response decisions are made in
+   end</p>
+<p>For more information about how response decisions are made in
 Webmachine based on your resource class, refer to the diagram at
-<a href="http://webmachine.basho.com/images/http-headers-status-v3.png" target="_parent" title="http://webmachine.basho.com/images/http-headers-status-v3.png">http://webmachine.basho.com/images/http-headers-status-v3.png</a>.
+<a href="http://webmachine.basho.com/images/http-headers-status-v3.png" target="_parent" title="http://webmachine.basho.com/images/http-headers-status-v3.png">http://webmachine.basho.com/images/http-headers-status-v3.png</a>.</p>
   </div>
 </div>
 <div class="tags">
-</div><div id="subclasses">
-  <h2>Direct Known Subclasses</h2>
-  <p class="children"><span class='object_link'><a href="Trace/TraceResource.html" title="Webmachine::Trace::TraceResource (class)">Trace::TraceResource</a></span></p>
-</div>
-<h2>Defined Under Namespace</h2>
+</div><h2>Defined Under Namespace</h2>
 <p class="children">
@@ -133,14 +134,8 @@ Webmachine based on your resource class, refer to the diagram at
 </p>
   <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
   <ul class="summary">
@@ -163,7 +158,8 @@ Webmachine based on your resource class, refer to the diagram at
-    <span class="summary_desc"><div class='inline'>Returns the value of attribute request.</div></span>
+    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute request.</p>
+</div></span>
 </li>
@@ -187,7 +183,8 @@ Webmachine based on your resource class, refer to the diagram at
-    <span class="summary_desc"><div class='inline'>Returns the value of attribute response.</div></span>
+    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute response.</p>
+</div></span>
 </li>
@@ -196,12 +193,6 @@ Webmachine based on your resource class, refer to the diagram at
     <h2>
@@ -227,8 +218,9 @@ Webmachine based on your resource class, refer to the diagram at
-    <span class="summary_desc"><div class='inline'>Creates a new <span class='object_link'><a href="" title="Webmachine::Resource (class)">Resource</a></span>, initializing it with the request and
-response.</div></span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new <span class='object_link'><a href="" title="Webmachine::Resource (class)">Resource</a></span>, initializing it with the request and
+response.</p>
+</div></span>
 </li>
@@ -272,7 +264,8 @@ response.</div></span>
 </p><div class="docstring">
   <div class="discussion">
-    Returns the value of attribute request
+    <p>Returns the value of attribute request</p>
   </div>
 </div>
@@ -292,7 +285,7 @@ response.</div></span>
     <td>
       <pre class="code"><span class="info file"># File 'lib/webmachine/resource.rb', line 25</span>
-<span class='kw'>def</span> <span class='id request'>request</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_request'>request</span>
   <span class='ivar'>@request</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -312,7 +305,8 @@ response.</div></span>
 </p><div class="docstring">
   <div class="discussion">
-    Returns the value of attribute response
+    <p>Returns the value of attribute response</p>
   </div>
 </div>
@@ -332,7 +326,7 @@ response.</div></span>
     <td>
       <pre class="code"><span class="info file"># File 'lib/webmachine/resource.rb', line 25</span>
-<span class='kw'>def</span> <span class='id response'>response</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
   <span class='ivar'>@response</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -356,10 +350,11 @@ response.</div></span>
 </p><div class="docstring">
   <div class="discussion">
-    Creates a new <span class='object_link'><a href="" title="Webmachine::Resource (class)">Webmachine::Resource</a></span>, initializing it with the request and
-response. Note that you may still override the `initialize` method to
+    <p>Creates a new <span class='object_link'><a href="" title="Webmachine::Resource (class)">Webmachine::Resource</a></span>, initializing it with the request and
+response. Note that you may still override the <code>initialize</code> method to
 initialize your resource. It will be called after the request
-and response ivars are set.
+and response ivars are set.</p>
   </div>
 </div>
@@ -377,7 +372,8 @@ and response ivars are set.
         &mdash;
-        <div class='inline'>the request object</div>
+        <div class='inline'><p>the request object</p>
+</div>
     </li>
@@ -391,7 +387,8 @@ and response ivars are set.
         &mdash;
-        <div class='inline'>the response object</div>
+        <div class='inline'><p>the response object</p>
+</div>
     </li>
@@ -408,7 +405,8 @@ and response ivars are set.
         &mdash;
-        <div class='inline'>the new resource</div>
+        <div class='inline'><p>the new resource</p>
+</div>
     </li>
@@ -431,12 +429,12 @@ and response ivars are set.
     <td>
       <pre class="code"><span class="info file"># File 'lib/webmachine/resource.rb', line 34</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id request'>request</span><span class='comma'>,</span> <span class='id response'>response</span><span class='rparen'>)</span>
-  <span class='id instance'>instance</span> <span class='op'>=</span> <span class='id allocate'>allocate</span>
-  <span class='id instance'>instance</span><span class='period'>.</span><span class='id instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='symbol'>:@request</span><span class='comma'>,</span> <span class='id request'>request</span><span class='rparen'>)</span>
-  <span class='id instance'>instance</span><span class='period'>.</span><span class='id instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='symbol'>:@response</span><span class='comma'>,</span> <span class='id response'>response</span><span class='rparen'>)</span>
-  <span class='id instance'>instance</span><span class='period'>.</span><span class='id send'>send</span> <span class='symbol'>:initialize</span>
-  <span class='id instance'>instance</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_instance'>instance</span> <span class='op'>=</span> <span class='id identifier rubyid_allocate'>allocate</span>
+  <span class='id identifier rubyid_instance'>instance</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='symbol'>:@request</span><span class='comma'>,</span> <span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_instance'>instance</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='symbol'>:@response</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_instance'>instance</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span> <span class='symbol'>:initialize</span>
+  <span class='id identifier rubyid_instance'>instance</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -448,9 +446,9 @@ and response ivars are set.
 </div>
     <div id="footer">
-  Generated on Wed Jan  4 08:47:39 2012 by
+  Generated on Thu Mar 22 10:24:44 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.3 (ruby-1.9.3).
+  0.7.5 (ruby-1.9.3).
 </div>
   </body>

data/doc/Webmachine/Response.html CHANGED Viewed

@@ -6,7 +6,7 @@
 <title>
   Class: Webmachine::Response
-    &mdash; Documentation by YARD 0.7.3
+    &mdash; Documentation by YARD 0.7.5
 </title>
@@ -94,7 +94,8 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    Represents an HTTP response from Webmachine.
+    <p>Represents an HTTP response from Webmachine.</p>
   </div>
 </div>
@@ -103,6 +104,8 @@
 </div>
   <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
   <ul class="summary">
@@ -125,7 +128,8 @@
-    <span class="summary_desc"><div class='inline'>The response body.</div></span>
+    <span class="summary_desc"><div class='inline'><p>The response body.</p>
+</div></span>
 </li>
@@ -149,7 +153,8 @@
-    <span class="summary_desc"><div class='inline'>The HTTP status code of the response.</div></span>
+    <span class="summary_desc"><div class='inline'><p>The HTTP status code of the response.</p>
+</div></span>
 </li>
@@ -173,8 +178,9 @@
-    <span class="summary_desc"><div class='inline'>When an error has occurred, the last state the
-FSM was in.</div></span>
+    <span class="summary_desc"><div class='inline'><p>When an error has occurred, the last state the
+FSM was in.</p>
+</div></span>
 </li>
@@ -198,8 +204,9 @@ FSM was in.</div></span>
-    <span class="summary_desc"><div class='inline'>The error message when responding with an error
-code.</div></span>
+    <span class="summary_desc"><div class='inline'><p>The error message when responding with an error
+code.</p>
+</div></span>
 </li>
@@ -223,7 +230,8 @@ code.</div></span>
-    <span class="summary_desc"><div class='inline'>Response headers that will be sent to the client.</div></span>
+    <span class="summary_desc"><div class='inline'><p>Response headers that will be sent to the client.</p>
+</div></span>
 </li>
@@ -249,7 +257,8 @@ code.</div></span>
-    <span class="summary_desc"><div class='inline'>Whether the response is a redirect.</div></span>
+    <span class="summary_desc"><div class='inline'><p>Whether the response is a redirect.</p>
+</div></span>
 </li>
@@ -273,7 +282,8 @@ code.</div></span>
-    <span class="summary_desc"><div class='inline'>The list of states that were traversed.</div></span>
+    <span class="summary_desc"><div class='inline'><p>The list of states that were traversed.</p>
+</div></span>
 </li>
@@ -309,7 +319,8 @@ code.</div></span>
-    <span class="summary_desc"><div class='inline'>Indicate that the response should be a redirect.</div></span>
+    <span class="summary_desc"><div class='inline'><p>Indicate that the response should be a redirect.</p>
+</div></span>
 </li>
@@ -332,7 +343,8 @@ code.</div></span>
-    <span class="summary_desc"><div class='inline'>Creates a new Response object with the appropriate defaults.</div></span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new Response object with the appropriate defaults.</p>
+</div></span>
 </li>
@@ -352,7 +364,8 @@ code.</div></span>
 </p><div class="docstring">
   <div class="discussion">
-    Creates a new Response object with the appropriate defaults.
+    <p>Creates a new Response object with the appropriate defaults.</p>
   </div>
 </div>
@@ -375,11 +388,11 @@ code.</div></span>
     <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='kw'>def</span> <span class='id identifier rubyid_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'>self</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>=</span> <span class='int'>200</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_redirect'>redirect</span> <span class='op'>=</span> <span class='kw'>false</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -403,7 +416,8 @@ code.</div></span>
 </p><div class="docstring">
   <div class="discussion">
-    The response body
+    <p>The response body</p>
   </div>
 </div>
@@ -420,7 +434,8 @@ code.</div></span>
         &mdash;
-        <div class='inline'>The response body</div>
+        <div class='inline'><p>The response body</p>
+</div>
     </li>
@@ -439,7 +454,7 @@ code.</div></span>
     <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='kw'>def</span> <span class='id identifier rubyid_body'>body</span>
   <span class='ivar'>@body</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -459,7 +474,8 @@ code.</div></span>
 </p><div class="docstring">
   <div class="discussion">
-    The HTTP status code of the response
+    <p>The HTTP status code of the response</p>
   </div>
 </div>
@@ -476,7 +492,8 @@ code.</div></span>
         &mdash;
-        <div class='inline'>The HTTP status code of the response</div>
+        <div class='inline'><p>The HTTP status code of the response</p>
+</div>
     </li>
@@ -495,7 +512,7 @@ code.</div></span>
     <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='kw'>def</span> <span class='id identifier rubyid_code'>code</span>
   <span class='ivar'>@code</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -515,8 +532,9 @@ code.</div></span>
 </p><div class="docstring">
   <div class="discussion">
-    When an error has occurred, the last state the
-FSM was in
+    <p>When an error has occurred, the last state the
+FSM was in</p>
   </div>
 </div>
@@ -533,8 +551,9 @@ FSM was in
         &mdash;
-        <div class='inline'>When an error has occurred, the last state the
-FSM was in</div>
+        <div class='inline'><p>When an error has occurred, the last state the
+FSM was in</p>
+</div>
     </li>
@@ -553,7 +572,7 @@ FSM was in</div>
     <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='kw'>def</span> <span class='id identifier rubyid_end_state'>end_state</span>
   <span class='ivar'>@end_state</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -573,8 +592,9 @@ FSM was in</div>
 </p><div class="docstring">
   <div class="discussion">
-    The error message when responding with an error
-code
+    <p>The error message when responding with an error
+code</p>
   </div>
 </div>
@@ -591,8 +611,9 @@ code
         &mdash;
-        <div class='inline'>The error message when responding with an error
-code</div>
+        <div class='inline'><p>The error message when responding with an error
+code</p>
+</div>
     </li>
@@ -611,7 +632,7 @@ code</div>
     <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='kw'>def</span> <span class='id identifier rubyid_error'>error</span>
   <span class='ivar'>@error</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -631,7 +652,8 @@ code</div>
 </p><div class="docstring">
   <div class="discussion">
-    Response headers that will be sent to the client
+    <p>Response headers that will be sent to the client</p>
   </div>
 </div>
@@ -648,7 +670,8 @@ code</div>
         &mdash;
-        <div class='inline'>Response headers that will be sent to the client</div>
+        <div class='inline'><p>Response headers that will be sent to the client</p>
+</div>
     </li>
@@ -667,7 +690,7 @@ code</div>
     <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='kw'>def</span> <span class='id identifier rubyid_headers'>headers</span>
   <span class='ivar'>@headers</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -691,7 +714,8 @@ code</div>
 </p><div class="docstring">
   <div class="discussion">
-    Whether the response is a redirect
+    <p>Whether the response is a redirect</p>
   </div>
 </div>
@@ -708,7 +732,8 @@ code</div>
         &mdash;
-        <div class='inline'>Whether the response is a redirect</div>
+        <div class='inline'><p>Whether the response is a redirect</p>
+</div>
     </li>
@@ -727,7 +752,7 @@ code</div>
     <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='kw'>def</span> <span class='id identifier rubyid_redirect'>redirect</span>
   <span class='ivar'>@redirect</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -747,7 +772,8 @@ code</div>
 </p><div class="docstring">
   <div class="discussion">
-    The list of states that were traversed
+    <p>The list of states that were traversed</p>
   </div>
 </div>
@@ -764,7 +790,8 @@ code</div>
         &mdash;
-        <div class='inline'>the list of states that were traversed</div>
+        <div class='inline'><p>the list of states that were traversed</p>
+</div>
     </li>
@@ -783,7 +810,7 @@ code</div>
     <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='kw'>def</span> <span class='id identifier rubyid_trace'>trace</span>
   <span class='ivar'>@trace</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -811,12 +838,13 @@ code</div>
 </p><div class="docstring">
   <div class="discussion">
-    Indicate that the response should be a redirect. This is only
+    <p>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>.
+using <span class='object_link'><a href="#headers-instance_method" title="Webmachine::Response#headers (method)">#headers</a></span>.</p>
   </div>
 </div>
@@ -836,7 +864,8 @@ using <span class='object_link'><a href="#headers-instance_method" title="Webmac
         &mdash;
-        <div class='inline'>the target of the redirection</div>
+        <div class='inline'><p>the target of the redirection</p>
+</div>
     </li>
@@ -857,9 +886,9 @@ using <span class='object_link'><a href="#headers-instance_method" title="Webmac
     <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'>def</span> <span class='id identifier rubyid_do_redirect'>do_redirect</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_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 identifier rubyid_location'>location</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>if</span> <span class='id identifier rubyid_location'>location</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_redirect'>redirect</span> <span class='op'>=</span> <span class='kw'>true</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -871,9 +900,9 @@ using <span class='object_link'><a href="#headers-instance_method" title="Webmac
 </div>
     <div id="footer">
-  Generated on Wed Jan  4 08:47:39 2012 by
+  Generated on Thu Mar 22 10:24:44 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.3 (ruby-1.9.3).
+  0.7.5 (ruby-1.9.3).
 </div>
   </body>