arangorb 0.1.0 → 1.0.0

data/lib/ArangoRB_Tra.rb

@@ -1,7 +1,7 @@
 # === TRAVERSAL ===
 
-class ArangoT < ArangoS
-  def initialize(body: {}, database: @@database, graph: nil, edgeCollection: nil)
+class ArangoTraversal < ArangoServer
+  def initialize(body: {}, database: @@database, graph: nil, edgeCollection: nil) # TESTED
     @sort        = body["sort"]
     @direction   = body["direction"]
     @maxDepth    = body["maxDepth"]
@@ -26,45 +26,45 @@ class ArangoT < ArangoS
   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)
+  def startVertex=(startVertex) # TESTED
     if startVertex.is_a?(String)
       @startVertex = startVertex
-    elsif startVertex.is_a?(ArangoDoc)
+    elsif startVertex.is_a?(ArangoDocument)
       @startVertex = startVertex.id
     else
-      raise "startVertex should be a String or an ArangoDoc instance, not a #{startVertex.class}"
+      raise "startVertex should be a String or an ArangoDocument instance, not a #{startVertex.class}"
     end
   end
 
-  def graphName=(graphName)
+  def graphName=(graphName) # TESTED
     if graphName.is_a?(String) || graphName.nil?
       @graphName = graphName
-    elsif graphName.is_a?(ArangoG)
+    elsif graphName.is_a?(ArangoGraph)
       @graphName = graphName.graph
     else
-      raise "graphName should be a String or an ArangoG instance, not a #{graphName.class}"
+      raise "graphName should be a String or an ArangoGraph instance, not a #{graphName.class}"
     end
   end
 
-  def edgeCollection=(edgeCollection)
+  def edgeCollection=(edgeCollection) # TESTED
     if edgeCollection.is_a?(String) || edgeCollection.nil?
       @edgeCollection = edgeCollection
-    elsif edgeCollection.is_a?(ArangoC)
+    elsif edgeCollection.is_a?(ArangoCollection)
       @edgeCollection = edgeCollection.collection
     else
-      raise "edgeCollection should be a String or an ArangoC instance, not a #{edgeCollection.class}"
+      raise "edgeCollection should be a String or an ArangoCollection instance, not a #{edgeCollection.class}"
     end
   end
 
-  def in
+  def in # TESTED
     @direction = "inbound"
   end
 
-  def out
+  def out # TESTED
     @direction = "outbound"
   end
 
-  def any
+  def any # TESTED
     @direction = "any"
   end
 
@@ -79,7 +79,7 @@ class ArangoT < ArangoS
   alias graph graphName
   alias graph= graphName=
 
-  def execute
+  def execute # TESTED
     body = {
       "sort"        => @sort,
       "direction"   => @direction,
@@ -98,35 +98,40 @@ class ArangoT < ArangoS
       "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"]
+    request = @@request.merge({ :body => body.to_json })
+    result = self.class.post("/_db/#{@database}/_api/traversal", request)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
     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
-          )}
+      result = result.parsed_response
+      if result["error"]
+        return @@verbose ? result : result["errorMessage"]
+      else
+        @vertices = result["result"]["visited"]["vertices"].map{|x| ArangoDocument.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| ArangoDocument.new(
+              key: e["_key"],
+              collection: e["_id"].split("/")[0],
+              database: @database,
+              body: e,
+              from: e["_from"],
+              to: e["_to"]
+            )},
+              "vertices" => x["vertices"].map{|v| ArangoDocument.new(
+              key: v["_key"],
+              collection: v["_id"].split("/")[0],
+              database: @database,
+              body: v
+            )}
+          }
         }
-      }
-      return @@verbose ? result : self
+        return @@verbose ? result : self
+      end
     end
   end
 end

data/lib/ArangoRB_Tran.rb

@@ -0,0 +1,48 @@
+# === TRANSACTION ===
+
+class ArangoTransaction < ArangoServer
+  def initialize(database: @@database, action:, write: [], read: [], params: nil, lockTimeout: nil, waitForSync: nil) # 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
+    @action = action
+    @collections = {}
+    @collections["write"] = write.is_a?(Array) ? write.map{ |x| x.is_a?(String) ? x : x.is_a?(ArangoCollection) ? x.collection : nil } : write.is_a?(String) ? [write] : write.is_a?(ArangoCollection) ? [write.collection] : []
+    @collections["read"] = read.is_a?(Array) ? read.map{ |x| x.is_a?(String) ? x : x.is_a?(ArangoCollection) ? x.collection : nil } : read.is_a?(String) ? [read] : read.is_a?(ArangoCollection) ? [read.collection] : []
+    @params = params
+    @lockTimeout = lockTimeout
+    @waitForSync = waitForSync
+  end
+
+  attr_reader :action, :collections, :params, :lockTimeout, :waitForSync
+
+  def execute # TESTED
+    body = {
+      "action" => @action,
+      "collections" => @collections,
+      "params" => @params,
+      "lockTimeout" => @lockTimeout,
+      "waitForSync" => @waitForSync
+    }.delete_if{|k,v| v.nil?}.to_json
+    request = @@request.merge({ :body => body })
+    result = self.class.post("/_db/#{@database}/_api/transaction", request)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
+    else
+      result = result.parsed_response
+      if @@verbose
+        result
+      else
+        if result["error"]
+          {"message": result["errorMessage"], "stacktrace": result["stacktrace"]}
+        else
+          result["result"]
+        end
+      end
+    end
+  end
+end

