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/Server.html ADDED

@@ -0,0 +1,242 @@
+<?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::Server</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::Server</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/server_rb.html">
+                lib/server.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>
+Zone Integration <a href="Server.html">Server</a> Facilitates communication
+between Agents. Acts as a central point where Agents can send their
+events/requests and receive the response from other Agents.
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000067">call</a>&nbsp;&nbsp;
+      <a href="#M000066">new</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="Protocol.html">Siffer::Protocol</a></span>
+        <span class="include-name"><a href="Registration.html">Siffer::Registration</a></span>
+      </div>
+    </div>
+    <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">agents</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">host</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">min_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">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">port</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-M000066" class="method-detail">
+        <a name="M000066"></a>
+        <div class="method-heading">
+          <a href="#M000066" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(options = {})</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <pre>
+ options Parameter
+</pre>
+<p>
+name = The name of the ZIS host = The host this instance is started on port
+= The port to connect to this ZIS admin = The administration site managing
+this ZIS min_buffer = The minimum buffer size this ZIS will facilitate
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000066-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000066-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/server.rb, line 19</span>
+19:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span> = {})
+20:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;Administration URL required&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">include?</span> <span class="ruby-value str">&quot;admin&quot;</span>
+21:       <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value str">&quot;name&quot;</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">&quot;Default Server&quot;</span>
+22:       <span class="ruby-ivar">@host</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value str">&quot;host&quot;</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">&quot;localhost&quot;</span>
+23:       <span class="ruby-ivar">@port</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value str">&quot;port&quot;</span>] <span class="ruby-operator">||</span> <span class="ruby-value">8300</span>
+24:       <span class="ruby-ivar">@min_buffer</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value str">&quot;min_buffer&quot;</span>] <span class="ruby-operator">||</span> <span class="ruby-value">1024</span>
+25:       <span class="ruby-ivar">@agents</span> = {}
+26:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000067" class="method-detail">
+        <a name="M000067"></a>
+        <div class="method-heading">
+          <a href="#M000067" class="method-signature">
+          <span class="method-name">call</span><span class="method-args">(env)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Process the request with all the SIF protocols
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000067-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000067-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/server.rb, line 29</span>
+29:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
+30:       <span class="ruby-identifier">with_each_request</span>(<span class="ruby-identifier">env</span>) <span class="ruby-keyword kw">do</span>
+31:          <span class="ruby-identifier">process_registration</span>
+32:           <span class="ruby-comment cmt"># process_provision</span>
+33:           <span class="ruby-comment cmt"># process_subscription</span>
+34:           <span class="ruby-comment cmt"># process_event</span>
+35:       <span class="ruby-keyword kw">end</span>
+36:     <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/created.rid ADDED

	@@ -0,0 +1 @@
1	+ Mon, 19 Jan 2009 19:38:07 -0700

data/doc/rdoc/files/LICENSE.html ADDED

@@ -0,0 +1,129 @@
+<?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>File: LICENSE</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="fileHeader">
+    <h1>LICENSE</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>LICENSE
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Fri Dec 19 07:32:30 -0700 2008</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+Copyright (c) 2008 h3o(software)
+</p>
+<p>
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+&quot;Software&quot;), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+</p>
+<p>
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+</p>
+<p>
+THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.
+</p>
+    </div>
+   </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>

data/doc/rdoc/files/README_rdoc.html ADDED

@@ -0,0 +1,184 @@
+<?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>File: README.rdoc</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="fileHeader">
+    <h1>README.rdoc</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>README.rdoc
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Sun Dec 21 20:02:32 -0700 2008</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <h1>Project: <a href="../classes/Siffer.html">Siffer</a> - h3o(software) SIF Implementation</h1>
+<h2>Welcome to <a href="../classes/Siffer.html">Siffer</a></h2>
+<p>
+This is the h3o(software) implementation of the SIF (School
+Interoperability Framework) in Ruby. The project is Ruby based and includes
+all of the SIF infrastructure (Data Model, Agents, Zone Integration Servers
+and even database stores).
+</p>
+<h2>Goal</h2>
+<p>
+The overriding goal of this project is to provide anyone in the education
+industry a quick, easy and simple SIF implementation tool. The entire
+system can be managed by a browser.
+</p>
+<h3>Setup and Deployment</h3>
+<p>
+<a href="../classes/Siffer.html">Siffer</a> is easy to install and setup.
+Zone Integration Servers and Agents can be created from the browser.
+Administrators will be able to manage all components of their deployment
+from a command line or browser.
+</p>
+<h2>Philosophy</h2>
+<p>
+Remove the complexity from the implementation. Make the execution and
+deployment of SIF easy.
+</p>
+<h2>Implementation Information (sifinfo.org)</h2>
+<p>
+This implementation is based on version 2.2 of the SIF Specification. The
+Specification is in <a
+href="../../SIF%20ImplementationSpecification.pdf">PDF</a> format inside
+the doc folder.
+</p>
+<p>
+More information here: <a href="http://sifinfo.org">sifinfo.org</a>.
+</p>
+<h2>Description of Contents</h2>
+<h2>Useage</h2>
+<h2>License</h2>
+<p>
+<a href="../classes/Siffer.html">Siffer</a> is released under the MIT
+License
+</p>
+<h2>Installation</h2>
+<p>
+<a href="../classes/Siffer.html">Siffer</a> can be installed from the
+siffer gem:
+</p>
+<p>
+% [sudo] gem install siffer
+</p>
+<h2>Support</h2>
+<p>
+Please contact the author (<a
+href="mailto://clint.hill@h3osoftware.com">clint.hill@h3osoftware.com</a>)
+for support issues. If you want to contribute do the same.
+</p>
+<h3>Contributors</h3>
+<p>
+This project is developed by spec. Build spec tests for all of your
+features. Document everything.
+</p>
+<h2>Contact</h2>
+<ul>
+<li>Author:: {Clint Hill} <a
+href="mailto://clint.hill@h3osoftware.com">clint.hill@h3osoftware.com</a>
+</li>
+<li>Home Page:: <a
+href="http://h3osoftware.com/siffer">h3osoftware.com/siffer</a>
+</li>
+<li>GitHub:: git://github.com/clinth3o/siffer.git
+</li>
+<li>RubyForge:: <a
+href="http://rubyforge.org/projects/siffer">rubyforge.org/projects/siffer</a>/
+</li>
+</ul>
+    </div>
+   </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>