orientdb4r 0.2.4 → 0.2.5

data/README.rdoc

@@ -72,12 +72,15 @@ see Wiki page for more sample at https://github.com/veny/orientdb4r/wiki
 Tested on
 * Ruby 1.9.3
 * OrientDB 1.0.0
+* OrientDB 1.1.0-SNAPSHOT r5913+
 
 == TESTS
+In order to run the tests you only need to:
 
-   rake test
+  cd /path/to/repository
+  rake test
 
-Start an instance of OrientDB (on localhost with default port and 'admin/admin' account) before running.
+Start an instance of OrientDB (on localhost with default web port 2480 and 'admin/admin' account) before running.
 
 == AUTHOR
 

data/lib/orientdb4r/client.rb

@@ -16,6 +16,7 @@ module Orientdb4r
       @connected = false
     end
 
+
     # --------------------------------------------------------------- CONNECTION
 
     ###
@@ -47,6 +48,7 @@ module Orientdb4r
       raise NotImplementedError, 'this should be overridden by concrete client'
     end
 
+
     # ----------------------------------------------------------------- DATABASE
 
     ###
@@ -59,11 +61,25 @@ module Orientdb4r
 
 
     ###
-    # Gets informations about requested class.
-    def get_class(name)
+    # Retrieves all the information about a database.
+    def get_database(name)
       raise NotImplementedError, 'this should be overridden by concrete client'
     end
 
+
+    ###
+    # Checks existence of a given database.
+    def database_exists?(name)
+      rslt = true
+      begin
+        get_database name
+      rescue NotFoundError
+        rslt = false
+      end
+      rslt
+    end
+
+
     # ---------------------------------------------------------------------- SQL
 
     ###
@@ -79,6 +95,7 @@ module Orientdb4r
       raise NotImplementedError, 'this should be overridden by concrete client'
     end
 
+
     # -------------------------------------------------------------------- CLASS
 
     ###
@@ -111,6 +128,13 @@ module Orientdb4r
     end
 
 
+    ###
+    # Gets informations about requested class.
+    def get_class(name)
+      raise NotImplementedError, 'this should be overridden by concrete client'
+    end
+
+
     ###
     # Removes a class from the schema.
     def drop_class(name, options={})

data/lib/orientdb4r/rest/client.rb

@@ -6,7 +6,7 @@ module Orientdb4r
     # Name of cookie that represents a session.
     SESSION_COOKIE_NAME = 'OSESSIONID'
 
-    before [:create_database, :get_class, :query, :command], :assert_connected
+    before [:create_database, :get_database, :get_class, :query, :command], :assert_connected
     around [:query, :command], :time_around
 
     attr_reader :host, :port, :ssl, :user, :password, :database, :session_id
@@ -22,6 +22,8 @@ module Orientdb4r
     end
 
 
+    # --------------------------------------------------------------- CONNECTION
+
     def connect(options) #:nodoc:
       options_pattern = { :database => :mandatory, :user => :mandatory, :password => :mandatory }
       verify_and_sanitize_options(options, options_pattern)
@@ -89,6 +91,26 @@ module Orientdb4r
     end
 
 
+    def server(options={}) #:nodoc:
+      # 'server' does NOT use the RestClient Resource to construct the HTTP request
+
+      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
+
+
+    # ----------------------------------------------------------------- DATABASE
+
     def create_database(options) #:nodoc:
       options_pattern = {
         :database => :mandatory, :type => 'memory',
@@ -108,6 +130,46 @@ module Orientdb4r
     end
 
 
+    def get_database(name) #:nodoc:
+      begin
+        response = @resource["database/#{name}"].get
+      rescue
+        raise NotFoundError
+      end
+      process_response(response)
+    end
+
+
+    # ---------------------------------------------------------------------- SQL
+
+    def query(sql) #:nodoc:
+      raise ArgumentError, 'query is blank' if blank? sql
+
+      response = @resource["query/#{@database}/sql/#{CGI::escape(sql)}"].get
+      entries = process_response(response)
+      rslt = entries['result']
+      # mixin all document entries (they have '@class' attribute)
+      rslt.each { |doc| doc.extend Orientdb4r::DocumentMetadata unless doc['@class'].nil? }
+      rslt
+    end
+
+
+    def command(sql) #:nodoc:
+      raise ArgumentError, 'command is blank' if blank? sql
+      begin
+#puts "REQ command/#{@database}/sql/#{CGI::escape(sql)}"
+        response = @resource["command/#{@database}/sql/#{CGI::escape(sql)}"].post ''
+        rslt = process_response(response)
+        rslt
+#puts "RESP #{response.body}"
+      rescue
+        raise OrientdbError
+      end
+    end
+
+
+    # -------------------------------------------------------------------- CLASS
+
     def get_class(name) #:nodoc:
       raise ArgumentError, "class name is blank" if blank?(name)
 
@@ -144,50 +206,6 @@ module Orientdb4r
     end
 
 
-    def query(sql) #:nodoc:
-      raise ArgumentError, 'query is blank' if blank? sql
-
-      response = @resource["query/#{@database}/sql/#{CGI::escape(sql)}"].get
-      entries = process_response(response)
-      rslt = entries['result']
-      # mixin all document entries (they have '@class' attribute)
-      rslt.each { |doc| doc.extend Orientdb4r::DocumentMetadata unless doc['@class'].nil? }
-      rslt
-    end
-
-
-    def command(sql) #:nodoc:
-      raise ArgumentError, 'command is blank' if blank? sql
-      begin
-#puts "REQ #{sql}"
-        response = @resource["command/#{@database}/sql/#{CGI::escape(sql)}"].post ''
-        rslt = process_response(response)
-        rslt
-puts "RESP #{response.body}"
-      rescue
-        raise OrientdbError
-      end
-    end
-
-
-    def server(options={}) #:nodoc:
-      # 'server' does NOT use the RestClient Resource to construct the HTTP request
-
-      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)

