RubyGems - siffer - Versions diffs - 0.0.4 → 0.0.5 - Mend

siffer 0.0.4 → 0.0.5

Files changed (97) hide show

data/Rakefile +2 -2
data/doc/rdoc/classes/Siffer.html +253 -368
data/doc/rdoc/classes/Siffer/Agent.html +169 -288
data/doc/rdoc/classes/Siffer/Container.html +158 -279
data/doc/rdoc/classes/Siffer/Messages.html +79 -139
data/doc/rdoc/classes/Siffer/Messages/Ack.html +109 -210
data/doc/rdoc/classes/Siffer/Messages/Acl.html +78 -155
data/doc/rdoc/classes/Siffer/Messages/Error.html +151 -242
data/doc/rdoc/classes/Siffer/Messages/Message.html +227 -351
data/doc/rdoc/classes/Siffer/Messages/Message/Header.html +102 -176
data/doc/rdoc/classes/Siffer/Messages/Register.html +147 -250
data/doc/rdoc/classes/Siffer/Messages/RequestBody.html +177 -292
data/doc/rdoc/classes/Siffer/Messages/Status.html +149 -262
data/doc/rdoc/classes/Siffer/Messaging.html +204 -323
data/doc/rdoc/classes/Siffer/Protocol.html +246 -380
data/doc/rdoc/classes/Siffer/Protocol/NonPostRequest.html +53 -110
data/doc/rdoc/classes/Siffer/Protocol/UnknownPath.html +53 -110
data/doc/rdoc/classes/Siffer/Registration.html +243 -383
data/doc/rdoc/classes/Siffer/Request.html +97 -203
data/doc/rdoc/classes/Siffer/RequestLogger.html +102 -204
data/doc/rdoc/classes/Siffer/Response.html +85 -176
data/doc/rdoc/classes/Siffer/Server.html +150 -236
data/doc/rdoc/created.rid +1 -1
data/doc/rdoc/files/LICENSE.html +75 -128
data/doc/rdoc/files/README_rdoc.html +130 -183
data/doc/rdoc/files/lib/siffer/agent_rb.html +49 -0
data/doc/rdoc/files/lib/siffer/container_rb.html +57 -0
data/doc/rdoc/files/lib/siffer/messages/ack_rb.html +49 -0
data/doc/rdoc/files/lib/siffer/messages/acl_rb.html +49 -0
data/doc/rdoc/files/lib/siffer/messages/error_rb.html +49 -0
data/doc/rdoc/files/lib/siffer/messages/message_rb.html +49 -0
data/doc/rdoc/files/lib/siffer/messages/register_rb.html +49 -0
data/doc/rdoc/files/lib/siffer/messages/request_body_rb.html +49 -0
data/doc/rdoc/files/lib/siffer/messages/status_rb.html +49 -0
data/doc/rdoc/files/lib/siffer/messages_rb.html +63 -0
data/doc/rdoc/files/lib/siffer/messaging_rb.html +49 -0
data/doc/rdoc/files/lib/siffer/protocol_rb.html +49 -0
data/doc/rdoc/files/lib/siffer/registration_rb.html +49 -0
data/doc/rdoc/files/lib/siffer/request_logger_rb.html +49 -0
data/doc/rdoc/files/lib/siffer/request_rb.html +49 -0
data/doc/rdoc/files/lib/siffer/response_rb.html +49 -0
data/doc/rdoc/files/lib/siffer/server_rb.html +49 -0
data/doc/rdoc/files/lib/siffer_rb.html +62 -113
data/doc/rdoc/fr_class_index.html +25 -47
data/doc/rdoc/fr_file_index.html +39 -46
data/doc/rdoc/fr_method_index.html +4539 -96
data/doc/rdoc/index.html +14 -23
data/doc/rdoc/rdoc-style.css +314 -203
data/lib/siffer.rb +6 -6
data/lib/{agent.rb → siffer/agent.rb} +5 -3
data/lib/{container.rb → siffer/container.rb} +3 -5
data/lib/siffer/messages.rb +7 -0
data/lib/{messages → siffer/messages}/ack.rb +0 -0
data/lib/{messages → siffer/messages}/acl.rb +0 -0
data/lib/{messages → siffer/messages}/error.rb +0 -0
data/lib/{messages → siffer/messages}/message.rb +0 -0
data/lib/{messages → siffer/messages}/register.rb +0 -0
data/lib/{messages → siffer/messages}/request_body.rb +0 -0
data/lib/{messages → siffer/messages}/status.rb +0 -0
data/lib/{messaging.rb → siffer/messaging.rb} +8 -5
data/lib/{protocol.rb → siffer/protocol.rb} +37 -32
data/lib/{registration.rb → siffer/registration.rb} +2 -2
data/lib/siffer/request.rb +28 -0
data/lib/{request_logger.rb → siffer/request_logger.rb} +8 -7
data/lib/{response.rb → siffer/response.rb} +1 -1
data/lib/{server.rb → siffer/server.rb} +5 -3
data/spec/agent_spec.rb +6 -11
data/spec/container_spec.rb +2 -2
data/spec/default_agent +1 -1
data/spec/messaging_spec.rb +3 -6
data/spec/protocol_spec.rb +27 -26
data/spec/registration_spec.rb +2 -2
data/spec/request_logger_spec.rb +22 -9
data/spec/request_spec.rb +15 -0
data/spec/response_spec.rb +2 -2
data/spec/server_spec.rb +0 -5
data/spec/spec_helper.rb +9 -0
metadata +40 -38
data/doc/rdoc/files/lib/agent_rb.html +0 -101
data/doc/rdoc/files/lib/container_rb.html +0 -108
data/doc/rdoc/files/lib/messages/ack_rb.html +0 -101
data/doc/rdoc/files/lib/messages/acl_rb.html +0 -101
data/doc/rdoc/files/lib/messages/error_rb.html +0 -101
data/doc/rdoc/files/lib/messages/message_rb.html +0 -101
data/doc/rdoc/files/lib/messages/register_rb.html +0 -101
data/doc/rdoc/files/lib/messages/request_body_rb.html +0 -101
data/doc/rdoc/files/lib/messages/status_rb.html +0 -101
data/doc/rdoc/files/lib/messages_rb.html +0 -114
data/doc/rdoc/files/lib/messaging_rb.html +0 -101
data/doc/rdoc/files/lib/protocol_rb.html +0 -101
data/doc/rdoc/files/lib/registration_rb.html +0 -101
data/doc/rdoc/files/lib/request_logger_rb.html +0 -101
data/doc/rdoc/files/lib/request_rb.html +0 -101
data/doc/rdoc/files/lib/response_rb.html +0 -101
data/doc/rdoc/files/lib/server_rb.html +0 -101
data/lib/messages.rb +0 -7
data/lib/request.rb +0 -25

