RubyGems - siffer - Versions diffs - 0.0.4 - Mend

siffer 0.0.4

Files changed (91) hide show

data/LICENSE +20 -0
data/README.rdoc +65 -0
data/Rakefile +64 -0
data/bin/siffer +71 -0
data/doc/SIF ImplementationSpecification.pdf +0 -0
data/doc/rdoc/classes/Siffer.html +374 -0
data/doc/rdoc/classes/Siffer/Agent.html +296 -0
data/doc/rdoc/classes/Siffer/Container.html +286 -0
data/doc/rdoc/classes/Siffer/Messages.html +141 -0
data/doc/rdoc/classes/Siffer/Messages/Ack.html +216 -0
data/doc/rdoc/classes/Siffer/Messages/Acl.html +160 -0
data/doc/rdoc/classes/Siffer/Messages/Error.html +248 -0
data/doc/rdoc/classes/Siffer/Messages/Message.html +359 -0
data/doc/rdoc/classes/Siffer/Messages/Message/Header.html +181 -0
data/doc/rdoc/classes/Siffer/Messages/Register.html +257 -0
data/doc/rdoc/classes/Siffer/Messages/RequestBody.html +300 -0
data/doc/rdoc/classes/Siffer/Messages/Status.html +269 -0
data/doc/rdoc/classes/Siffer/Messaging.html +331 -0
data/doc/rdoc/classes/Siffer/Protocol.html +388 -0
data/doc/rdoc/classes/Siffer/Protocol/NonPostRequest.html +111 -0
data/doc/rdoc/classes/Siffer/Protocol/UnknownPath.html +111 -0
data/doc/rdoc/classes/Siffer/Registration.html +391 -0
data/doc/rdoc/classes/Siffer/Request.html +209 -0
data/doc/rdoc/classes/Siffer/RequestLogger.html +211 -0
data/doc/rdoc/classes/Siffer/Response.html +182 -0
data/doc/rdoc/classes/Siffer/Server.html +242 -0
data/doc/rdoc/created.rid +1 -0
data/doc/rdoc/files/LICENSE.html +129 -0
data/doc/rdoc/files/README_rdoc.html +184 -0
data/doc/rdoc/files/lib/agent_rb.html +101 -0
data/doc/rdoc/files/lib/container_rb.html +108 -0
data/doc/rdoc/files/lib/messages/ack_rb.html +101 -0
data/doc/rdoc/files/lib/messages/acl_rb.html +101 -0
data/doc/rdoc/files/lib/messages/error_rb.html +101 -0
data/doc/rdoc/files/lib/messages/message_rb.html +101 -0
data/doc/rdoc/files/lib/messages/register_rb.html +101 -0
data/doc/rdoc/files/lib/messages/request_body_rb.html +101 -0
data/doc/rdoc/files/lib/messages/status_rb.html +101 -0
data/doc/rdoc/files/lib/messages_rb.html +114 -0
data/doc/rdoc/files/lib/messaging_rb.html +101 -0
data/doc/rdoc/files/lib/protocol_rb.html +101 -0
data/doc/rdoc/files/lib/registration_rb.html +101 -0
data/doc/rdoc/files/lib/request_logger_rb.html +101 -0
data/doc/rdoc/files/lib/request_rb.html +101 -0
data/doc/rdoc/files/lib/response_rb.html +101 -0
data/doc/rdoc/files/lib/server_rb.html +101 -0
data/doc/rdoc/files/lib/siffer_rb.html +115 -0
data/doc/rdoc/fr_class_index.html +47 -0
data/doc/rdoc/fr_file_index.html +46 -0
data/doc/rdoc/fr_method_index.html +96 -0
data/doc/rdoc/index.html +24 -0
data/doc/rdoc/rdoc-style.css +208 -0
data/lib/agent.rb +43 -0
data/lib/container.rb +96 -0
data/lib/messages.rb +7 -0
data/lib/messages/ack.rb +43 -0
data/lib/messages/acl.rb +25 -0
data/lib/messages/error.rb +174 -0
data/lib/messages/message.rb +71 -0
data/lib/messages/register.rb +60 -0
data/lib/messages/request_body.rb +66 -0
data/lib/messages/status.rb +55 -0
data/lib/messaging.rb +96 -0
data/lib/protocol.rb +159 -0
data/lib/registration.rb +87 -0
data/lib/request.rb +25 -0
data/lib/request_logger.rb +31 -0
data/lib/response.rb +26 -0
data/lib/server.rb +40 -0
data/lib/siffer.rb +44 -0
data/spec/agent_spec.rb +53 -0
data/spec/cli_spec.rb +40 -0
data/spec/container_spec.rb +103 -0
data/spec/default_agent +6 -0
data/spec/default_server +5 -0
data/spec/message_specs/ack_spec.rb +28 -0
data/spec/message_specs/error_spec.rb +24 -0
data/spec/message_specs/header_spec.rb +25 -0
data/spec/message_specs/message_spec.rb +57 -0
data/spec/message_specs/register_spec.rb +86 -0
data/spec/message_specs/request_body_spec.rb +58 -0
data/spec/message_specs/status_spec.rb +25 -0
data/spec/messaging_spec.rb +88 -0
data/spec/protocol_spec.rb +49 -0
data/spec/registration_spec.rb +33 -0
data/spec/request_logger_spec.rb +15 -0
data/spec/request_spec.rb +10 -0
data/spec/response_spec.rb +24 -0
data/spec/server_spec.rb +35 -0
data/spec/spec_helper.rb +26 -0
metadata +191 -0

