arangorb 1.4.1 → 2.0.0

data/lib/ArangoRB_Edg.rb

@@ -1,184 +0,0 @@
-# === GRAPH EDGE ===
-
-class ArangoEdge < ArangoDocument
-  def initialize(key: nil, collection: @@collection, graph: @@graph, database: @@database, body: {}, from: nil, to: nil) # TESTED
-    if collection.is_a?(String)
-      @collection = collection
-    elsif collection.is_a?(ArangoCollection)
-      @collection = collection.collection
-    else
-      raise "collection should be a String or an ArangoCollection instance, not a #{collection.class}"
-    end
-
-    if graph.is_a?(String)
-      @graph = graph
-    elsif graph.is_a?(ArangoGraph)
-      @graph = graph.graph
-    else
-      raise "graph should be a String or an ArangoGraph instance, not a #{graph.class}"
-    end
-
-    if database.is_a?(String)
-      @database = database
-    elsif database.is_a?(ArangoDatabase)
-      @database = database.database
-    else
-      raise "database should be a String or an ArangoDatabase instance, not a #{database.class}"
-    end
-
-    if key.is_a?(String) || key.nil?
-      @key = key
-      unless key.nil?
-        body["_key"] = @key
-        @id = "#{@collection}/#{@key}"
-      end
-    elsif key.is_a?(ArangoDocument)
-      @key = key.key
-      @id = key.id
-    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?(ArangoDocument)
-      @body["_from"] = from.id
-    elsif from.nil?
-    else
-      raise "from should be a String or an ArangoDocument instance, not a #{from.class}"
-    end
-
-    if to.is_a?(String)
-      @body["_to"] = to
-    elsif to.is_a?(ArangoDocument)
-      @body["_to"] = to.id
-    elsif to.nil?
-    else
-      raise "to should be a String or an ArangoDocument instance, not a #{to.class}"
-    end
-
-    @idCache = "EDG_#{@id}"
-  end
-
-  attr_reader :key, :id, :body, :idCache
-
-  # === RETRIEVE ===
-
-  def to_hash
-    {
-      "key" => @key,
-      "id" => @id,
-      "collection" => @collection,
-      "database" => @database,
-      "body" => @body,
-      "idCache" => @idCache
-    }.delete_if{|k,v| v.nil?}
-  end
-  alias to_h to_hash
-
-  def graph
-    ArangoGraph.new(graph: @graph, database: @database)
-  end
-
-  # === GET ===
-
-  def retrieve # TESTED
-    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{@id}", @@request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    if @@verbose
-      @body = result["edge"] unless result["error"]
-      result
-    else
-      return result["errorMessage"] if result["error"]
-      @body = result["edge"]
-      self
-    end
-  end
-
-# === POST ====
-
-  def create(body: {}, from: @body["_from"], to: @body["_to"], waitForSync: nil) # TESTED
-    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
-    request = @@request.merge({ :body => body.to_json, :query => query })
-    result = self.class.post("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{@collection}", request)
-    return_result result: result, body: body
-  end
-  alias create_document create
-  alias create_vertex create
-
-# === MODIFY ===
-
-  def replace(body: {}, waitForSync: nil) # TESTED
-    query = { "waitForSync" => waitForSync }.delete_if{|k,v| v.nil?}
-    request = @@request.merge({ :body => body.to_json, :query => query })
-    result = self.class.put("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{@id}", request)
-    return_result result: result, body: body
-  end
-
-  def update(body: {}, waitForSync: nil, keepNull: nil) # TESTED
-    query = {"waitForSync" => waitForSync, "keepNull" => keepNull}.delete_if{|k,v| v.nil?}
-    request = @@request.merge({ :body => body.to_json, :query => query })
-    result = self.class.patch("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{@id}", request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    if @@verbose
-      unless result["error"]
-        @key = result["_key"]
-        @id = "#{@collection}/#{@key}"
-        @body = body
-      end
-      result
-    else
-      return result["errorMessage"] if result["error"]
-      @key = result["edge"]["_key"]
-      @id = "#{@collection}/#{@key}"
-      @body = @body.merge(body)
-      @body = @body.merge(result["edge"])
-      self
-    end
-  end
-
-# === DELETE ===
-
-  def destroy(body: nil, waitForSync: nil) # TESTED
-    query = { "waitForSync" => waitForSync }.delete_if{|k,v| v.nil?}
-    request = @@request.merge({ :query => query })
-    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{@id}", request)
-    return_result result: result, caseTrue: true
-  end
-
-# === UTILITY ===
-
-  def return_result(result:, body: {}, caseTrue: false)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    if @@verbose
-      unless result["error"]
-        @key = result["edge"]["_key"]
-        @id = "#{@collection}/#{@key}"
-        @body = body
-      end
-      result
-    else
-      return result["errorMessage"] if result["error"]
-      return true if caseTrue
-      @key = result["edge"]["_key"]
-      @id = "#{@collection}/#{@key}"
-      @body = body
-      self
-    end
-  end
-end

data/lib/ArangoRB_Gra.rb

@@ -1,201 +0,0 @@
-# ==== GRAPH ====
-
-class ArangoGraph < ArangoServer
-  def initialize(graph: @@graph, database: @@database, edgeDefinitions: [], orphanCollections: [])  # TESTED
-    if database.is_a?(String)
-      @database = database
-    elsif database.is_a?(ArangoDatabase)
-      @database = database.database
-    else
-      raise "database should be a String or an ArangoDatabase instance, not a #{database.class}"
-    end
-
-    if graph.is_a?(String)
-      @graph = graph
-    elsif database.is_a?(ArangoGraph)
-      @graph = graph.graph
-    else
-      raise "graph should be a String or an ArangoGraph instance, 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
-
-    @idCache = "GRA_#{@graph}"
-  end
-
-  attr_reader :graph, :edgeDefinitions, :orphanCollections, :database, :idCache
-  alias name graph
-
-# === RETRIEVE ===
-
-  def to_hash
-    {
-      "graph" => @graph,
-      "collection" => @collection,
-      "database" => @database,
-      "edgeDefinitions" => @edgeDefinitions,
-      "orphanCollections" => @orphanCollections,
-      "idCache" => @idCache
-    }.delete_if{|k,v| v.nil?}
-  end
-  alias to_h to_hash
-
-  def database
-    ArangoDatabase.new(database: @database)
-  end
-
-# === GET ===
-
-  def retrieve  # TESTED
-    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}", @@request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    return result if @@verbose
-    return result["errorMessage"] if result["error"]
-    @edgeDefinitions = result["graph"]["edgeDefinitions"]
-    @orphanCollections = result["graph"]["orphanCollections"]
-    self
-  end
-
-# === POST ===
-
-  def create  # TESTED
-    body = { "name" => @graph, "edgeDefinitions" => @edgeDefinitions, "orphanCollections" => @orphanCollections }
-    request = @@request.merge({ :body => body.to_json })
-    result = self.class.post("/_db/#{@database}/_api/gharial", request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    @@verbose ? result : result["error"] ? result["errorMessage"] : self
-  end
-
-# === DELETE ===
-
-  def destroy  # TESTED
-    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}", @@request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    @@verbose ? result : result["error"] ? result["errorMessage"] : true
-  end
-
-# === VERTEX COLLECTION  ===
-
-  def vertexCollections  # TESTED
-    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}/vertex", @@request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    @@verbose ? result : result["error"] ? result["errorMessage"] : result["collections"].map{|x| ArangoCollection.new(collection: x)}
-  end
-
-  def addVertexCollection(collection:)  # TESTED
-    collection = collection.is_a?(String) ? collection : collection.collection
-    body = { "collection" => collection }.to_json
-    request = @@request.merge({ :body => body })
-    result = self.class.post("/_db/#{@database}/_api/gharial/#{@graph}/vertex", request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    if @@verbose
-      @orphanCollections << collection unless result["error"]
-      result
-    else
-      return result["errorMessage"] if result["error"]
-      @orphanCollections << collection
-      self
-    end
-  end
-
-  def removeVertexCollection(collection:)  # TESTED
-    collection = collection.is_a?(String) ? collection : collection.collection
-    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{collection}", @@request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    if @@verbose
-      @orphanCollections -= [collection] unless result["error"]
-      result
-    else
-      return result["errorMessage"] if result["error"]
-      @orphanCollections -= [collection]
-      self
-    end
-  end
-
-# === EDGE COLLECTION ===
-
-  def edgeCollections  # TESTED
-    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}/edge", @@request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    @@verbose ? result : result["error"] ? result["errorMessage"] : result["collections"].map{|x| ArangoCollection.new(collection: x)}
-  end
-
-  def addEdgeCollection(collection:, from:, to:, replace: false)  # TESTED
-    from = from.is_a?(String) ? [from] : from.is_a?(ArangoCollection) ? [from.collection] : from
-    to = to.is_a?(String) ? [to] : to.is_a?(ArangoCollection) ? [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 }
-    request = @@request.merge({ :body => body.to_json })
-    if replace
-      result = self.class.put("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{collection}", request)
-    else
-      result = self.class.post("/_db/#{@database}/_api/gharial/#{@graph}/edge", request)
-    end
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    if @@verbose
-      unless result["error"]
-        @edgeDefinitions = result["graph"]["edgeDefinitions"]
-        @orphanCollections = result["graph"]["orphanCollections"]
-      end
-      result
-    else
-      return result["errorMessage"] if result["error"]
-      @edgeDefinitions = result["graph"]["edgeDefinitions"]
-      @orphanCollections = result["graph"]["orphanCollections"]
-      self
-    end
-  end
-
-  def replaceEdgeCollection(collection:, from:, to:)  # TESTED
-    self.addEdgeCollection(collection: collection, from: from, to: to, replace: true)
-  end
-
-  def removeEdgeCollection(collection:)  # TESTED
-    collection = collection.is_a?(String) ? collection : collection.collection
-    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{collection}", @@request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    if @@verbose
-      unless result["error"]
-        @edgeDefinitions = result["graph"]["edgeDefinitions"]
-        @orphanCollections = result["graph"]["orphanCollections"]
-      end
-      result
-    else
-      return result["errorMessage"] if result["error"]
-      @edgeDefinitions = result["graph"]["edgeDefinitions"]
-      @orphanCollections = result["graph"]["orphanCollections"]
-      self
-    end
-  end
-end