data/doc/rdoc/classes/Siffer/Protocol/NonPostRequest.html CHANGED

@@ -1,111 +1,54 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!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>
-  <title>Class: Siffer::Protocol::NonPostRequest</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-    elemStyle = elem.style;
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-    return true;
-  }
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  // ]]>
-  </script>
-</head>
-<body>
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Class</strong></td>
-          <td class="class-name-in-header">Siffer::Protocol::NonPostRequest</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../../files/lib/protocol_rb.html">
-                lib/protocol.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                Exception
-            </td>
-        </tr>
-        </table>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html lang='en'>
+  <head>
+    <title>Class: Siffer::Protocol::NonPostRequest [Siffer == h3o(software) SIF]</title>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
+    <link href='../../.././rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
+    <script type='text/javascript'>
+      //<![CDATA[
+        function popupCode(url) {
+          window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+        }
+        function toggleCode(id) {
+          var code = document.getElementById(id)
+          code.style.display = code.style.display != 'block' ? 'block' : 'none'
+          return true
+        }
+        // Make codeblocks hidden by default
+        document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
+      //]]>
+    </script>
+  </head>
+  <body class='page'>
+    <div class='class' id='wrapper'>
+      <div class='header'>
+        <h1 class='name'>
+          <span class='type'>Class</span>
+          Siffer::Protocol::NonPostRequest
+        </h1>
+        <ol class='paths'>
+          <li>
+            <a href="../../../files/lib/siffer/protocol_rb.html">lib/siffer/protocol.rb</a>
+          </li>
+        </ol>
+        <div class='parent'>
+          Parent:
+          <strong>Exception</strong>
+        </div>
+      </div>
+      <div id='content'>
+        <div id='text'>
+          <div id='section'>
+          </div>
+        </div>
+      </div>
+      <div id='footer-push'></div>
     </div>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-   </div>
