orientdb-binary 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 822de4e7fe6c71ba013c1a5ff83d47359fc29bf9
+  data.tar.gz: 20409e9c8397250249a51a4f94da04613d094846
+SHA512:
+  metadata.gz: b3593c9e0a8f34d3777de2a1f8bdf916c48cf5667168de66482c2f8df689f1e3345d28978760962f6fbfa0eb78936824357492108c09632a5fb70c0d477e4c88
+  data.tar.gz: 7df96f629462b46a538f68e7fd93ff0cc19e2d6beccbf5b925587f3a8f345e9b1af6d2e65a52e8e80311de01c473f39af9ccf85f6ceb040d8d7e613213585491

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+coverage/*

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in orientdb_binary.gemspec
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michal Ostrowski
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Orientdb Binary
+
+OrientDB Network Binary library for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'orientdb-binary'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install orientdb-binary
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/espresse/orientdb-binary/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,64 @@
+require "bundler/gem_tasks"
+task :default => [:test]
+
+
+task :build do
+  system "gem build orientdb-binary.gemspec"
+end
+
+task :release => :build do
+  system "gem push orientdb-binary-#{OrientdbBinary::VERSION}"
+end
+
+task :install do
+  system "gem install orientdb-binary-#{OrientdbBinary::Version}"
+end
+
+test_tasks = ['test:all']
+desc "Run all tests"
+task :test => test_tasks
+
+namespace :test do
+  desc "Run server tests"
+  task :server do
+    $: << 'lib'
+
+    $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
+    require_relative 'lib/orientdb_binary'
+    require 'test/test_helper'
+
+    Dir['./test/server/**/test_*.rb'].each { |test| require test }
+  end
+end
+
+namespace :test do
+  desc "Run database tests"
+  task :database do
+    $: << 'lib'
+
+    $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
+    require_relative 'lib/orientdb_binary'
+    require 'test/test_helper'
+
+    Dir['./test/database/**/test_*.rb'].each { |test| require test }
+  end
+end
+
+namespace :test do
+  desc "Run all tests and check coverage"
+  task :all do
+    $: << 'lib'
+    require 'simplecov'
+
+    SimpleCov.start do
+      add_filter "test"
+      command_name 'Mintest'
+    end
+
+    $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
+    require_relative 'lib/orientdb_binary'
+    require 'test/test_helper'
+
+    Dir['./test/**/test_*.rb'].each { |test| require test }
+  end
+end

data/lib/orientdb_binary.rb

@@ -0,0 +1,25 @@
+require 'socket'
+require 'bindata'
+require 'set'
+require 'bigdecimal'
+require 'date'
+
+require "orientdb_binary/config"
+
+require 'orientdb_binary/parser/deserializer'
+require 'orientdb_binary/parser/serializer'
+
+require 'orientdb_binary/operation_types'
+require 'orientdb_binary/protocols/base'
+require 'orientdb_binary/protocols/bindata_primitives'
+require 'orientdb_binary/protocols/errors'
+
+require 'orientdb_binary/connection'
+require 'orientdb_binary/base'
+
+require 'orientdb_binary/server'
+require 'orientdb_binary/database'
+
+module OrientdbBinary
+
+end

data/lib/orientdb_binary/base.rb

@@ -0,0 +1,40 @@
+module OrientdbBinary
+  class OrientdbBase
+    attr_accessor :socket, :protocol, :session
+
+    def initialize(options)
+      defaults = {
+        host: 'localhost',
+        port: 2424
+      }
+
+      @options = defaults.merge(options)
+
+      @server_connection = OrientdbBinary::Connection.new(@options)
+      @socket = @server_connection.socket
+      @connected = false
+      @session = OrientdbBinary::OperationTypes::NEW_SESSION
+    end
+
+    def connected?
+      @connected
+    end
+
+    def disconnect
+      close
+      @server_connection.close()
+    end
+
+    def close
+      @session = OrientdbBinary::OperationTypes::NEW_SESSION
+      @connected = false
+    end
+
+    private
+
+    def params (args={})
+      args.merge(session: session)
+    end
+
+  end
+end