data/lib/ArangoRB_Index.rb

@@ -1,135 +0,0 @@
-# === INDEXES ===
-
-class ArangoIndex < ArangoServer
-  def initialize(collection: @@collection, database: @@database, body: {}, id: nil, type: nil, unique: nil, fields:, sparse: nil) # TESTED
-    if collection.is_a?(String)
-      @collection = collection
-    elsif collection.is_a?(ArangoCollection)
-      @collection = collection.collection
-    else
-      raise "collection should be a String or a ArangoCollection instance, not a #{collection.class}"
-    end
-
-    if database.is_a?(String)
-      @database = database
-    elsif database.is_a?(ArangoDatabase)
-      @database = database.database
-    else
-      raise "database should be a String or a ArangoDatabase instance, not a #{database.class}"
-    end
-
-    if body.is_a?(Hash)
-      @body = body
-    else
-      raise "body should be a Hash, not a #{body.class}"
-    end
-
-    unless id.nil?
-      @key = id.split("/")[1]
-      @id = id
-    end
-    @type = type
-    @sparse = sparse
-    @unique = unique unless unique.nil?
-
-    if fields.is_a?(String)
-      @fields = [fields]
-    elsif fields.is_a?(Array)
-      @fields = fields
-    else
-      raise "fields should be a String or an Array, not a #{database.class}"
-    end
-
-    @idCache = "IND_#{@id}"
-  end
-
-  attr_reader :body, :type, :id, :unique, :fields, :key, :sparse, :idCache
-
-  ### RETRIEVE ###
-
-  def to_hash
-    {
-      "key" => @key,
-      "id" => @id,
-      "collection" => @collection,
-      "database" => @database,
-      "body" => @body,
-      "type" => @type,
-      "sparse" => @sparse,
-      "unique" => @unique,
-      "fields" => @fields,
-      "idCache" => @idCache
-    }.delete_if{|k,v| v.nil?}
-  end
-  alias to_h to_hash
-
-  def database
-    ArangoDatabase.new(database: @database)
-  end
-
-  def collection
-    ArangoCollection.new(collection: @collection, database: @database)
-  end
-
-  def retrieve # TESTED
-    result = self.class.get("/_db/#{@database}/_api/index/#{@id}", @@request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    return result if @@verbose
-    return result["errorMessage"] if result["error"]
-    result.delete_if{|k,v| k == "error" || k == "code"}
-    @body = result
-    @type = result["type"]
-    @unique = result["unique"]
-    @fields = result["fields"]
-    @sparse = result["sparse"]
-    self
-  end
-
-  def self.indexes(database: @@database, collection: @@collection) # TESTED
-    database = database.database if database.is_a?(ArangoDatabase)
-    collection = collection.collection if collection.is_a?(ArangoCollection)
-    query = { "collection": collection }
-    request = @@request.merge({ :query => query })
-    result = get("/_db/#{database}/_api/index", request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    return result if @@verbose
-    return result["errorMessage"] if result["error"]
-    result.delete_if{|k,v| k == "error" || k == "code"}
-    result["indexes"] = result["indexes"].map{|x| ArangoIndex.new(body: x, id: x["id"], database: database, collection: collection, type: x["type"], unique: x["unique"], fields: x["fields"], sparse: x["sparse"])}
-    result
-  end
-
-  def create # TESTED
-    body = @body.merge({
-      "fields" => @fields,
-      "unique" => @unique,
-      "type" => @type,
-      "id" => @id
-    }.delete_if{|k,v| v.nil?})
-    query = { "collection": @collection }
-    request = @@request.merge({ :body => body.to_json, :query => query })
-    result = self.class.post("/_db/#{@database}/_api/index", request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    return result if @@verbose
-    return result["errorMessage"] if result["error"]
-    result.delete_if{|k,v| k == "error" || k == "code"}
-    @body = result
-    @id = result["id"]
-    @key = @id.split("/")[1]
-    self
-  end
-
-  def destroy # TESTED
-    result = self.class.delete("/_db/#{@database}/_api/index/#{id}", @@request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    @@verbose ? result : result["error"] ? result["errorMessage"] : true
-  end
-end