data/doc/rdoc/classes/Siffer/Messages/Message/Header.html ADDED

@@ -0,0 +1,181 @@
+<?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::Messages::Message::Header</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::Messages::Message::Header</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../../files/lib/messages/message_rb.html">
+                lib/messages/message.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+Each <a href="../Message.html">Message</a> requires a <a
+href="Header.html">Header</a> to identify the source. You shouldn&#8216;t
+need to initialize this by itself, it is used by <a
+href="../Message.html">Message</a>.
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000025">new</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">msg_id</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">source_id</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">timestamp</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000025" class="method-detail">
+        <a name="M000025"></a>
+        <div class="method-heading">
+          <a href="#M000025" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(source)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000025-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000025-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/message.rb, line 60</span>
+60:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">source</span>)
+61:           <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;Source not provided.&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">nil?</span>
+62:           <span class="ruby-ivar">@timestamp</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
+63:           <span class="ruby-ivar">@msg_id</span> = <span class="ruby-constant">UUID</span>.<span class="ruby-identifier">generate</span>(<span class="ruby-identifier">:compact</span>).<span class="ruby-identifier">upcase</span>
+64:           <span class="ruby-ivar">@source_id</span> = <span class="ruby-identifier">source</span>
+65:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/rdoc/classes/Siffer/Messages/Register.html ADDED

