siffer 0.0.7 → 0.1.0

data/lib/sif/code_sets/provision_error_codes.rb

@@ -0,0 +1,8 @@
+module Siffer
+  module CodeSets
+    class ProvisionErrorCode < BaseCodeSet; end
+    ProvisionErrorCode.register(1,:generic,"Generic error")
+    ProvisionErrorCode.register(3,:invalid_object,"Invalid object")
+    ProvisionErrorCode.register(4,:duplicate,"Object already has a provider (SIF_Provide message)")
+  end
+end

data/lib/sif/code_sets/registration_error_codes.rb

@@ -0,0 +1,13 @@
+module Siffer
+  module CodeSets
+    class RegistrationErrorCode < BaseCodeSet; end
+    RegistrationErrorCode.register(1,:generic,"Generic error")
+    RegistrationErrorCode.register(2,:source_invalid,"The SIF_SourceId is invalid")
+    RegistrationErrorCode.register(3,:protocol_not_supported,"Requested transport protocol is unsupported")
+    RegistrationErrorCode.register(4,:version_not_supported,"Requested SIF_Version(s) not supporrted")
+    RegistrationErrorCode.register(6,:max_buffer_size_too_small,"Requested SIF_MaxBufferSize is too small")
+    RegistrationErrorCode.register(7,:requires_secure_transport,"ZIS requires a secure transport")
+    RegistrationErrorCode.register(9,:registered_for_push_mode,"Agent is registered for push mode (returned when a push-mode agent sends a SIF_GetMessage)")
+    RegistrationErrorCode.register(10,:encoding_not_supported,"ZIS does not support the requested Accept-Encoding value")
+  end
+end

data/lib/sif/code_sets/request_response_error_codes.rb

@@ -0,0 +1,20 @@
+module Siffer
+  module CodeSets
+    class RequestResponseErrorCode < BaseCodeSet; end
+    RequestResponseErrorCode.register(1,:generic,"Generic error")
+    RequestResponseErrorCode.register(3,:invalid_object,"Invalid Object")
+    RequestResponseErrorCode.register(4,:no_provider,"No provider")
+    RequestResponseErrorCode.register(7,:version_not_supported,"Responder does not support requested SIF_Version")
+    RequestResponseErrorCode.register(8,:buffer_size_not_supported,"Responder does not support requested SIF_MaxBufferSize")
+    RequestResponseErrorCode.register(9,:unsupported_query,"Unsupported query in request")
+    RequestResponseErrorCode.register(10,:invalid_msg_id,"Invalid SIF_RequestMsgId specified in SIF_Response")
+    RequestResponseErrorCode.register(11,:response_larger_than_buffer,"SIF_Response is larger than requested SIF_MaxBufferSize")
+    RequestResponseErrorCode.register(12,:invalid_packet_number,"SIF_PacketNumber is invalid in SIF_Response")
+    RequestResponseErrorCode.register(13,:response_does_not_match_version,"SIF_Response does not match any SIF_Version from SIF_Request")
+    RequestResponseErrorCode.register(14,:destination_does_not_match_source,"SIF_DestinationId does not match SIF_SourceId from SIF_Request")
+    RequestResponseErrorCode.register(15,:extended_query_not_supported,"No support for SIF_ExtendedQuery")
+    RequestResponseErrorCode.register(16,:deleted_due_to_timeout,"SIF_RequestMsgId deleted from cache due to timeout")
+    RequestResponseErrorCode.register(17,:deleted_by_administrator,"SIF_RequestMsgId deleted from cache by administrator")
+    RequestResponseErrorCode.register(18,:cancelled_by_agent,"SIF_Request cancelled by requesting agent")
+  end
+end

data/lib/sif/code_sets/smb_error_codes.rb

