siffer 0.0.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 h3o(software)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), 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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", 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.

data/README.rdoc

@@ -0,0 +1,65 @@
+= Project: Siffer  -  h3o(software) SIF Implementation
+
+== Welcome to Siffer
+
+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). 
+
+== Goal
+
+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.
+
+=== Setup and Deployment
+
+Siffer 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.
+
+== Philosophy 
+
+Remove the complexity from the implementation. Make the execution and 
+deployment of SIF easy.
+
+== Implementation Information (sifinfo.org)
+
+This implementation is based on version 2.2 of the SIF Specification. The 
+Specification is in {PDF}[link:../SIF%20ImplementationSpecification.pdf] format 
+inside the doc folder.
+
+
+More information here: http://sifinfo.org.
+
+== Description of Contents
+
+== Useage
+
+== License
+
+Siffer is released under the MIT License
+
+== Installation
+
+Siffer can be installed from the siffer gem:
+
+% [sudo] gem install siffer
+
+== Support
+
+Please contact the author (mailto://clint.hill@h3osoftware.com) for support 
+issues. If you want to contribute do the same. 
+
+=== Contributors
+
+This project is developed by spec. Build spec tests for all of your features. 
+Document everything.
+
+== Contact
+
+- Author:: {Clint Hill} mailto://clint.hill@h3osoftware.com
+- Home Page:: http://h3osoftware.com/siffer
+- GitHub:: git://github.com/clinth3o/siffer.git
+- RubyForge:: http://rubyforge.org/projects/siffer/

data/Rakefile

@@ -0,0 +1,64 @@
+require 'rake'
+require 'rake/clean'                       
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+require 'fileutils'
+include FileUtils
+require File.join(File.dirname(__FILE__),"lib","siffer")
+include Siffer
+
+spec = Gem::Specification.new do |s|
+  s.name = "siffer"
+  s.version = Siffer.version
+  s.platform = Gem::Platform::RUBY
+  s.author = "Clint Hill"
+  s.email = "clint.hill@h3osoftware.com"
+  s.homepage = "http://h3osoftware.com/siffer"
+  s.summary = "Siffer - School Interoperability Framework by h3o(software)"
+  s.rubyforge_project = "siffer"
+  s.require_path = "lib"
+  s.files        = %w( LICENSE README.rdoc Rakefile ) + Dir["{spec,lib,doc}/**/*"]
+  s.bindir = "bin"
+  s.executables = %w( siffer )
+  s.add_dependency "uuid"
+  s.add_dependency "rack"
+  s.add_dependency "hpricot"
+  s.add_dependency "builder"
+end
+
+Rake::GemPackageTask.new(spec) do |package|
+ package.gem_spec = spec
+end
+
+##############################################################################
+# rSpec
+##############################################################################
+desc 'Run all specs and rcov'
+task :spec => ["spec:default"]
+namespace :spec do
+  Spec::Rake::SpecTask.new('default') do |t|
+      t.spec_opts = ["--format", "specdoc", "--colour"]
+      t.spec_files = Dir['spec/**/*_spec.rb'].sort
+      t.libs = ['lib']
+      t.rcov = true
+      t.rcov_opts = ["--exclude 'bin,doc,pkg,spec,#{Gem::path.join(',')}'"] 
+  end
+end
+
+##############################################################################
+# Documentation
+##############################################################################
+task :doc => ["doc:rdoc"]
+namespace :doc do
+  Rake::RDocTask.new do |rdoc|
+    files = ["README.rdoc","LICENSE","lib/**/*.rb"]
+    rdoc.rdoc_files.add(files)
+    rdoc.main = "README.rdoc"
+    rdoc.title = "Siffer == h3o(software) SIF"
+    rdoc.rdoc_dir = "doc/rdoc"
+    rdoc.options << "--line-numbers" << "--inline-source"
+  end
+end
+
+

data/bin/siffer

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+require 'yaml'
+# For test purposes rescue the require so we can get the local lib
+begin
+  require 'siffer'
+rescue LoadError
+  require 'lib/siffer'
+end
+options = {:environment => "development"}
+
+opts = OptionParser.new("", 24, ' ') { |opts| 
+  opts.banner = "Usage: siffer [start|run|stop|kill] [component] [options]"
+  
+  opts.separator ""
+  opts.separator "Siffer options:"
+  
+  opts.on("-e", 
+          "--env ENVIRONMENT", 
+          "development, deployment, test, none (default: development)") { |e|
+    options[:environment] = e
+  }
+   
+  opts.on("-d", 
+          "--daemonize", 
+          "run daemonized in the background (default: true)") { |d|
+    options[:daemonize] = d ? true : false
+  }
+  
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("-v", "--version", "Show version") do
+   puts "Siffer #{Siffer.version} (SIF Version #{Siffer.sif_version})"
+   exit
+  end
+
+  opts.parse! ARGV
+}
+
+unless command = ARGV[0]
+  abort opts.to_s
+end
+
+unless options[:component] = ARGV[1]
+  abort opts.to_s
+end
+
+options[:config] = YAML.load_file(File.expand_path(options[:component]))
+
+component = options[:component].split('/')[-1]
+cwd = File.expand_path(File.dirname(options[:component]))
+options[:log] = File.join(cwd,"#{component}.log")
+options[:pid] = File.join(cwd,"#{component}.pid")
+container = Siffer::Container.new(options)
+if command == "start" or command == "run"
+  if options[:environment] == "test"
+    puts options.inspect # For testing purposes let's just output the options
+  else
+    container.run
+  end
+else
+  container.stop
+end
+
+
+

data/doc/rdoc/classes/Siffer.html

@@ -0,0 +1,374 @@
+<?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</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</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/agent_rb.html">
+                lib/agent.rb
+                </a>
+        <br />
+                <a href="../files/lib/container_rb.html">
+                lib/container.rb
+                </a>
+        <br />
+                <a href="../files/lib/messages/ack_rb.html">
+                lib/messages/ack.rb
+                </a>
+        <br />
+                <a href="../files/lib/messages/acl_rb.html">
+                lib/messages/acl.rb
+                </a>
+        <br />
+                <a href="../files/lib/messages/error_rb.html">
+                lib/messages/error.rb
+                </a>
+        <br />
+                <a href="../files/lib/messages/message_rb.html">
+                lib/messages/message.rb
+                </a>
+        <br />
+                <a href="../files/lib/messages/register_rb.html">
+                lib/messages/register.rb
+                </a>
+        <br />
+                <a href="../files/lib/messages/request_body_rb.html">
+                lib/messages/request_body.rb
+                </a>
+        <br />
+                <a href="../files/lib/messages/status_rb.html">
+                lib/messages/status.rb
+                </a>
+        <br />
+                <a href="../files/lib/messaging_rb.html">
+                lib/messaging.rb
+                </a>
+        <br />
+                <a href="../files/lib/protocol_rb.html">
+                lib/protocol.rb
+                </a>
+        <br />
+                <a href="../files/lib/registration_rb.html">
+                lib/registration.rb
+                </a>
+        <br />
+                <a href="../files/lib/request_rb.html">
+                lib/request.rb
+                </a>
+        <br />
+                <a href="../files/lib/request_logger_rb.html">
+                lib/request_logger.rb
+                </a>
+        <br />
+                <a href="../files/lib/response_rb.html">
+                lib/response.rb
+                </a>
+        <br />
+                <a href="../files/lib/server_rb.html">
+                lib/server.rb
+                </a>
+        <br />
+                <a href="../files/lib/siffer_rb.html">
+                lib/siffer.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000005">root</a>&nbsp;&nbsp;
+      <a href="#M000006">root=</a>&nbsp;&nbsp;
+      <a href="#M000003">sif_version</a>&nbsp;&nbsp;
+      <a href="#M000004">sif_xmlns</a>&nbsp;&nbsp;
+      <a href="#M000001">vendor</a>&nbsp;&nbsp;
+      <a href="#M000002">version</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="Siffer/Messages.html" class="link">Siffer::Messages</a><br />
+Module <a href="Siffer/Messaging.html" class="link">Siffer::Messaging</a><br />
+Module <a href="Siffer/Protocol.html" class="link">Siffer::Protocol</a><br />
+Module <a href="Siffer/Registration.html" class="link">Siffer::Registration</a><br />
+Class <a href="Siffer/Agent.html" class="link">Siffer::Agent</a><br />
+Class <a href="Siffer/Container.html" class="link">Siffer::Container</a><br />
+Class <a href="Siffer/Request.html" class="link">Siffer::Request</a><br />
+Class <a href="Siffer/RequestLogger.html" class="link">Siffer::RequestLogger</a><br />
+Class <a href="Siffer/Response.html" class="link">Siffer::Response</a><br />
+Class <a href="Siffer/Server.html" class="link">Siffer::Server</a><br />
+
+    </div>
+
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">VENDOR</td>
+          <td>=</td>
+          <td class="context-item-value">&quot;h3o(software)&quot; unless defined?(Siffer::VENDOR)</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">VERSION</td>
+          <td>=</td>
+          <td class="context-item-value">[0,0,4] unless defined?(Siffer::VERSION)</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">SIF_VERSION</td>
+          <td>=</td>
+          <td class="context-item-value">[2,2,0] unless defined?(Siffer::SIF_VERSION)</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">SIF_XMLNS</td>
+          <td>=</td>
+          <td class="context-item-value">&quot;http://www.sifinfo.org/infrastructure/2.x&quot; unless defined?(Siffer::SIF_XMLNS)</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+
+        <div class="method-heading">
+          <a href="#M000005" class="method-signature">
+          <span class="method-name">root</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+The <a href="Siffer.html#M000005">root</a> directory that the SIF
+implementation is running from
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000005-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/siffer.rb, line 32</span>
+32:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">root</span>() <span class="ruby-ivar">@root</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">pwd</span> <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+
+        <div class="method-heading">
+          <a href="#M000006" class="method-signature">
+          <span class="method-name">root=</span><span class="method-args">(value)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000006-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/siffer.rb, line 33</span>
+33:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">root=</span>(<span class="ruby-identifier">value</span>) <span class="ruby-ivar">@root</span> = <span class="ruby-identifier">value</span> <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="#M000003" class="method-signature">
+          <span class="method-name">sif_version</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+The <a href="Siffer.html#M000002">version</a> of SIF being implemented -
+based on the specification
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000003-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/siffer.rb, line 26</span>
+26:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">sif_version</span>() <span class="ruby-constant">SIF_VERSION</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">&quot;.&quot;</span>) <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+
+        <div class="method-heading">
+          <a href="#M000004" class="method-signature">
+          <span class="method-name">sif_xmlns</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+The SIF XML namespace to be used across this implementation
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000004-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/siffer.rb, line 29</span>
+29:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">sif_xmlns</span>() <span class="ruby-constant">SIF_XMLNS</span> <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="#M000001" class="method-signature">
+          <span class="method-name">vendor</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+The <a href="Siffer.html#M000001">vendor</a> of this SIF implementation
+(self describing for Agents)
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000001-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/siffer.rb, line 20</span>
+20:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">vendor</span>() <span class="ruby-constant">VENDOR</span> <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+
+        <div class="method-heading">
+          <a href="#M000002" class="method-signature">
+          <span class="method-name">version</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+The <a href="Siffer.html#M000002">version</a> of the h3o(software) SIF
+implementation
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000002-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/siffer.rb, line 23</span>
+23:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">version</span>() <span class="ruby-constant">VERSION</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">&quot;.&quot;</span>) <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>