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.4.0/doc/Webmachine/Resource/Authentication.html DELETED Viewed

@@ -1,333 +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>
-  Module: Webmachine::Resource::Authentication
-    &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 (A)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../../Webmachine.html" title="Webmachine (module)">Webmachine</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Resource.html" title="Webmachine::Resource (class)">Resource</a></span></span>
-     &raquo;
-    <span class="title">Authentication</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>Module: Webmachine::Resource::Authentication
-</h1>
-<dl class="box">
-    <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/webmachine/resource/authentication.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    Helper methods that can be included in your
-<span class='object_link'><a href="../Resource.html" title="Webmachine::Resource (class)">Webmachine::Resource</a></span> to assist in performing HTTP
-Authentication.
-  </div>
-</div>
-<div class="tags">
-</div>
-  <h2>Constant Summary</h2>
-    <dl class="constants">
-        <dt id="BASIC_HEADER-constant" class="">BASIC_HEADER =
-          <div class="docstring">
-  <div class="discussion">
-    Pattern for matching Authorization headers that use the Basic
-auth scheme.
-  </div>
-</div>
-<div class="tags">
-</div>
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^Basic (.*)$</span><span class='regexp_end'>/i</span></span><span class='period'>.</span><span class='id freeze'>freeze</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="#basic_auth-instance_method" title="#basic_auth (instance method)">- (true, String) <strong>basic_auth</strong>(header, realm = &quot;Webmachine&quot;) {|user, password| ... }</a>
-  </span>
-    <span class="summary_desc"><div class='inline'>A simple implementation of HTTP Basic auth.</div></span>
-</li>
-    </ul>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <p class="signature first" id="basic_auth-instance_method">
-    - (<tt>true</tt>, <tt>String</tt>) <strong>basic_auth</strong>(header, realm = &quot;Webmachine&quot;) {|user, password| ... }
-</p><div class="docstring">
-  <div class="discussion">
-    A simple implementation of HTTP Basic auth. Call this from the
-<span class='object_link'><a href="Callbacks.html#is_authorized%3F-instance_method" title="Webmachine::Resource::Callbacks#is_authorized? (method)">Callbacks#is_authorized?</a></span> callback,
-giving it a block which will be yielded the username and
-password and return true or false.
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>header</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>the value of the Authentication request
-header, passed to the <span class='object_link'><a href="Callbacks.html#is_authorized%3F-instance_method" title="Webmachine::Resource::Callbacks#is_authorized? (method)">Callbacks#is_authorized?</a></span> callback.</div>
-    </li>
-    <li>
-        <span class='name'>realm</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        <em class="default">(defaults to: <tt>&quot;Webmachine&quot;</tt>)</em>
-        &mdash;
-        <div class='inline'>the &quot;realm&quot;, or description of the
-resource that requires authentication</div>
-    </li>
-</ul>
-<h3>Yields:</h3>
-<ul class="yield">
-    <li>
-        <span class='type'>(<tt>user</tt>, <tt>password</tt>)</span>
-        &mdash;
-        <div class='inline'>a block that will verify the client-provided user/password
-against application constraints</div>
-    </li>
-</ul>
-<h3>Yield Parameters:</h3>
-<ul class="yieldparam">
-    <li>
-        <span class='name'>user</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>the passed username</div>
-    </li>
-    <li>
-        <span class='name'>password</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>the passed password</div>
-    </li>
-</ul>
-<h3>Yield Returns:</h3>
-<ul class="yieldreturn">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>whether the username/password is correct</div>
-    </li>
-</ul>
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>true if the client is authorized, or
-the appropriate WWW-Authenticate header</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-26
-27
-28
-29
-30
-31
-32</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/authentication.rb', line 26</span>
-<span class='kw'>def</span> <span class='id basic_auth'>basic_auth</span><span class='lparen'>(</span><span class='id header'>header</span><span class='comma'>,</span> <span class='id realm'>realm</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Webmachine</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
-  <span class='kw'>if</span> <span class='id header'>header</span> <span class='op'>=~</span> <span class='const'>BASIC_HEADER</span> <span class='op'>&amp;&amp;</span> <span class='lparen'>(</span><span class='kw'>yield</span> <span class='op'>*</span><span class='backref'>$1</span><span class='period'>.</span><span class='id unpack'>unpack</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>m*</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>:</span><span class='regexp_end'>/</span></span><span class='comma'>,</span><span class='int'>2</span><span class='rparen'>)</span><span class='rparen'>)</span>
-    <span class='kw'>true</span>
-  <span class='kw'>else</span>
-    <span class='tstring'><span class='tstring_beg'>%Q[</span><span class='tstring_content'>Basic realm=&quot;</span><span class='embexpr_beg'>#{</span><span class='id realm'>realm</span><span class='rbrace'>}</span><span class='tstring_content'>&quot;</span><span class='tstring_end'>]</span></span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Wed Jan  4 08:47:41 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>