@@ -0,0 +1,9 @@
+module Siffer
+  module CodeSets
+    class SMBErrorCode < BaseCodeSet; end
+    SMBErrorCode.register(1,:generic,"Generic error")
+    SMBErrorCode.register(2,:invocation,"SMB can only be invoked during a SIF_Event acknowledgement")
+    SMBErrorCode.register(3,:final_expected,"Final SIF_Ack expected from Push-Mode Agent")
+    SMBErrorCode.register(4,:incorrect_msgid,"Incorrect SIF_MsgId in final SIF_Ack")
+  end
+end

data/lib/sif/code_sets/status_codes.rb

@@ -0,0 +1,13 @@
+module Siffer
+  module CodeSets
+    class StatusCode < BaseCodeSet; end
+    StatusCode.register(0,:success,"Success (ZIS ONLY). SIF_Status/SIF_Data may contain additional data.")
+    StatusCode.register(1,:immediate,"Immediate SIF_Ack (AGENT ONLY). Message is persisted or processing is complete. Discard the referenced message.")
+    StatusCode.register(2,:intermediate,"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.")
+    StatusCode.register(3,:final,"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.")
+    StatusCode.register(7,:duplicate,"Already have a message with this SIF_MsgId from you.")
+    StatusCode.register(8,:sleeping,"Receiver is sleeping.")
+    StatusCode.register(9,:not_available,"No messages available. This is returned when an agent is trying to pull messages from a ZIS and there are no messages available.")
+  end
+end
+   

data/lib/sif/code_sets/subscription_error_codes.rb

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

data/lib/sif/code_sets/system_error_codes.rb

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

data/lib/sif/code_sets/transport_error_codes.rb

@@ -0,0 +1,9 @@
+module Siffer
+  module CodeSets
+    class TransportErrorCode < BaseCodeSet; end
+    TransportErrorCode.register(1,:generic,"Generic error")
+    TransportErrorCode.register(2,:protocol_not_supported,"Requested protocol is not supported")
+    TransportErrorCode.register(3,:secure_path_missing,"Secure channel requested and no secure path exists")
+    TransportErrorCode.register(4,:no_connection,"Unable to establish connection")
+  end
+end

data/lib/sif/code_sets/xml_validation_error_codes.rb

@@ -0,0 +1,10 @@
+module Siffer
+  module CodeSets
+    class XmlValidationErrorCode < BaseCodeSet; end
+    XmlValidationErrorCode.register(1,:generic,"Generic error")
+    XmlValidationErrorCode.register(2,:not_well_formed,"Message is not well formed")
+    XmlValidationErrorCode.register(3,:validation,"Generic validation error")
+    XmlValidationErrorCode.register(4,:invalid_value,"Invalid value for element/attribute")
+    XmlValidationErrorCode.register(6,:missing,"Missing mandatory element/attribute")
+  end
+end

data/lib/sif/config.rb

@@ -0,0 +1,100 @@
+require 'yaml'
+
+module Siffer
+    class Config
+      
+      class << self
+        
+        # ==== Returns
+        # Hash:: The defaults for the config.
+        def defaults
+          @defaults ||= {
+            :host                   => "0.0.0.0",
+            :port                   => "4000",
+            :environment            => "development",
+            :sif_root              => Dir.pwd,
+            :session_id_key         => "_session_id",
+          }
+        end
+        
+        # Yields the configuration.
+        #
+        # ==== Block parameters
+        # c<Hash>:: The configuration parameters.
+        #
+        # ==== Examples
+        #   H3O::SIF::Config.use do |config|
+        #     config[:port] = 3100
+        #   end
+        def use
+          @configuration ||= {}
+          yield @configuration
+        end
+        
+        # ==== Parameters
+        # key<Object>:: The key to check.
+        #
+        # ==== Returns
+        # Boolean:: True if the key exists in the config.
+        def key?(key)
+          @configuration.key?(key)
+        end
+
+        # ==== Parameters
+        # key<Object>:: The key to retrieve the parameter for.
+        #
+        # ==== Returns
+        # Object:: The value of the configuration parameter.
+        def [](key)
+          (@configuration||={})[key]
+        end
+
+        # ==== Parameters
+        # key<Object>:: The key to set the parameter for.
+        # val<Object>:: The value of the parameter.
+        def []=(key,val)
+          @configuration[key] = val
+        end
+
+        # ==== Parameters
+        # key<Object>:: The key of the parameter to delete.
+        def delete(key)
+          @configuration.delete(key)
+        end
+
+        # ==== Parameters
+        # key<Object>:: The key to retrieve the parameter for.
+        # default<Object>::
+        #   The default value to return if the parameter is not set.
+        #
+        # ==== Returns
+        # Object:: The value of the configuration parameter or the default.
+        def fetch(key, default)
+          @configuration.fetch(key, default)
+        end
+
+        # ==== Returns
+        # Hash:: The config as a hash.
+        def to_hash
+          @configuration
+        end
+
+        # ==== Returns
+        # String:: The config as YAML.
+        def to_yaml
+          @configuration.to_yaml
+        end
+
+        # Sets up the configuration by storing the given settings.
+        #
+        # ==== Parameters
+        # settings<Hash>::
+        #   Configuration settings to use. These are merged with the defaults.
+        def setup(settings = {})
+          @configuration = defaults.merge(settings)
+        end
+      end
+      
+    end
+
+end

