arangorb 1.0.0 → 1.1.0

data/lib/ArangoRB_DB.rb

@@ -12,6 +12,18 @@ class ArangoDatabase < ArangoServer
   end
 
   attr_reader :database # TESTED
+  alias name database
+
+  # === RETRIEVE ===
+
+  def [](collection_name)
+    ArangoCollection.new(collection: collection_name, database: @database)
+  end
+  alias collection []
+
+  def graph(graph_name)
+     ArangoGraph.new(graph: graph_name, database: @database)
+  end
 
   # === GET ===
 
@@ -58,38 +70,16 @@ class ArangoDatabase < ArangoServer
     query = { "excludeSystem": excludeSystem }.delete_if{|k,v| v.nil?}
     request = @@request.merge({ :query => query })
     result = self.class.get("/_db/#{@database}/_api/collection", 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["result"].map{|x| ArangoCollection.new(database: @database, collection: x["name"])}
-        end
-      end
-    end
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    result = result.parsed_response
+    @@verbose ? result : result["error"] ? result["errorMessage"] : result["result"].map{|x| ArangoCollection.new(database: @database, collection: x["name"])}
   end
 
   def graphs  # TESTED
     result = self.class.get("/_db/#{@database}/_api/gharial", @@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["graphs"].map{|x| ArangoGraph.new(database: @database, graph: x["_key"], edgeDefinitions: x["edgeDefinitions"], orphanCollections: x["orphanCollections"])}
-        end
-      end
-    end
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    result = result.parsed_response
+    @@verbose ? result : result["error"] ? result["errorMessage"] : result["graphs"].map{|x| ArangoGraph.new(database: @database, graph: x["_key"], edgeDefinitions: x["edgeDefinitions"], orphanCollections: x["orphanCollections"])}
   end
 
   def functions  # TESTED
@@ -175,49 +165,6 @@ class ArangoDatabase < ArangoServer
     self.class.return_result result: result, caseTrue: true
   end
 
-  # # === ASYNC ===
-  #
-  # def pendingAsync # TESTED
-  #   result = self.class.get("/_db/#{@database}/_api/job/pending")
-  #   return_result_async result: result
-  # end
-  #
-  # def fetchAsync(id:) # TESTED
-  #   result = self.class.put("/_db/#{@database}/_api/job/#{id}")
-  #   return_result_async result: result
-  # end
-  #
-  # def retrieveAsync(type:) # TESTED
-  #   result = self.class.get("/_db/#{@database}/_api/job/#{type}")
-  #   return_result_async result: result
-  # end
-  #
-  # def retrieveDoneAsync # TESTED
-  #   retrieveAsync(type: "done")
-  # end
-  #
-  # def retrievePendingAsync # TESTED
-  #   retrieveAsync(type: "pending")
-  # end
-  #
-  # def cancelAsync(id:) # TESTED
-  #   result = self.class.put("/_db/#{@database}/_api/job/#{id}/cancel")
-  #   return_result_async result: result
-  # end
-  #
-  # def destroyAsync(type:) # TESTED
-  #   result = self.class.delete("/_db/#{@database}/_api/job/#{type}")
-  #   return_result_async result: result, caseTrue: true
-  # end
-  #
-  # def destroyAllAsync # TESTED
-  #   destroyAsync(type: "all")
-  # end
-  #
-  # def destroyExpiredAsync # TESTED
-  #   destroyAsync(type: "expired")
-  # end
-
   # === REPLICATION ===
 
   def inventory(includeSystem: false) # TESTED
@@ -374,23 +321,4 @@ class ArangoDatabase < ArangoServer
     result = self.class.put("/_api/user/#{user}/database/#{@database}", request)
     self.class.return_result result: result, caseTrue: true
   end
-
-  # # === UTILITY ===
-  #
-  # def return_result_async(result:, caseTrue: false)
-  #   result = result.parsed_response
-  #   if @@verbose || !result.is_a?(Hash)
-  #     result
-  #   else
-  #     if result["error"]
-  #       result["errorMessage"]
-  #     else
-  #       if caseTrue
-  #         true
-  #       else
-  #         result.delete_if{|k,v| k == "error" || k == "code"}
-  #       end
-  #     end
-  #   end
-  # end
 end

data/lib/ArangoRB_Doc.rb

@@ -24,6 +24,9 @@ class ArangoDocument < ArangoServer
         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
@@ -53,7 +56,18 @@ class ArangoDocument < ArangoServer
     end
   end
 
-  attr_reader :key, :id, :body, :collection, :database
+  attr_reader :key, :id, :body
+  alias name key
+
+  # === RETRIEVE ===
+
+  def collection
+    ArangoCollection.new(collection: @collection, database: @database)
+  end
+
+  def database
+    ArangoDatabase.new(database: @database)
+  end
 
   # === GET ===
 
@@ -69,21 +83,19 @@ class ArangoDocument < ArangoServer
     result = self.class.get("/_db/#{@database}/_api/edges/#{collection}", request)
     return result.headers["x-arango-async-id"] if @@async == "store"
     result = result.parsed_response
-    @@verbose ? result : result["error"] ? result["errorMessage"] : result["edges"].map{|edge|
-      ArangoDocument.new(key: edge["_key"], collection: collection, database: @database, body: edge)
-    }
+    @@verbose ? result : result["error"] ? result["errorMessage"] : result["edges"].map{|edge| ArangoDocument.new(key: edge["_key"], collection: collection, database: @database, body: edge)}
   end
 
-  def in(collection)  # TESTED
-    self.retrieve_edges collection: collection, direction: "in"
+  def in(edgeCollection)  # TESTED
+    self.retrieve_edges collection: edgeCollection, direction: "in"
   end
 
-  def out(collection)  # TESTED
-    self.retrieve_edges collection: collection, direction: "out"
+  def out(edgeCollection)  # TESTED
+    self.retrieve_edges collection: edgeCollection, direction: "out"
   end
 
-  def any(collection)  # TESTED
-    self.retrieve_edges collection: collection
+  def any(edgeCollection)  # TESTED
+    self.retrieve_edges collection: edgeCollection
   end
 
   def from  # TESTED
@@ -222,14 +234,11 @@ class ArangoDocument < ArangoServer
         end
         result
       else
-        if result["error"]
-          result["errorMessage"]
-        else
-          @key = result["_key"]
-          @id = "#{@collection}/#{@key}"
-          @body = @body.merge(body)
-          self
-        end
+        return result["errorMessage"] if result["error"]
+        @key = result["_key"]
+        @id = "#{@collection}/#{@key}"
+        @body = @body.merge(body)
+        return self
       end
     else
       result = self.class.patch("/_db/#{@database}/_api/document/#{@collection}", request)
@@ -262,34 +271,26 @@ class ArangoDocument < ArangoServer
 # === UTILITY ===
 
   def return_result(result:, body: {}, caseTrue: false, key: nil)
-    if @@async == "store"
-      result.headers["x-arango-async-id"]
-    else
-      result = result.parsed_response
-      if @@verbose || !result.is_a?(Hash)
-        resultTemp = result
-        unless result["errorMessage"]
-          result.delete("error")
-          result.delete("code")
-          @key = result["_key"]
-          @collection = result["_id"].split("/")[0]
-          @body = result.merge(body)
-        end
-        resultTemp
-      else
-        if result["error"]
-          result["errorMessage"]
-        else
-          return true if caseTrue
-          result.delete("error")
-          result.delete("code")
-          @key = result["_key"]
-          @collection = result["_id"].split("/")[0]
-          @id = "#{@collection}/#{@key}"
-          @body = result.merge(body)
-          key.nil? ? self : result[key]
-        end
+    return  result.headers["x-arango-async-id"] if @@async == "store"
+    result = result.parsed_response
+    if @@verbose || !result.is_a?(Hash)
+      resultTemp = result
+      unless result["errorMessage"]
+        result.delete_if{|k,v| k == "error" || k == "code"}
+        @key = result["_key"]
+        @collection = result["_id"].split("/")[0]
+        @body = result.merge(body)
       end
+      return resultTemp
+    else
+      return result["errorMessage"] if result["error"]
+      return true if caseTrue
+      result.delete_if{|k,v| k == "error" || k == "code"}
+      @key = result["_key"]
+      @collection = result["_id"].split("/")[0]
+      @id = "#{@collection}/#{@key}"
+      @body = result.merge(body)
+      key.nil? ? self : result[key]
     end
   end
 end

data/lib/ArangoRB_Edg.rb

@@ -32,6 +32,9 @@ class ArangoEdge < ArangoDocument
         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
@@ -61,27 +64,27 @@ class ArangoEdge < ArangoDocument
     end
   end
 
-  attr_reader :key, :id, :body, :database, :graph, :collection
+  attr_reader :key, :id, :body
+
+  # === RETRIEVE ===
+
+  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)
-    if @@async == "store"
-      result.headers["x-arango-async-id"]
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    result = result.parsed_response
+    if @@verbose
+      @body = result["edge"] unless result["error"]
+      result
     else
-      result = result.parsed_response
-      if @@verbose
-        @body = result["edge"] unless result["error"]
-        result
-      else
-        if result["error"]
-          result["errorMessage"]
-        else
-          @body = result["edge"]
-          self
-        end
-      end
+      return result["errorMessage"] if result["error"]
+      @body = result["edge"]
+      self
     end
   end
 
@@ -112,28 +115,22 @@ class ArangoEdge < ArangoDocument
     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)
