arangorb 0.1.0

data/lib/ArangoRB_Edg.rb

@@ -0,0 +1,157 @@
+# === GRAPH EDGE ===
+
+class ArangoE < ArangoDoc
+  def initialize(key: nil, collection: @@collection, graph: @@graph, database: @@database, body: {}, from: nil, to: nil)
+    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
+
+    if from.is_a?(String)
+      @body["_from"] = from
+    elsif from.is_a?(ArangoDoc)
+      @body["_from"] = from.id
+    elsif from.nil?
+    else
+      raise "from should be a String or an ArangoDoc instance, not a #{from.class}"
+    end
+
+    if to.is_a?(String)
+      @body["_to"] = to
+    elsif to.is_a?(ArangoDoc)
+      @body["_to"] = to.id
+    elsif to.nil?
+    else
+      raise "to should be a String or an ArangoDoc instance, not a #{to.class}"
+    end
+  end
+
+  attr_reader :key, :id, :body, :database, :graph, :collection
+
+  # === GET ===
+
+  def retrieve #DONE
+    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{@id}").parsed_response
+    if @@verbose
+      @body = result["edge"] unless result["error"]
+      result
+    else
+      if result["error"]
+        result["errorMessage"]
+      else
+        @body = result["edge"]
+        self
+      end
+    end
+  end
+
+# === POST ====
+
+  def create(body: {}, from: @body["_from"], to: @body["_to"], waitForSync: nil) #DONE
+    query = {"waitForSync" => waitForSync}.delete_if{|k,v| v.nil?}
+    body["_key"] = @key if body["_key"].nil? && !@key.nil?
+    body["_from"] = from.is_a?(String) ? from : from.id
+    body["_to"] = to.is_a?(String) ? to : to.id
+    new_Document = { :body => body.to_json, :query => query }.delete_if{|k,v| v.nil?}
+    result = self.class.post("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{@collection}", new_Document).parsed_response
+    self.return_result(result, body)
+  end
+  alias create_document create
+  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 }.delete_if{|k,v| v.nil?}
+    result = self.class.put("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{@id}", new_Document).parsed_response
+    self.return_result(result, body)
+  end
+
+  def update(body: {}, waitForSync: nil, keepNull: nil) #DONE
+    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}/edge/#{@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) #OONE
+    query = { "waitForSync" => waitForSync }.delete_if{|k,v| v.nil?}
+    new_Document = { :query => query }
+    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{@id}").parsed_response
+    @@verbose ? result : result["error"] ? result["errorMessage"] : true
+  end
+
+# === UTILITY ===
+
+  def return_result(result, body)
+    if @@verbose
+      unless result["error"]
+        @key = result["edge"]["_key"]
+        @id = "#{@collection}/#{@key}"
+        @body = body
+      end
+      result
+    else
+      if result["error"]
+        result["errorMessage"]
+      else
+        @key = result["edge"]["_key"]
+        @id = "#{@collection}/#{@key}"
+        @body = body
+        self
+      end
+    end
+  end
+end

data/lib/ArangoRB_Gra.rb

