siffer 0.0.7 → 0.1.0

data/lib/siffer/messages.rb

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

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

data/lib/siffer/messages/event.rb

@@ -1,20 +0,0 @@
-module Siffer
-  module Messages
-    
-    # Message for SIF_Event, used to deliver objects defined in SIF. 
-    # Events represent the availability of new data object, changes to
-    # or deletions of data object
-    #@see EventObject
-    class Event < Message
-      element :object_data
-    end
-    
-    # Message Element that holds the data object that is add/change/delete
-    #@see Event
-    class EventObject < AcDc::Body
-      attribute :object_name
-      attribute :action
-    end
-    
-  end
-end

data/lib/siffer/messages/message.rb

@@ -1,60 +0,0 @@
-module Siffer
-  module Messages
-             
-    # Security Element for the Header Element 
-    #@see Header
-    class Security < SifBody
-      element :secure_channel
-    end
-    
-    # SecureChannel Element for the Security Element
-    #@see Security
-    class SecureChannel < SifBody
-      element :encryption_level
-      element :authentication_level
-    end
-    
-    # List of Contexts for the Message
-    class Contexts < SifBody
-      element :context
-    end
-    
-    # Header for all SIF_Message types
-    #@see Message
-    class Header < SifBody
-      element :msg_id, :tag => "SIF_MsgId"
-      element :timestamp, :tag => "SIF_Timestamp"
-      element :security, :tag => "SIF_security"
-      element :source_id, :tag => "SIF_SourceId", :required => true
-      element :destination_id, :tag => "SIF_DestinationId"
-      element :contexts, :tag => "SIF_Contexts"
-      
-      def initialize(values = {})
-        values.update(:msg_id => UUID.generate(:compact).upcase) unless values.has_key?(:msg_id)
-        values.update(:timestamp => Time.now.strftime("%Y-%m-%dT%H:%M:%SZ")) unless values.has_key?(:timestamp)
-        super(values)
-      end
-      
-    end
-    
-    # Base Message for all SIF_Message types
-    class Message < SifBody
-      element :header, Header
-      
-      def initialize(values={})
-        values.update(:header => Header.new(:source_id => values[:header])) unless values[:header].nil?
-        super(values)
-      end
-      
-      alias_method :old_acdc, :acdc
-      def acdc
-        xml = Builder::XmlMarkup.new
-        attrs = { :Version => Siffer.sif_version, :xmlns => Siffer.sif_xmlns }
-        xml.tag!("SIF_Message", attrs){|body| body << old_acdc} 
-        xml.target!
-      end
-
-    end
-
-  end
-end

data/lib/siffer/messages/provide.rb

@@ -1,25 +0,0 @@
-module Siffer
-  module Messages
-    
-    # Element used by SIF_Provide to represent the object being provided
-    #@see Provide
-    class Object < SifBody
-      attribute :object_name
-      element :extended_query_support
-      element :contexts
-    end
-    
-    # Message used to attempt registering as a provider of one or more data objects
-    #@see Object
-    class Provide < Message
-      element :object
-    end
-    
-    # This message performs the opposite function of SIF_Provide.
-    #@see Object
-    class UnProvide < Message
-      element :object
-    end
-    
-  end
-end

data/lib/siffer/messages/provision.rb

@@ -1,17 +0,0 @@
-module Siffer
-  module Messages
-    
-    # This message allows an agent to announce to the ZIS the functionality the agent will provide.
-    #@see Object
-    class Provision < Message
-      element :provide_objects
-      element :subscribe_objects
-      element :publish_add_objects
-      element :publish_change_objects
-      element :publish_delete_objects
-      element :request_objects
-      element :respond_objects
-    end
-    
-  end
-end

data/lib/siffer/messages/register.rb