-  </div>
-    <!-- if includes -->
-    <div id="section">
-    <!-- if method_list -->
-  </div>
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-</body>
-</html>
+    <div id='footer'>
+      <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
+    </div>
+  </body>
+</html>

data/doc/rdoc/classes/Siffer/Protocol/UnknownPath.html CHANGED

@@ -1,111 +1,54 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!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>
-  <title>Class: Siffer::Protocol::UnknownPath</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-    elemStyle = elem.style;
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-    return true;
-  }
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  // ]]>
-  </script>
-</head>
-<body>
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Class</strong></td>
-          <td class="class-name-in-header">Siffer::Protocol::UnknownPath</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../../files/lib/protocol_rb.html">
-                lib/protocol.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                Exception
-            </td>
-        </tr>
-        </table>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html lang='en'>
+  <head>
+    <title>Class: Siffer::Protocol::UnknownPath [Siffer == h3o(software) SIF]</title>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
+    <link href='../../.././rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
+    <script type='text/javascript'>
+      //<![CDATA[
+        function popupCode(url) {
+          window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+        }
+        function toggleCode(id) {
+          var code = document.getElementById(id)
+          code.style.display = code.style.display != 'block' ? 'block' : 'none'
+          return true
+        }
+        // Make codeblocks hidden by default
+        document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
+      //]]>
+    </script>
+  </head>
+  <body class='page'>
+    <div class='class' id='wrapper'>
+      <div class='header'>
+        <h1 class='name'>
+          <span class='type'>Class</span>
+          Siffer::Protocol::UnknownPath
+        </h1>
+        <ol class='paths'>
+          <li>
+            <a href="../../../files/lib/siffer/protocol_rb.html">lib/siffer/protocol.rb</a>
+          </li>
+        </ol>
+        <div class='parent'>
+          Parent:
+          <strong>Exception</strong>
+        </div>
+      </div>
+      <div id='content'>
+        <div id='text'>
+          <div id='section'>
+          </div>
+        </div>
+      </div>
+      <div id='footer-push'></div>
     </div>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-   </div>
-  </div>
-    <!-- if includes -->
-    <div id="section">
-    <!-- if method_list -->
-  </div>
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-</body>
-</html>
+    <div id='footer'>
+      <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
+    </div>
+  </body>
+</html>

data/doc/rdoc/classes/Siffer/Registration.html CHANGED