data/lib/ArangoRB_User.rb

@@ -0,0 +1,152 @@
+# === USER ===
+
+class ArangoUser < ArangoServer
+  def initialize(user: @@user, password: nil, active: nil, extra: nil) # TESTED
+    @password = password
+    @user = user
+    @active = active
+    @extra = extra
+  end
+
+  attr_reader :user, :active, :extra
+
+  def create(active: nil, extra: nil) # TESTED
+    body = {
+      "user" => @user,
+      "passwd" => @password,
+      "active" => active,
+      "extra" => extra
+    }.delete_if{|k,v| v.nil?}.to_json
+    request = @@request.merge({ :body => body })
+    result = self.class.post("/_api/user", request)
+    resultTemp = result.parsed_response
+    if @@async != "store" && !resultTemp["error"]
+      @active = resultTemp["active"]
+      @extra = resultTemp["extra"]
+    end
+    return_result result: result
+  end
+
+  def retrieve # TESTED
+    result = self.class.get("/_api/user/#{@user}", @@request)
+    resultTemp = result.parsed_response
+    if @@async != "store" && !resultTemp["error"]
+      @active = resultTemp["active"]
+      @extra = resultTemp["extra"]
+    end
+    return_result result: result
+  end
+
+  def grant(database: @@database) # TESTED
+    database = database.database if database.is_a?(ArangoDatabase)
+    body = { "grant" => "rw" }.to_json
+    request = @@request.merge({ :body => body })
+    result = self.class.put("/_api/user/#{@user}/database/#{database}", request)
+    return_result result: result, caseTrue: true
+  end
+
+  def revoke(database: @@database) # TESTED
+    database = database.database if database.is_a?(ArangoDatabase)
+    body = { "grant" => "none" }.to_json
+    request = @@request.merge({ :body => body })
+    result = self.class.put("/_api/user/#{@user}/database/#{database}", request)
+    return_result result: result, caseTrue: true
+  end
+
+  def databases # TESTED
+    result = self.class.get("/_api/user/#{@user}/database/", @@request)
+    return_result result: result, key: "result"
+  end
+
+  def replace(password:, active: nil, extra: nil) # TESTED
+    body = {
+      "passwd" => password,
+      "active" => active,
+      "extra" => extra
+    }.delete_if{|k,v| v.nil?}.to_json
+    request = @@request.merge({ :body => body })
+    result = self.class.put("/_api/user/#{@user}", request)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
+    else
+      result = result.parsed_response
+      if @@verbose
+        unless result["error"]
+          @password = password
+          @active = active.nil? || active
+          @extra = extra
+        end
+        result
+      else
+        if result["error"]
+          result["errorMessage"]
+        else
+          @password = password
+          @active = active.nil? || active
+          @extra = extra
+          self
+        end
+      end
+    end
+  end
+
+  def update(password: , active: nil, extra: nil) # TESTED
+    body = {
+      "passwd" => password,
+      "active" => active,
+      "extra" => extra
+    }.delete_if{|k,v| v.nil?}.to_json
+    request = @@request.merge({ :body => body })
+    result = self.class.patch("/_api/user/#{@user}", request)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
+    else
+      result = result.parsed_response
+      if @@verbose
+        unless result["error"]
+          @password = password
+          @active = active.nil? || active
+          @extra = extra
+        end
+        result
+      else
+        if result["error"]
+          result["errorMessage"]
+        else
+          @password = password
+          @active = active.nil? || active
+          @extra = extra
+          self
+        end
+      end
+    end
+  end
+
+  def destroy # TESTED
+    result = self.class.delete("/_api/user/#{@user}", @@request)
+    return_result result: result, caseTrue: true
+  end
+
+  def return_result(result:, caseTrue: false, key: nil)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
+    else
+      result = result.parsed_response
+      if @@verbose || !result.is_a?(Hash)
+        result
+      else
+        if result["error"]
+          result["errorMessage"]
+        else
+          if caseTrue
+            true
+          elsif key.nil?
+            self
+          else
+            result[key]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ArangoRB_Ver.rb

@@ -2,22 +2,22 @@
 
 # ==== DOCUMENT ====
 
-class ArangoV < ArangoDoc
-  def initialize(key: nil, collection: @@collection, graph: @@graph, database: @@database,  body: {})
+class ArangoVertex < ArangoDocument
+  def initialize(key: nil, collection: @@collection, graph: @@graph, database: @@database,  body: {}) # TESTED
     if collection.is_a?(String)
       @collection = collection
-    elsif collection.is_a?(ArangoC)
+    elsif collection.is_a?(ArangoCollection)
       @collection = collection.collection
     else
