skydb 0.2.0

data/README.md

@@ -0,0 +1,4 @@
+sky.rb
+======
+
+The Ruby client for the Sky database.

data/lib/ext/string.rb

@@ -0,0 +1,11 @@
+class String
+  def to_hex
+    bytes.map do |ch|
+      if ch.chr.index(/^[a-z_]$/i)
+        ch.chr
+      else
+        '\x%02x' % ch
+      end
+    end.join('')
+  end
+end

data/lib/skydb.rb

@@ -0,0 +1,88 @@
+require 'date'
+require 'msgpack'
+require 'socket'
+
+require 'skydb/action'
+require 'skydb/client'
+require 'skydb/event'
+require 'skydb/message'
+require 'skydb/property'
+require 'skydb/timestamp'
+require 'skydb/version'
+
+require 'ext/string'
+
+class SkyDB
+  ############################################################################
+  #
+  # Errors
+  #
+  ############################################################################
+
+  class TableRequiredError < StandardError; end
+
+  class ObjectIdRequiredError < StandardError; end
+  class TimestampRequiredError < StandardError; end
+
+  ############################################################################
+  #
+  # Constants
+  #
+  ############################################################################
+
+  CLIENT_PASSTHROUGH = [
+    :host, :host=, :port, :port=,
+    :table, :table=,
+    :multi,
+    :add_event,
+    :add_action, :get_action, :get_actions,
+    :add_property, :get_property, :get_properties,
+    :next_actions,
+    :map_reduce
+  ]
+  
+  
+  ############################################################################
+  #
+  # Static Attributes
+  #
+  ############################################################################
+
+  ######################################
+  # Debugging
+  ######################################
+
+  class << self
+    attr_accessor :debug
+  end
+
+  ######################################
+  # Default Client
+  ######################################
+  
+  # The default Sky client.
+  def self.client
+    @client ||= SkyDB::Client.new()
+    return @client
+  end
+
+  def self.client=(value)
+    @client = value
+  end
+  
+
+  ############################################################################
+  #
+  # Static Methods
+  #
+  ############################################################################
+
+  def self.method_missing(method, *args, &block)
+    method = method
+    if CLIENT_PASSTHROUGH.include?(method.to_sym)
+      client.__send__(method.to_sym, *args, &block)
+    else
+      raise NoMethodError.new("Message type not available: #{method}")
+    end
+  end
+end

data/lib/skydb/action.rb

@@ -0,0 +1,57 @@
+class SkyDB
+  class Action
+    ##########################################################################
+    #
+    # Constructor
+    #
+    ##########################################################################
+
+    # Initializes the action.
+    def initialize(options={})
+      self.id = options[:id]
+      self.name = options[:name]
+    end
+    
+
+    ##########################################################################
+    #
+    # Attributes
+    #
+    ##########################################################################
+
+    ##################################
+    # ID
+    ##################################
+
+    # The action identifier.
+    attr_reader :id
+    
+    def id=(value)
+      @id = value.to_i
+    end
+
+
+    ##################################
+    # Name
+    ##################################
+
+    # The name of the action.
+    attr_reader :name
+    
+    def name=(value)
+      @name = value.to_s
+    end
+
+
+    ##########################################################################
+    #
+    # Methods
+    #
+    ##########################################################################
+    
+    # Encodes the action into MsgPack format.
+    def to_msgpack
+      return {id:id, name:name}.to_msgpack
+    end
+  end
+end

data/lib/skydb/client.rb