@@ -1,391 +1,251 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!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>
-  <title>Module: Siffer::Registration</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-    elemStyle = elem.style;
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-    return true;
-  }
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  // ]]>
-  </script>
-</head>
-<body>
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Module</strong></td>
-          <td class="class-name-in-header">Siffer::Registration</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../files/lib/registration_rb.html">
-                lib/registration.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-        </table>
-    </div>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-    <div id="description">
-      <p>
-The <a href="Registration.html">Registration</a> module manages Register
-message types and processes registration requests.
-</p>
-    </div>
-   </div>
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-      <div class="name-list">
-      <a href="#M000041">check_for_registration</a>&nbsp;&nbsp;
-      <a href="#M000040">process_registration</a>&nbsp;&nbsp;
-      <a href="#M000042">register</a>&nbsp;&nbsp;
-      <a href="#M000047">registered?</a>&nbsp;&nbsp;
-      <a href="#M000046">validate_max_buffer_size</a>&nbsp;&nbsp;
-      <a href="#M000044">validate_permission</a>&nbsp;&nbsp;
-      <a href="#M000043">validate_source_id</a>&nbsp;&nbsp;
-      <a href="#M000045">validate_version</a>&nbsp;&nbsp;
-      </div>
-    </div>
-  </div>
-    <!-- if includes -->
-    <div id="includes">
-      <h3 class="section-bar">Included Modules</h3>
-      <div id="includes-list">
-        <span class="include-name"><a href="Messages.html">Siffer::Messages</a></span>
-      </div>
-    </div>
-    <div id="section">
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Instance methods</h3>
-      <div id="method-M000041" class="method-detail">
-        <a name="M000041"></a>
-        <div class="method-heading">
-          <a href="#M000041" class="method-signature">
-          <span class="method-name">check_for_registration</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Parses the request body with RequestBody to determine if the the request is
-a registration message. If it is or if the source is already registered it
-passes through, otherwise raises AgentNotRegistered exception.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000041-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000041-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/registration.rb, line 25</span>
-25:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">check_for_registration</span>
-26:       <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">register?</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">registered?</span>(<span class="ruby-ivar">@request</span>.<span class="ruby-identifier">message</span>.<span class="ruby-identifier">source_id</span>)
-27:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">AgentNotRegistered</span>
-28:       <span class="ruby-keyword kw">end</span>
-29:     <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000040" class="method-detail">
-        <a name="M000040"></a>
-        <div class="method-heading">
-          <a href="#M000040" class="method-signature">
-          <span class="method-name">process_registration</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-The request (message) is processed for registration requests.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000040-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000040-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/registration.rb, line 12</span>
-12:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">process_registration</span>
-13:       <span class="ruby-keyword kw">begin</span>
-14:         <span class="ruby-identifier">check_for_registration</span>
-15:         <span class="ruby-identifier">register</span>
-16:       <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">AgentNotRegistered</span>
-17:         <span class="ruby-identifier">error_response</span>(<span class="ruby-value">4</span>,<span class="ruby-value">9</span>)
-18:       <span class="ruby-keyword kw">end</span>
-19:     <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000042" class="method-detail">
-        <a name="M000042"></a>
-        <div class="method-heading">
-          <a href="#M000042" class="method-signature">
-          <span class="method-name">register</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Process the message for registration by validating:
-</p>
-<ul>
-<li>source_id
-</li>
-<li>permissions to <a href="Registration.html#M000042">register</a> with ZIS
-</li>
-<li>version compatibility
-</li>
-<li>buffer size compatibility
-</li>
-</ul>
-<p>
-If all validations pass the registration is stored by the ZIS and the agent
-is added to the list of agents available to the zone.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000042-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000042-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/registration.rb, line 38</span>
-38:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">register</span>
-39:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">register?</span>
-40:         <span class="ruby-ivar">@registration</span> = <span class="ruby-constant">Register</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-ivar">@request</span>.<span class="ruby-identifier">body</span>)
-41:         <span class="ruby-identifier">validate_source_id</span>
-42:         <span class="ruby-identifier">validate_permission</span>
-43:         <span class="ruby-identifier">validate_version</span>
-44:         <span class="ruby-identifier">validate_max_buffer_size</span>
-45:         <span class="ruby-comment cmt"># ignore the fact we haven't stored away any registration information !!!!!!</span>
-46:         <span class="ruby-comment cmt"># ignore the fact we haven't even built a data model for objects and permissions for the acl !!!!!</span>
-47:         <span class="ruby-identifier">ack</span> = <span class="ruby-constant">Ack</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>, <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">original</span>, <span class="ruby-identifier">:status</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">Status</span>.<span class="ruby-identifier">success</span>(<span class="ruby-constant">Acl</span>.<span class="ruby-identifier">new</span>))
-48:         <span class="ruby-ivar">@response</span> = <span class="ruby-constant">Response</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">ack</span>)
-49:       <span class="ruby-keyword kw">end</span>
-50:     <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000047" class="method-detail">
-        <a name="M000047"></a>
-        <div class="method-heading">
-          <a href="#M000047" class="method-signature">
-          <span class="method-name">registered?</span><span class="method-args">(agent)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Returns true if the agent is included in the list of Agents previously
-registered.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000047-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000047-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/registration.rb, line 82</span>
-82:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">registered?</span>(<span class="ruby-identifier">agent</span>)
-83:       <span class="ruby-identifier">agents</span>.<span class="ruby-identifier">has_key?</span> <span class="ruby-identifier">agent</span>
-84:     <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html lang='en'>
+  <head>
+    <title>Module: Siffer::Registration [Siffer == h3o(software) SIF]</title>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
+    <link href='../.././rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
+    <script type='text/javascript'>
+      //<![CDATA[
+        function popupCode(url) {
+          window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+        }
+        function toggleCode(id) {
+          var code = document.getElementById(id)
+          code.style.display = code.style.display != 'block' ? 'block' : 'none'
+          return true
+        }
+        // Make codeblocks hidden by default
+        document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
+      //]]>
+    </script>
+  </head>
+  <body class='page'>
+    <div class='class' id='wrapper'>
+      <div class='header'>
+        <h1 class='name'>
+          <span class='type'>Module</span>
+          Siffer::Registration
+        </h1>
+        <ol class='paths'>
+          <li>
+            <a href="../../files/lib/siffer/registration_rb.html">lib/siffer/registration.rb</a>
+          </li>
+        </ol>
       </div>
