skydb 0.2.0

data/lib/skydb/message.rb

@@ -0,0 +1,134 @@
+class SkyDB
+  class Message
+    ##########################################################################
+    #
+    # Constants
+    #
+    ##########################################################################
+
+    # The version of the message. This must be compatible with the server's
+    # version for the client to work.
+    VERSION = 1
+    
+
+    ##########################################################################
+    #
+    # Constructor
+    #
+    ##########################################################################
+
+    # Initializes the message.
+    def initialize(name)
+      @name = name
+      @table = ""
+    end
+    
+
+    ##########################################################################
+    #
+    # Attributes
+    #
+    ##########################################################################
+
+    ####################################
+    # Name
+    ####################################
+
+    # The name of message being sent. This is defined by the subclass.
+    attr_reader :name
+
+
+    ####################################
+    # Table
+    ####################################
+
+    # The name of the table the message is being sent to/from.
+    attr_accessor :table
+
+    def table=(value)
+      @table = value.to_s
+    end
+
+
+    ##########################################################################
+    #
+    # Methods
+    #
+    ##########################################################################
+
+    ####################################
+    # Validation
+    ####################################
+
+    # Validates that the message is ready to be sent. If any validation issues
+    # are found then an error is raised.
+    def validate!
+      if table.nil? || table.empty?
+        raise SkyDB::TableRequiredError.new('Table required')
+      end
+    end
+
+
+    ####################################
+    # Encoding
+    ####################################
+
+    # Encodes the message contents to a buffer.
+    #
+    # @param [IO] buffer  the buffer to write to.
+    def encode(buffer)
+      buffer.set_encoding(Encoding::BINARY, Encoding::BINARY)
+      
+      # Encode the header and body.
+      encode_header(buffer)
+      encode_body(buffer)
+      
+      return nil
+    end
+
+    # Encodes the message header.
+    #
+    # @param [IO] buffer  the buffer to write the header to.
+    def encode_header(buffer)
+      buffer << [
+        SkyDB::Message::VERSION,
+        name,
+        table
+        ].to_msgpack
+    end
+
+    # Encodes the message body.
+    #
+    # @param [IO] buffer  the buffer to write the header to.
+    def encode_body(buffer)
+      # To be implemented by the subclass.
+    end
+
+
+    ####################################
+    # Response processing
+    ####################################
+
+    # Performs any necessary post-processing on the response.
+    #
+    # @param [Object] response  
+    def process_response(response)
+      return response
+    end
+  end
+end
+
+require 'skydb/message/add_action'
+require 'skydb/message/get_action'
+require 'skydb/message/get_actions'
+
+require 'skydb/message/add_property'
+require 'skydb/message/get_property'
+require 'skydb/message/get_properties'
+
+require 'skydb/message/add_event'
+require 'skydb/message/next_actions'
+
+require 'skydb/message/lua/map_reduce'
+
+require 'skydb/message/multi'

data/lib/skydb/message/add_action.rb

@@ -0,0 +1,53 @@
+class SkyDB
+  class Message
+    class AddAction < SkyDB::Message
+      ########################################################################
+      #
+      # Constructor
+      #
+      ########################################################################
+
+      # Initializes the 'action add' message.
+      def initialize(action=nil, options={})
+        super('add_action')
+        self.action = action
+      end
+
+
+      ##########################################################################
+      #
+      # Attributes
+      #
+      ##########################################################################
+
+      ##################################
+      # Action
+      ##################################
+
+      # The action to add.
+      attr_reader :action
+      
+      def action=(value)
+        @action = value if value.is_a?(Action)
+      end
+
+
+      ##########################################################################
+      #
+      # Methods
+      #
+      ##########################################################################
+
+      ####################################
+      # Encoding
+      ####################################
+
+      # Encodes the message body.
+      #
+      # @param [IO] buffer  the buffer to write the header to.
+      def encode_body(buffer)
+        buffer << action.to_msgpack
+      end
+    end
+  end
+end

data/lib/skydb/message/add_event.rb

@@ -0,0 +1,72 @@
+class SkyDB
+  class Message
+    class AddEvent < SkyDB::Message
+      ########################################################################
+      #
+      # Constructor
+      #
+      ########################################################################
+
+      # Initializes the 'event add' message.
+      #
+      # @param [Event] event  the event to add.
+      def initialize(event=nil, options={})
+        super('add_event')
+        self.event = event
+      end
+
+
+      ##########################################################################
+      #
+      # Attributes
+      #
+      ##########################################################################
+
+      ##################################
+      # Event
+      ##################################
+
+      # The event to add.
+      attr_reader :event
+      
+      def event=(value)
+        @event = value if value.is_a?(Event)
+      end
+
+
+      ##########################################################################
+      #
+      # Methods
+      #
+      ##########################################################################
+
+      ####################################
+      # Validation
+      ####################################
+
+      def validate!
+        super
+        
+        if !(event.object_id > 0)
+          raise SkyDB::ObjectIdRequiredError.new('Object ID required')
+        end
+        
+        if event.timestamp.nil?
+          raise SkyDB::TimestampRequiredError.new('Timestamp required')
+        end
+      end
+
+
+      ####################################
+      # Encoding
+      ####################################
+
+      # Encodes the message body.
+      #
+      # @param [IO] buffer  the buffer to write the header to.
+      def encode_body(buffer)
+        buffer << event.to_msgpack
+      end
+    end
+  end
+end

