siffer 0.0.7 → 0.1.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008-2009 Clint Hill - h3o(software)
+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

data/README

@@ -1,93 +1,63 @@
-= 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). 
-
-Siffer is a platform - not a development kit. Certainly it's open source and
-you can take this code and do as you wish. However, Siffer provides out of the
-box all the things you need to run a SIF environment. 
-
-Simply put you can do one of two things with Siffer:
-
-1) You can download it and run the admin server and setup Servers and Agents. 
-2) You can download it and write the code to build your own Servers and Agents.
-
-
-It's currently incomplete - Stay Tuned!
-
-== Goal
-
-The overriding goal of this project is to provide anyone in the education 
-industry a quick, easy and simple SIF implementation tool. 
-
-== Philosophy 
-
-Remove the complexity from the implementation. Make the execution and 
-deployment of SIF easy. 
-
-Make SIF more REST'ful. As much as possible expose the actions and data models
-through the URI and URL of ZIS and Agent components.
-
-Make SIF more useful. As much as possible remove the "XML" and "Database" 
-questions out of the equation. 
-
-Make it simple. Make it easy. Make it fun. Make it intuitive. 
-Make it do exactly what needs to be done.
-You're too busy for anything else.
-
-== Implementation Information (sifinfo.org)
-
-This implementation is based on version 2.3 of the SIF Specification.
-It can be found here: http://specification.sifinfo.org/Implementation/2.3/
-
-More information here: http://sifinfo.org.
-
-== Description of Contents
-
-== Useage
-
-% siffer start agent "default agent" -p 8001 -d
-% siffer start server "default zis" -p 8002 -d
-
-% siffer stop agent "default agent"
-% siffer stop server "default zis"
-
-Or from the admin browser !!!
-
-% siffer start admin
-
-open http://0.0.0.0:2828 from any browser and enjoy!
-
-== 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 (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 (RSpec) for all of 
-your features. Document everything.
-
-Fork the project and then make a pull request. 
-http://github.com/clinth3o/siffer
-
-== Contact
-
-- Author:: Clint Hill clint.hill@h3osoftware.com
-- Home Page:: http://h3osoftware.com/siffer
-- GitHub:: git://github.com/clinth3o/siffer.git
-- RubyForge:: http://rubyforge.org/projects/siffer/
+= 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
+small SIF implementation tool. Sane Defaults in front of easy Configurations.
+
+=== Setup and Deployment
+
+Siffer is easy to install and setup. Zone Integration Servers and Agents can be created at the command
+line. Zone Integration Servers are managed by web based interfaces and Agents will be centrally managed 
+by a web based interface. Administrators will be able to manage all components of their deployment from a 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 docs 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
+Email:: mailto://clint.hill@h3osoftware.com
+Home Page:: http://h3osoftware.com/siffer
+SVN:: http://svn.h3osoftware.com/siffer
+
+
+

data/Rakefile

@@ -0,0 +1,60 @@
+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","sif")
+include Siffer
+
+NAME = "siffer"
+
+spec = Gem::Specification.new do |s|
+  s.name = NAME
+  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 Rakefile ) + Dir["{spec,lib,doc}/**/*"]
+  s.bindir = "bin"
+  s.executables = %w( siffer )
+  s.add_dependency "uuid"
+  s.required_ruby_version = ">= 1.8.7"
+end
+
+Rake::GemPackageTask.new(spec) do |package|
+ package.gem_spec = spec
+end
+
+##############################################################################
+# rSpec
+##############################################################################
+desc 'Run all specs'
+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
+  end
+end
+
+##############################################################################
+# Documentation
+##############################################################################
+task :doc => ["doc:rdoc"]
+namespace :doc do
+  Rake::RDocTask.new do |rdoc|
+    files = ["README","LICENSE","lib/**/*.rb"]
+    rdoc.rdoc_files.add(files)
+    rdoc.main = "README"
+    rdoc.title = "Siffer == h3o(software) SIF"
+    rdoc.rdoc_dir = "docs/rdoc"
+    rdoc.options << "--line-numbers" << "--inline-source"
+  end
+end

data/bin/siffer

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+
+app_help = <<-EOF
+  =========================================
+  ===  h3o(software) siffer generator   ===
+  =========================================
+EOF
+
+puts app_help

