skydb 0.2.3 → 0.3.0

data/lib/skydb/event.rb

@@ -6,14 +6,12 @@ class SkyDB
     #
     ##########################################################################
 
-    # Initializes an event object.
+    # Initializes the event.
     def initialize(options={})
-      self.object_id = options[:object_id]
-      self.timestamp = options[:timestamp]
-      self.action = options[:action]
-      self.data = options[:data]
+      self.timestamp = options[:timestamp] || DateTime.now
+      self.data = options[:data] || {}
     end
-
+    
 
     ##########################################################################
     #
@@ -21,90 +19,63 @@ class SkyDB
     #
     ##########################################################################
 
-    ##################################
-    # Object ID
-    ##################################
+    # The moment the event occurred.
+    attr_accessor :timestamp
 
-    # The object identifier.
-    attr_accessor :object_id
-
-    ##################################
-    # Timestamp
-    ##################################
+    # The data associated with the event.
+    attr_accessor :data
 
-    # The timestamp of when the event occurred.
-    attr_reader :timestamp
-    
-    def timestamp=(value)
-      @timestamp = value.to_time if value.class.method_defined?(:to_time)
+    # The timestamp as ISO8601 formatted string with fractional seconds.
+    def formatted_timestamp()
+      return SkyDB.format_timestamp(timestamp)
     end
 
-    ##################################
-    # Action
-    ##################################
 
-    # The hash containing action related information (including the name of
-    # the action being performed).
-    attr_reader :action
-    
-    def action=(value)
-      clone = {}
+    ##########################################################################
+    #
+    # Methods
+    #
+    ##########################################################################
 
-      # 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
+    ####################################
+    # Encoding
+    ####################################
 
-      # Only set the data if we have keys.
-      @action = clone.keys.length > 0 ? clone : nil
+    # Encodes the event into a hash.
+    def to_hash(*a)
+      {
+        'timestamp' => formatted_timestamp,
+        'data' => data
+      }
     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
+    # Decodes a hash into a event.
+    def from_hash(hash, *a)
+      self.timestamp = !hash.nil? ? parse_timestamp(hash['timestamp']) : Time.now.utc.to_datetime()
+      self.data = !hash.nil? ? hash['data'] : {}
+      return self
     end
 
+    def as_json(*a); return to_hash(*a); end
+    def to_json(*a); return as_json(*a).to_json; end
 
-    ##########################################################################
+    ####################################
+    # Timestamp
+    ####################################
+    
+    # Parses an ISO8601 date string with fractional seconds.
     #
-    # Methods
+    # @param [String] str  The date string to parse.
     #