-      <div id="method-M000046" class="method-detail">
-        <a name="M000046"></a>
-        <div class="method-heading">
-          <a href="#M000046" class="method-signature">
-          <span class="method-name">validate_max_buffer_size</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Validates the registration buffer size is greater than the minimum buffer
-set by the ZIS.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000046-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000046-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/registration.rb, line 74</span>
-74:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_max_buffer_size</span>
-75:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@registration</span>.<span class="ruby-identifier">max_buffer</span> <span class="ruby-operator">&lt;</span> <span class="ruby-identifier">min_buffer</span>
-76:         <span class="ruby-identifier">error_response</span>(<span class="ruby-value">5</span>,<span class="ruby-value">6</span>)
-77:       <span class="ruby-keyword kw">end</span>
-78:     <span class="ruby-keyword kw">end</span>
-</pre>
+      <div id='content'>
+        <div id='text'>
+          <div id='description'>
+            <p>
+            The <a href="Registration.html">Registration</a> module manages Register
+            message types and processes registration requests.
+            </p>
           </div>
-        </div>
-      </div>
-      <div id="method-M000044" class="method-detail">
-        <a name="M000044"></a>
-        <div class="method-heading">
-          <a href="#M000044" class="method-signature">
-          <span class="method-name">validate_permission</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-We need to check for permissions previously assigned for this agent
-(possibly from Central Admin).
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000044-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000044-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/registration.rb, line 60</span>
-60:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_permission</span>
-61:     <span class="ruby-keyword kw">end</span>
-</pre>
+          <div id='method-list'>
+            <h2>Methods</h2>
+            <h3>public instance</h3>
+            <ol>
+              <li><a href="#M000042">check_for_registration</a></li>
+              <li><a href="#M000041">process_registration</a></li>
+              <li><a href="#M000043">register</a></li>
+              <li><a href="#M000048">registered?</a></li>
+              <li><a href="#M000047">validate_max_buffer_size</a></li>
+              <li><a href="#M000045">validate_permission</a></li>
+              <li><a href="#M000044">validate_source_id</a></li>
+              <li><a href="#M000046">validate_version</a></li>
+            </ol>
           </div>
-        </div>
-      </div>
-      <div id="method-M000043" class="method-detail">
-        <a name="M000043"></a>
-        <div class="method-heading">
-          <a href="#M000043" class="method-signature">
-          <span class="method-name">validate_source_id</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-We may not do anything here - will we pre-permit sources to register? We
-could possibly call the Central Admin to qualify the source there?
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000043-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000043-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/registration.rb, line 54</span>
-54:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_source_id</span>
-55:     <span class="ruby-keyword kw">end</span>
-</pre>
+          <div id='context'>
+            <div id='includes'>
+              <h2>Included modules</h2>
+              <ol>
+                <li><a href="Messages.html">Siffer::Messages</a></li>
+              </ol>
+            </div>
           </div>
