orientdb4r 0.1.2 → 0.2.0

data/lib/orientdb4r/chained_error.rb

@@ -0,0 +1,37 @@
+module Orientdb4r
+
+  ###
+  # This mixin extends an error to be able to track a chain of exceptions.
+  module ChainedError
+
+    attr_reader :cause
+
+    ###
+    # Constructor.
+    def initialize message = nil, cause = $!
+      super message unless message.nil?
+      super $! if message.nil? and !cause.nil?
+      @cause = cause
+    end
+
+    ###
+    # Modification of original method Error#set_backtrace
+    # to descend the full depth of the exception chain.
+    def set_backtrace bt
+      unless cause.nil?
+        cause.backtrace.reverse.each do |line|
+          if bt.last == line
+            bt.pop
+            next
+          end
+          break
+        end
+        bt.push "<<<CAUSED BY>>>: #{cause.class}: #{cause.message}"
+        bt.concat cause.backtrace
+      end
+      super bt
+    end
+
+  end
+
+end

data/lib/orientdb4r/client.rb

@@ -9,24 +9,39 @@ module Orientdb4r
       @connected = false
     end
 
+    # --------------------------------------------------------------- CONNECTION
+
     ###
     # Connects client to the server.
     def connect options
       raise NotImplementedError, 'this should be overridden by concrete client'
     end
 
+
     ###
     # Disconnects client from the server.
     def disconnect
       raise NotImplementedError, 'this should be overridden by concrete client'
     end
 
+
     ###
     # Gets flag whenever the client is connected or not.
     def connected?
       @connected
     end
 
+
+    ###
+    # Retrieve information about the connected OrientDB Server.
+    # Enables additional authentication to the server with an account
+    # that can access the 'server.info' resource.
+    def server(options={})
+      raise NotImplementedError, 'this should be overridden by concrete client'
+    end
+
+    # ----------------------------------------------------------------- DATABASE
+
     ###
     # Creates a new database.
     # You can provide an additional authentication to the server with 'database.create' resource
@@ -35,24 +50,30 @@ module Orientdb4r
       raise NotImplementedError, 'this should be overridden by concrete client'
     end
 
+
     ###
     # Gets informations about requested class.
     def get_class(name)
       raise NotImplementedError, 'this should be overridden by concrete client'
     end
 
+    # ---------------------------------------------------------------------- SQL
+
     ###
     # Executes a query against the database.
     def query(sql)
       raise NotImplementedError, 'this should be overridden by concrete client'
     end
 
+
     ###
     # Executes a command against the database.
-    def command(sql, options={})
+    def command(sql)
       raise NotImplementedError, 'this should be overridden by concrete client'
     end
 
+    # -------------------------------------------------------------------- CLASS
+
     ###
     # Creates a new class in the schema.
     def create_class(name, options={})
@@ -66,7 +87,7 @@ module Orientdb4r
 
       drop_class name if options[:force]
 
-      command sql, :http_code_500 => 'failed to create class (exists already, bad supperclass?)'
+      command sql
 
       if block_given?
         proxy = Orientdb4r::Utils::Proxy.new(self, name)
@@ -77,14 +98,28 @@ module Orientdb4r
       end
     end
 
+
     ###
     # Removes a class from the schema.
-    def drop_class(name)
-      # TODO in :mode=>:strict verify if the class is no a super class
+    def drop_class(name, options={})
       raise ArgumentError, "class name is blank" if blank?(name)
+
+      # :mode=>:strict forbids to drop a class that is a super class for other one
+      opt_pattern = { :mode => :nil }
+      verify_options(options, opt_pattern)
+      if :strict == options[:mode]
+        response = @resource["connect/#{@database}"].get
+        connect_info = process_response(response, :mode => :strict)
+        children = connect_info['classes'].select { |i| i['superClass'] == name }
+        unless children.empty?
+          raise OrientdbError, "class is super-class, cannot be deleted, name=#{name}"
+        end
+      end
+
       command "DROP CLASS #{name}"
     end
 
+
     ###
     # Creates a new property in the schema.
     # You need to create the class before.