data/lib/sif/core_ext/array.rb

@@ -0,0 +1,12 @@
+module Siffer
+  module CoreExtensions
+    module Array
+      module ExtractOptions
+        # Politely stolen from ActiveSupport
+        def extract_options!
+          last.is_a?(::Hash) ? pop : {}
+        end
+      end
+    end
+  end
+end

data/lib/sif/error.rb

@@ -0,0 +1,34 @@
+module Siffer
+  class Error
+    
+    attr_reader :category, :code, :desc, :extended_desc
+    
+    def initialize(category, code, extended_desc = nil)
+      @code = case category
+          when :xml_validation then CodeSets::XmlValidationErrorCode[code]
+          when :encryption then CodeSets::EncryptionErrorCode[code]
+          when :authentication then CodeSets::AuthenticationErrorCode[code]
+          when :access_and_permissions then CodeSets::AccessPermissionErrorCode[code]
+          when :registration then CodeSets::RegistrationErrorCode[code]
+          when :provision then CodeSets::ProvisionErrorCode[code]
+          when :subscription then CodeSets::SubscriptionErrorCode[code]
+          when :request_and_response then CodeSets::RequestResponseErrorCode[code]
+          when :event_reporting_and_processing then CodeSets::EventReportingProcessingErrorCode[code]
+          when :transport then CodeSets::TransportErrorCode[code]
+          when :system then CodeSets::SystemErrorCode[code]
+          when :generic_message_handling then CodeSets::GenericMessageHandlingErrorCode[code]
+          when :smb_handling then CodeSets::SMBErrorCode[code]
+          else raise Exceptions::InvalidErrorCategory, "Invalid Error Category provided."
+      end
+      @category = CodeSets::ErrorCategoryCode[category]
+      @desc = @code.description
+      @extended_desc = extended_desc unless extended_desc.nil?
+    end
+    
+    def to_s
+        "#{@category}: #{@desc}"
+    end
+    
+    
+  end
+end

data/lib/sif/exceptions.rb

@@ -0,0 +1,9 @@
+module Siffer
+  module Exceptions
+    class MissingSource < Exception; end
+    class MissingUrl < Exception; end
+    class NoProtocol < Exception; end
+    class InvalidErrorCategory < Exception; end
+    class InvalidErrorCode < Exception; end
+  end
+end

data/lib/sif/messages.rb

@@ -0,0 +1,3 @@
+require 'sif/messages/message'
+require 'sif/messages/ack'
+require 'sif/messages/register'

data/lib/sif/messages/ack.rb