@@ -0,0 +1,168 @@
+# ==== GRAPH ====
+
+class ArangoG < ArangoS
+  def initialize(graph: @@graph, database: @@database, edgeDefinitions: [], orphanCollections: [])
+    if database.is_a?(String)
+      @database = database
+    else
+      raise "database should be a String, not a #{collection.class}"
+    end
+
+    if graph.is_a?(String)
+      @graph = graph
+      ArangoS.graph = graph
+    else
+      raise "graph should be a String, not a #{graph.class}"
+    end
+
+    if edgeDefinitions.is_a?(Array)
+      @edgeDefinitions = edgeDefinitions
+    else
+      raise "edgeDefinitions should be an Array, not a #{edgeDefinitions.class}"
+    end
+
+    if orphanCollections.is_a?(Array)
+      @orphanCollections = orphanCollections
+    else
+      raise "orphanCollections should be an Array, not a #{orphanCollections.class}"
+    end
+  end
+
+  attr_reader :graph, :edgeDefinitions, :orphanCollections, :database
+
+# === GET ===
+
+  def retrieve
+    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}").parsed_response
+    if @@verbose
+      result
+    else
+      if result["error"]
+        result["errorMessage"]
+      else
+        @edgeDefinitions = result["graph"]["edgeDefinitions"]
+        @orphanCollections = result["graph"]["orphanCollections"]
+        self
+      end
+    end
+  end
+
+# === POST ===
+
+  def create
+    body = { "name" => @graph, "edgeDefinitions" => @edgeDefinitions, "orphanCollections" => @orphanCollections }
+    new_Document = { :body => body.to_json }
+    result = self.class.post("/_db/#{@database}/_api/gharial", new_Document).parsed_response
+    @@verbose ? result : result["error"] ? result["errorMessage"] : self
+  end
+
+# === DELETE ===
+
+  def destroy
+    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}").parsed_response
+    @@verbose ? result : result["error"] ? result["errorMessage"] : result["removed"]
+  end
+
+# === VERTEX COLLECTION  ===
+
+  def vertexCollections
+    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}/vertex").parsed_response
+    @@verbose ? result : result["error"] ? result["errorMessage"] : result["collections"].map{|x| ArangoC.new(collection: x)}
+  end
+
+  def addVertexCollection(collection:)
+    collection = collection.is_a?(String) ? collection : collection.collection
+    body = { "collection" => collection }
+    new_Document = { :body => body.to_json }
+    result = self.class.post("/_db/#{@database}/_api/gharial/#{@graph}/vertex", new_Document).parsed_response
+    if @@verbose
+      result
+    else
+      if result["error"]
+        result["errorMessage"]
+      else
+        @orphanCollections << collection
+        self
+      end
+    end
+  end
+
+  def removeVertexCollection(collection:)
+    collection = collection.is_a?(String) ? collection : collection.collection
+    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{collection}")
+    if @@verbose
+      result
+    else
+      if result["error"]
+        result["errorMessage"]
+      else
+        @orphanCollections -= [collection]
+        self
+      end
+    end
+  end
+
+# === EDGE COLLECTION ===
+
+  def edgeCollections
+    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}/edge").parsed_response
+    @@verbose ? result : result["error"] ? result["errorMessage"] : result["collections"].map{|x| ArangoC.new(collection: x)}
+  end
+
+  def addEdgeCollection(collection:, from:, to:, replace: false)
+    from = from.is_a?(String) ? [from] : from.is_a?(ArangoC) ? [from.collection] : from
+    to = to.is_a?(String) ? [to] : to.is_a?(ArangoC) ? [to.collection] : to
+    body = {}
+    collection = collection.is_a?(String) ? collection : collection.collection
+    body["collection"] = collection
+    body["from"] = from.map{|f| f.is_a?(String) ? f : f.id }
+    body["to"] = to.map{|t| t.is_a?(String) ? t : t.id }
+    new_Document = { :body => body.to_json }
+
+    if replace
+      result = self.class.put("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{collection}", new_Document).parsed_response
+    else
+      result = self.class.post("/_db/#{@database}/_api/gharial/#{@graph}/edge", new_Document).parsed_response
+    end
+
+    if @@verbose
+      unless result["error"]
+        @edgeDefinitions = result["graph"]["edgeDefinitions"]
+        @orphanCollections = result["graph"]["orphanCollections"]
+      end
+      result
+    else
+      if result["error"]
+        result["errorMessage"]
+      else
+        @edgeDefinitions = result["graph"]["edgeDefinitions"]
+        @orphanCollections = result["graph"]["orphanCollections"]
+        self
+      end
+    end
+  end
+
+  def replaceEdgeCollection(collection:, from:, to:)
+    self.addEdgeCollection(collection: collection, from: from, to: to, replace: true)
+  end
+
+  def removeEdgeCollection(collection:)
+    collection = collection.is_a?(String) ? collection : collection.collection
+    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{collection}")
+    if @@verbose
+      unless result["error"]
+        @edgeDefinitions = result["graph"]["edgeDefinitions"]
+        @orphanCollections = result["graph"]["orphanCollections"]
+      end
+      result
+    else
+      if result["error"]
+        result["errorMessage"]
+      else
+        @edgeDefinitions = result["graph"]["edgeDefinitions"]
+        @orphanCollections = result["graph"]["orphanCollections"]
+        self
+      end
+    end
+  end
+end

data/lib/ArangoRB_Ser.rb

@@ -0,0 +1,64 @@
+# === SERVER ===
+
+class ArangoS
+  include HTTParty
+  @@verbose = false
+  @@database = "_system"
+  @@graph = nil
+  @@collection = nil
+
+  def self.default_server(user: "root", password:, server: "localhost", port: "8529")
+    base_uri "http://#{server}:#{port}"
+    basic_auth user, password
+  end
+
+  def self.verbose=(verbose)
+    @@verbose = verbose
+  end
+
+  def self.verbose
+    @@verbose
+  end
+
+  def self.database=(database)
+    if database.is_a? String
+      @@database = database
+    elsif database.is_a? ArangoDB
+      @@database = database.database
+    else
+      raise "database should be a String or an ArangoDB instance, not a #{database.class}"
+    end
+  end
+
+  def self.database
+    @@database
+  end
+
+  def self.graph=(graph)
+    if graph.is_a? String
+      @@graph = graph
+    elsif graph.is_a? ArangoG
+      @@graph = graph
+    else
+      raise "graph should be a String or an ArangoG instance, not a #{graph.class}"
+    end
+  end
+
+  def self.graph
+    @@graph
+  end
+
+  def self.collection=(collection)
+    if collection.is_a? String
+      @@collection = collection
+    elsif collection.is_a? ArangoC
+      @@collection = collection
+    else
+      raise "graph should be a String or an ArangoC instance, not a #{collection.class}"
+    end
+  end
+
+  def self.collection
+    @@collection
+  end
+end