@@ -98,7 +133,7 @@ module Orientdb4r
       verify_options(options, opt_pattern)
 
       cmd = "CREATE PROPERTY #{clazz}.#{property} #{type.to_s}"
-      command cmd, :http_code_500 => 'failed to create property (exists already?)'
+      command cmd
 
       unless options.empty?
         options.each do |k,v|
@@ -107,6 +142,37 @@ module Orientdb4r
       end
     end
 
+    # ----------------------------------------------------------------- DOCUMENT
+
+    ###
+    # Create a new document.
+    # Returns the Record-id assigned.
+    def create_document(doc)
+      raise NotImplementedError, 'this should be overridden by concrete client'
+    end
+
+
+    ###
+    # Retrieves a document by given ID.
+    def get_document(rid)
+      raise NotImplementedError, 'this should be overridden by concrete client'
+    end
+
+
+    ###
+    # Updates an existing document.
+    def update_document(doc)
+      raise NotImplementedError, 'this should be overridden by concrete client'
+    end
+
+
+    ###
+    # Deletes an existing document.
+    def delete_document(rid)
+      raise NotImplementedError, 'this should be overridden by concrete client'
+    end
+
+
     protected
 
       ###

data/lib/orientdb4r/rest/client.rb

@@ -31,15 +31,13 @@ module Orientdb4r
       begin
         response = @resource["connect/#{@database}"].get
         rslt = process_response(response, :mode => :strict)
+
+        decorate_classes_with_model(rslt['classes'])
+
         @connected = true
-      rescue ::RestClient::Exception => e
+      rescue
         @connected = false
-        raise process_error e, :http_code_401 => 'connect failed (bad credentials?)'
-      rescue Exception => e
-        Orientdb4r::logger.error e.message
-        Orientdb4r::logger.error e.backtrace.inspect
-        @connected = false
-        raise e
+        raise ConnectionError
       end
       rslt
     end
@@ -54,6 +52,8 @@ module Orientdb4r
         Orientdb4r::logger.warn '401 Unauthorized - bug in disconnect?'
       ensure
         @connected = false
+        @user = nil
+        @password = nil
       end
     end
 
@@ -70,11 +70,8 @@ module Orientdb4r
       resource = ::RestClient::Resource.new(url, :user => u, :password => p)
       begin
         response = resource["database/#{options[:database]}/#{options[:type]}"].post ''
-      rescue ::RestClient::Exception => e
-        raise process_error e, \
-          :http_code_403 => 'forbidden operation (insufficient rights?)', \
-          :http_code_500 => 'failed to create database (exists already?)'
-
+      rescue
+        raise OrientdbError
       end
       process_response(response)
     end
@@ -90,31 +87,128 @@ module Orientdb4r
       # workaround - use metadate delivered by 'connect'
       response = @resource["connect/#{@database}"].get
       connect_info = process_response(response, :mode => :strict)
-      clazz = connect_info['classes'].select { |i| i['name'] == name }
-      raise ArgumentError, "class not found, name=#{name}" unless 1 == clazz.size
-      rslt = clazz[0]
-      rslt.extend Orientdb4r::OClass
-      rslt
+
+      classes = connect_info['classes'].select { |i| i['name'] == name }
+      raise ArgumentError, "class not found, name=#{name}" unless 1 == classes.size
+      decorate_classes_with_model(classes)
+      clazz = classes[0]
+      clazz.extend Orientdb4r::HashExtension
+      clazz.extend Orientdb4r::OClass
+      unless clazz['properties'].nil? # there can be a class without properties
+        clazz.properties.each do |prop|
+          prop.extend Orientdb4r::HashExtension
+          prop.extend Orientdb4r::Property
+        end
+      end
+
+
+      clazz
     end
 
+
     def query(sql) #:nodoc:
+      raise ArgumentError, 'query is blank' if blank? sql
+
       response = @resource["query/#{@database}/sql/#{URI.escape(sql)}"].get
       rslt = process_response(response)
       rslt['result']
     end
 