-      raise "collection should be a String or an ArangoC instance, not a #{collection.class}"
+      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?(ArangoG)
+    elsif graph.is_a?(ArangoGraph)
       @graph = graph.graph
     else
-      raise "graph should be a String or an ArangoG instance, not a #{graph.class}"
+      raise "graph should be a String or an ArangoGraph instance, not a #{graph.class}"
     end
 
     if database.is_a?(String)
@@ -47,91 +47,108 @@ class ArangoV < ArangoDoc
 
   # === 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
+  def retrieve # TESTED
+    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{@id}", @@request)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
     else
-      if result["error"]
-        result["errorMessage"]
+      result = result.parsed_response
+      if @@verbose
+        @body = result["vertex"] unless result["error"]
+        result
       else
-        @body = result["vertex"]
-        self
+        if result["error"]
+          result["errorMessage"]
+        else
+          @body = result["vertex"]
+          self
+        end
       end
     end
   end
 
 # === POST ====
 
-  def create(body: @body, waitForSync: nil)
+  def create(body: @body, waitForSync: nil) # TESTED
     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)
+    request = @@request.merge({ :body => body.to_json, :query => query })
+    result = self.class.post("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{@collection}", request)
+    return_result result: result, body: body
   end
   alias create_vertex create
 
 # === MODIFY ===
 
-  def replace(body: {}, waitForSync: nil)
+  def replace(body: {}, waitForSync: nil) # TESTED
     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)
+    request = @@request.merge({ :body => body.to_json, :query => query })
+    result = self.class.put("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{@id}", request)
+    return_result result: result, body: body
   end
 
-  def update(body: {}, waitForSync: nil, keepNull: nil)
+  def update(body: {}, waitForSync: nil, keepNull: nil) # TESTED
     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
+    request = @@request.merge({ :body => body.to_json, :query => query })
+    result = self.class.patch("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{@id}", 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"]
+          @key = result["_key"]
+          @id = "#{@collection}/#{@key}"
+          @body = result["vertex"].body
+        end
+        result
       else
-        @key = result["_key"]
-        @id = "#{@collection}/#{@key}"
-        @body = @body.merge(body)
-        self
+        if result["error"]
+          result["errorMessage"]
+        else
+          @key = result["vertex"]["_key"]
+          @id = "#{@collection}/#{@key}"
+          @body = @body.merge(body)
+          @body = @body.merge(result["vertex"])
+          self
+        end
       end
     end
   end
 
 # === DELETE ===
 
-  def destroy(body: nil, waitForSync: nil)
+  def destroy(waitForSync: nil) # TESTED
     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
+    request = @@request.merge({ :query => query })
+    result = self.class.delete("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{@id}", request)
+    return_result result: result, caseTrue: true
   end
 
 # === UTILITY ===
 
-  def return_result(result, body)
-    if @@verbose
-      unless result["error"]
-        @key = result["vertex"]["_key"]
-        @id = "#{@collection}/#{@key}"
-        @body = body
-      end
-      result
+  def return_result(result:, body: {}, caseTrue: false)
+    if @@async == "store"
+      result.headers["x-arango-async-id"]
     else
-      if result["error"]
-        result["errorMessage"]
+      result = result.parsed_response
+      if @@verbose
+        unless result["error"]
+          @key = result["vertex"]["_key"]
+          @id = "#{@collection}/#{@key}"
+          @body = result["vertex"].merge(body)
+        end
+        result
       else
-        @key = result["vertex"]["_key"]
-        @id = "#{@collection}/#{@key}"
-        @body = body
-        self
+        if result["error"]
+          result["errorMessage"]
+        else
+          return true if caseTrue
+          @key = result["vertex"]["_key"]
+          @id = "#{@collection}/#{@key}"
+          @body = result["vertex"].merge(body)
+          self
+        end
       end
     end
   end

data/lib/arangorb.rb

@@ -8,3 +8,7 @@ require_relative "ArangoRB_Ver"
 require_relative "ArangoRB_Edg"
 require_relative "ArangoRB_Tra"
 require_relative "ArangoRB_AQL"
+require_relative "ArangoRB_User"
+require_relative "ArangoRB_Index"
+require_relative "ArangoRB_Task"
+require_relative "ArangoRB_Tran"

data/spec/arangoRB_helper.rb

@@ -1,9 +1,2 @@
-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"
+require "lib/arangoRB_0.1.0_helper"
+require "lib/arangoRB_1.0.0_helper"

data/spec/arangoRestart_helper.rb

@@ -0,0 +1,14 @@
+require "rspec"
+require_relative File.expand_path('../../lib/arangorb', __FILE__)
+
+RSpec.configure do |config|
+	config.color = true
+end
+
+describe ArangoServer do
+	context "#restart" do
+		it "restart" do
+			print ArangoServer.restart
+		end
+	end
+end

data/spec/lib/{arangoAQL_helper.rb → 0.1.0/arangoAQL_helper.rb}

@@ -1,25 +1,6 @@
-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
+require_relative './../../spec_helper'
 
+describe ArangoAQL do
   context "#new" do
     it "create a new AQL instance" do
       myAQL = ArangoAQL.new query: "FOR u IN MyCollection RETURN u.num"