arangorb 0.1.0 → 1.0.0

data/lib/ArangoRB_Gra.rb

@@ -1,18 +1,21 @@
 # ==== GRAPH ====
 
-class ArangoG < ArangoS
-  def initialize(graph: @@graph, database: @@database, edgeDefinitions: [], orphanCollections: [])
+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, not a #{collection.class}"
+      raise "database should be a String or an ArangoDatabase instance, not a #{database.class}"
     end
 
     if graph.is_a?(String)
       @graph = graph
-      ArangoS.graph = graph
+    elsif database.is_a?(ArangoGraph)
+      @graph = graph.graph
     else
-      raise "graph should be a String, not a #{graph.class}"
+      raise "graph should be a String or an ArangoGraph instance, not a #{graph.class}"
     end
 
     if edgeDefinitions.is_a?(Array)
@@ -32,136 +35,182 @@ class ArangoG < ArangoS
 
 # === GET ===
 
-  def retrieve
-    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}").parsed_response
-    if @@verbose
-      result
+  def retrieve  # TESTED
+    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}", @@request)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
     else
-      if result["error"]
-        result["errorMessage"]
+      result = result.parsed_response
+      if @@verbose
+        result
       else
-        @edgeDefinitions = result["graph"]["edgeDefinitions"]
-        @orphanCollections = result["graph"]["orphanCollections"]
-        self
+        if result["error"]
+          result["errorMessage"]
+        else
+          @edgeDefinitions = result["graph"]["edgeDefinitions"]
+          @orphanCollections = result["graph"]["orphanCollections"]
+          self
+        end
       end
     end
   end
 
 # === POST ===
 
-  def create
+  def create  # TESTED
     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
+    request = @@request.merge({ :body => body.to_json })
+    result = self.class.post("/_db/#{@database}/_api/gharial", request)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
+    else
+      result = result.parsed_response
+      @@verbose ? result : result["error"] ? result["errorMessage"] : self
+    end
   end
 
 # === DELETE ===
 
-  def destroy
-    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}").parsed_response
-    @@verbose ? result : result["error"] ? result["errorMessage"] : result["removed"]
+  def destroy  # TESTED
+    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}", @@request)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
+    else
+      result = result.parsed_response
+      @@verbose ? result : result["error"] ? result["errorMessage"] : true
+    end
   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)}
+  def vertexCollections  # TESTED
+    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}/vertex", @@request)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
+    else
+      result = result.parsed_response
+      @@verbose ? result : result["error"] ? result["errorMessage"] : result["collections"].map{|x| ArangoCollection.new(collection: x)}
+    end
   end
 
-  def addVertexCollection(collection:)
+  def addVertexCollection(collection:)  # TESTED
     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
+    body = { "collection" => collection }.to_json
+    request = @@request.merge({ :body => body })
+    result = self.class.post("/_db/#{@database}/_api/gharial/#{@graph}/vertex", request)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
     else
-      if result["error"]
-        result["errorMessage"]
+      result = result.parsed_response
+      if @@verbose
+        result
       else
-        @orphanCollections << collection
-        self
+        if result["error"]
+          result["errorMessage"]
+        else
+          @orphanCollections << collection
+          self
+        end
       end
     end
   end
 
-  def removeVertexCollection(collection:)
+  def removeVertexCollection(collection:)  # TESTED
     collection = collection.is_a?(String) ? collection : collection.collection
-    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{collection}")
-    if @@verbose
-      result
+    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{collection}", @@request)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
     else
-      if result["error"]
-        result["errorMessage"]
+      result = result.parsed_response
+      if @@verbose
+        result
       else
-        @orphanCollections -= [collection]
-        self
+        if result["error"]
+          result["errorMessage"]
+        else
+          @orphanCollections -= [collection]
+          self
+        end
       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)}
+  def edgeCollections  # TESTED
+    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}/edge", @@request)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
+    else
+      result = result.parsed_response
+      @@verbose ? result : result["error"] ? result["errorMessage"] : result["collections"].map{|x| ArangoCollection.new(collection: x)}
+    end
   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
