siffer 0.0.5 → 0.0.7

data/lib/siffer/messages/subscribe.rb

@@ -0,0 +1,17 @@
+module Siffer
+  module Messages
+    
+    # Message is used to subscribe to event objects that are contained in this message
+    #@see Object
+    class Subscribe < Message
+      element :object
+    end
+    
+    # This message performs the opposite function of SIF_Subscribe.
+    #@see Object
+    class Unsubscribe < Message
+      element :object
+    end
+    
+  end
+end

data/lib/siffer/messages/system_control.rb

@@ -0,0 +1,94 @@
+module Siffer
+  module Messages
+
+    NOTIFICATION_TYPES = {
+      :standard => "Standard",
+      :none => "None"
+    }
+    
+    # Sent to detect if a ZIS or push-mode agent is ready to receive and process messages.
+    #@see SystemControl
+    class Ping < SifElement; end
+
+    # Allows an agent to notify a ZIS or a ZIS to notify a push-mode agent that it must not send any more messages to the sender of the SIF_Sleep.
+    #@see SystemControl
+    class Sleep < SifElement; end
+
+    # This will signal the receiver that the sender is now able to process messages.
+    #@see SystemControl
+    class Wakeup < SifElement; end
+    
+    # This message tells the ZIS to return the first available message to the agent, subject to Selective Message Blocking.
+    #@see SystemControl
+    class GetMessage < SifElement; end
+    
+    # This message tells the ZIS to return the current SIF_ZoneStatus in a SIF_Ack.
+    #@see SystemControl
+    class GetZoneStatus < SifElement; end
+    
+    # This message tells the ZIS to return the Agent's ACL permissions in a SIF_Ack.
+    #@see SystemControl
+    class GetAgentACL < SifElement; end
+    
+    # The list of SIF_Requests to cancel
+    #@see CancelRequests
+    class RequestMsgIds < SifBody
+      element :request_msg_id
+    end
+    
+    # Asks a receiver (ZIS or Push-Mode Agent) to cancel the specified SIF_Requests, pending or in process
+    #@see SystemControl
+    class CancelRequests < SifBody 
+      element :notification_type
+      element :request_msg_ids
+    end
+    
+    
+    # Message designed to control the flow of data between an agent and ZIS or vice-versa.
+    class SystemControl < Message
+      element :system_control_data, :tag => "SIF_SystemControlData"
+      
+      class << self
+        
+        # Returns a SIF_Ping
+        def ping(source)
+          SystemControl.new(:header => source, :system_control_data => Ping.new)
+        end
+        
+        # Returns a SIF_Sleep
+        def sleep(source)
+          SystemControl.new(:header => source, :system_control_data => Sleep.new)
+        end
+        
+        # Returns a SIF_Wakeup
+        def wake_up(source)
+          SystemControl.new(:header => source, :system_control_data => Wakeup.new)
+        end
+        
+        # Returns a SIF_GetMessage
+        def get_message(source)
+          SystemControl.new(:header => source, :system_control_data => GetMessage.new)
+        end
+        
+        # Returns a SIF_GetZoneStatus
+        def get_zone_status(source)
+          SystemControl.new(:header => source, :system_control_data => GetZoneStatus.new)
+        end
+        
+        # Returns a SIF_GetAgentACL
+        def get_agent_acl(source)
+          SystemControl.new(:header => source, :system_control_data => GetAgentACL.new)
+        end
+        
+        # Returns a SIF_CancelRequest
+        def cancel_requests(source, notification, *ids)
+          cancel = CancelRequests.new(
+                  :notification_type => notification, 
+                  :request_msg_ids => RequestMsgIds.new(:request_msg_id => ids))
+          SystemControl.new(:header => source, :system_control_data => cancel)
+        end
+      end
+    end
+    
+  end
+end

data/lib/siffer/models.rb

@@ -0,0 +1 @@
+require 'siffer/models/address'

data/lib/siffer/models/address.rb

@@ -0,0 +1,39 @@
+module Siffer
+  module Models
+    class Street < AcDc::Body
+      element :line_1
+      element :line_2
+      element :line_3
+      element :complex
+      element :street_number
+      element :street_prefix
+      element :street_name
+      element :street_type
+      element :street_suffix
+      element :apartment_type
+      element :apartment_number_prefix
+      element :apartment_number
+      element :apartment_number_suffix
+    end
+
+    class GridLocation < AcDc::Body
+      element :longitude
+      element :latitude
+    end
+
+    class Address < AcDc::Body
+      attribute :type
+      element :street
+      element :city
+      element :county
+      element :state_province
+      element :country
+      element :postal_code
+      element :grid_location
+    end
+    
+    class AddressList < AcDc::Body
+      element :address
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: siffer
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors: 
 - Clint Hill
@@ -9,162 +9,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-25 00:00:00 -07:00
+date: 2009-11-23 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: uuid
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: rack
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hpricot
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: builder
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-description: 
+dependencies: []
+
+description: "    Siffer is a SIF that plans to remove the complexity from the implementation.\n    Siffer is SIF done easy. It's also the first entirely done in Ruby!\n"
 email: clint.hill@h3osoftware.com
-executables: 
-- siffer
+executables: []
+
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
-- LICENSE
-- README.rdoc
-- Rakefile
-- spec/agent_spec.rb
-- spec/cli_spec.rb
-- spec/container_spec.rb
-- spec/default_agent
-- spec/default_server
-- spec/message_specs
-- spec/message_specs/ack_spec.rb
-- spec/message_specs/error_spec.rb
-- spec/message_specs/header_spec.rb
-- spec/message_specs/message_spec.rb
-- spec/message_specs/register_spec.rb
-- spec/message_specs/request_body_spec.rb
-- spec/message_specs/status_spec.rb
-- spec/messaging_spec.rb
-- spec/protocol_spec.rb
-- spec/registration_spec.rb
-- spec/request_logger_spec.rb
-- spec/request_spec.rb
-- spec/response_spec.rb
-- spec/server_spec.rb
-- spec/spec_helper.rb
-- lib/siffer
 - lib/siffer/agent.rb