-    ##########################################################################
-    
-    # Encodes the event into MsgPack format.
-    def to_msgpack
-      obj = {
-        :objectId => object_id.to_msgpack,
-        :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
+    # @return [DateTime]  The parsed date.
+    def parse_timestamp(str)
+      # Try to parse with fractional seconds first and then fallback to
+      # a regular ISO8601 format.
+      begin
+        return DateTime.strptime(str, '%Y-%m-%dT%H:%M:%S.%NZ')
+      rescue ArgumentError
+        return DateTime.strptime(str, '%Y-%m-%dT%H:%M:%SZ')
+      end
     end
   end
 end

data/lib/skydb/property.rb

@@ -1,5 +1,3 @@
-require 'skydb/property/type'
-
 class SkyDB
   class Property
     ##########################################################################
@@ -10,10 +8,10 @@ class SkyDB
 
     # Initializes the property.
     def initialize(options={})
-      self.id = options[:id]
-      self.type = options[:type]
-      self.data_type = options[:data_type]
+      self.id = options[:id].to_i
       self.name = options[:name]
+      self.transient = options[:transient] || false
+      self.data_type = options[:data_type] || "string"
     end
     
 
@@ -23,55 +21,17 @@ class SkyDB
     #
     ##########################################################################
 
-    ##################################
-    # ID
-    ##################################
-
     # The property identifier.
-    attr_reader :id
-    
-    def id=(value)
-      @id = value.to_i
-    end
-
-
-    ##################################
-    # Type
-    ##################################
-
-    # The property type. This can be either :object or :action.
-    attr_reader :type
-    
-    def type=(value)
-      value = :object unless [:object, :action].index(value)
-      @type = value
-    end
-
-
-    ##################################
-    # Data Type
-    ##################################
-
-    # The property data type. This can be either 'String', 'Int', 'Float',
-    # or 'Boolean'.
-    attr_reader :data_type
-    
-    def data_type=(value)
-      value = nil unless ['String', 'Int', 'Float', 'Boolean'].index(value)
-      @data_type = value
-    end
+    attr_accessor :id
 
+    # The name of the property.
+    attr_accessor :name
 
-    ##################################
-    # Name
-    ##################################
+    # A flag stating if the value of the property only exists for a single moment.
+    attr_accessor :transient
 
-    # The name of the property.
-    attr_reader :name
-    
-    def name=(value)
-      @name = value.to_s
-    end
+    # The property's data type.
+    attr_accessor :data_type
 
 
     ##########################################################################
@@ -79,25 +39,32 @@ class SkyDB
     # Methods
     #
     ##########################################################################
-    
-    # Encodes the property into MsgPack format.
-    def to_msgpack
-      return {
-        id:id,
-        type:SkyDB::Property::Type.encode(type),
-        dataType:data_type,
-        name:name
-      }.to_msgpack
-    end
 
-    # Encodes the property into JSON format.
-    def to_json(*a)
-      {
-        'id' => id,
-        'type' => type,
+    ####################################
+    # Encoding
+    ####################################
+
+    # Encodes the property into a hash.
+    def to_hash(*a)
+      hash = {
+        'name' => name,
+        'transient' => transient,
         'dataType' => data_type,
-        'name' => name
-      }.to_json(*a)
+      }
+      hash['id'] = id if id < 0 || id > 0
+      return hash
     end
+
+    # Decodes a hash into a property.
+    def from_hash(hash, *a)
+      self.id = !hash.nil? ? hash['id'].to_i : 0
+      self.name = !hash.nil? ? hash['name'] : ''
+      self.transient = !hash.nil? ? hash['transient'] : false
+      self.data_type = !hash.nil? ? hash['dataType'] : ''
+      return self
+    end
+
+    def as_json(*a); return to_hash(*a); end
+    def to_json(*a); return as_json(*a).to_json; end
   end
 end

data/lib/skydb/table.rb

@@ -2,75 +2,155 @@ class SkyDB
   class Table
     ##########################################################################
     #
-    # Constants
+    # Constructor
     #
     ##########################################################################
 
-    DEFAULT_TABLET_COUNT = 4
+    # Initializes the table.
+    def initialize(options={})
+      self.client = options[:client]
+      self.name = options[:name]
+    end
     
 
     ##########################################################################
     #
-    # Constructor
+    # Attributes
     #
     ##########################################################################
 
-    # Initializes the table.
-    def initialize(name='', options={})
-      self.name = name
-      self.tablet_count = options[:tablet_count].to_i
-    end
-    
+    # The client this table is associated with.
+    attr_accessor :client
+
+    # The name of the table.
+    attr_accessor :name
+
 
     ##########################################################################
     #
-    # Attributes
+    # Methods
     #
     ##########################################################################
 
-    ##################################
-    # Name
-    ##################################
+    ####################################
+    # Property API
+    ####################################
 
-    # The name of the table.
-    attr_reader :name
-    
-    def name=(value)
-      @name = value.to_s
+    # Retrieves a list of all properties for the table.
+    #
+    # @return [Array]  the list of properties on the table.
+    def get_properties(options={})
+      raise ArgumentError.new("Table not associated with client") if client.nil?
+      return client.get_properties(self, options)
     end
 
+    # Retrieves a single property by name from the table.
+    #
+    # @param [String] name  The name of the property to retrieve.
+    #
+    # @return [Array]  the list of properties on the table.
+    def get_property(name, options={})
+      raise ArgumentError.new("Table not associated with client") if client.nil?
+      return client.get_property(self, name, options)
+    end
 
-    ##################################
-    # Tablet count
-    ##################################
+    # Creates a property on a table.
+    #
+    # @param [Property] property  the property to create.
+    def create_property(property, options={})
+      raise ArgumentError.new("Table not associated with client") if client.nil?
+      return client.create_property(self, property, options)
+    end
 
-    # The number of tablets the table has
-    attr_reader :tablet_count
-    
-    def tablet_count=(value)
-      @tablet_count = value.to_i || DEFAULT_TABLET_COUNT
+    # Updates a property on a table.
+    #
+    # @param [Property] property  the property to update.
+    def update_property(property, options={})
+      raise ArgumentError.new("Table not associated with client") if client.nil?
+      return client.update_property(self, property, options)
     end
 
+    # Deletes a property on a table.
+    #
+    # @param [Property] property  the property to delete.
+    def delete_property(property, options={})
+      raise ArgumentError.new("Table not associated with client") if client.nil?
+      return client.delete_property(self, property, options)
+    end
 
-    ##########################################################################
+
+    ####################################
+    # Event API
+    ####################################
+
+    # Retrieves all events for a given object.
     #
-    # Methods
+    # @return [Array]  the list of events on the table.
+    def get_events(object_id, options={})
+      raise ArgumentError.new("Table not associated with client") if client.nil?
+      return client.get_events(self, object_id, options)
+    end
+
+    # Retrieves the event that occurred at a given point in time for an object.
     #
-    ##########################################################################
-    
-    # Encodes the table into MsgPack format.
-    def to_msgpack
-      return {
-        name: name,
-        tablet_count: tablet_count
-      }.to_msgpack
+    # @return [Event]  the event.
+    def get_event(object_id, timestamp, options={})
+      raise ArgumentError.new("Table not associated with client") if client.nil?
+      return client.get_event(self, object_id, timestamp, options)
     end
 
-    # Encodes the table into JSON format.
-    def to_json(*a)
-      {
-        'name' => name
-      }.to_json(*a)
+    # Adds an event to an object.
+    #
+    # @param [String] object_id  the object's identifier.
+    # @param [Event] event  the event to add.
+    #
+    # @return [Event]  the event.
+    def add_event(object_id, event, options={})
+      raise ArgumentError.new("Table not associated with client") if client.nil?
+      return client.add_event(self, object_id, event, options)
+    end
+
+    # Deletes an event for an object on a table.
+    #
+    # @param [String] object_id  the object's identifier.
+    # @param [Event] event  the event to delete.
+    def delete_event(object_id, event, options={})
+      raise ArgumentError.new("Table not associated with client") if client.nil?
+      return client.delete_event(self, object_id, event, options)
     end
+
+
+    ####################################
+    # Query API
+    ####################################
+
+    # Runs a query against a given table.
+    #
+    # @param [Hash] q  The query definition to run.
+    #
+    # @return [Results]  the results of the query.
+    def query(q)
+      raise ArgumentError.new("Table not associated with client") if client.nil?
+      return client.query(self, q)
+    end
+
+
+    ####################################
+    # Encoding
+    ####################################
+
+    # Encodes the table into a hash.
+    def to_hash(*a)
+      {'name' => name}
+    end
+
+    # Decodes a hash into a table.
+    def from_hash(hash, *a)
+      self.name = hash.nil? ? '' : hash['name']
+      return self
+    end
+
+    def as_json(*a); return to_hash(*a); end
+    def to_json(*a); return as_json(*a).to_json; end
   end
 end