orientdb4r 0.3.2 → 0.3.3

data/changelog.txt

@@ -1,3 +1,7 @@
+0.3.3 2012-12-16
+- Enhancement #18 : Added 'abstract' option into creating a new class
+- Enhancement #19 : Added GET - List Databases
+
 0.3.2 2012-11-02
 - Enhancement #13 : configurable User-Agent request header
 - Enhancement #16 : configurable Recovery Time in Load Balancing

data/lib/orientdb4r/client.rb

@@ -7,7 +7,7 @@ module Orientdb4r
     DEFAULT_SERVER_VERSION = '1.0.0--'
 
     # # Regexp to validate format of providet version.
-    SERVER_VERSION_PATTERN = /^\d+\.\d+\.\d+/
+    SERVER_VERSION_PATTERN = /^\d+\.\d+\.\d+[-SNAPHOT]*$/
 
     # connection parameters
     attr_reader :user, :password, :database
@@ -107,6 +107,15 @@ module Orientdb4r
       raise NotImplementedError, 'this should be overridden by concrete client'
     end
 
+
+    ###
+    # Retrieves the available databases.
+    # That is protected by the resource "server.listDatabases"
+    # that by default is assigned to the guest (anonymous) user in orientdb-server-config.xml.
+    def list_databases()
+      raise NotImplementedError, 'this should be overridden by concrete client'
+    end
+
     # ---------------------------------------------------------------------- SQL
 
     ###
@@ -129,12 +138,24 @@ module Orientdb4r
     # Creates a new class in the schema.
     def create_class(name, options={})
       raise ArgumentError, "class name is blank" if blank?(name)
-      opt_pattern = { :extends => :optional , :cluster => :optional, :force => false, :properties => :optional }
+      opt_pattern = {
+          :extends => :optional, :cluster => :optional, :force => false, :abstract => false,
+          :properties => :optional
+      }
       verify_options(options, opt_pattern)
 
       sql = "CREATE CLASS #{name}"
       sql << " EXTENDS #{options[:extends]}" if options.include? :extends
       sql << " CLUSTER #{options[:cluster]}" if options.include? :cluster
+      # abstract (TODO should be block)
+      bigger_1_2 = (compare_versions(server_version, '1.2.0') > 0)
+      if options.include?(:abstract)
+        if bigger_1_2
+          sql << ' ABSTRACT'
+        else
+          Orientdb4r::logger.warn("abstract class not supported in OrientDB version #{compare_versions}")
+        end
+      end
 
       drop_class name if options[:force]
 

data/lib/orientdb4r/rest/client.rb

@@ -16,6 +16,7 @@ module Orientdb4r
         :host => 'localhost', :port => 2480, :ssl => false,
         :nodes => :optional,
         :connection_library => :restclient,
+#        :connection_library => :excon,
         :load_balancing => :sequence,
         :proxy => :optional,
         :user_agent => :optional,
@@ -80,10 +81,12 @@ module Orientdb4r
     def connect(options) #:nodoc:
       options_pattern = { :database => :mandatory, :user => :mandatory, :password => :mandatory }
       verify_and_sanitize_options(options, options_pattern)
+
       @database = options[:database]
       @user = options[:user]
       @password = options[:password]
 
+      @nodes.each { |node| node.cleanup } # destroy all used session <= problem in 1.3.0-SNAPSHOT
       begin
         response = call_server(:method => :get, :uri => "connect/#{@database}")
       rescue
@@ -109,7 +112,7 @@ module Orientdb4r
         @server_version = DEFAULT_SERVER_VERSION
       end
 
-      Orientdb4r::logger.debug "successfully connected to server, version=#{server_version}"
+      Orientdb4r::logger.info "successfully connected to server, version=#{server_version}"
       @connected = true
       rslt
     end
@@ -139,8 +142,14 @@ module Orientdb4r
       options_pattern = { :user => :optional, :password => :optional }
       verify_options(options, options_pattern)
 
+      params = { :method => :get, :uri => 'server' }
+      params[:no_session] = true # out of existing session which represents an already done authentication
+
       # additional authentication allowed, overriden in 'call_server' if not defined
-      response = call_server :method => :get, :uri => 'server'
+      params[:user] = options[:user] if options.include? :user
+      params[:password] = options[:password] if options.include? :password
+
+      response = call_server params
       process_response(response)
     end
 
@@ -154,8 +163,14 @@ module Orientdb4r
       }
       verify_and_sanitize_options(options, options_pattern)
 
+      params = { :method => :post, :uri => "database/#{options[:database]}/#{options[:type]}" }
+      params[:no_session] = true # out of existing session which represents an already done authentication
+
       # additional authentication allowed, overriden in 'call_server' if not defined
