arangorb 0.1.0

data/lib/ArangoRB_Ver.rb

@@ -0,0 +1,138 @@
+# === GRAPH VERTEX ===
+
+# ==== DOCUMENT ====
+
+class ArangoV < ArangoDoc
+  def initialize(key: nil, collection: @@collection, graph: @@graph, database: @@database,  body: {})
+    if collection.is_a?(String)
+      @collection = collection
+    elsif collection.is_a?(ArangoC)
+      @collection = collection.collection
+    else
+      raise "collection should be a String or an ArangoC instance, not a #{collection.class}"
+    end
+
+    if graph.is_a?(String)
+      @graph = graph
+    elsif graph.is_a?(ArangoG)
+      @graph = graph.graph
+    else
+      raise "graph should be a String or an ArangoG instance, not a #{graph.class}"
+    end
+
+    if database.is_a?(String)
+      @database = database
+    else
+      raise "database should be a String, not a #{database.class}"
+    end
+
+    if key.is_a?(String) || key.nil?
+      @key = key
+      unless key.nil?
+        body["_key"] = @key
+        @id = "#{@collection}/#{@key}"
+      end
+    else
+      raise "key should be a String, not a #{key.class}"
+    end
+
+    if body.is_a?(Hash)
+      @body = body
+    else
+      raise "body should be a Hash, not a #{body.class}"
+    end
+  end
+
+  attr_reader :key, :id, :body, :database, :graph, :collection
+
+  # === GET ===
+
+  def retrieve
+    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{@id}").parsed_response
+    if @@verbose
+      @body = result["vertex"] unless result["error"]
+      result
+    else
+      if result["error"]
+        result["errorMessage"]
+      else
+        @body = result["vertex"]
+        self
+      end
+    end
+  end
+
+# === POST ====
+
+  def create(body: @body, waitForSync: nil)
+    query = {"waitForSync" => waitForSync}.delete_if{|k,v| v.nil?}
+    body["_key"] = @key if body["_key"].nil? && !@key.nil?
+    new_Document = { :body => body.to_json, :query => query }
+    result = self.class.post("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{@collection}", new_Document).parsed_response
+    return_result(result, body)
+  end
+  alias create_vertex create
+
+# === MODIFY ===
+
+  def replace(body: {}, waitForSync: nil)
+    query = { "waitForSync" => waitForSync }.delete_if{|k,v| v.nil?}
+    new_Document = { :body => body.to_json, :query => query }
+    result = self.class.put("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{@id}", new_Document).parsed_response
+    return_result(result, body)
+  end
+
+  def update(body: {}, waitForSync: nil, keepNull: nil)
+    query = {"waitForSync" => waitForSync, "keepNull" => keepNull}.delete_if{|k,v| v.nil?}
+    new_Document = { :body => body.to_json, :query => query }
+    result = self.class.patch("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{@id}", new_Document).parsed_response
+    if @@verbose
+      unless result["error"]
+        @key = result["_key"]
+        @id = "#{@collection}/#{@key}"
+        @body = body
+      end
+      result
+    else
+      if result["error"]
+        result["errorMessage"]
+      else
+        @key = result["_key"]
+        @id = "#{@collection}/#{@key}"
+        @body = @body.merge(body)
+        self
+      end
+    end
+  end
+
+# === DELETE ===
+
+  def destroy(body: nil, waitForSync: nil)
+    query = { "waitForSync" => waitForSync }.delete_if{|k,v| v.nil?}
+    new_Document = { :query => query }
+    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{@id}").parsed_response
+    @@verbose ? result : result["error"] ? result["errorMessage"] : true
+  end
+
+# === UTILITY ===
+
+  def return_result(result, body)
+    if @@verbose
+      unless result["error"]
+        @key = result["vertex"]["_key"]
+        @id = "#{@collection}/#{@key}"
+        @body = body
+      end
+      result
+    else
+      if result["error"]
+        result["errorMessage"]
+      else
+        @key = result["vertex"]["_key"]
+        @id = "#{@collection}/#{@key}"
+        @body = body
+        self
+      end
+    end
+  end
+end

data/lib/arangorb.rb