@@ -1,50 +0,0 @@
-module Siffer
-  module Messages
-    
-    # Used by Protocol to describe the protocol used by the agent
-    DEFINED_PROTOCOLS_TYPE = {
-      :http => "HTTP",
-      :https => "HTTPS"
-    }
-        
-    # Used by Protocl to describe any protocol settings
-    class Property < SifBody
-      element :name
-      element :value
-    end
-    
-    # Contains protocol information regarding a ZIS or Agent.
-    class Protocol < SifBody
-      attribute :type, DEFINED_PROTOCOLS_TYPE[:https]
-      attribute :secure, true
-      element :url
-      element :property
-    end
-    
-    # Contains information about the vendor of the product that the agent represents
-    class Application < SifBody
-      element :vendor
-      element :product
-      element :version
-    end
-    
-    # Register is a message for registering an agent with a ZIS. 
-    # An agent must be registered before it sends out messages.
-    class Register < Message
-      element :name
-      element :version
-      element :max_buffer_size
-      element :mode
-      element :protocol
-      element :node_vendor
-      element :node_version
-      element :application
-      element :icon
-    end
-    
-    # This message allows an agent to remove any association it has with the ZIS.
-    #@see Register
-    class Unregister < Message; end
-    
-  end
-end

data/lib/siffer/messages/request.rb

@@ -1,138 +0,0 @@
-module Siffer
-  module Messages
-    
-    CONDITION_GROUP_TYPES = {
-      :and => "And",
-      :or => "Or",
-      :none => "None"
-    }
-    
-    OPERATORS = {
-      :equals => "EQ",
-      :less_than => "LT",
-      :greater_than => "GT",
-      :less_than_or_equals => "LE",
-      :greater_than_or_equals => "GE",
-      :not_equals => "NE"
-    }
-    
-    ORDERING = {
-      :asc => "Ascending",
-      :des => "Descending"
-    }
-    
-    # Represents a condition used in a Query
-    #@see Conditions
-    class Condition < SifBody
-      element :element
-      element :operator
-      element :value
-    end
-    
-    # List of Conditions
-    #@see ConditionGroup
-    class Conditions < SifBody
-      attribute :type, CONDITION_GROUP_TYPES[:none]
-      element :condition
-    end
-    
-    # Represents a group conditions that the queried objects must meet.
-    # If conditions are not specified all objects named are returned
-    class ConditionGroup < SifBody
-      attribute :type, CONDITION_GROUP_TYPES[:none]
-      element :conditions
-    end
-    
-    # The object that is being queried for
-    class QueryObject < SifBody
-      attribute :object_name
-      element :element
-    end
-    
-    # SIF's default query mechanism
-    class Query < SifBody
-      element :query_object
-      element :condition_group
-      element :example
-    end
-    
-    # Element used in Select to identify the element/attribute
-    #@see Select
-    #@see Condition
-    #@see OrderBy
-    #@see QueryObject
-    class Element < SifBody
-      attribute :alias
-      attribute :object_name
-      attribute :ordering, ORDERING[:asc]
-      attribute :xsi_type # need to work this out , it should be xsi:type
-    end
-    
-    # Identifies elements to be returned as columns in a query
-    #@see ExtendedQuery
-    class Select < SifBody
-      attribute :distinct, false
-      attribute :row_count, 0 # This represents a number, 0 for all rows
-      element :element
-    end
-    
-    # Specifies left join on which to constrain the join
-    #@see JoinOn
-    class LeftElement < SifBody
-      attribute :object_name
-    end
-    
-    # Specifies right join on which to constrain the join
-    #@see JoinOn
-    class RightElement < SifBody
-      attribute :object_name
-    end
-    
-    # Specifies conditions to limit/filter rows
-    #@see ExtendedQuery
-    class Where < SifBody
-      element :condition_group
-    end
-    
-    # Optional list of elements/attributes by which to sort the resulting rows
-    #@see ExtendedQuery
-    class OrderBy < SifBody
-      element :element
-    end
-    
-    # Specifies conditions for the join
-    #@see From
-    class JoinOn < SifBody
-      element :left_element
-      element :right_element
-    end
-    
-    # Join specification for the query if more than one object is being queried
-    #@see ExtendedQuery
-    class From < SifBody
-      attribute :object_name
-      element :join
-    end
-    
-    # A more advanced form of Query that allows for joins and retrieval of data
-    # in row/column form.
-    class ExtendedQuery < SifBody
-      element :destination_provider
-      element :select
-      element :from
-      element :where
-      element :order_by
-    end
-    
-    # Message used to request information in SIF data objects from other SIF nodes.
-    #@see Query
-    #@see ExtendedQuery
-    class Request < Message
-      element :version
-      element :max_buffer_size
-      element :query
-      element :extended_query
-    end
-    
-  end
-end