data/lib/orientdb_binary/config.rb

@@ -0,0 +1,5 @@
+module OrientdbBinary
+  VERSION = "0.6.0"
+  NAME = "OrientDB Binary Protocol Ruby Client"
+  PROTOCOL_VERSION = 20
+end

data/lib/orientdb_binary/connection.rb

@@ -0,0 +1,17 @@
+module OrientdbBinary
+  class Connection
+
+    attr_accessor :socket, :protocol
+
+    def initialize(options)
+      @socket = TCPSocket.open(options[:host], options[:port])
+      @protocol = BinData::Int16be.read(socket)
+    end
+
+    def close
+      socket.close
+      @protocol = nil
+    end
+
+  end
+end

data/lib/orientdb_binary/database.rb

@@ -0,0 +1,24 @@
+require 'orientdb_binary/database_operations/base_operations'
+require 'orientdb_binary/database_operations/data_segment'
+require 'orientdb_binary/database_operations/data_cluster'
+require 'orientdb_binary/database_operations/record'
+require 'orientdb_binary/database_operations/query'
+require 'orientdb_binary/database_operations/transaction'
+
+module OrientdbBinary
+  class Database < OrientdbBinary::OrientdbBase
+    include OrientdbBinary::DatabaseOperations::BaseOperations
+    include OrientdbBinary::DatabaseOperations::DataSegment
+    include OrientdbBinary::DatabaseOperations::DataCluster
+    include OrientdbBinary::DatabaseOperations::Record
+    include OrientdbBinary::DatabaseOperations::Query
+    include OrientdbBinary::DatabaseOperations::Transaction
+
+    attr_accessor :clusters
+
+    def self.connect(options)
+      Database.new(options)
+    end
+
+  end
+end

data/lib/orientdb_binary/database_operations/base_operations.rb

@@ -0,0 +1,70 @@
+require 'orientdb_binary/protocols/db_close'
+require 'orientdb_binary/protocols/db_open'
+require 'orientdb_binary/protocols/db_reload'
+require 'orientdb_binary/protocols/db_size'
+require 'orientdb_binary/protocols/db_list'
+
+module OrientdbBinary
+  module DatabaseOperations
+    module BaseOperations
+
+      # Open database connection.
+      # Params:
+      # db: string -> database name
+      # user: username for accessing database
+      # password: user's pasword for database access
+      # storage: string -> memory, local, plocal; plocal is used by default
+      # Usage:
+      # db = OrientdbBinary::Database.open(db: "test", storage: 'plocal', user: 'admin', password: 'admin')
+      #
+      def open(args)
+        @db_params = {
+          db: args[:db],
+          storage: args[:storage]
+        }
+
+        defaults = {
+          storage: 'plocal'
+        }
+
+
+        connection = OrientdbBinary::Protocols::DbOpen.new(defaults.merge(args)).process(socket)
+
+        @session = connection[:session]
+        @connected = true if @session >= 0
+        @clusters = connection[:clusters]
+        connection
+      end
+
+      # Close databse connection
+      # No params are accepted
+      # Usage:
+      # db.close()
+      #
+      def close
+        OrientdbBinary::Protocols::DbClose.new(params).process(socket)
+        super
+      end
+
+      # Reload database. Information about clusters are updated
+      # No params are accepted
+      # Usage
+      # db.reload()
+      #
+      def reload
+        answer = OrientdbBinary::Protocols::DbReload.new(params).process(socket)
+        @clusters = answer[:clusters]
+        answer
+      end
+
+      # Return size of the database
+      # No params are accepted
+      # Usage:
+      # db.size()
+      #
+      def size
+        OrientdbBinary::Protocols::DbSize.new(params).process(socket)
+      end
+    end
+  end
+end

data/lib/orientdb_binary/database_operations/data_cluster.rb

