siffer 0.1.0 → 0.1.1

data/LICENSE

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

data/lib/siffer.rb

@@ -1 +1,41 @@
-require 'sif'
+require 'rubygems'
+require 'activesupport'
+require 'uuid'
+require 'builder'
+require 'sinatra/base'
+require 'haml'
+require 'rest_client'
+require 'acdc'
+
+$: << File.expand_path(File.dirname(__FILE__))
+
+module Siffer
+
+    VENDOR = "h3o(software)" unless defined?(Siffer::VENDOR)
+    VERSION = [0,1,1] unless defined?(Siffer::VERSION)
+    SIF_VERSION = [2,3] unless defined?(Siffer::SIF_VERSION)
+    SIF_XMLNS = "http://www.sifinfo.org/infrastructure/2.x" unless defined?(Siffer::SIF_XMLNS)
+  
+    # The vendor of this SIF implementation (self describing for Agents)
+    def self.vendor() VENDOR end
+      
+    # 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, "siffer/messages"
+    autoload :Models, "siffer/models"
+        
+end
+
+require "siffer/agent"
+require "siffer/core_ext/hash"

data/lib/siffer/agent.rb

@@ -0,0 +1,53 @@
+module Siffer
+
+  class Agent < Sinatra::Base
+
+    enable :static
+        
+    set :root, File.join(File.dirname(__FILE__),"agent")
+    set :port, 2828
+    set :haml, {:format => :html5 }    
+    set :agent_name, "Not Named"
+    set :zis_url, "Not Set"
+    
+    before do
+      @agent_name = options.agent_name
+      @zis_url = options.zis_url
+      #redirect '/' unless registered? or request.path == "/register" or request.path == "/"
+    end
+    
+    helpers do
+      def registered?
+        @zis_url != "Not Set"
+      end
+    end
+    
+    get "/" do
+      haml :index
+    end
+    
+    post "/register" do
+      url = params[:zis_url]
+      msg = SystemControl.get_zone_status(@agent_name)
+      # msg = Register.new(
+      #          :header => @agent_name,
+      #          :version => Siffer.sif_version,
+      #          :mode => "Pull",
+      #          :max_buffer_size => 1024,
+      #          :name => @agent_name,
+      #          :application => Application.new(
+      #                :vendor => "h3o(software)",
+      #                :version => Siffer.version,
+      #                :product => "Siffer"
+      #              )
+      #          )
+      puts msg
+      raw = RestClient.post(url, msg, :content_type => 'application/xml')
+      puts raw
+      return_msg = Message.parse(raw)
+      return_msg
+    end
+    
+  end
+  
+end

data/lib/siffer/core_ext/hash.rb

@@ -0,0 +1,15 @@
+class Hash
+  
+  # Recursively changes key names to underscored symbols
+  def recursively_underscore
+    keys.each do |key|
+     if self[key].is_a?(Hash)
+        self[key.underscore.to_sym] = delete(key).recursively_underscore
+      else
+        self[key.underscore.to_sym] = delete(key)
+      end
+    end
+    self
+  end
+
+end

data/lib/siffer/messages.rb

@@ -0,0 +1,41 @@
+module Siffer
+  module Messages
+    
+    class SifBody < AcDc::Body
+      def tag_name
+        "SIF_#{super}"
+      end
+      
+      class << self
+        def acdc(xml)
+          super(xml.gsub(/SIF_/,''))
+        end
+      end
+    end
+
+    class SifElement < AcDc::Element
+      def initialize(values=nil, options={})
+        @required = options[:required] || false
+        super(value,options)
+      end
+      def required?
+        @required
+      end
+      def tag_name
+        "SIF_#{super}"
+      end
+    end
+    
+  end
+end
+
+require 'siffer/messages/message'
+require 'siffer/messages/ack'
+require 'siffer/messages/event'
+require 'siffer/messages/provide'
+require 'siffer/messages/provision'
+require 'siffer/messages/register'
+require 'siffer/messages/request'
+require 'siffer/messages/response'
+require 'siffer/messages/subscribe'
+require 'siffer/messages/system_control'

data/lib/siffer/messages/ack.rb