@@ -0,0 +1,216 @@
+class SkyDB
+  class Client
+    ##########################################################################
+    #
+    # Constants
+    #
+    ##########################################################################
+
+    # The default host to connect to if one is not specified.
+    DEFAULT_HOST = 'localhost'
+
+    # The default port to connect to if one is not specified.
+    DEFAULT_PORT = 8585
+
+
+    ##########################################################################
+    #
+    # Constructor
+    #
+    ##########################################################################
+
+    # Initializes the client.
+    def initialize(options={})
+      self.host = options[:host] || DEFAULT_HOST
+      self.port = options[:port] || DEFAULT_PORT
+    end
+
+
+    ##########################################################################
+    #
+    # Attributes
+    #
+    ##########################################################################
+
+    # The name of the host to conect to.
+    attr_accessor :host
+
+    # The port on the host to connect to.
+    attr_accessor :port
+
+    # The table to connect to.
+    attr_accessor :table
+
+
+    ##########################################################################
+    #
+    # Methods
+    #
+    ##########################################################################
+    
+    ####################################
+    # Action Messages
+    ####################################
+
+    # Adds an action to the server.
+    #
+    # @param [Action] action  the action to add.
+    def add_action(action, options={})
+      return send_message(SkyDB::Message::AddAction.new(action, options))
+    end
+
+    # Retrieves an individual action from the server.
+    #
+    # @param [Fixnum] action_id  the identifier of the action to retrieve.
+    def get_action(action_id, options={})
+      return send_message(SkyDB::Message::GetAction.new(action_id, options))
+    end
+
+    # Retrieves a list of all actions from the server.
+    def get_actions(options={})
+      return send_message(SkyDB::Message::GetActions.new(options))
+    end
+
+
+    ####################################
+    # Property Messages
+    ####################################
+
+    # Adds a property to the server.
+    #
+    # @param [Property] property  the property to add.
+    def add_property(property, options={})
+      return send_message(SkyDB::Message::AddProperty.new(property, options))
+    end
+
+    # Retrieves an individual property from the server.
+    #
+    # @param [Fixnum] property_id  the identifier of the property to retrieve.
+    def get_property(property_id, options={})
+      return send_message(SkyDB::Message::GetProperty.new(property_id, options))
+    end
+
+    # Retrieves a list of all properties from the server.
+    def get_properties(options={})
+      return send_message(SkyDB::Message::GetProperties.new(options))
+    end
+
+
+    ####################################
+    # Event Messages
+    ####################################
+
+    # Adds an event to the server.
+    #
+    # @param [Event] event  the event to add.
+    def add_event(event, options={})
+      return send_message(SkyDB::Message::AddEvent.new(event, options))
+    end
+
+
+    ####################################
+    # Path Messages
+    ####################################
+
+    # Finds a count of the action that occurs immediately after a set of
+    # actions.
+    #
+    # @param [Array] prior_action_ids  the prior action ids to match on.
+    def next_actions(prior_action_ids, options={})
+      return send_message(SkyDB::Message::NextActions.new(prior_action_ids, options))
+    end
+
+
+    ####################################
+    # Lua Messages
+    ####################################
+
+    # Executes a Lua map/reduce job on the server and returns the results.
+    #
+    # @param [String] source  the Lua source code to execute
+    def map_reduce(source, options={})
+      return send_message(SkyDB::Message::Lua::MapReduce.new(source, options))
+    end
+
+
+    ####################################
+    # Multi message
+    ####################################
+
+    # Executes multiple messages in one call.
+    def multi(options={})
+      raise "Already in a multi-message block" unless @multi_message.nil?
+      
+      # Create multi-message.
+      @multi_message = SkyDB::Message::Multi.new(options)
+      
+      # Execute the block normally and send the message.
+      begin
+        yield
+        
+        # Clear multi message so it doesn't add to itself.
+        tmp = @multi_message
+        @multi_message = nil
+        
+        # Send all messages at once.
+        send_message(tmp)
+
+      ensure
+        @multi_message = nil
+      end
+      
+      return nil
+    end
+    
+
+    ####################################
+    # Send
+    ####################################
+
+    # Sends a message to the server.
+    #
+    # @param [SkyDB::Message] message  the message to send.
+    # @return [Object]  the object returned by the server.
+    def send_message(message)
+      # Set the table if they're not set.
+      message.table = table if message.table.nil? || message.table.empty?
+
+      # Validate message before sending.
+      message.validate!
+      
+      # If this is part of a multi message then simply append the message for
+      # later sending.
+      if !@multi_message.nil?
+        @multi_message.messages << message
+        return nil
+      
+      # Otherwise send the message immediately.
+      else
+        # Connect to the server.
+        socket = TCPSocket.new(host, port.to_i)
+      
+        # Encode and send message request.
+        message.encode(socket)
+      
+        # Decode msgpack response. There should only be one return object.
+        response = nil
+        unpacker = MessagePack::Unpacker.new(socket)
+        unpacker.each do |obj|
+          response = obj
+          break
+        end
+      
+        # Close socket.
+        socket.close()
+      
+        # TODO: Exception processing.
+      
+        # Process response back through the message.
+        response = message.process_response(response)
+      
+        # Return response.
+        return response
+      end
+    end
+  end
+end

data/lib/skydb/event.rb

@@ -0,0 +1,114 @@
+class SkyDB
+  class Event
+    ##########################################################################
+    #
+    # Constructor
+    #
+    ##########################################################################
+
+    # Initializes an event object.
+    def initialize(options={})
+      self.object_id = options[:object_id]
+      self.timestamp = options[:timestamp]
+      self.action = options[:action]
+      self.data = options[:data]
+    end
+
+
+    ##########################################################################
+    #
+    # Attributes
+    #
+    ##########################################################################
+
+    ##################################
+    # Object ID
+    ##################################
+
+    # The numeric identifier of the object that the event is attached to.
+    attr_reader :object_id
+    
+    def object_id=(value)
+      @object_id = value.to_i
+    end
+
+    ##################################
+    # Timestamp
+    ##################################
+
+    # The timestamp of when the event occurred.
+    attr_reader :timestamp
+    
+    def timestamp=(value)
+      @timestamp = value.to_time if value.class.method_defined?(:to_time)
+    end
+
+    ##################################
+    # Action
+    ##################################
+
+    # The hash containing action related information (including the name of
+    # the action being performed).
+    attr_reader :action
+    
+    def action=(value)
+      clone = {}
+
+      # Copy over keys
+      if !value.nil?
+        value.each_pair do |k, v|
+          # Only copy keys with valid value types.
+          if v.is_a?(String) || v.is_a?(Fixnum) || v.is_a?(Float) || v == true || v == false
+            clone[k] = value[k]
+          end
+        end
+      end
+
+      # Only set the data if we have keys.
+      @action = clone.keys.length > 0 ? clone : nil
+    end
+
+    ##################################
+    # Data
+    ##################################
+
+    # A hash of data properties to set on the event. Properties can only be
+    # a String, Fixnum, Float or Boolean.
+    attr_reader :data
+    
+    def data=(value)
+      clone = {}
+
+      # Copy over keys
+      if !value.nil?
+        value.each_pair do |k, v|
+          # Only copy keys with valid value types.
+          if v.is_a?(String) || v.is_a?(Fixnum) || v.is_a?(Float) || v == true || v == false
+            clone[k] = value[k]
+          end
+        end
+      end
+
+      # Only set the data if we have keys.
+      @data = clone.keys.length > 0 ? clone : nil
+    end
+
+
+    ##########################################################################
+    #
+    # Methods
+    #
+    ##########################################################################
+    
+    # Encodes the event into MsgPack format.
+    def to_msgpack
+      obj = {
+        :objectId => object_id,
+        :timestamp => SkyDB::Timestamp.to_timestamp(timestamp)
+      }
+      obj[:action] = action unless action.nil? || action.empty?
+      obj[:data] = data unless data.nil? || data.empty?
+      return obj.to_msgpack
+    end
+  end
+end