data/lib/skydb/message/add_property.rb

@@ -0,0 +1,55 @@
+class SkyDB
+  class Message
+    class AddProperty < SkyDB::Message
+      ########################################################################
+      #
+      # Constructor
+      #
+      ########################################################################
+
+      # Initializes the 'property add' message.
+      #
+      # @param [Property] property  the property to add.
+      def initialize(property=nil, options={})
+        super('add_property')
+        self.property = property
+      end
+
+
+      ##########################################################################
+      #
+      # Attributes
+      #
+      ##########################################################################
+
+      ##################################
+      # Property
+      ##################################
+
+      # The property to add.
+      attr_reader :property
+      
+      def property=(value)
+        @property = value if value.is_a?(Property)
+      end
+
+
+      ##########################################################################
+      #
+      # Methods
+      #
+      ##########################################################################
+
+      ####################################
+      # Encoding
+      ####################################
+
+      # Encodes the message body.
+      #
+      # @param [IO] buffer  the buffer to write the header to.
+      def encode_body(buffer)
+        buffer << property.to_msgpack
+      end
+    end
+  end
+end

data/lib/skydb/message/get_action.rb

@@ -0,0 +1,55 @@
+class SkyDB
+  class Message
+    class GetAction < SkyDB::Message
+      ########################################################################
+      #
+      # Constructor
+      #
+      ########################################################################
+
+      # Initializes the 'action get' message.
+      #
+      # @param [Fixnum] action_id  the identifier of the action to retrieve.
+      def initialize(action_id=nil, options={})
+        super('get_action')
+        self.action_id = action_id
+      end
+
+
+      ##########################################################################
+      #
+      # Attributes
+      #
+      ##########################################################################
+
+      ##################################
+      # Action ID
+      ##################################
+
+      # The action identifier to retrieve.
+      attr_reader :action_id
+      
+      def action_id=(value)
+        @action_id = value.to_i
+      end
+
+
+      ##########################################################################
+      #
+      # Methods
+      #
+      ##########################################################################
+
+      ####################################
+      # Encoding
+      ####################################
+
+      # Encodes the message body.
+      #
+      # @param [IO] buffer  the buffer to write the header to.
+      def encode_body(buffer)
+        buffer << action_id.to_msgpack
+      end
+    end
+  end
+end

data/lib/skydb/message/get_actions.rb

@@ -0,0 +1,34 @@
+class SkyDB
+  class Message
+    class GetActions < SkyDB::Message
+      ########################################################################
+      #
+      # Constructor
+      #
+      ########################################################################
+
+      # Initializes the 'action all' message.
+      def initialize(options={})
+        super('get_actions')
+      end
+
+
+      ##########################################################################
+      #
+      # Methods
+      #
+      ##########################################################################
+
+      ####################################
+      # Encoding
+      ####################################
+
+      # Encodes the message body.
+      #
+      # @param [IO] buffer  the buffer to write the header to.
+      def encode_body(buffer)
+        # Do nothing.
+      end
+    end
+  end
+end

data/lib/skydb/message/get_properties.rb

@@ -0,0 +1,34 @@
+class SkyDB
+  class Message
+    class GetProperties < SkyDB::Message
+      ########################################################################
+      #
+      # Constructor
+      #
+      ########################################################################
+
+      # Initializes the 'property all' message.
+      def initialize(options={})
+        super('get_properties')
+      end
+
+
+      ##########################################################################
+      #
+      # Methods
+      #
+      ##########################################################################
+
+      ####################################
+      # Encoding
+      ####################################
+
+      # Encodes the message body.
+      #
+      # @param [IO] buffer  the buffer to write the header to.
+      def encode_body(buffer)
+        # Do nothing.
+      end
+    end
+  end
+end

data/lib/skydb/message/get_property.rb

@@ -0,0 +1,55 @@
+class SkyDB
+  class Message
+    class GetProperty < SkyDB::Message
+      ########################################################################
+      #
+      # Constructor
+      #
+      ########################################################################
+
+      # Initializes the 'property get' message.
+      #
+      # @param [Fixnum] property_id  The identifier for the property to retrieve.
+      def initialize(property_id=nil, options={})
+        super('get_property')
+        self.property_id = property_id
+      end
+
+
+      ##########################################################################
+      #
+      # Attributes
+      #
+      ##########################################################################
+
+      ##################################
+      # Property ID
+      ##################################
+
+      # The property identifier to retrieve.
+      attr_reader :property_id
+      
+      def property_id=(value)
+        @property_id = value.to_i
+      end
+
+
+      ##########################################################################
+      #
+      # Methods
+      #
+      ##########################################################################
+
+      ####################################
+      # Encoding
+      ####################################
+
+      # Encodes the message body.
+      #
+      # @param [IO] buffer  the buffer to write the header to.
+      def encode_body(buffer)
+        buffer << property_id.to_msgpack
+      end
+    end
+  end
+end