siffer 0.1.0 → 0.1.1

data/lib/siffer/messages/event.rb

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

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

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

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

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

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

data/lib/siffer/messages/response.rb

@@ -0,0 +1,48 @@
+module Siffer
+  module Messages
+    
+    MORE_PACKETS = {
+      :yes => "Yes",
+      :no => "No"
+    }
+    
+    # Provides element/attribute caption information for each column supplied in
+    # ExtendedQuery. The order must correspend to the order in the ExtendedQuery
+    #@see ExtendedQueryResults
+    #@see Element
+    class ColumnHeaders < SifBody
+      element :element
+    end
+    
+    class R < SifBody
+      element :c
+    end
+    
+    class Rows < SifBody
+      element :r
+    end
+    
+    # Element provides a wrapper for data returned in response to 
+    # an ExtendedQuery
+    #@see Response
+    #@see ReportObject
+    class ExtendedQueryResults < SifBody
+      element :column_headers
+      element :rows
+    end
+    
+    # Used to respond to a SIF_Request message.
+    # May span multiple SIF_Response messages.
+    #@see Error
+    #@see ExtendedQueryResults
+    class Response < Message
+      element :request_msg_id
+      element :packet_number
+      element :more_packets
+      element :error
+      element :object_data
+      element :extended_query_results
+    end
+    
+  end
+end

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