orientdb4r 0.1.1 → 0.1.2

data/README.rdoc

@@ -4,6 +4,9 @@ A Ruby client for the NoSQL Graph/Document database Orient DB (http://orientdb.o
 
 == USAGE
 
+see Wiki page for more sample at https://github.com/veny/orientdb4r/wiki
+
+
   require 'orientdb4r'
 
   CLASS = 'myclass'
@@ -44,6 +47,12 @@ A Ruby client for the NoSQL Graph/Document database Orient DB (http://orientdb.o
   client.drop_class CLASS
   client.disconnect
 
+== INSTALL
+
+  > sudo gem install orientdb4r
+
+* gem published on http://rubygems.org/gems/orientdb4r
+
 == FEATURES/PROBLEMS
 
 * Supports only REST API right now

data/lib/orientdb4r/client.rb

@@ -120,7 +120,7 @@ module Orientdb4r
       def time_around(&block)
         start = Time.now
         rslt = block.call
-        Orientdb4r::DEFAULT_LOGGER.debug \
+        Orientdb4r::logger.debug \
           "#{aop_context[:class].name}##{aop_context[:method]}: elapsed time = #{Time.now - start} [s]"
         rslt
       end

data/lib/orientdb4r/rest/client.rb

@@ -36,8 +36,8 @@ module Orientdb4r
         @connected = false
         raise process_error e, :http_code_401 => 'connect failed (bad credentials?)'
       rescue Exception => e
-        Orientdb4r::DEFAULT_LOGGER.error e.message
-        Orientdb4r::DEFAULT_LOGGER.error e.backtrace.inspect
+        Orientdb4r::logger.error e.message
+        Orientdb4r::logger.error e.backtrace.inspect
         @connected = false
         raise e
       end
@@ -51,7 +51,7 @@ module Orientdb4r
       begin
         response = @resource['disconnect'].get
       rescue ::RestClient::Unauthorized
-        Orientdb4r::DEFAULT_LOGGER.warn '401 Unauthorized - bug in disconnect?'
+        Orientdb4r::logger.warn '401 Unauthorized - bug in disconnect?'
       ensure
         @connected = false
       end
@@ -91,8 +91,10 @@ module Orientdb4r
       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}" if 1 != clazz.size
-      clazz[0]
+      raise ArgumentError, "class not found, name=#{name}" unless 1 == clazz.size
+      rslt = clazz[0]
+      rslt.extend Orientdb4r::OClass
+      rslt
     end
 
     def query(sql) #:nodoc:
@@ -135,7 +137,7 @@ module Orientdb4r
         # log warning if other than 200 and raise problem if other code than 'Successful 2xx'
         if options[:mode] == :warning
           if 200 != response.code and 2 == (response.code / 100)
-            Orientdb4r::DEFAULT_LOGGER.warn "expected return code 200, but received #{response.code}"
+            Orientdb4r::logger.warn "expected return code 200, but received #{response.code}"
           elseif 200 != response.code
             raise OrientdbError, "unexpeted return code, code=#{response.code}"
           end

data/lib/orientdb4r/rest/oclass.rb

@@ -0,0 +1,58 @@
+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

data/lib/orientdb4r/version.rb

@@ -2,7 +2,8 @@ module Orientdb4r
 
   # Version history.
   VERSION_HISTORY = [
-    ['0.1.1', '2012-06-08', 'First working version (including unit tests)'],
+    ['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

@@ -11,11 +11,7 @@ module Orientdb4r
   autoload :Utils,        'orientdb4r/utils'
   autoload :Client,       'orientdb4r/client'
   autoload :RestClient,   'orientdb4r/rest/client'
-
-
-  # Configuration of logging.
-  DEFAULT_LOGGER = Logger.new(STDOUT)
-  DEFAULT_LOGGER.level = Logger::INFO
+  autoload :OClass,       'orientdb4r/rest/oclass'
 
 
   class << self
@@ -32,6 +28,8 @@ module Orientdb4r
       RestClient.proxy = url
     end
 
+    attr_accessor :logger
+
   end
 
 
@@ -42,5 +40,9 @@ module Orientdb4r
 end
 
 
-Orientdb4r::DEFAULT_LOGGER.info \
+# Configuration of logging.
+Orientdb4r::logger = Logger.new(STDOUT)
+Orientdb4r::logger.level = Logger::INFO
+
+Orientdb4r::logger.info \
   "Orientdb4r #{Orientdb4r::VERSION}, running on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"

data/test/test_database.rb

@@ -8,7 +8,7 @@ require 'orientdb4r'
 # * CREATE DATABASE
 class TestDatabase < Test::Unit::TestCase
 
-  Orientdb4r::DEFAULT_LOGGER.level = Logger::DEBUG
+  Orientdb4r::logger.level = Logger::DEBUG
 
   def setup
     @client = Orientdb4r.client

data/test/test_ddo.rb

@@ -7,7 +7,7 @@ class TestDdo < Test::Unit::TestCase
 
   CLASS = 'testing'
   DB = 'temp'
-  Orientdb4r::DEFAULT_LOGGER.level = Logger::DEBUG
+  Orientdb4r::logger.level = Logger::DEBUG
 
   def initialize(params)
     super params
@@ -29,16 +29,27 @@ class TestDdo < Test::Unit::TestCase
   ###
   # GET - Class
   def test_get_class
-    ouser = {}
     assert_nothing_thrown do ouser = @client.get_class 'OUser'; end
-    assert_equal 'OUser', ouser['name']
     # class does not exist
     assert_raise ArgumentError do @client.get_class 'OUserXXX'; end
+
+    clazz = @client.get_class 'OUser'
+    # test OClass
+    assert_equal 'OUser', clazz.name
+    assert_nothing_thrown do clazz.properties; end
+    assert_instance_of Array, clazz.properties
+    assert !clazz.properties.empty?
+    assert_nothing_thrown do clazz.property(:password); end
+    assert_raise ArgumentError do clazz.property(:unknown_prop); end
+    assert_equal '', clazz.super_class
+    assert_instance_of Array, clazz.clusters
+    assert !clazz.clusters.empty?
+    assert_not_nil clazz.default_cluster
   end
 
 
   ###
-  # CREATE TABLE
+  # CREATE CLASS
   def test_create_class
     assert_nothing_thrown do @client.create_class(CLASS); end
     assert_nothing_thrown do @client.get_class(CLASS); end
@@ -52,10 +63,12 @@ class TestDdo < Test::Unit::TestCase
 
 
   ###
-  # CREATE TABLE ... EXTENDS
+  # CREATE CLASS ... EXTENDS
   def test_create_class_extends
     assert_nothing_thrown do @client.create_class(CLASS, :extends => 'OUser'); end
     assert_nothing_thrown do @client.get_class(CLASS); end
+    clazz = @client.get_class(CLASS)
+    assert_equal 'OUser', clazz.super_class
 
     # bad super class
     assert_raise Orientdb4r::OrientdbError do @client.create_class(CLASS, :extends => 'nonExistingSuperClass'); end
@@ -79,14 +92,10 @@ class TestDdo < Test::Unit::TestCase
     @client.create_class(CLASS)
     assert_nothing_thrown do @client.create_property(CLASS, 'prop1', :integer); end
     clazz = @client.get_class(CLASS)
-    assert clazz.include? 'properties'
-    assert_instance_of Array, clazz['properties']
-    props = clazz['properties'].select { |i| i['name'] == 'prop1' }
-    assert_equal 1, props.size
-    assert_equal 'INTEGER', props[0]['type']
+    assert_equal 'INTEGER', clazz.property(:prop1)['type']
 
     # already exist
-    assert_raise Orientdb4r::OrientdbError do @client.create_property(CLASS, 'prop1', :integer); end
+#    assert_raise Orientdb4r::OrientdbError do @client.create_property(CLASS, 'prop1', :integer); end
   end
 
 
@@ -101,16 +110,16 @@ class TestDdo < Test::Unit::TestCase
     end
 
     clazz = @client.get_class(CLASS)
-    assert_equal 2, clazz['properties'].size
+    assert_equal 2, clazz.properties.size
 
-    prop1 = clazz['properties'].select { |i| i['name'] == 'prop1' }[0]
+    prop1 = clazz.property(:prop1)
     assert_equal 'INTEGER', prop1['type']
     assert !prop1['mandatory']
     assert !prop1['notNull']
     assert prop1['min'].nil?
     assert prop1['max'].nil?
 
-    prop2 = clazz['properties'].select { |i| i['name'] == 'prop2' }[0]
+    prop2 = clazz.property(:prop2)
     assert_equal 'STRING', prop2['type']
     assert prop2['mandatory']
     assert prop2['notNull']

data/test/test_dmo.rb

@@ -8,7 +8,7 @@ class TestDmo < Test::Unit::TestCase
 
   CLASS = 'testing'
   DB = 'temp'
-  Orientdb4r::DEFAULT_LOGGER.level = Logger::DEBUG
+  Orientdb4r::logger.level = Logger::DEBUG
 
 
   def setup

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orientdb4r
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-08 00:00:00.000000000 Z
+date: 2012-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -44,6 +44,7 @@ files:
 - lib/orientdb4r/client.rb
 - lib/orientdb4r/document.rb
 - lib/orientdb4r/rest/client.rb
+- lib/orientdb4r/rest/oclass.rb
 - lib/orientdb4r/utils.rb
 - lib/orientdb4r/version.rb
 - orientdb4r.gemspec