@@ -0,0 +1,10 @@
+require "httparty"
+require_relative "ArangoRB_Ser"
+require_relative "ArangoRB_DB"
+require_relative "ArangoRB_Col"
+require_relative "ArangoRB_Doc"
+require_relative "ArangoRB_Gra"
+require_relative "ArangoRB_Ver"
+require_relative "ArangoRB_Edg"
+require_relative "ArangoRB_Tra"
+require_relative "ArangoRB_AQL"

data/spec/arangoRB_helper.rb

@@ -0,0 +1,9 @@
+require "lib/arangoS_helper"
+require "lib/arangoDB_helper"
+require "lib/arangoC_helper"
+require "lib/arangoDoc_helper"
+require "lib/arangoG_helper"
+require "lib/arangoV_helper"
+require "lib/arangoE_helper"
+require "lib/arangoT_helper"
+require "lib/arangoAQL_helper"

data/spec/lib/arangoAQL_helper.rb

@@ -0,0 +1,83 @@
+require_relative './../spec_helper'
+
+describe ArangoT do
+  before :all do
+    ArangoS.default_server user: "root", password: "tretretre", server: "localhost", port: "8529"
+    ArangoS.database = "MyDatabase"
+    ArangoS.collection = "MyCollection"
+    ArangoS.graph = "MyGraph"
+    ArangoDB.new.create
+    @myGraph = ArangoG.new.create
+    @myCollection = ArangoC.new.create
+    @myEdgeCollection = ArangoC.new(collection: "MyEdgeCollection").create_edge_collection
+    @myGraph.addEdgeCollection collection: "MyEdgeCollection", from: "MyCollection", to: "MyCollection"
+    @myAQL = ArangoAQL.new query: "FOR u IN MyCollection RETURN u.num"
+    @myDoc = @myCollection.create_document document: [{"num" => 1, "_key" => "FirstKey"}, {"num" => 1}, {"num" => 1}, {"num" => 1}, {"num" => 1}, {"num" => 1}, {"num" => 1}, {"num" => 2}, {"num" => 2}, {"num" => 2}, {"num" => 3}, {"num" => 2}, {"num" => 5}, {"num" => 2}]
+    @myEdgeCollection.create_edge from: [@myDoc[0].id, @myDoc[1].id, @myDoc[2].id, @myDoc[3].id, @myDoc[7].id], to: [@myDoc[4].id, @myDoc[5].id, @myDoc[6].id, @myDoc[8].id]
+  end
+
+  after :all do
+    ArangoDB.new.destroy
+  end
+
+  context "#new" do
+    it "create a new AQL instance" do
+      myAQL = ArangoAQL.new query: "FOR u IN MyCollection RETURN u.num"
+      expect(myAQL.query).to eq "FOR u IN MyCollection RETURN u.num"
+    end
+
+    it "instantiate size" do
+      @myAQL.size = 5
+      expect(@myAQL.size).to eq 5
+    end
+  end
+
+  context "#execute" do
+    it "execute Transaction" do
+      @myAQL.execute
+      expect(@myAQL.result.length).to eq 5
+    end
+
+    it "execute again Transaction" do
+      @myAQL.next
+      expect(@myAQL.result.length).to eq 5
+    end
+  end
+
+  context "#info" do
+    it "explain" do
+      expect(@myAQL.explain["cacheable"]).to be true
+    end
+
+    it "parse" do
+      expect(@myAQL.parse["parsed"]).to be true
+    end
+
+    it "properties" do
+      expect(@myAQL.properties["enabled"]).to be true
+    end
+
+    it "current" do
+      expect(@myAQL.current).to eq []
+    end
+
+    it "slow" do
+      expect(@myAQL.slow).to eq []
+    end
+  end
+
+  context "#delete" do
+    it "stopSlow" do
+      expect(@myAQL.stopSlow).to be true
+    end
+
+    it "kill" do
+      expect(@myAQL.kill.class).to be String
+    end
+
+    it "changeProperties" do
+      result = @myAQL.changeProperties maxSlowQueries: 65
+      expect(result["maxSlowQueries"]).to eq 65
+    end
+  end
+end