-    if @@async == "store"
-      result.headers["x-arango-async-id"]
-    else
-      result = result.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["edge"]["_key"]
-          @id = "#{@collection}/#{@key}"
-          @body = @body.merge(body)
-          @body = @body.merge(result["edge"])
-          self
-        end
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    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
 
@@ -149,28 +146,22 @@ class ArangoEdge < ArangoDocument
 # === UTILITY ===
 
   def return_result(result:, body: {}, caseTrue: false)
-    if @@async == "store"
-      result.headers["x-arango-async-id"]
-    else
-      result = result.parsed_response
-      if @@verbose
-        unless result["error"]
-          @key = result["edge"]["_key"]
-          @id = "#{@collection}/#{@key}"
-          @body = body
-        end
-        result
-      else
-        if result["error"]
-          result["errorMessage"]
-        else
-          return true if caseTrue
-          @key = result["edge"]["_key"]
-          @id = "#{@collection}/#{@key}"
-          @body = body
-          self
-        end
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    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

@@ -32,27 +32,25 @@ class ArangoGraph < ArangoServer
   end
 
   attr_reader :graph, :edgeDefinitions, :orphanCollections, :database
+  alias name graph
+
+# === RETRIEVE ===
+
+  def database
+    ArangoDatabase.new(database: @database)
+  end
 
 # === GET ===
 
   def retrieve  # TESTED
     result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}", @@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