-        </div>
-      </div>
-      <div id="method-M000045" class="method-detail">
-        <a name="M000045"></a>
-        <div class="method-heading">
-          <a href="#M000045" class="method-signature">
-          <span class="method-name">validate_version</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Currently only validating that the registration version matches identically
-to the SIF version implemented by <a href="../Siffer.html">Siffer</a>.
-TODO: This will need refinement to provide broader version support.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000045-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000045-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/registration.rb, line 66</span>
-66:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_version</span>
-67:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@registration</span>.<span class="ruby-identifier">version</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">Siffer</span>.<span class="ruby-identifier">sif_version</span>
-68:         <span class="ruby-identifier">error_response</span>(<span class="ruby-value">5</span>,<span class="ruby-value">4</span>,<span class="ruby-node">&quot;Unsupported version: #{@registration.version}&quot;</span>)
-69:       <span class="ruby-keyword kw">end</span>
-70:     <span class="ruby-keyword kw">end</span>
-</pre>
+          <div id='section'>
+            <div id='methods'>
+              <h2>Public instance methods</h2>
+              <div class='public-instance method' id='method-M000042'>
+                <a name='M000042'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>check_for_registration</span>
+                  <span class='arguments'>()</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Parses the request body with RequestBody to determine if the the request is
+                  a registration message. If it is or if the source is already registered it
+                  passes through, otherwise raises AgentNotRegistered exception.
+                  </p>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000042-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000042-source'>    <span class="ruby-comment cmt"># File lib/siffer/registration.rb, line 25</span>&#x000A;25:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">check_for_registration</span> &#x000A;26:       <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">register?</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">registered?</span>(<span class="ruby-ivar">@request</span>.<span class="ruby-identifier">message</span>.<span class="ruby-identifier">source_id</span>)&#x000A;27:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">AgentNotRegistered</span>&#x000A;28:       <span class="ruby-keyword kw">end</span>&#x000A;29:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000041'>
+                <a name='M000041'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>process_registration</span>
+                  <span class='arguments'>()</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  The request (message) is processed for registration requests.
+                  </p>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000041-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000041-source'>    <span class="ruby-comment cmt"># File lib/siffer/registration.rb, line 12</span>&#x000A;12:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">process_registration</span>&#x000A;13:       <span class="ruby-keyword kw">begin</span>&#x000A;14:         <span class="ruby-identifier">check_for_registration</span>&#x000A;15:         <span class="ruby-identifier">register</span>&#x000A;16:       <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">AgentNotRegistered</span>&#x000A;17:         <span class="ruby-identifier">error_response</span>(<span class="ruby-value">4</span>,<span class="ruby-value">9</span>)&#x000A;18:       <span class="ruby-keyword kw">end</span>&#x000A;19:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000043'>
+                <a name='M000043'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>register</span>
+                  <span class='arguments'>()</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Process the message for registration by validating:
+                  </p>
+                  <ul>
+                  <li>source_id
+                  </li>
+                  <li>permissions to register with ZIS
+                  </li>
+                  <li>version compatibility
+                  </li>
+                  <li>buffer size compatibility
+                  </li>
+                  </ul>
+                  <p>
+                  If all validations pass the registration is stored by the ZIS and the agent
+                  is added to the list of agents available to the zone.
+                  </p>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000043-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000043-source'>    <span class="ruby-comment cmt"># File lib/siffer/registration.rb, line 38</span>&#x000A;38:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">register</span>&#x000A;39:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">register?</span>&#x000A;40:         <span class="ruby-ivar">@registration</span> = <span class="ruby-constant">Register</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-ivar">@request</span>.<span class="ruby-identifier">body</span>)&#x000A;41:         <span class="ruby-identifier">validate_source_id</span>&#x000A;42:         <span class="ruby-identifier">validate_permission</span>&#x000A;43:         <span class="ruby-identifier">validate_version</span>&#x000A;44:         <span class="ruby-identifier">validate_max_buffer_size</span>&#x000A;45:         <span class="ruby-comment cmt"># ignore the fact we haven't stored away any registration information !!!!!!</span>&#x000A;46:         <span class="ruby-comment cmt"># ignore the fact we haven't even built a data model for objects and permissions for the acl !!!!!</span>&#x000A;47:         <span class="ruby-identifier">ack</span> = <span class="ruby-constant">Ack</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>, <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">original</span>, <span class="ruby-identifier">:status</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">Status</span>.<span class="ruby-identifier">success</span>(<span class="ruby-constant">Acl</span>.<span class="ruby-identifier">new</span>))&#x000A;48:         <span class="ruby-ivar">@response</span> = <span class="ruby-constant">Response</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">ack</span>)&#x000A;49:       <span class="ruby-keyword kw">end</span>&#x000A;50:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000048'>
+                <a name='M000048'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>registered?</span>
+                  <span class='arguments'>(agent)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Returns true if the agent is included in the list of Agents previously
+                  registered.
+                  </p>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000048-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000048-source'>    <span class="ruby-comment cmt"># File lib/siffer/registration.rb, line 82</span>&#x000A;82:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">registered?</span>(<span class="ruby-identifier">agent</span>)&#x000A;83:       <span class="ruby-identifier">agents</span>.<span class="ruby-identifier">has_key?</span> <span class="ruby-identifier">agent</span>&#x000A;84:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000047'>
+                <a name='M000047'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>validate_max_buffer_size</span>
+                  <span class='arguments'>()</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Validates the registration buffer size is greater than the minimum buffer
+                  set by the ZIS.
+                  </p>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000047-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000047-source'>    <span class="ruby-comment cmt"># File lib/siffer/registration.rb, line 74</span>&#x000A;74:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_max_buffer_size</span>&#x000A;75:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@registration</span>.<span class="ruby-identifier">max_buffer</span> <span class="ruby-operator">&lt;</span> <span class="ruby-identifier">min_buffer</span>&#x000A;76:         <span class="ruby-identifier">error_response</span>(<span class="ruby-value">5</span>,<span class="ruby-value">6</span>)&#x000A;77:       <span class="ruby-keyword kw">end</span>&#x000A;78:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000045'>
+                <a name='M000045'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>validate_permission</span>
+                  <span class='arguments'>()</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  We need to check for permissions previously assigned for this agent
+                  (possibly from Central Admin).
+                  </p>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000045-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000045-source'>    <span class="ruby-comment cmt"># File lib/siffer/registration.rb, line 60</span>&#x000A;60:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_permission</span>&#x000A;61:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000044'>
+                <a name='M000044'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>validate_source_id</span>
+                  <span class='arguments'>()</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  We may not do anything here - will we pre-permit sources to register? We
+                  could possibly call the Central Admin to qualify the source there?
+                  </p>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000044-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000044-source'>    <span class="ruby-comment cmt"># File lib/siffer/registration.rb, line 54</span>&#x000A;54:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_source_id</span>&#x000A;55:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000046'>
+                <a name='M000046'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>validate_version</span>
+                  <span class='arguments'>()</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Currently only validating that the registration version matches identically
+                  to the SIF version implemented by <a href="../Siffer.html">Siffer</a>.
+                  TODO: This will need refinement to provide broader version support.
+                  </p>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000046-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000046-source'>    <span class="ruby-comment cmt"># File lib/siffer/registration.rb, line 66</span>&#x000A;66:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_version</span>&#x000A;67:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@registration</span>.<span class="ruby-identifier">version</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">Siffer</span>.<span class="ruby-identifier">sif_version</span>&#x000A;68:         <span class="ruby-identifier">error_response</span>(<span class="ruby-value">5</span>,<span class="ruby-value">4</span>,<span class="ruby-node">&quot;Unsupported version: #{@registration.version}&quot;</span>)&#x000A;69:       <span class="ruby-keyword kw">end</span>&#x000A;70:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+            </div>
           </div>
         </div>
       </div>
+      <div id='footer-push'></div>
+    </div>
+    <div id='footer'>
+      <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
     </div>
-  </div>
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-</body>
-</html>
+  </body>
+</html>