data/lib/sif.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'uuid'
+
+$: << File.expand_path(File.dirname(__FILE__))
+
+module Siffer
+
+    VENDOR = "h3o(software)" unless defined?(Siffer::VENDOR)
+    VERSION = [0,1,0] unless defined?(Siffer::VERSION)
+    SIF_VERSION = [2,2,0] unless defined?(Siffer::SIF_VERSION)
+    SIF_XMLNS = "http://www.sifinfo.org/infrastructure/2.x" unless defined?(Siffer::SIF_XMLNS)
+  
+    # The version of the h3o(software) SIF implementation
+    def self.version() VERSION.join(".") end
+  
+    # The version of SIF being implemented - based on the specification
+    def self.sif_version() SIF_VERSION.join(".") end
+    
+    # The SIF XML namespace to be used across this implementation
+    def self.sif_xmlns() SIF_XMLNS end
+  
+    # The root directory that the SIF implementation is running from
+    def self.root() @root ||= Dir.pwd end
+    def self.root=(value) @root = value end
+      
+    autoload :Messages, "sif/messages"
+    autoload :Exceptions, "sif/exceptions"
+    autoload :Protocols, "sif/protocols"
+    autoload :CodeSets, "sif/code_sets"
+  
+end
+require "sif/config"
+require "sif/status"
+require "sif/error"
+require "sif/core_ext/array"
+class Array
+    include Siffer::CoreExtensions::Array::ExtractOptions
+end

data/lib/sif/code_sets.rb

@@ -0,0 +1,9 @@
+require 'lib/sif/code_sets/base_code_set'
+%w[access_permission_error_codes authentication_error_codes encryption_error_codes 
+error_category_codes event_reporting_processing_error_codes generic_message_handling_error_codes 
+provision_error_codes registration_error_codes request_response_error_codes smb_error_codes 
+status_codes subscription_error_codes system_error_codes transport_error_codes 
+xml_validation_error_codes].each do |codes|
+    require "lib/sif/code_sets/#{codes}"
+end
+

data/lib/sif/code_sets/access_permission_error_codes.rb

@@ -0,0 +1,17 @@
+module Siffer
+  module CodeSets
+    class AccessPermissionErrorCode < BaseCodeSet; end
+    AccessPermissionErrorCode.register(1,:generic,"Generic error")
+    AccessPermissionErrorCode.register(2,:register,"No permission to register")
+    AccessPermissionErrorCode.register(3,:provide,"No permission to provide this object")
+    AccessPermissionErrorCode.register(4,:subscribe,"No permission to subscribe to this SIF_Event")
+    AccessPermissionErrorCode.register(5,:requrest,"No permission to request this object")
+    AccessPermissionErrorCode.register(6,:responsd,"No permission to respond to this object request")
+    AccessPermissionErrorCode.register(7,:publish,"No permission to publish SIF_Event")
+    AccessPermissionErrorCode.register(8,:administer,"No permission to administer policies")
+    AccessPermissionErrorCode.register(9,:source_not_registered,"SIF_SourceId is not registered")
+    AccessPermissionErrorCode.register(10,:publish_add,"No permission to publish SIF_Event Add")
+    AccessPermissionErrorCode.register(11,:publish_change,"No permission to publish SIF_Event Change")
+    AccessPermissionErrorCode.register(12,:publish_delete,"No permission to publish SIF_Event Delete")
+  end
+end

data/lib/sif/code_sets/authentication_error_codes.rb

@@ -0,0 +1,15 @@
+module Siffer
+  module CodeSets
+    class AuthenticationErrorCode < BaseCodeSet; end
+    AuthenticationErrorCode.register(1,:generic,"Generic error")
+    AuthenticationErrorCode.register(2,:generic_with_signature,"Generic authentication error (with signature)")
+    AuthenticationErrorCode.register(3,:missing_certification,"Missing sender's certificate")
+    AuthenticationErrorCode.register(4,:invalid_certificate,"Invalid certificate")
+    AuthenticationErrorCode.register(5,:not_trusted,"Sender's certificate is not trusted")
+    AuthenticationErrorCode.register(6,:expired,"Expired certificate")
+    AuthenticationErrorCode.register(7,:invalid_signature,"Invalid signature")
+    AuthenticationErrorCode.register(8,:invalid_encryption,"Invalid encryption algorithm (only accepts MD4)")
+    AuthenticationErrorCode.register(9,:missing_public_key,"Missing public key of the receiver (when decrypting message)")
+    AuthenticationErrorCode.register(10,:missing_private_key,"Missing receiver's private key (when decrypting message)")
+  end
+end

data/lib/sif/code_sets/base_code_set.rb