-          @edgeDefinitions = result["graph"]["edgeDefinitions"]
-          @orphanCollections = result["graph"]["orphanCollections"]
-          self
-        end
-      end
-    end
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    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 ===
@@ -61,36 +59,27 @@ class ArangoGraph < ArangoServer
     body = { "name" => @graph, "edgeDefinitions" => @edgeDefinitions, "orphanCollections" => @orphanCollections }
     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
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    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)
-    if @@async == "store"
-      result.headers["x-arango-async-id"]
-    else
-      result = result.parsed_response
-      @@verbose ? result : result["error"] ? result["errorMessage"] : true
-    end
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    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)
-    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
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    result = result.parsed_response
+    @@verbose ? result : result["error"] ? result["errorMessage"] : result["collections"].map{|x| ArangoCollection.new(collection: x)}
   end
 
   def addVertexCollection(collection:)  # TESTED
@@ -98,40 +87,30 @@ class ArangoGraph < ArangoServer
     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"]
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    result = result.parsed_response
+    if @@verbose
+      @orphanCollections << collection unless result["error"]
+      result
     else
-      result = result.parsed_response
-      if @@verbose
-        result
-      else
-        if result["error"]
-          result["errorMessage"]
-        else
-          @orphanCollections << collection
-          self
-        end
-      end
+      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)
-    if @@async == "store"
-      result.headers["x-arango-async-id"]
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    result = result.parsed_response
+    if @@verbose
+      @orphanCollections -= [collection] unless result["error"]
+      result
     else
-      result = result.parsed_response
-      if @@verbose
-        result
-      else
-        if result["error"]
-          result["errorMessage"]
-        else
-          @orphanCollections -= [collection]
-          self
-        end
-      end
+      return result["errorMessage"] if result["error"]
+      @orphanCollections -= [collection]
+      self
     end
   end
 
@@ -139,12 +118,9 @@ class ArangoGraph < ArangoServer
 
   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
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    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
@@ -156,32 +132,24 @@ class ArangoGraph < ArangoServer
     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
-
-    if @@async == "store"
-      result.headers["x-arango-async-id"]
-    else
-      result = result.parsed_response
-      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
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    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
 
@@ -192,26 +160,19 @@ class ArangoGraph < ArangoServer
   def removeEdgeCollection(collection:)  # TESTED
     collection = collection.is_a?(String) ? collection : collection.collection
     result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}/edge/#{collection}", @@request)
-
-    if @@async == "store"
-      result.headers["x-arango-async-id"]
-    else
-      result = result.parsed_response
-      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
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    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