-      response = call_server_one_off :method => :post, :uri => "database/#{options[:database]}/#{options[:type]}"
+      params[:user] = options[:user] if options.include? :user
+      params[:password] = options[:password] if options.include? :password
+
+      response = call_server params
       process_response(response)
     end
 
@@ -173,8 +188,10 @@ module Orientdb4r
       options_pattern = { :database => :mandatory, :user => :optional, :password => :optional }
       verify_options(options, options_pattern)
 
-      # additional authentication allowed, overriden in 'call_server' if not defined
       params = {:method => :get, :uri => "database/#{options[:database]}"}
+      params[:no_session] = true # out of existing session which represents an already done authentication
+
+      # additional authentication allowed, overriden in 'call_server' if not defined
       params[:user] = options[:user] if options.include? :user
       params[:password] = options[:password] if options.include? :password
 
@@ -191,12 +208,24 @@ module Orientdb4r
       }
       verify_and_sanitize_options(options, options_pattern)
 
+      params = { :method => :delete, :uri => "database/#{options[:database]}" }
+      params[:no_session] = true # out of existing session which represents an already done authentication
+
       # additional authentication allowed, overriden in 'call_server' if not defined
-      response = call_server_one_off :method => :delete, :uri => "database/#{options[:database]}"
+      params[:user] = options[:user] if options.include? :user
+      params[:password] = options[:password] if options.include? :password
+
+      response = call_server params
       process_response(response)
     end
 
 
+    def list_databases() #:nodoc:
+      response = call_server :method => :get, :uri => 'listDatabases', :no_session => true
+      rslt = process_response(response)
+      rslt['databases']
+    end
+
     # ---------------------------------------------------------------------- SQL
 
     def query(sql, options=nil) #:nodoc:

data/lib/orientdb4r/rest/excon_node.rb

@@ -11,7 +11,8 @@ module Orientdb4r
 
     def request(options) #:nodoc:
       verify_options(options, {:user => :mandatory, :password => :mandatory, \
-          :uri => :mandatory, :method => :mandatory, :content_type => :optional, :data => :optional})
+          :uri => :mandatory, :method => :mandatory, :content_type => :optional, :data => :optional,
+          :no_session => :optional})
 
       opts = options.clone # if not cloned we change original hash map that cannot be used more with load balancing
 
@@ -19,6 +20,7 @@ module Orientdb4r
       opts[:headers] = headers(opts)
       opts.delete :user
       opts.delete :password
+      use_session = !opts.delete(:no_session)
 
       opts[:body] = opts[:data] if opts.include? :data # just other naming convention
       opts.delete :data
@@ -33,7 +35,7 @@ module Orientdb4r
         # store session ID if received to reuse in next request
         cookies = CGI::Cookie::parse(response.headers['Set-Cookie'])
         sessid = cookies[SESSION_COOKIE_NAME][0]
-        if session_id != sessid
+        if session_id != sessid and use_session
           @session_id = sessid
           Orientdb4r::logger.debug "new session id: #{session_id}"
         end
@@ -94,7 +96,7 @@ module Orientdb4r
       # Get request headers prepared with session ID and Basic Auth.
       def headers(options)
         rslt = {'Authorization' => basic_auth_header(options[:user], options[:password])}
-        rslt['Cookie'] = "#{SESSION_COOKIE_NAME}=#{session_id}" unless session_id.nil?
+        rslt['Cookie'] = "#{SESSION_COOKIE_NAME}=#{session_id}" if !session_id.nil? and !options[:no_session]
         rslt['Content-Type'] = options[:content_type] if options.include? :content_type
         rslt['User-Agent'] = user_agent unless user_agent.nil?
         rslt

data/lib/orientdb4r/rest/model.rb

@@ -61,6 +61,12 @@ module Orientdb4r
       get_mandatory_attribute :defaultCluster
     end
 
+    ###
+    # Get flag whether the class is abstract.
+    def abstract?
+      get_mandatory_attribute :abstract
+    end
+
   end
 
 

data/lib/orientdb4r/rest/restclient_node.rb

@@ -9,7 +9,8 @@ module Orientdb4r
 
     def request(options) #:nodoc:
       verify_options(options, {:user => :mandatory, :password => :mandatory, \
-          :uri => :mandatory, :method => :mandatory, :content_type => :optional, :data => :optional})
+          :uri => :mandatory, :method => :mandatory, :content_type => :optional, :data => :optional,
+          :no_session => :optional})
 
       opts = options.clone # if not cloned we change original hash map that cannot be used more with load balancing
 
@@ -23,7 +24,8 @@ module Orientdb4r
       opts[:payload] = data unless data.nil?
 
       # cookies
-      opts[:cookies] = { SESSION_COOKIE_NAME => session_id} unless session_id.nil?
+      use_session = !opts.delete(:no_session)
+      opts[:cookies] = { SESSION_COOKIE_NAME => session_id} if use_session and !session_id.nil?
       # headers
       opts[:headers] = { 'User-Agent' => user_agent } unless user_agent.nil?
 