+  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 }
-    new_Document = { :body => body.to_json }
+    request = @@request.merge({ :body => body.to_json })
 
     if replace
-      result = self.class.put("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{collection}", new_Document).parsed_response
+      result = self.class.put("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{collection}", request)
     else
-      result = self.class.post("/_db/#{@database}/_api/gharial/#{@graph}/edge", new_Document).parsed_response
+      result = self.class.post("/_db/#{@database}/_api/gharial/#{@graph}/edge", request)
     end
 
-    if @@verbose
-      unless result["error"]
-        @edgeDefinitions = result["graph"]["edgeDefinitions"]
-        @orphanCollections = result["graph"]["orphanCollections"]
-      end
-      result
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
     else
-      if result["error"]
-        result["errorMessage"]
+      result = result.parsed_response
+      if @@verbose
+        unless result["error"]
+          @edgeDefinitions = result["graph"]["edgeDefinitions"]
+          @orphanCollections = result["graph"]["orphanCollections"]
+        end
+        result
       else
-        @edgeDefinitions = result["graph"]["edgeDefinitions"]
-        @orphanCollections = result["graph"]["orphanCollections"]
-        self
+        if result["error"]
+          result["errorMessage"]
+        else
+          @edgeDefinitions = result["graph"]["edgeDefinitions"]
+          @orphanCollections = result["graph"]["orphanCollections"]
+          self
+        end
       end
     end
   end
 
-  def replaceEdgeCollection(collection:, from:, to:)
+  def replaceEdgeCollection(collection:, from:, to:)  # TESTED
     self.addEdgeCollection(collection: collection, from: from, to: to, replace: true)
   end
 
-  def removeEdgeCollection(collection:)
+  def removeEdgeCollection(collection:)  # TESTED
     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
+    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{collection}", @@request)
+
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
     else
-      if result["error"]
-        result["errorMessage"]
+      result = result.parsed_response
+      if @@verbose
+        unless result["error"]
+          @edgeDefinitions = result["graph"]["edgeDefinitions"]
+          @orphanCollections = result["graph"]["orphanCollections"]
+        end
+        result
       else
-        @edgeDefinitions = result["graph"]["edgeDefinitions"]
-        @orphanCollections = result["graph"]["orphanCollections"]
-        self
+        if result["error"]
+          result["errorMessage"]
+        else
+          @edgeDefinitions = result["graph"]["edgeDefinitions"]
+          @orphanCollections = result["graph"]["orphanCollections"]
+          self
+        end
       end
     end
   end

data/lib/ArangoRB_Index.rb

@@ -0,0 +1,144 @@
+# === 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
+  end
+
+  attr_reader :database, :collection, :body, :type, :id, :unique, :fields, :key, :sparse
+
+  def retrieve # TESTED
+    result = self.class.get("/_db/#{@database}/_api/index/#{@id}", @@request)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
+    else
+      result = result.parsed_response
+      if @@verbose
+        result
+      else
+        if result["error"]
+          result["errorMessage"]
+        else
+          result.delete("error")
+          result.delete("code")
+          @body = result
+          @type = result["type"]
+          @unique = result["unique"]
+          @fields = result["fields"]
+          @sparse = result["sparse"]
+          self
+        end
+      end
+    end
+  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)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
+    else
+      result = result.parsed_response
+      if @@verbose
+        result
+      else
+        if result["error"]
+          result["errorMessage"]
+        else
+          result.delete("error")
+          result.delete("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
+      end
+    end
+  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)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
+    else
+      result = result.parsed_response
+      if @@verbose
+        result
+      else
+        if result["error"]
+          result["errorMessage"]
+        else
+          result.delete("error")
+          result.delete("code")
+          @body = result
+          @id = result["id"]
+          @key = @id.split("/")[1]
+          self
+        end
+      end
+    end
+  end
+
+  def destroy # TESTED
+    result = self.class.delete("/_db/#{@database}/_api/index/#{id}", @@request)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
+    else
+      result = result.parsed_response
+      if @@verbose
+        result
+      else
+        if result["error"]
+          result["errorMessage"]
+        else
+          true
+        end
+      end
+    end
+  end
+end