@@ -0,0 +1,257 @@
+<?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::Messages::Register</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::Messages::Register</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/messages/register_rb.html">
+                lib/messages/register.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="Message.html">
+                Message
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+<a href="Message.html">Message</a> used by Agents to register themselves
+with the ZIS.
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000027">content</a>&nbsp;&nbsp;
+      <a href="#M000026">new</a>&nbsp;&nbsp;
+      <a href="#M000028">parse</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">max_buffer</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">mode</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">name</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">vendor</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">version</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000026" class="method-detail">
+        <a name="M000026"></a>
+        <div class="method-heading">
+          <a href="#M000026" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(source, name, options = {})</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000026-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000026-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/register.rb, line 9</span>
+ 9:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">source</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span> = {})
+10:         <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">source</span>, <span class="ruby-identifier">options</span>)
+11:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;Agent name required&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">name</span>
+12:         <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
+13:         <span class="ruby-ivar">@version</span> = <span class="ruby-identifier">options</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>
+14:         <span class="ruby-ivar">@max_buffer</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:max_buffer</span>] <span class="ruby-operator">||</span> <span class="ruby-value">1024</span>
+15:         <span class="ruby-ivar">@mode</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:mode</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">'Pull'</span>
+16:         <span class="ruby-ivar">@vendor</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:vendor</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Siffer</span>.<span class="ruby-identifier">vendor</span>
+17:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000028" class="method-detail">
+        <a name="M000028"></a>
+        <div class="method-heading">
+          <a href="#M000028" class="method-signature">
+          <span class="method-name">parse</span><span class="method-args">(body)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Parses the body passed as a <a href="Register.html">Register</a> message
+and returns a <a href="RequestBody.html">RequestBody</a> that provides
+access to <a href="Register.html">Register</a> properties.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000028-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000028-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/register.rb, line 33</span>
+33:       <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">body</span>)
+34:         <span class="ruby-constant">RegisterBody</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">body</span>)
+35:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000027" class="method-detail">
+        <a name="M000027"></a>
+        <div class="method-heading">
+          <a href="#M000027" class="method-signature">
+          <span class="method-name">content</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000027-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000027-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/register.rb, line 19</span>
+19:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">content</span>
+20:         <span class="ruby-identifier">body</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">reg</span><span class="ruby-operator">|</span>
+21:           <span class="ruby-identifier">reg</span>.<span class="ruby-constant">SIF_Register</span>() { <span class="ruby-operator">|</span><span class="ruby-identifier">xml</span><span class="ruby-operator">|</span>
+22:             <span class="ruby-identifier">put_header_into</span> <span class="ruby-identifier">xml</span>
+23:             <span class="ruby-identifier">reg</span>.<span class="ruby-constant">SIF_Name</span>(<span class="ruby-ivar">@name</span>)
+24:             <span class="ruby-identifier">reg</span>.<span class="ruby-constant">SIF_Version</span>(<span class="ruby-ivar">@version</span>)
+25:             <span class="ruby-identifier">reg</span>.<span class="ruby-constant">SIF_MaxBufferSize</span>(<span class="ruby-ivar">@max_buffer</span>)
+26:             <span class="ruby-identifier">reg</span>.<span class="ruby-constant">SIF_Mode</span>(<span class="ruby-ivar">@mode</span>)
+27:           }
+28:         <span class="ruby-keyword kw">end</span>
+29:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/rdoc/classes/Siffer/Messages/RequestBody.html ADDED