data/spec/lib/arangoC_helper.rb

@@ -0,0 +1,149 @@
+require_relative './../spec_helper'
+
+describe ArangoC do
+  before :all do
+    ArangoS.default_server user: "root", password: "tretretre", server: "localhost", port: "8529"
+    ArangoS.database = "MyDatabase"
+    ArangoS.collection = "MyCollection"
+    ArangoDB.new.create
+    @myCollection = ArangoC.new
+    @myEdgeCollection = ArangoC.new collection: "MyEdgeCollection"
+  end
+
+  after :all do
+    ArangoDB.new.destroy
+  end
+
+  context "#new" do
+    it "create a new instance without global" do
+      myCollection = ArangoC.new collection: "MyCollection"
+      expect(myCollection.collection).to eq "MyCollection"
+    end
+
+    it "create a new instance with global" do
+      myCollection = ArangoC.new
+      expect(myCollection.collection).to eq "MyCollection"
+    end
+
+    it "create a new instance with type Edge" do
+      myCollection = ArangoC.new collection: "MyCollection", type: "Edge"
+      expect(myCollection.type).to eq "Edge"
+    end
+  end
+
+  context "#create" do
+    it "create a new Collection" do
+      myCollection = @myCollection.create
+      expect(myCollection.collection).to eq "MyCollection"
+    end
+
+    it "create a duplicate Collection" do
+      myCollection = @myCollection.create
+      expect(myCollection).to eq "cannot create collection: duplicate name"
+    end
+
+    it "create a new Edge Collection" do
+      myCollection = @myEdgeCollection.create_edge_collection
+      expect(myCollection.type).to eq "Edge"
+    end
+
+    it "create a new Document in the Collection" do
+      myDocument = @myCollection.create_document document: {"Hello" => "World", "num" => 1}
+      expect(myDocument.body["Hello"]).to eq "World"
+    end
+
+    it "create new Documents in the Collection" do
+      myDocument = @myCollection.create_document document: [{"Ciao" => "Mondo", "num" => 1}, {"Hallo" => "Welt", "num" => 2}]
+      expect(myDocument[0].body["Ciao"]).to eq "Mondo"
+    end
+
+    it "create a new Edge in the Collection" do
+      myDoc = @myCollection.create_document document: [{"A" => "B", "num" => 1}, {"C" => "D", "num" => 3}]
+      myEdge = @myEdgeCollection.create_edge from: myDoc[0].id, to: myDoc[1].id
+      expect(myEdge.body["_from"]).to eq myDoc[0].id
+    end
+  end
+
+  context "#info" do
+    it "retrieve the Collection" do
+      info = @myCollection.retrieve
+      expect(info.collection).to eq "MyCollection"
+    end
+
+    it "properties of the Collection" do
+      info = @myCollection.properties
+      expect(info["name"]).to eq "MyCollection"
+    end
+
+    it "documents in the Collection" do
+      info = @myCollection.count
+      expect(info).to eq 5
+    end
+
+    it "statistics" do
+      info = @myCollection.stats
+      expect(info["lastTick"]).to eq "0"
+    end
+
+    it "checksum" do
+      info = @myCollection.checksum
+      expect(info.class).to eq String
+    end
+
+    it "list Documents" do
+      info = @myCollection.allDocuments
+      expect(info.length).to eq 5
+    end
+
+    it "search Documents by match" do
+      info = @myCollection.documentsMatch match: {"num" => 1}
+      expect(info.length).to eq 3
+    end
+
+    it "search Document by match" do
+      info = @myCollection.documentMatch match: {"num" => 1}
+      expect(info.collection).to eq "MyCollection"
+    end
+
+    it "search random Document" do
+      info = @myCollection.random
+      expect(info.collection).to eq "MyCollection"
+    end
+  end
+
+  context "#modify" do
+    it "load" do
+      myCollection = @myCollection.load
+      expect(myCollection.collection).to eq "MyCollection"
+    end
+
+    it "unload" do
+      myCollection = @myCollection.unload
+      expect(myCollection.collection).to eq "MyCollection"
+    end
+
+    it "change" do
+      myCollection = @myCollection.change waitForSync: true
+      expect(myCollection.body["waitForSync"]).to be true
+    end
+
+    it "rename" do
+      myCollection = @myCollection.rename "MyCollection2"
+      expect(myCollection.collection).to eq "MyCollection2"
+    end
+  end
+
+  context "#truncate" do
+    it "truncate a Collection" do
+      myCollection = @myCollection.truncate
+      expect(myCollection.count).to eq 0
+    end
+  end
+
+  context "#destroy" do
+    it "delete a Collection" do
+      myCollection = @myCollection.destroy
+      expect(myCollection).to be true
+    end
+  end
+end