-    def command(sql, options={}) #:nodoc:
+
+    def command(sql) #:nodoc:
+      raise ArgumentError, 'command is blank' if blank? sql
       begin
 #puts "REQ #{sql}"
         response = @resource["command/#{@database}/sql/#{URI.escape(sql)}"].post ''
         rslt = process_response(response)
         rslt
 #puts "RESP #{response.code}"
-      rescue Exception => e
-        raise process_error e, options.select { |k,v| k.to_s.start_with? 'http_code' }
+      rescue
+        raise OrientdbError
+      end
+    end
+
+
+    def server(options={}) #:nodoc:
+      options_pattern = { :user => :optional, :password => :optional }
+      verify_options(options, options_pattern)
+
+
+      u = options.include?(:user) ? options[:user] : user
+      p = options.include?(:password) ? options[:password] : password
+      resource = ::RestClient::Resource.new(url, :user => u, :password => p)
+      begin
+        response = resource['server'].get
+      rescue
+        raise OrientdbError
+      end
+      process_response(response)
+    end
+
+
+    # ----------------------------------------------------------------- DOCUMENT
+
+    def create_document(doc)
+      begin
+        response = @resource["document/#{@database}"].post doc.to_json, :content_type => 'application/json'
+      rescue
+        raise DataError
+      end
+      rid = process_response(response)
+      raise ArgumentError, "invalid RID format, RID=#{rid}" unless rid =~ /^#[0-9]+:[0-9]+/
+      rid
+    end
+
+
+    def get_document(rid) #:nodoc:
+      raise ArgumentError, 'blank RID' if blank? rid
+      # remove the '#' prefix
+      rid = rid[1..-1] if rid.start_with? '#'
+
+      begin
+        response = @resource["document/#{@database}/#{rid}"].get
+      rescue
+        raise NotFoundError
       end
+      rslt = process_response(response)
+      rslt.extend Orientdb4r::DocumentMetadata
+      rslt
     end
 
+
+    def update_document(doc) #:nodoc:
+      raise ArgumentError, 'document is nil' if doc.nil?
+      raise ArgumentError, 'document has no RID' if doc.doc_rid.nil?
+      raise ArgumentError, 'document has no version' if doc.doc_version.nil?
+
+      rid = doc.delete '@rid'
+      rid = rid[1..-1] if rid.start_with? '#'
+
+      begin
+        @resource["document/#{@database}/#{rid}"].put doc.to_json, :content_type => 'application/json'
+      rescue
+        raise DataError
+      end
+      # empty http response
+    end
+
+
+    def delete_document(rid) #:nodoc:
+      raise ArgumentError, 'blank RID' if blank? rid
+      # remove the '#' prefix
+      rid = rid[1..-1] if rid.start_with? '#'
+
+      begin
+        response = @resource["document/#{@database}/#{rid}"].delete
+        puts "DELETE '#{response}'"
+      rescue
+        raise DataError
+      end
+      # empty http response
+    end
+
+    # ------------------------------------------------------------------ Helpers
+
     private
 
       ###
@@ -156,10 +250,17 @@ module Orientdb4r
         rslt
       end
 
-      def process_error(error, messages={})
-        code = "http_code_#{error.http_code}".to_sym
-        msg = messages.include?(code) ? "#{messages[code]}, cause = " : ''
-        OrientdbError.new "#{msg}#{error.to_s}"
+      def decorate_classes_with_model(classes)
+        classes.each do |clazz|
+          clazz.extend Orientdb4r::HashExtension
+          clazz.extend Orientdb4r::OClass
+            unless clazz['properties'].nil? # there can be a class without properties
+              clazz.properties.each do |prop|
+                prop.extend Orientdb4r::HashExtension
+                prop.extend Orientdb4r::Property
+            end
+          end
+        end
       end
 
   end

data/lib/orientdb4r/rest/model.rb