data/lib/orientdb4r/utils.rb

@@ -82,16 +82,22 @@ module Orientdb4r
     class DataGenerator
 
       def initialize
-        @worlds = IO.readlines('/usr/share/dict/words')
-        0.upto(@worlds.size - 1) do |i|
-          word = @worlds[i]
+        @words = IO.readlines('/usr/share/dict/words')
+        0.upto(@words.size - 1) do |i|
+          word = @words[i]
           word.strip!
           idx = word.index("'")
           word = word[0..(idx - 1)] unless idx.nil?
-          @worlds[i] = word
+          @words[i] = word
         end
-        @worlds.uniq
-        Orientdb4r::logger.info "DataGenerator: #{@worlds.size} words"
+        @words.uniq
+        Orientdb4r::logger.info "DataGenerator: #{@words.size} words"
+      end
+
+      ###
+      # Gets a random word.
+      def word
+        @words[rand(@words.size)]
       end
 
     end # DataGenerator

data/lib/orientdb4r/version.rb

@@ -2,6 +2,7 @@ module Orientdb4r
 
   # Version history.
   VERSION_HISTORY = [
+    ['0.2.5', '2012-07-01', "Added 'get_database' into database CRUD"],
     # v-- https://groups.google.com/forum/?fromgroups#!topic/orient-database/5MAMCvFavTc
     ['0.2.4', '2012-06-26', "Added session management"],
     ['0.2.3', '2012-06-24', "Documents received by a query are kind of Orientdb4r::DocumentMetadata"],

data/test/graphs.rb

@@ -0,0 +1,114 @@
+require 'orientdb4r'
+
+DB = 'temp'
+
+c = Orientdb4r.client
+c.connect :database => DB, :user => 'admin', :password => 'admin'
+dg = Orientdb4r::Utils::DataGenerator.new
+
+
+def clear(conn)
+  conn.drop_class 'Community'
+  puts "droped class: Community"
+  conn.drop_class 'OrgUnit'
+  puts "droped class: OrgUnit"
+  conn.drop_class 'User'
+  puts "droped class: User"
+end
+
+if ARGV.include?('--clear')
+  clear(c)
+end
+
+if ARGV.include?('--schema')
+  clear(c)
+  # OrgUnit
+  c.create_class 'OrgUnit' do |c|
+    c.property 'name', :string, :mandatory => true
+    c.property 'network', :boolean
+    c.link 'descendants', :linkset, 'OrgUnit'
+  end
+  puts "created class: OrgUnit"
+  # Community
+  c.create_class 'Community' do |c|
+    c.property 'name', :string, :mandatory => true
+  end
+  puts "created class: Community"
+  # User
+  c.create_class 'User' do |c|
+    c.property 'username', :string, :mandatory => true
+    c.property 'name', :string, :mandatory => true
+    c.link     'unit', :link, 'OrgUnit', :mandatory => true
+    c.link     'communities', :linkset, 'Community'
+  end
+  puts "created class: User"
+end
+
+if ARGV.include?('--data')
+
+  # Organisational Units
+  c. command 'DELETE FROM OrgUnit'
+  units = []
+
+  comp_rids = []
+  auto_rids = []
+  auto_rids << c.create_document({ '@class' => 'OrgUnit', :name => 'Sales', :network => true })
+  auto_rids << c.create_document({ '@class' => 'OrgUnit', :name => 'Marketing', :network => true })
+  auto_rids << c.create_document({ '@class' => 'OrgUnit', :name => 'Design', :network => true })
+  comp_rids << c.create_document({ '@class' => 'OrgUnit', :name => 'Automotive', :network => true, :descendants => auto_rids })
+  #
+  research_rids = []
+  research_rids << c.create_document({ '@class' => 'OrgUnit', :name => 'Scientist', :network => false })
+  research_rids << c.create_document({ '@class' => 'OrgUnit', :name => 'Spies', :network => false })
+  comp_rids << c.create_document({ '@class' => 'OrgUnit', :name => 'Research', :network => false, :descendants => research_rids })
+  #
+  infra_rids = []
+  recruit_rid = c.create_document({ '@class' => 'OrgUnit', :name => 'Recruitment', :network => false })
+  infra_rids << c.create_document({ '@class' => 'OrgUnit', :name => 'Human Resources', :network => false, :descendants => [recruit_rid] })
+  infra_rids << c.create_document({ '@class' => 'OrgUnit', :name => 'Accounting', :network => false })
+  comp_rids << c.create_document({ '@class' => 'OrgUnit', :name => 'Company Infrastructure', :network => false, :descendants => infra_rids })
+  #
+  units << c.create_document({ '@class' => 'OrgUnit', :name => 'Big Company', :network => false, :descendants => comp_rids })
+  units << auto_rids << research_rids << infra_rids << comp_rids
+  units.flatten!.uniq!
+  puts "created units: #{units}"
+
+  # Communities
+  c. command 'DELETE FROM Community'
+  communities = []
+  communities << c.create_document({ '@class' => 'Community', :name => 'Pianists' })
+  communities << c.create_document({ '@class' => 'Community', :name => 'Violinists' })
+  communities << c.create_document({ '@class' => 'Community', :name => 'Dog fanciers' })
+  communities << c.create_document({ '@class' => 'Community', :name => 'Cat fanciers' })
+  communities << c.create_document({ '@class' => 'Community', :name => 'Soccer fans' })
+  communities << c.create_document({ '@class' => 'Community', :name => 'Ski fans' })
+  communities << c.create_document({ '@class' => 'Community', :name => 'Basket fans' })
+  communities << c.create_document({ '@class' => 'Community', :name => 'Gourmets' })
+  communities << c.create_document({ '@class' => 'Community', :name => 'Scifi reader' })
+  communities << c.create_document({ '@class' => 'Community', :name => 'Comic reader' })
+  puts "created communities: #{communities}"
+
+  # Users
+  c. command 'DELETE FROM User'
+  1.upto(1000) do
+    first_name = dg.word.capitalize
+    surname = dg.word.capitalize
+    # random distribution of Units (1) & Communities (0..3)
+    unit = units[rand(units.size)]
+    comms = []
+    0.upto(rand(4)) { |i| comms << communities[rand(communities.size)] if i > 0 }
+
+    c.create_document({ '@class' => 'User', \
+                        :username => "#{first_name.downcase}.#{surname.downcase}", \
+                        :name => "#{first_name.capitalize} #{surname.capitalize}", \
+                        :unit => unit, \
+                        :communities => comms })
+  end
+
+end
+
+# FIND REFERENCES #6:5 [OrgUnit]  # get parent
+
+# TRAVERSE descendants FROM #6:10 WHERE $depth < 2  # get first level of descendants
+# SELECT FROM (TRAVERSE descendants FROM #6:10 WHERE $depth < 2) WHERE $depth > 0  # eliminate root of query
+# SELECT FROM orgunit WHERE any() traverse(0,10) (name = 'Recruitment')  # get ancestors

data/test/test_database.rb

@@ -75,6 +75,7 @@ class TestDatabase < Test::Unit::TestCase
   # 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'
+    assert_nothing_thrown do @client.get_database 'UniT'; end
     # creating an existing DB
     assert_raise Orientdb4r::OrientdbError do
       @client.create_database :database => 'UniT', :user => 'root', :password => 'root'
@@ -91,6 +92,26 @@ class TestDatabase < Test::Unit::TestCase
   end
 
 
+  ###
+  # GET DATABASE
+  def test_get_database
+    @client.connect :database => 'temp', :user => 'admin', :password => 'admin'
+    assert_nothing_thrown do @client.get_database 'temp'; end
+
+    rslt = @client.get_database 'temp'
+    assert_not_nil rslt
+    assert_instance_of Hash, rslt
+    assert rslt.include? 'classes'
+    assert @client.database_exists?('temp')
+
+    # bad databases
+    assert_raise Orientdb4r::NotFoundError do @client.get_database 'UnknownDB'; end
+    assert_raise Orientdb4r::NotFoundError do @client.get_database 'temp/admin'; end
+    assert !@client.database_exists?('UnknownDB')
+    assert !@client.database_exists?('temp/admin')
+  end
+
+
   ###
   # SERVER info
   # Temporary disabled because of dependency to password of 'root' account

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orientdb4r
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-26 00:00:00.000000000 Z
+date: 2012-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -48,6 +48,7 @@ files:
 - lib/orientdb4r/utils.rb
 - lib/orientdb4r/version.rb
 - orientdb4r.gemspec
+- test/graphs.rb
 - test/readme_sample.rb
 - test/test_database.rb
 - test/test_ddo.rb
@@ -80,6 +81,7 @@ signing_key:
 specification_version: 3
 summary: Ruby binding for Orient DB.
 test_files:
+- test/graphs.rb
 - test/readme_sample.rb
 - test/test_database.rb
 - test/test_ddo.rb