@@ -0,0 +1,29 @@
+module Siffer
+  module Messages
+  
+    class Ack < Message
+  
+      attr_reader :original_source_id, :original_message_id, :status, :error
+    
+      # source:: source id of this message
+      # original_source_id:: the source id of the message being acknowledged
+      # original_message_id:: the message id of the message being acknowledged
+      # status:: the status of the acknowledgement
+      # error:: the error that occured
+      def initialize(source, *args)
+        super(source)
+        @options = args.extract_options!
+        @original_source_id = @options[:original_source_id]
+        @original_message_id = @options[:original_message_id]
+        @status = @options[:status] unless @options[:status].nil?
+        @error = @options[:error] unless @options[:error].nil?
+      end
+          
+      def error?
+          !@error.nil?
+      end
+
+    end
+  
+  end
+end

data/lib/sif/messages/message.rb

@@ -0,0 +1,32 @@
+module Siffer
+  module Messages
+    # Base class for all Messages in the framework.
+    class Message
+    
+      attr_reader :xmlns, :version, :header
+    
+      def initialize(source)
+        raise MissingSource, "Source not provided." if source.nil?
+        @xmlns = Siffer.sif_xmlns
+        @version = Siffer.sif_version
+        @header = Header.new(source)
+      end
+    
+      # Each Message requires a Header to identify the source and time as well 
+      # as provide an ID for the message itself.
+      class Header
+      
+        attr_reader :timestamp, :msg_id, :source_id
+      
+        def initialize(source)
+          raise MissingSource, "Source not provided." if source.nil?
+          @timestamp = Time.now
+          @msg_id = UUID.generate(:compact).upcase
+          @source_id = source
+        end
+      
+      end
+  
+    end
+  end
+end

data/lib/sif/messages/register.rb

@@ -0,0 +1,38 @@
+module Siffer
+  module Messages
+     class Register < Message
+  
+      attr_reader :max_buffer_size, :name, :mode, :protocol, :application, :icon, :version, :node_vendor, :node_version
+  
+      def initialize(source, *args)
+        super(source)
+        @options = args.extract_options!
+        @name = @options[:name]
+        @mode = @options[:mode] ||= "Pull"
+        raise NoProtocol, "Protocol not provided." if @mode == "Push" and @options[:protocol].nil?
+        @protocol = @options[:protocol]
+        @max_buffer_size = @options[:max_buffer_size] ||= 524288
+        @application = Application.new(@options[:application]) unless @options[:application].nil?
+        @icon = @options[:icon] unless @options[:icon].nil?
+        # This is the SIF version of messages that the Agent is capable of receiving/sending
+        # as opposed to the Message#version which is the version of h3o SIF implemented.
+        @version = @options[:version] ||= "2.*"
+        @node_vendor = Siffer::VENDOR
+        # The version of the registering Agent is the version of the SIF framework. This should always coordinate.
+        @node_version = Siffer::VERSION
+      end
+  
+      # internal class used to model the application this registering Agent supports/represents
+      class Application
+    
+          attr_reader :vendor, :product, :version
+      
+          def initialize(options)
+            @vendor, @product, @version = options[:vendor], options[:product], options[:version]
+          end
+      
+      end
+  
+    end
+  end
+end

data/lib/sif/protocols.rb

@@ -0,0 +1,15 @@
+module Siffer
+  module Protocols
+      class Protocol
+      
+        attr_reader :url, :properties
+      
+        def initialize(url,*properties)
+          raise MissingUrl, "Url not provided." if url.nil?
+          @url = url
+          @properties = properties.extract_options!
+        end
+      
+      end
+  end
+end

data/lib/sif/status.rb

@@ -0,0 +1,17 @@
+module Siffer
+  class Status
+    
+    attr_reader :code, :description, :data
+    
+    def initialize(code, data = nil)
+      @code = H3O::SIF::CodeSets::StatusCode[code]
+      @description = @code.description
+      @data = data unless data.nil?
+    end
+    
+    def ==(object)
+      return @code == object
+    end
+    
+  end
+end

data/lib/siffer.rb

@@ -1,41 +1 @@
-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,0,7] 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"
+require 'sif'