@@ -0,0 +1,140 @@
+module Orientdb4r
+
+
+  ###
+  # Extends a Hash produced by JSON.parse.
+  module HashExtension
+
+    ###
+    # Gets an attribute value that has to be presented.
+    def get_mandatory_attribute(name)
+      key = name.to_s
+      raise ::ArgumentError, "unknown attribute, name=#{key}" unless self.include? key
+      self[key]
+    end
+
+  end
+
+
+  ###
+  # This module represents API to OrientDB's class.
+  module OClass
+
+    ###
+    # Gets name of the class.
+    def name
+      get_mandatory_attribute :name
+    end
+
+    ###
+    # Gets properties of the class.
+    # Returns nil for a class without properties.
+    def properties
+      self['properties']
+    end
+
+    ###
+    # Gets a property with the given name.
+    def property(name)
+      raise ArgumentError, 'no properties defined on class' if properties.nil?
+      props = properties.select { |i| i['name'] == name.to_s }
+      raise ::ArgumentError, "unknown property, name=#{name}" if props.empty?
+      raise ::ArgumentError, "too many properties found, name=#{name}" if props.size > 1 # just to be sure
+      props[0]
+    end
+
+    ###
+    # Gets the super-class.
+    def super_class
+      get_mandatory_attribute :superClass
+    end
+
+    ###
+    # Gets clusters of the class.
+    def clusters
+      get_mandatory_attribute :clusters
+    end
+
+    ###
+    # Gets the default cluster.
+    def default_cluster
+      get_mandatory_attribute :defaultCluster
+    end
+
+  end
+
+
+  ###
+  # This module represents API to OrientDB's property.
+  module Property
+
+    ###
+    # Gets name of the property.
+    def name
+      get_mandatory_attribute :name
+    end
+
+    ###
+    # Gets type of the property.
+    def type
+      get_mandatory_attribute :type
+    end
+
+    ###
+    # Gets the 'mandatory' flag.
+    def mandatory
+      get_mandatory_attribute :mandatory
+    end
+
+    ###
+    # Gets the 'notNull' flag.
+    def not_null
+      get_mandatory_attribute :notNull
+    end
+
+    ###
+    # Gets the minimal allowed value.
+    def min
+      self['min']
+    end
+
+    ###
+    # Gets the maximal allowed value.
+    def max
+      self['max']
+    end
+
+  end
+
+
+  ###
+  # This module represents API to document metadata.
+  module DocumentMetadata
+
+    ###
+    # Gets the document class.
+    def doc_class
+      self['@class']
+    end
+
+    ###
+    # Gets the document ID.
+    def doc_rid
+      self['@rid']
+    end
+
+    ###
+    # Gets the document version.
+    def doc_version
+      self['@version']
+    end
+
+    ###
+    # Gets the document type.
+    def doc_type
+      self['@type']
+    end
+
+  end
+
+end

data/lib/orientdb4r/utils.rb

@@ -3,6 +3,8 @@ module Orientdb4r
   module Utils
 
     def verify_options(options, pattern)
+      raise ArgumentError, 'options cannot be nil' if options.nil?
+
       # unknown key?
       options.keys.each do |k|
         raise ArgumentError, "unknow option: #{k}" unless pattern.keys.include? k
@@ -11,6 +13,13 @@ module Orientdb4r
       pattern.each do |k,v|
         raise ArgumentError, "missing mandatory option: #{k}" if v == :mandatory and !options.keys.include? k
       end
+      # option in a set of allowed values
+      pattern.each do |k,v|
+        if v.instance_of? Array
+          raise ArgumentError, "value '#{options[k]}' not in #{v.inspect}, key=#{k}" unless v.include?(options[k])
+        end
+      end
+
       options
     end
 

data/lib/orientdb4r/version.rb