@@ -0,0 +1,116 @@
+require 'orientdb_binary/protocols/datacluster_add'
+require 'orientdb_binary/protocols/datacluster_drop'
+require 'orientdb_binary/protocols/datacluster_count'
+require 'orientdb_binary/protocols/datacluster_datarange'
+require 'orientdb_binary/protocols/datacluster_lh_cluster_is_used'
+
+module OrientdbBinary
+  module DatabaseOperations
+    module DataCluster
+
+      # Add datacluster.
+      # name: string
+      # optional parameters:
+      # cluster_type: string (PHYSICAL or MEMORY), for memory databases it should be 'MEMORY', for local/plocal it can be either 'MEMORY or 'PHYSICAL'
+      # datasegment_name: string (should exists, 'default' is used by default)
+      # location: string
+      # cluster_id: string, should be -1 for new clusters
+      #
+      # Usage:
+      # db.add_datacluster(name: "posts") # uses default datasegment
+      # If needed datasegment should be created before
+      # db.add_datasegment(name: "posts")
+      # db.add_datacluster(name: "posts", datasegment_name: "posts")
+      #
+      def add_datacluster(args)
+        types = {
+          local: 'PHYSICAL',
+          plocal: 'PHYSICAL',
+          memory: 'MEMORY'
+        }
+
+        defaults = {
+          cluster_type: types[@db_params[:storage].to_sym],
+          datasegment_name: "default",
+          location: args[:name] + "_datacluster",
+          cluster_id: -1
+        }
+
+        options = defaults.merge(args)
+
+        OrientdbBinary::Protocols::DataclusterAdd.new(params(options)).process(socket)
+      end
+
+      # Find cluster by its parameter
+      # Usage:
+      # db.find_datacluster_by(name: 'default')
+      # db.find_datacluster_by(id: 1)
+      # Only first cluster is returned!
+      #
+      def find_datacluster_by(arg)
+        key = arg.keys.first
+        val = arg[key]
+        @clusters.select {|cluster| cluster["#{key}".to_sym] == val}.first
+      end
+
+      # Drops datacluster
+      # cluster_id: int
+      # or
+      # cluster_name: string
+      # Usage:
+      # db.drop_datacluster(cluster_id: 7)
+      # db.drop_datacluster(cluster_name: 'posts')
+      #
+      def drop_datacluster(args)
+        if args[:cluster_name] and not args[:cluster_id]
+          if cluster=find_datacluster_by(cluster_name: args[:cluster_name])
+            args[:cluster_id] = cluster[:cluster_id]
+          end
+        end
+        OrientdbBinary::Protocols::DataclusterDrop.new(params(args)).process(socket)
+      end
+
+      # cluster_ids: array of ids
+      # or
+      # cluster_names: array of names
+      # Usage:
+      # db.count_datacluster(cluster_ids: [0,1,2,3])
+      # db.count_datacluster(cluster_names: ['default', 'posts'])
+      #
+      def count_datacluster(args)
+        if args[:cluster_names] and not args[:cluster_ids]
+          args[:cluster_ids] = args[:cluster_names].map do |name|
+            cluster = find_datacluster_by(cluster_name: name)
+            cluster[:cluster_id] if cluster
+          end
+        end
+        args[:cluster_ids] = args[:cluster_ids].delete_if {|cluster| !cluster}
+        args[:cluster_count] = args[:cluster_ids].length
+
+        OrientdbBinary::Protocols::DataclusterCount.new(params(args)).process(socket)
+      end
+
+      # cluster_id: int
+      # or
+      # cluster_name: string
+      # Usage:
+      # db.datarange_datacluster(cluster_id: 7)
+      # db.datarange_datacluster(cluster_name: 'posts')
+      #
+      def datarange_datacluster(args)
+        if args[:cluster_name] and not args[:cluster_id]
+          if cluster=find_datacluster_by(cluster_name: args[:cluster_name])
+            args[:cluster_id] = cluster[:cluster_id]
+          end
+        end
+        OrientdbBinary::Protocols::DataclusterDatarange.new(params(args)).process(socket)
+      end
+
+      # it looks like it's not supported (?)
+      def datacluster_lh_cluster_is_used()
+        # OrientdbBinary::Protocols::DataclusterLhClusterIsUsed.new(session: session).process(socket)
+        return nil
+      end
+    end
+  end
+end