data/spec/lib/arangoDB_helper.rb

@@ -0,0 +1,119 @@
+require_relative './../spec_helper'
+
+describe ArangoDB do
+  before :all do
+    ArangoS.default_server user: "root", password: "tretretre", server: "localhost", port: "8529"
+    ArangoS.database = "MyDatabase"
+    @myDatabase = ArangoDB.new
+  end
+
+  context "#new" do
+    it "create a new instance without global" do
+      myDatabase = ArangoDB.new database: "MyDatabase"
+      expect(myDatabase.database).to eq "MyDatabase"
+    end
+
+    it "create a new instance with global" do
+      myDatabase = ArangoDB.new
+      expect(myDatabase.database).to eq "MyDatabase"
+    end
+  end
+
+  context "#create" do
+    it "create a new Database" do
+      myDatabase = @myDatabase.create
+      expect(myDatabase.database).to eq "MyDatabase"
+    end
+
+    it "create a duplicate Database" do
+      myDatabase = @myDatabase.create
+      expect(myDatabase).to eq "duplicate name"
+    end
+  end
+
+  context "#info" do
+    it "obtain general info" do
+      info = ArangoDB.info
+      expect(info["name"]).to eq "_system"
+    end
+
+    it "list databases" do
+      list = ArangoDB.databases
+      expect(list.length).to be >= 1
+    end
+
+    it "list collections" do
+      list = @myDatabase.collections
+      expect(list.length).to be 0
+    end
+
+    it "list graphs" do
+      list = @myDatabase.graphs
+      expect(list.length).to be 0
+    end
+  end
+
+  context "#query" do
+    it "properties" do
+      expect(@myDatabase.propertiesQuery["enabled"]).to be true
+    end
+
+    it "current" do
+      expect(@myDatabase.currentQuery).to eq []
+    end
+
+    it "slow" do
+      expect(@myDatabase.slowQuery).to eq []
+    end
+  end
+
+  context "#delete query" do
+    it "stopSlow" do
+      expect(@myDatabase.stopSlowQuery).to be true
+    end
+
+    it "kill" do
+      expect(@myDatabase.killQuery(id: "4353453463443").class).to be String
+    end
+
+    it "changeProperties" do
+      result = @myDatabase.changePropertiesQuery maxSlowQueries: 65
+      expect(result["maxSlowQueries"]).to eq 65
+    end
+  end
+
+  context "#cache" do
+    it "clear" do
+      expect(@myDatabase.clearCache).to be true
+    end
+
+    it "change Property Cache" do
+      @myDatabase.changePropertyCache maxResults: 130
+      expect(@myDatabase.propertyCache["maxResults"]).to eq 130
+    end
+  end
+
+  context "#function" do
+    it "create Function" do
+      result = @myDatabase.createFunction name: "myfunctions::temperature::celsiustofahrenheit", code: "function (celsius) { return celsius * 1.8 + 32; }"
+      expect(result.class).to eq Hash
+    end
+
+    it "list Functions" do
+      result = @myDatabase.functions
+      expect(result[0]["name"]).to eq "myfunctions::temperature::celsiustofahrenheit"
+    end
+
+    it "delete Function" do
+      result = @myDatabase.deleteFunction name: "myfunctions::temperature::celsiustofahrenheit"
+      expect(result).to be true
+    end
+  end
+
+  context "#destroy" do
+    it "delete a Database" do
+      myDatabase = @myDatabase.destroy
+      expect(myDatabase).to be true
+    end
+  end
+end