@@ -0,0 +1,75 @@
+module Siffer
+  module CodeSets
+   # This class supports a base for all Code Sets.
+   # It allows for a class to implement a symbol,
+   # code and a description.
+   # 
+   # Example:
+   #  def GenericCode < BaseCodeSet; end
+   #  Siffer::CodeSets::GenericCode.register(0,:generic, "Generic Error")
+   #  @error = Siffer::CodeSets::GenericCode[:generic]
+   #  @error == 0
+   #  #=> true
+   #  @error == :generic
+   #  #=> true
+   #  puts @error.description
+   #  #=> "Generic Error"
+   #  @error == Siffer::CodeSets::GenericCode[:generic]
+   #  #=> true
+   #  @error.generic? 
+   #  #=> true
+   class BaseCodeSet
+
+    attr_reader :description
+    SET = []
+
+    def initialize(code, symbol, description)
+      @code = code
+      @symbol = symbol
+      @description = description
+    end
+
+    def to_s
+      @description
+    end
+
+    def to_str
+      to_s
+    end 
+
+    def to_sym
+      @symbol
+    end
+
+    def ==(obj)
+      return @symbol == obj if obj.kind_of? Symbol
+      return @code == obj if obj.kind_of? Integer
+    end
+
+    class << self
+      def register(code, symbol, description)
+        self.instance_eval { const_set symbol.to_s.upcase, self.new(code,symbol,description) }
+        SET << self.const_get(symbol.to_s.upcase)
+      end
+
+      def [](index)
+        SET.each do |status|
+          return status if status == index
+        end
+        raise Exceptions::InvalidErrorCode, "#{index} code not found in #{self.name} codes."
+      end
+
+    end
+    
+    private
+      def method_missing(method, *args)
+        if method.to_s =~ /(\w+)\?$/
+          $1.downcase.to_sym == to_sym
+        else
+          super
+        end
+      end
+
+    end
+  end
+end

data/lib/sif/code_sets/encryption_error_codes.rb

@@ -0,0 +1,6 @@
+module Siffer
+  module CodeSets
+    class EncryptionErrorCode < BaseCodeSet; end
+    EncryptionErrorCode.register(1,:generic,"Generic error")
+  end
+end

data/lib/sif/code_sets/error_category_codes.rb

@@ -0,0 +1,20 @@
+module Siffer
+  module CodeSets
+    class ErrorCategoryCode < BaseCodeSet; end
+    ErrorCategoryCode.register(0,:unknown,"This should never be used if possible.")
+    ErrorCategoryCode.register(1,:xml_validation, "XML Validation")
+    ErrorCategoryCode.register(2,:encryption,"Encryption")
+    ErrorCategoryCode.register(3,:authentication,"Authentication")
+    ErrorCategoryCode.register(4,:access_and_permissions,"Access and Permissions")
+    ErrorCategoryCode.register(5,:registration,"Registration")
+    ErrorCategoryCode.register(6,:provision,"Provision")
+    ErrorCategoryCode.register(7,:subscription,"Subscription")
+    ErrorCategoryCode.register(8,:requrest_and_response,"Request and Response")
+    ErrorCategoryCode.register(9,:event_reporting_and_processing,"Event Reporting and Processing")
+    ErrorCategoryCode.register(10,:transport,"Transport")
+    ErrorCategoryCode.register(11,:system,"System (OS, Database, Vendor localized, etc.)")
+    ErrorCategoryCode.register(12,:generic_message_handling,"Generic Message Handling")
+    ErrorCategoryCode.register(13,:smb_handling,"SMB Handling")
+  end
+end
+

data/lib/sif/code_sets/event_reporting_processing_error_codes.rb

@@ -0,0 +1,7 @@
+module Siffer
+  module CodeSets
+    class EventReportingProcessingErrorCode < BaseCodeSet; end
+    EventReportingProcessingErrorCode.register(1,:generic,"Generic error")
+    EventReportingProcessingErrorCode.register(3,:invalid_event,"Invalid event")
+  end
+end

data/lib/sif/code_sets/generic_message_handling_error_codes.rb

@@ -0,0 +1,12 @@
+module Siffer
+  module CodeSets
+    class GenericMessageHandlingErrorCode < BaseCodeSet; end
+    GenericMessageHandlingErrorCode.register(1,:generic,"Generic error")
+    GenericMessageHandlingErrorCode.register(2,:message_not_supported,"Message not supported")
+    GenericMessageHandlingErrorCode.register(3,:version_not_supported,"Version not supported")
+    GenericMessageHandlingErrorCode.register(4,:context_not_supported,"Context not supported")
+    GenericMessageHandlingErrorCode.register(5,:protocol_error,"Protocol error")
+    GenericMessageHandlingErrorCode.register(6,:no_such_message,"No such message (as identified by SIF_OriginalMsgId)")
+    GenericMessageHandlingErrorCode.register(7,:multiple_contexts_not_supported,"Multiple contexts not supported")
+  end
+end