@@ -0,0 +1,300 @@
+<?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::Messages::RequestBody</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::Messages::RequestBody</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/messages/request_body_rb.html">
+                lib/messages/request_body.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+This class is used to <a href="RequestBody.html#M000038">parse</a> the SIF
+<a href="Message.html">Message</a> information out of the <a
+href="../Request.html">Request</a> Body. It parses enough information to
+redirect to other processes. It does not <a
+href="RequestBody.html#M000038">parse</a> details of the <a
+href="Message.html">Message</a> such as <a
+href="../Protocol.html">Protocol</a> if a <a
+href="Register.html">Register</a> message, or <a
+href="Error.html">Error</a> if an <a href="Ack.html">Ack</a> message. Each
+message <a href="RequestBody.html#M000035">type</a> will inherit this class
+in order to provide a <a href="RequestBody.html#M000038">parse</a> method
+that will allow access to those specific attributes. It provides access to:
+</p>
+<ul>
+<li><a href="RequestBody.html#M000036">source_id</a>
+</li>
+<li><a href="RequestBody.html#M000037">msg_id</a>
+</li>
+<li><a href="RequestBody.html#M000035">type</a>
+</li>
+</ul>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000037">msg_id</a>&nbsp;&nbsp;
+      <a href="#M000034">new</a>&nbsp;&nbsp;
+      <a href="#M000038">parse</a>&nbsp;&nbsp;
+      <a href="#M000036">source_id</a>&nbsp;&nbsp;
+      <a href="#M000035">type</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000034" class="method-detail">
+        <a name="M000034"></a>
+        <div class="method-heading">
+          <a href="#M000034" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(xml_string)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000034-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000034-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/request_body.rb, line 17</span>
+17:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">xml_string</span>)
+18:         <span class="ruby-ivar">@xml</span> = <span class="ruby-identifier">xml_string</span>
+19:         <span class="ruby-ivar">@doc</span> = <span class="ruby-constant">Hpricot</span>(<span class="ruby-ivar">@xml</span>, <span class="ruby-identifier">:xml</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">true</span>)
+20:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000038" class="method-detail">
+        <a name="M000038"></a>
+        <div class="method-heading">
+          <a href="#M000038" class="method-signature">
+          <span class="method-name">parse</span><span class="method-args">(xml)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Parses the xml provided and returns a <a
+href="RequestBody.html">RequestBody</a>. Xml must respond to read or be a
+String.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000038-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000038-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/request_body.rb, line 48</span>
+48:       <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">xml</span>)
+49:         <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">&quot;read&quot;</span>) <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
+50:           <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;Unable to read Xml&quot;</span>
+51:         <span class="ruby-keyword kw">end</span>
+52:         <span class="ruby-identifier">xml</span> = <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">read</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">&quot;read&quot;</span>)
+53:         <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">xml</span>) <span class="ruby-comment cmt"># use self because we are going to inherit this class</span>
+54:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000037" class="method-detail">
+        <a name="M000037"></a>
+        <div class="method-heading">
+          <a href="#M000037" class="method-signature">
+          <span class="method-name">msg_id</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+The SIF_MsgId from the SIF_Header
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000037-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000037-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/request_body.rb, line 42</span>
+42:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">msg_id</span>
+43:         (<span class="ruby-ivar">@doc</span><span class="ruby-operator">/</span><span class="ruby-value str">&quot;//SIF_Header/SIF_MsgId/&quot;</span>).<span class="ruby-identifier">text</span>
+44:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000036" class="method-detail">
+        <a name="M000036"></a>
+        <div class="method-heading">
+          <a href="#M000036" class="method-signature">
+          <span class="method-name">source_id</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+The SIF_SourceId from the SIF_Header
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000036-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000036-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/request_body.rb, line 37</span>
+37:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">source_id</span>
+38:         (<span class="ruby-ivar">@doc</span><span class="ruby-operator">/</span><span class="ruby-value str">&quot;//SIF_Header/SIF_SourceId/&quot;</span>).<span class="ruby-identifier">text</span>
+39:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000035" class="method-detail">
+        <a name="M000035"></a>
+        <div class="method-heading">
+          <a href="#M000035" class="method-signature">
+          <span class="method-name">type</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Will return the name of the element found just inside the root or just
+inside SIF_SystemControl if present.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000035-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000035-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/messages/request_body.rb, line 24</span>
+24:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">type</span>
+25:         <span class="ruby-keyword kw">begin</span>
+26:           <span class="ruby-identifier">msg_type</span> = (<span class="ruby-ivar">@doc</span><span class="ruby-operator">/</span><span class="ruby-identifier">:SIF_Message</span>).<span class="ruby-identifier">first</span>.<span class="ruby-identifier">children</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">name</span>
+27:           <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">msg_type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;SIF_SystemControl&quot;</span>
+28:             <span class="ruby-identifier">msg_type</span> = (<span class="ruby-ivar">@doc</span><span class="ruby-operator">/</span><span class="ruby-identifier">:SIF_Message</span><span class="ruby-operator">/</span><span class="ruby-identifier">:SIF_SystemControl</span>).<span class="ruby-identifier">first</span>.<span class="ruby-identifier">children</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">name</span>
+29:           <span class="ruby-keyword kw">end</span>
+30:           <span class="ruby-identifier">drop_sif</span> <span class="ruby-identifier">msg_type</span>
+31:         <span class="ruby-keyword kw">rescue</span>
+32:           <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Failed to parse #{@xml} for SIF Type&quot;</span>
+33:         <span class="ruby-keyword kw">end</span>
+34:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>