-- lib/siffer/container.rb
-- lib/siffer/messages
+- lib/siffer/core_ext/hash.rb
 - lib/siffer/messages/ack.rb
-- lib/siffer/messages/acl.rb
-- lib/siffer/messages/error.rb
+- lib/siffer/messages/event.rb
 - lib/siffer/messages/message.rb
+- lib/siffer/messages/provide.rb
+- lib/siffer/messages/provision.rb
 - lib/siffer/messages/register.rb
-- lib/siffer/messages/request_body.rb
-- lib/siffer/messages/status.rb
+- lib/siffer/messages/request.rb
+- lib/siffer/messages/response.rb
+- lib/siffer/messages/subscribe.rb
+- lib/siffer/messages/system_control.rb
 - lib/siffer/messages.rb
-- lib/siffer/messaging.rb
-- lib/siffer/protocol.rb
-- lib/siffer/registration.rb
-- lib/siffer/request.rb
-- lib/siffer/request_logger.rb
-- lib/siffer/response.rb
-- lib/siffer/server.rb
+- lib/siffer/models/address.rb
+- lib/siffer/models.rb
 - lib/siffer.rb
-- doc/rdoc
-- doc/rdoc/classes
-- doc/rdoc/classes/Siffer
-- doc/rdoc/classes/Siffer/Agent.html
-- doc/rdoc/classes/Siffer/Container.html
-- doc/rdoc/classes/Siffer/Messages
-- doc/rdoc/classes/Siffer/Messages/Ack.html
-- doc/rdoc/classes/Siffer/Messages/Acl.html
-- doc/rdoc/classes/Siffer/Messages/Error.html
-- doc/rdoc/classes/Siffer/Messages/Message
-- doc/rdoc/classes/Siffer/Messages/Message/Header.html
-- doc/rdoc/classes/Siffer/Messages/Message.html
-- doc/rdoc/classes/Siffer/Messages/Register.html
-- doc/rdoc/classes/Siffer/Messages/RequestBody.html
-- doc/rdoc/classes/Siffer/Messages/Status.html
-- doc/rdoc/classes/Siffer/Messages.html
-- doc/rdoc/classes/Siffer/Messaging.html
-- doc/rdoc/classes/Siffer/Protocol
-- doc/rdoc/classes/Siffer/Protocol/NonPostRequest.html
-- doc/rdoc/classes/Siffer/Protocol/UnknownPath.html
-- doc/rdoc/classes/Siffer/Protocol.html
-- doc/rdoc/classes/Siffer/Registration.html
-- doc/rdoc/classes/Siffer/Request.html
-- doc/rdoc/classes/Siffer/RequestLogger.html
-- doc/rdoc/classes/Siffer/Response.html
-- doc/rdoc/classes/Siffer/Server.html
-- doc/rdoc/classes/Siffer.html
-- doc/rdoc/created.rid
-- doc/rdoc/files
-- doc/rdoc/files/lib
-- doc/rdoc/files/lib/siffer
-- doc/rdoc/files/lib/siffer/agent_rb.html
-- doc/rdoc/files/lib/siffer/container_rb.html
-- doc/rdoc/files/lib/siffer/messages
-- doc/rdoc/files/lib/siffer/messages/ack_rb.html
-- doc/rdoc/files/lib/siffer/messages/acl_rb.html
-- doc/rdoc/files/lib/siffer/messages/error_rb.html
-- doc/rdoc/files/lib/siffer/messages/message_rb.html
-- doc/rdoc/files/lib/siffer/messages/register_rb.html
-- doc/rdoc/files/lib/siffer/messages/request_body_rb.html
-- doc/rdoc/files/lib/siffer/messages/status_rb.html
-- doc/rdoc/files/lib/siffer/messages_rb.html
-- doc/rdoc/files/lib/siffer/messaging_rb.html
-- doc/rdoc/files/lib/siffer/protocol_rb.html
-- doc/rdoc/files/lib/siffer/registration_rb.html
-- doc/rdoc/files/lib/siffer/request_logger_rb.html
-- doc/rdoc/files/lib/siffer/request_rb.html
-- doc/rdoc/files/lib/siffer/response_rb.html
-- doc/rdoc/files/lib/siffer/server_rb.html
-- doc/rdoc/files/lib/siffer_rb.html
-- doc/rdoc/files/LICENSE.html
-- doc/rdoc/files/README_rdoc.html
-- doc/rdoc/fr_class_index.html
-- doc/rdoc/fr_file_index.html
-- doc/rdoc/fr_method_index.html
-- doc/rdoc/index.html
-- doc/rdoc/rdoc-style.css
-- doc/SIF ImplementationSpecification.pdf
-has_rdoc: false
+- README
+- LICENSE
+has_rdoc: true
 homepage: http://h3osoftware.com/siffer
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -184,10 +63,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: siffer
-rubygems_version: 1.3.1
+rubyforge_project: 
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Siffer - School Interoperability Framework by h3o(software)
 test_files: []
 

data/README.rdoc

@@ -1,65 +0,0 @@
-= 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

@@ -1,64 +0,0 @@
-require 'rake'
-require 'rake/clean'                       
-require 'rake/gempackagetask'
-require 'hanna/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','lib/siffer']
-      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
-
-