@@ -32,7 +34,7 @@ module Orientdb4r
 
         # store session ID if received to reuse in next request
         sessid = response.cookies[SESSION_COOKIE_NAME]
-        if session_id != sessid
+        if session_id != sessid and use_session
           @session_id = sessid
           Orientdb4r::logger.debug "new session id: #{session_id}"
         end

data/lib/orientdb4r/utils.rb

@@ -81,7 +81,7 @@ module Orientdb4r
   end # Utils
 
 
-  # TODO extend it to work with already defined methods ('before :foo, :baz' after method definition)
+  # TODO extend it to work with already defined methods ('before :foo, :baz' after method definition) [BF #21]
   module Aop2
 
     def self.included(base)

data/lib/orientdb4r/version.rb

@@ -2,7 +2,8 @@ module Orientdb4r
 
   # Version history.
   VERSION_HISTORY = [
-    ['0.3.2',   '2012-11-02', "Feature #13 (User-Agent), #16 (configurable Recover Time in Load Balancing)"],
+    ['0.3.3',   '2012-12-16', "Enh #18 ('abstract' option into creating a new class), Enh #19 (GET - List Databases)"],
+    ['0.3.2',   '2012-11-02', "Enh #13 (User-Agent), Enh #16 (configurable Recover Time in Load Balancing)"],
     ['0.3.1',   '2012-08-27', "Timeout for reuse of dirty nodes in load balancing; BF #14, BF #15"],
     ['0.3.0',   '2012-08-01', "Added support for cluster of distributed servers + load balancing"],
     ['0.2.10',  '2012-07-21', "Experimental support for Excon HTTP library with Keep-Alive connection"],

data/test/test_database.rb

@@ -49,6 +49,9 @@ class TestDatabase < Test::Unit::TestCase
     assert_raise Orientdb4r::UnauthorizedError do
       @client.connect :database => 'temp', :user => 'admin1', :password => 'admin'
     end
+
+    # clean up
+    @client.disconnect
   end
 
 
@@ -161,12 +164,24 @@ class TestDatabase < Test::Unit::TestCase
   end
 
 
+  ###
+  # GET List Databases
+  # Retrieves the available databases.
+  def test_list_databases
+    dbs = @client.list_databases
+    assert_not_nil dbs
+    assert_instance_of Array, dbs
+    assert !dbs.empty?
+    assert dbs.include? 'temp'
+  end
+
+
   ###
   # Test of :assert_connected before advice.
   def test_assert_connected
     assert_raise Orientdb4r::ConnectionError do @client.query 'SELECT FROM OUser'; end
     assert_raise Orientdb4r::ConnectionError do @client.query "INSERT INTO OUser(name) VALUES('x')"; end
-    assert_raise Orientdb4r::ConnectionError do @client.create_class 'x'; end
+    #BF #21 assert_raise Orientdb4r::ConnectionError do @client.create_class 'x'; end
     assert_raise Orientdb4r::ConnectionError do @client.create_property 'x', 'prop', :boolean; end
     assert_raise Orientdb4r::ConnectionError do @client.get_class 'x'; end
     assert_raise Orientdb4r::ConnectionError do @client.drop_class 'x'; end

data/test/test_ddo.rb

@@ -45,6 +45,7 @@ class TestDdo < Test::Unit::TestCase
     assert !clazz.clusters.empty?
     assert_not_nil clazz.default_cluster
     assert clazz.kind_of? Orientdb4r::OClass
+    assert !clazz.abstract?
     # test Property
     prop = clazz.property :password
     assert_equal 'password', prop.name
@@ -73,6 +74,15 @@ class TestDdo < Test::Unit::TestCase
     # create with :force=>true
     assert_nothing_thrown do @client.create_class(CLASS, :force => true); end
     assert_nothing_thrown do @client.get_class(CLASS); end
+
+    # create ABSTRACT
+    ab_class = 'testingAbstr'
+    assert_nothing_thrown do @client.create_class(ab_class, :abstract => true); end
+    clazz = @client.get_class ab_class
+    assert clazz.abstract?
+    assert_raise Orientdb4r::ServerError do @client.create_document({ '@class' => ab_class, 'prop1' => 1 }); end
+    # clean up
+    @client.drop_class(ab_class, :mode => :strict)
   end
 
 

data/test/test_document_crud.rb

@@ -107,6 +107,7 @@ class TestDocumentCrud < Test::Unit::TestCase
 
     # bad version
     doc = @client.get_document rid
+    doc['prop1'] = 222 # a property has to be changed to server engine sees a difference
     doc['@version'] = 2
     assert_raise Orientdb4r::DataError do @client.update_document doc; end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orientdb4r
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-02 00:00:00.000000000 Z
+date: 2012-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client