data/lib/ArangoRB_Tra.rb

@@ -0,0 +1,132 @@
+# === TRAVERSAL ===
+
+class ArangoT < ArangoS
+  def initialize(body: {}, database: @@database, graph: nil, edgeCollection: nil)
+    @sort        = body["sort"]
+    @direction   = body["direction"]
+    @maxDepth    = body["maxDepth"]
+    @minDepth    = body["minDepth"]
+    @startVertex = body["startVertex"]
+    @visitor     = body["visitor"]
+    @itemOrder   = body["itemOrder"]
+    @strategy    = body["strategy"]
+    @filter      = body["filter"]
+    @init        = body["init"]
+    @maxiterations = body["maxiterations"]
+    @uniqueness  = body["uniqueness"]
+    @order       = body["order"]
+    @graphName   = body["graphName"].nil? ? graph : body["graphName"]
+    @expander    = body["expander"]
+    @edgeCollection = body["edgeCollection"].nil? ? edgeCollection : body["edgeCollection"]
+    @database = database
+    @vertices = nil
+    @paths = nil
+  end
+
+  attr_accessor :sort, :direction, :maxDepth, :minDepth, :visitor, :itemOrder, :strategy, :filter, :init, :maxiterations, :uniqueness, :order, :expander, :vertices, :paths, :database
+  attr_reader :startVertex, :graphName, :edgeCollection
+
+  def startVertex=(startVertex)
+    if startVertex.is_a?(String)
+      @startVertex = startVertex
+    elsif startVertex.is_a?(ArangoDoc)
+      @startVertex = startVertex.id
+    else
+      raise "startVertex should be a String or an ArangoDoc instance, not a #{startVertex.class}"
+    end
+  end
+
+  def graphName=(graphName)
+    if graphName.is_a?(String) || graphName.nil?
+      @graphName = graphName
+    elsif graphName.is_a?(ArangoG)
+      @graphName = graphName.graph
+    else
+      raise "graphName should be a String or an ArangoG instance, not a #{graphName.class}"
+    end
+  end
+
+  def edgeCollection=(edgeCollection)
+    if edgeCollection.is_a?(String) || edgeCollection.nil?
+      @edgeCollection = edgeCollection
+    elsif edgeCollection.is_a?(ArangoC)
+      @edgeCollection = edgeCollection.collection
+    else
+      raise "edgeCollection should be a String or an ArangoC instance, not a #{edgeCollection.class}"
+    end
+  end
+
+  def in
+    @direction = "inbound"
+  end
+
+  def out
+    @direction = "outbound"
+  end
+
+  def any
+    @direction = "any"
+  end
+
+  alias vertex= startVertex=
+  alias vertex startVertex
+  alias max maxDepth
+  alias max= maxDepth=
+  alias min minDepth
+  alias min= minDepth=
+  alias collection edgeCollection
+  alias collection= edgeCollection=
+  alias graph graphName
+  alias graph= graphName=
+
+  def execute
+    body = {
+      "sort"        => @sort,
+      "direction"   => @direction,
+      "maxDepth"    => @maxDepth,
+      "minDepth"    => @minDepth,
+      "startVertex" => @startVertex,
+      "visitor"     => @visitor,
+      "itemOrder"   => @itemOrder,
+      "strategy"    => @strategy,
+      "filter"      => @filter,
+      "init"        => @init,
+      "maxiterations" => @maxiterations,
+      "uniqueness"  => @uniqueness,
+      "order"       => @order,
+      "graphName"   => @graphName,
+      "expander"    => @expander,
+      "edgeCollection" => @edgeCollection
+    }.delete_if{|k,v| v.nil?}
+    new_Document = { :body => body.to_json }
+    result = self.class.post("/_db/#{@database}/_api/traversal", new_Document).parsed_response
+    if result["error"]
+      return @@verbose ? result : result["errorMessage"]
+    else
+      @vertices = result["result"]["visited"]["vertices"].map{|x| ArangoDoc.new(
+        key: x["_key"],
+        collection: x["_id"].split("/")[0],
+        database: @database,
+        body: x
+      )}
+      @paths = result["result"]["visited"]["paths"].map{|x|
+        { "edges" => x["edges"].map{|e| ArangoDoc.new(
+            key: e["_key"],
+            collection: e["_id"].split("/")[0],
+            database: @database,
+            body: e,
+            from: e["_from"],
+            to: e["_to"]
+          )},
+            "vertices" => x["vertices"].map{|v| ArangoDoc.new(
+            key: v["_key"],
+            collection: v["_id"].split("/")[0],
+            database: @database,
+            body: v
+          )}
+        }
+      }
+      return @@verbose ? result : self
+    end
+  end
+end