@@ -2,6 +2,7 @@ module Orientdb4r
 
   # Version history.
   VERSION_HISTORY = [
+    ['0.2.0', '2012-06-12', "Introduces document's CRUD operations"],
     ['0.1.2', '2012-06-10', 'Introduces new OClass module'],
     ['0.1.1', '2012-06-08', 'First working version (including unit tests) released at github.com'],
     ['0.1.0', '2012-06-02', 'Initial version on Ruby-1.9.3p194 and OrientDB-1.0.0']

data/lib/orientdb4r.rb

@@ -8,17 +8,26 @@ require 'orientdb4r/version'
 # This module represents the entry point for using the Ruby OrientDB client.
 module Orientdb4r
 
-  autoload :Utils,        'orientdb4r/utils'
-  autoload :Client,       'orientdb4r/client'
-  autoload :RestClient,   'orientdb4r/rest/client'
-  autoload :OClass,       'orientdb4r/rest/oclass'
+  autoload :Utils,          'orientdb4r/utils'
+  autoload :Client,         'orientdb4r/client'
+  autoload :RestClient,     'orientdb4r/rest/client'
+  autoload :HashExtension,  'orientdb4r/rest/model'
+  autoload :OClass,         'orientdb4r/rest/model'
+  autoload :ChainedError,   'orientdb4r/chained_error'
 
 
   class << self
 
     ###
     # Gets a new database client or an existing for the current thread.
+    # === options
+    #  * :force => true
     def client options={}
+      if :new == options[:instance]
+        options.delete :instance
+        return RestClient.new options
+      end
+
       Thread.current[:orientdb_client] ||= RestClient.new options
     end
 
@@ -34,8 +43,23 @@ module Orientdb4r
 
 
   ###
-  # Basic error raised to signal an unexpected situation.
-  class OrientdbError < StandardError; end
+  # Basic error that indicates an unexpected situation during the client call.
+  class OrientdbError < StandardError
+    include ChainedError
+  end
+
+  ###
+  # Error indicating problems with communicating with the database.
+  class ConnectionError < OrientdbError; end
+
+  ###
+  # Error raised to inform that an object identified by RID cannot be get.
+  class NotFoundError < OrientdbError; end
+
+  ###
+  # Error indicating that manipulation against the given data resulted in some illegal operation,
+  # mismatched types or incorrect cardinality.
+  class DataError < OrientdbError; end
 
 end
 
@@ -46,3 +70,7 @@ Orientdb4r::logger.level = Logger::INFO
 
 Orientdb4r::logger.info \
   "Orientdb4r #{Orientdb4r::VERSION}, running on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+
+
+#client = Orientdb4r.client
+#client.connect :database => 'temp', :user => 'admin', :password => 'admin'

data/test/test_database.rb

@@ -17,17 +17,24 @@ class TestDatabase < Test::Unit::TestCase
   ###
   # CONNECT
   def test_connect
+    assert_nothing_thrown do @client.connect :database => 'temp', :user => 'admin', :password => 'admin'; end
     rslt = @client.connect :database => 'temp', :user => 'admin', :password => 'admin'
     assert_instance_of Hash, rslt
     assert rslt.size > 0
     assert rslt.include? 'classes'
 
+    # connection refused
+    client = Orientdb4r.client :port => 2840, :instance => :new
+    assert_raise Orientdb4r::ConnectionError do
+      client.connect :database => 'temp', :user => 'admin', :password => 'admin'
+    end
+
     # bad DB name
-    assert_raise Orientdb4r::OrientdbError do
+    assert_raise Orientdb4r::ConnectionError do
       @client.connect :database => 'unknown_db', :user => 'admin', :password => 'admin'
     end
     # bad credentials
-    assert_raise Orientdb4r::OrientdbError do
+    assert_raise Orientdb4r::ConnectionError do
       @client.connect :database => 'temp', :user => 'admin1', :password => 'admin'
     end
   end
@@ -45,7 +52,7 @@ class TestDatabase < Test::Unit::TestCase
 
   ###
   # CREATE DATABASE
-  # Temporary disabled bacause of unknown way how to drop a new created datatabse.
+  # Temporary disabled because of unknown way how to drop a new created datatabse.
   def xtest_create_database
     @client.create_database :database => 'UniT', :user => 'root', :password => 'root'
     # creating an existing DB
@@ -63,4 +70,19 @@ class TestDatabase < Test::Unit::TestCase
     #@client.command "DROP DATABASE UniT" : NOT WORKING now
   end
 
+
+  ###
+  # SERVER info
+  # Temporary disabled because of dependency to password of 'root' account
+  def xtest_server
+    # admin/admin has not 'server.info' resource access in standard installation
+    assert_raise Orientdb4r::OrientdbError do @client.server :user => 'admin', :password => 'admin'; end
+
+    assert_nothing_thrown do @client.server :user => 'root', :password => 'root'; end
+    rslt = @client.server :user => 'root', :password => 'root'
+    assert_instance_of Hash, rslt
+    assert rslt.include? 'connections'
+    assert_not_nil rslt['connections']
+  end
+
 end

data/test/test_ddo.rb

@@ -11,7 +11,6 @@ class TestDdo < Test::Unit::TestCase
 
   def initialize(params)
     super params
-
     @client = Orientdb4r.client
   end
 
@@ -21,7 +20,7 @@ class TestDdo < Test::Unit::TestCase
 
   def teardown
     # remove the testing class after each test
-    @client.drop_class(CLASS)
+    @client.drop_class(CLASS, :mode => :strict)
     @client.disconnect
   end
 
@@ -45,6 +44,14 @@ class TestDdo < Test::Unit::TestCase
     assert_instance_of Array, clazz.clusters
     assert !clazz.clusters.empty?
     assert_not_nil clazz.default_cluster
+    # test Property
+    prop = clazz.property :password
+    assert_equal 'password', prop.name
+    assert_equal 'STRING', prop.type
+    assert prop.mandatory
+    assert prop.not_null
+    assert_nil prop.min
+    assert_nil prop.min
   end
 
 
@@ -52,7 +59,7 @@ class TestDdo < Test::Unit::TestCase
   # CREATE CLASS
   def test_create_class
     assert_nothing_thrown do @client.create_class(CLASS); end
-    assert_nothing_thrown do @client.get_class(CLASS); end
+    assert_nothing_thrown do @client.get_class(CLASS); end # raises an Error if no class found
     # already exist
     assert_raise Orientdb4r::OrientdbError do @client.create_class(CLASS); end
 
@@ -77,12 +84,23 @@ class TestDdo < Test::Unit::TestCase
 
   ###
   # DROP TABLE
-  def test_drop_table
+  def test_drop_class
+    super_clazz = "#{CLASS}Sup"
+    @client.drop_class(super_clazz); # just to be sure if previous test failed
+    @client.create_class(super_clazz);
+    @client.create_class(CLASS);
     assert_nothing_thrown do @client.drop_class(CLASS); end
-
+    assert_raise ArgumentError do @client.get_class(CLASS); end # no info more
     # the class is not visible in class list delivered by connect
     rslt = @client.connect :database => DB, :user => 'admin', :password => 'admin'
-    assert rslt['classes'].select { |i| i['name'] == CLASS }.empty?
+    assert rslt['classes'].select { |i| i.name == CLASS }.empty?
+
+    # CLASS extends super_class
+    @client.create_class(CLASS, :extends => super_clazz);
+    assert_raise Orientdb4r::OrientdbError do @client.drop_class(super_clazz, :mode => :strict); end
+    assert_nothing_thrown do @client.get_class(super_clazz); end # still there
+    @client.drop_class(CLASS);
+    assert_nothing_thrown do @client.drop_class(super_clazz, :mode => :strict); end
   end
 
 

data/test/test_document_crud.rb

@@ -0,0 +1,135 @@
+require 'test/unit'
+require 'orientdb4r'
+
+###
+# This class tests Data Manipulation Operarions.
+class TestDocumentCrud < Test::Unit::TestCase
+  include Orientdb4r::Utils
+
+  CLASS = 'testing'
+  DB = 'temp'
+  Orientdb4r::logger.level = Logger::DEBUG
+
+
+  def setup
+    @client = Orientdb4r.client
+    @client.connect :database => DB, :user => 'admin', :password => 'admin'
+    @client.create_class(CLASS) do |c|
+      c.property 'prop1', :integer, :notnull => :true, :min => 1, :max => 99
+      c.property 'prop2', :string, :mandatory => true
+    end
+  end
+
+  def teardown
+    # remove the testing class after each test
+    @client.drop_class(CLASS)
+    @client.disconnect
+  end
+
+
+  ###
+  # CREATE
+  def test_create_document
+    assert_nothing_thrown do @client.create_document( { '@class' => CLASS, 'prop1' => 99, 'prop2' => 'ipsum lorem' }); end
+    rid = @client.create_document({ '@class' => CLASS, 'prop1' => 1, 'prop2' => 'text' })
+    assert rid =~ /#[0-9]+:[0-9]+$/
+
+    # no effect if a define the version
+    assert_nothing_thrown do
+      @client.create_document({ '@class' => CLASS, '@version' => 2, 'prop1' => 1, 'prop2' => 'text' })
+    end
+    rid = @client.create_document({ '@class' => CLASS, 'prop1' => 1, 'prop2' => 'text' })
+    doc = @client.get_document rid
+    assert_equal 0, doc.doc_version
+
+    # no effect if an unknown class
+    assert_nothing_thrown do
+      @client.create_document({ '@class' => 'unknown_class', 'a' => 1, 'b' => 'text' })
+    end
+    rid = @client.create_document({ '@class' => 'unknown_class', 'a' => 11, 'b' => 'text1' })
+    doc = @client.get_document rid
+    assert_nil doc.doc_class
+    assert_equal 11, doc['a']
+    assert_equal 'text1', doc['b']
+
+    # no mandatory property
+    assert_raise Orientdb4r::DataError do @client.create_document({ '@class' => CLASS, 'prop1' => 1 }); end
+    # notNull is null, or lesser/bigger
+    assert_raise Orientdb4r::DataError do
+      @client.create_document({ '@class' => CLASS, 'prop1' => nil, 'prop2' => 'text' })
+    end
+    assert_raise Orientdb4r::DataError do
+      @client.create_document({ '@class' => CLASS, 'prop1' => 0, 'prop2' => 'text' })
+    end
+    assert_raise Orientdb4r::DataError do
+      @client.create_document({ '@class' => CLASS, 'prop1' => 100, 'prop2' => 'text' })
+    end
+  end
+
+  ###
+  # GET
+  def test_get_document
+    rid = @client.create_document( { '@class' => CLASS, 'prop1' => 1, 'prop2' => 'text' })
+
+    doc = @client.get_document rid
+    assert_equal CLASS, doc.doc_class
+    assert_equal rid, doc.doc_rid
+    assert_equal 0, doc.doc_version
+    assert_equal 'd', doc.doc_type
+    assert_equal 1, doc['prop1']
+    assert_equal 'text', doc['prop2']
+    assert_nil doc['unknown_property']
+
+    # not existing RID
+    rid1 = rid.sub(/[0-9]+$/, (rid.split(':')[1].to_i + 1).to_s) # '#6:0' > '#6:1' or '#6:11' > '#6:12'
+    assert_raise Orientdb4r::NotFoundError do @client.get_document rid1; end
+  end
+
+  ###
+  # UPDATE
+  def test_update_document
+    rid = @client.create_document( { '@class' => CLASS, 'prop1' => 1, 'prop2' => 'text' })
+    doc = @client.get_document rid
+
+    doc['prop1'] = 2
+    doc['prop2'] = 'unit'
+    assert_nothing_thrown do @client.update_document doc; end
+    doc = @client.get_document rid
+    assert_equal 2, doc['prop1']
+    assert_equal 'unit', doc['prop2']
+
+    # bad version
+    doc = @client.get_document rid
+    doc['@version'] = 2
+    assert_raise Orientdb4r::DataError do @client.update_document doc; end
+
+    # class cannot be changed
+    doc = @client.get_document rid
+    doc['@class'] = 'OUser'
+    assert_nothing_thrown do @client.update_document doc; end
+    assert_equal CLASS, @client.get_document(rid).doc_class
+
+    # no mandatory property
+    doc = @client.get_document rid
+    doc.delete 'prop2'
+    assert_raise Orientdb4r::DataError do @client.update_document doc; end
+    # notNull is null, or lesser/bigger
+    doc = @client.get_document rid
+    doc['prop1'] = nil
+    assert_raise Orientdb4r::DataError do @client.update_document doc; end
+  end
+
+
+  ###
+  # DELETE
+  def test_delete_document
+    rid = @client.create_document( { '@class' => CLASS, 'prop1' => 1, 'prop2' => 'text' })
+    doc = @client.get_document rid
+    assert_not_nil doc
+
+    # already deleted
+    @client.delete_document rid
+    assert_raise Orientdb4r::NotFoundError do @client.get_document rid; end
+  end
+
+end

data/test/test_utils.rb

@@ -0,0 +1,30 @@
+require 'test/unit'
+require 'orientdb4r'
+
+###
+# This class tests Utils methods.
+class TestDmo < Test::Unit::TestCase
+  include Orientdb4r::Utils
+
+  def test_verify_options
+    opt_pattern = {:a => :mandatory, :b => :optional, :c => 'predefined', :d => [1, false]}
+    assert_nothing_thrown do verify_options({:a => 'A', :b => 'B', :c => 'C', :d => 1}, opt_pattern); end
+
+    # missing mandatory
+    assert_raise ArgumentError do verify_options({}, opt_pattern); end
+    # unknown key
+    assert_raise ArgumentError do verify_options({:a => 1, :z => 2}, opt_pattern); end
+    # value not in predefined set
+    assert_raise ArgumentError do verify_options({:a => 1, :d => 3}, opt_pattern); end
+  end
+
+  def test_verify_and_sanitize_options
+    opt_pattern = {:a => 'A', :b => 'B'}
+    options = {:a => 'X'}
+    verify_and_sanitize_options(options, opt_pattern)
+    assert_equal 2, options.size
+    assert_equal 'X', options[:a]
+    assert_equal 'B', options[:b]
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orientdb4r
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-10 00:00:00.000000000 Z
+date: 2012-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -41,16 +41,18 @@ files:
 - README.rdoc
 - Rakefile
 - lib/orientdb4r.rb
+- lib/orientdb4r/chained_error.rb
 - lib/orientdb4r/client.rb
-- lib/orientdb4r/document.rb
 - lib/orientdb4r/rest/client.rb
-- lib/orientdb4r/rest/oclass.rb
+- lib/orientdb4r/rest/model.rb
 - lib/orientdb4r/utils.rb
 - lib/orientdb4r/version.rb
 - orientdb4r.gemspec
 - test/test_database.rb
 - test/test_ddo.rb
 - test/test_dmo.rb
+- test/test_document_crud.rb
+- test/test_utils.rb
 homepage: http://github.com/veny/orientdb4r
 licenses: []
 post_install_message: 
@@ -80,3 +82,5 @@ test_files:
 - test/test_database.rb
 - test/test_ddo.rb
 - test/test_dmo.rb
+- test/test_document_crud.rb
+- test/test_utils.rb

data/lib/orientdb4r/document.rb

@@ -1,6 +0,0 @@
-module Orientdb4r
-
-  class Document
-  end
-
-end

data/lib/orientdb4r/rest/oclass.rb

@@ -1,58 +0,0 @@
-module Orientdb4r
-
-  ###
-  # This module represents API to OrientDB's class.
-  module OClass
-
-    ###
-    # Gets name of the class.
-    def name
-      get_mandatory_attribute :name
-    end
-
-    ###
-    # Gets properties of the class.
-    def properties
-      get_mandatory_attribute :properties
-    end
-
-    ###
-    # Gets a property with the given name.
-    def property(name)
-      props = properties.select { |i| i['name'] == name.to_s }
-      raise ArgumentError, "unknown property, name=#{name}" if props.empty?
-      raise ArgumentError, "too many properties found, name=#{name}" if props.size > 1 # just to be sure
-      props[0]
-    end
-
-    ###
-    # Gets the super-class.
-    def super_class
-      get_mandatory_attribute :superClass
-    end
-
-    ###
-    # Gets clusters of the class.
-    def clusters
-      get_mandatory_attribute :clusters
-    end
-
-    ###
-    # Gets the default cluster.
-    def default_cluster
-      get_mandatory_attribute :defaultCluster
-    end
-
-    #------------------------------------------------------------------- Helpers
-
-    ###
-    # Gets an attribute value that has to be presented.
-    def get_mandatory_attribute(name)
-      key = name.to_s
-      raise ArgumentError "unknown attribute, name=#{key}" unless self.include? key
-      self[key]
-    end
-
-  end
-
-end