@@ -0,0 +1,168 @@
+module Siffer
+  module Messages
+    
+    # Element containing Status information
+    #@see Ack
+    class Status < SifBody
+      element :code
+      element :desc
+      element :data
+    end
+    
+    # Element containing Error information
+    #@see Ack
+    class Error < SifBody
+      element :category
+      element :code
+      element :desc
+      element :extended_desc
+    end
+    
+    # Message used as an acknowledgement for infrastructure messages.
+    # Ack must contain either a SIF_Status or a SIF_Error
+    #@see Status
+    #@see Error
+    class Ack < Message
+      element :original_source_id
+      element :original_msg_id
+      element :status
+      element :error
+    end
+    
+    STATUS_CODE = {
+      0	=> "Success (ZIS ONLY). SIF_Status/SIF_Data may contain additional data.",
+      1	=> "Immediate SIF_Ack (AGENT ONLY). Message is persisted or processing is complete. Discard the referenced message.",
+      2	=> "Intermediate SIF_Ack (AGENT ONLY). Only valid in response to SIF_Event delivery. Invokes Selective Message Blocking. The event referenced must still be persisted, and no other events must be delivered, until the agent sends a \"Final\" SIF_Ack at a later time.",
+      3	=> "Final SIF_Ack (AGENT ONLY). Sent (a SIF_Ack with this value is never returned by an agent in response to a delivered message) by an agent to the ZIS to end Selective Message Blocking. Discard the referenced event and allow for delivery of other events.",
+      7	=> "Already have a message with this SIF_MsgId from you.",
+      8	=> "Receiver is sleeping.",
+      9	=> "No messages available. This is returned when an agent is trying to pull messages from a ZIS and there are no messages available."
+    }
+    
+    ERROR_CATEGORY = {
+      0	 => "Unknown (This should NEVER be used if possible)",
+      1	 => "XML Validation",
+      2	 => "Encryption",
+      3	 => "Authentication",
+      4	 => "Access and Permissions",
+      5	 => "Registration",
+      6	 => "Provision",
+      7	 => "Subscription",
+      8	 => "Request and Response",
+      9	 => "Event Reporting and Processing",
+      10 => "Transport",
+      11 => "System (OS, Database, Vendor localized, etc.)",
+      12 => "Generic Message Handling",
+      13 => "SMB Handling"
+    }
+    
+    XML_VALIDATION_ERROR = {
+      1	=> "Generic error",
+      2	=> "Message is not well-formed",
+      3	=> "Generic validation error",
+      4	=> "Invalid value for element/attribute",
+      6	=> "Missing mandatory element/attribute"
+    }
+    
+    ENCRYPTION_ERROR = { 1 => "Generic Error" }
+    
+    AUTHENTICATION_ERROR = {
+      1	 => "Generic error",
+      2	 => "Generic authentication error (with signature)",
+      3	 => "Missing sender's certificate",
+      4	 => "Invalid certificate",
+      5	 => "Sender's certificate is not trusted",
+      6	 => "Expired certificate",
+      7	 => "Invalid signature",
+      8	 => "Invalid encryption algorithm (only accepts MD4)",
+      9	 => "Missing public key of the receiver (when decrypting message)",
+      10 => "Missing receiver's private key (when decrypting message)"
+    }
+    
+    ACCESS_AND_PERMISSION_ERROR = {
+      1	 => "Generic error",
+      2	 => "No permission to register",
+      3	 => "No permission to provide this object",
+      4	 => "No permission to subscribe to this SIF_Event",
+      5	 => "No permission to request this object",
+      6	 => "No permission to respond to this object request",
+      7	 => "No permission to publish SIF_Event",
+      8	 => "No permission to administer policies",
+      9	 => "SIF_SourceId is not registered",
+      10 => "No permission to publish SIF_Event Add",
+      11 => "No permission to publish SIF_Event Change",
+      12 => "No permission to publish SIF_Event Delete"
+    }
+    
+    REGISTRATION_ERROR = {
+      1	 => "Generic error",
+      2	 => "The SIF_SourceId is invalid",
+      3	 => "Requested transport protocol is unsupported",
+      4	 => "Requested SIF_Version(s) not supported.",
+      6	 => "Requested SIF_MaxBufferSize is too small",
+      7	 => "ZIS requires a secure transport",
+      9	 => "Agent is registered for push mode (returned when a push-mode agent sends a SIF_GetMessage).",
+      10 => "ZIS does not support the requested Accept-Encoding value."
+    }
+    
+    PROVISION_ERROR = {
+      1	=> "Generic error",
+      3	=> "Invalid object",
+      4	=> "Object already has a provider (SIF_Provide message)"
+    }
+    
+    SUBSCRIPTION_ERROR = {
+      1 => "Generic error",
+      3 => "Invalid object"
+    }
+    
+    REQUEST_AND_RESPONSE_ERROR = {
+      1	 => "Generic error",
+      3	 => "Invalid object",
+      4	 => "No provider",
+      7	 => "Responder does not support requested SIF_Version",
+      8	 => "Responder does not support requested SIF_MaxBufferSize",
+      9	 => "Unsupported query in request",
+      10 => "Invalid SIF_RequestMsgId specified in SIF_Response",
+      11 => "SIF_Response is larger than requested SIF_MaxBufferSize",
+      12 => "SIF_PacketNumber is invalid in SIF_Response",
+      13 => "SIF_Response does not match any SIF_Version from SIF_Request",
+      14 => "SIF_DestinationId does not match SIF_SourceId from SIF_Request",
+      15 => "No support for SIF_ExtendedQuery",
+      16 => "SIF_RequestMsgId deleted from cache due to timeout",
+      17 => "SIF_RequestMsgId deleted from cache by administrator",
+      18 => "SIF_Request cancelled by requesting agent"
+    }
+    
+    EVENT_REPORTING_AND_PROCESSING_ERROR = {
+      1 => "Generic error",
+      3 => "Invalid event"
+    }
+    
+    TRANSPORT_ERROR = {
+      1	=> "Generic error",
+      2	=> "Requested protocol is not supported",
+      3	=> "Secure channel requested and no secure path exists",
+      4	=> "Unable to establish connection"
+    }
+    
+    SYSTEM_ERROR = { 1 => "Generic error" }
+    
+    GENERIC_MESSAGE_HANDLING_ERROR = {
+      1	=> "Generic error",
+      2	=> "Message not supported",
+      3	=> "Version not supported",
+      4	=> "Context not supported",
+      5	=> "Protocol error",
+      6	=> "No such message (as identified by SIF_OriginalMsgId)",
+      7	=> "Multiple contexts not supported"
+    }
+    
+    SMB_ERROR = {
+      1	=> "Generic error",
+      2	=> "SMB can only be invoked during a SIF_Event acknowledgement",
+      3	=> "Final SIF_Ack expected from Push-Mode Agent",
+      4	=> "Incorrect SIF_MsgId in final SIF_Ack"
+    }
+  end
+end