arangorb 1.2.0 → 1.3.0

data/lib/ArangoRB_Tran.rb

@@ -1,53 +1,68 @@
-# === 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
-    @result = nil
-    @idCache = "AT_#{@database}_#{Random.rand(0..10^12)}"
-  end
-
-  attr_reader :action, :params, :lockTimeout, :waitForSync, :idCache
-
-  ### RETRIEVE ###
-
-  def collections
-    result = {}
-    result["write"] = @collections["write"].map{|x| ArangoCollection.new(database: @database, collection: x)} unless @collections["write"].nil?
-    result["read"] = @collections["read"].map{|x| ArangoCollection.new(database: @database, collection: x)} unless @collections["read"].nil?
-    result
-  end
-
-  def database
-    ArangoDatabase.new(database: @database)
-  end
-
-  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)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    result = result.parsed_response
-    @result = result["result"] unless result["error"]
-    @@verbose ? result : result["error"] ? {"message": result["errorMessage"], "stacktrace": result["stacktrace"]} : result["result"]
-  end
-end
+# === 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
+    @result = nil
+    @idCache = "AT_#{@database}_#{Random.rand(0..10^12)}"
+  end
+
+  attr_reader :action, :params, :lockTimeout, :waitForSync, :idCache
+
+  ### RETRIEVE ###
+
+  def to_hash
+    {
+      "database"    => @database,
+      "action"      => @action,
+      "collections" => @collections,
+      "result"      => @result,
+      "params"      => @params,
+      "lockTimeout" => @lockTimeout,
+      "waitForSync" => @waitForSync,
+      "idCache"     => @idCache
+    }.delete_if{|k,v| v.nil?}
+  end
+  alias to_h to_hash
+
+  def collections
+    result = {}
+    result["write"] = @collections["write"].map{|x| ArangoCollection.new(database: @database, collection: x)} unless @collections["write"].nil?
+    result["read"] = @collections["read"].map{|x| ArangoCollection.new(database: @database, collection: x)} unless @collections["read"].nil?
+    result
+  end
+
+  def database
+    ArangoDatabase.new(database: @database)
+  end
+
+  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)
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    return true if @@async
+    result = result.parsed_response
+    @result = result["result"] unless result["error"]
+    @@verbose ? result : result["error"] ? {"message": result["errorMessage"], "stacktrace": result["stacktrace"]} : result["result"]
+  end
+end

data/lib/ArangoRB_User.rb

@@ -1,136 +1,149 @@
-# === USER ===
-
-class ArangoUser < ArangoServer
-  def initialize(user: @@user, password: nil, active: nil, extra: nil) # TESTED
-    @password = password
-    @user = user
-    @active = active
-    @extra = extra
-    @idCache = "USER_#{@user}"
-  end
-
-  attr_reader :user, :active, :extra, :idCache
-  alias name user
-
-  def [](database)
-    if self.databases[database] == "rw"
-      ArangoDatabase.new database: database
-    else
-      "This User does not have access to Database #{database}."
-    end
-  end
-  alias database []
-
-  def create # 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)
-    return_result result: result
-  end
-
-  def retrieve # TESTED
-    result = self.class.get("/_api/user/#{@user}", @@request)
-    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)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    result = result.parsed_response
-    if @@verbose
-      unless result["error"]
-        @password = password
-        @active = active.nil? || active
-        @extra = extra
-      end
-      result
-    else
-      return result["errorMessage"] if result["error"]
-      @password = password
-      @active = active.nil? || active
-      @extra = extra
-      self
-    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)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    result = result.parsed_response
-    if @@verbose
-      unless result["error"]
-        @password = password
-        @active = active.nil? || active
-        @extra = extra
-      end
-      result
-    else
-      return result["errorMessage"] if result["error"]
-      @password = password
-      @active = active.nil? || active
-      @extra = extra
-      self
-    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)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    result = result.parsed_response
-    if @@verbose || !result.is_a?(Hash)
-      unless result["error"]
-        @active = result["active"]
-        @extra = result["extra"]
-      end
-      result
-    else
-      return result["errorMessage"] if result["error"]
-      @active = result["active"]
-      @extra = result["extra"]
-      return true if caseTrue
-      key.nil? ? self : result[key]
-    end
-  end
-end
+# === USER ===
+
+class ArangoUser < ArangoServer
+  def initialize(user: @@user, password: nil, active: nil, extra: nil) # TESTED
+    @password = password
+    @user = user
+    @active = active
+    @extra = extra
+    @idCache = "USER_#{@user}"
+  end
+
+  attr_reader :user, :active, :extra, :idCache
+  alias name user
+
+  def to_hash
+    {
+      "user"        => @user,
+      "active"      => @active,
+      "extra"       => @extra,
+      "idCache"     => @idCache
+    }.delete_if{|k,v| v.nil?}
+  end
+  alias to_h to_hash
+
+  def [](database)
+    if self.databases[database] == "rw"
+      ArangoDatabase.new database: database
+    else
+      "This User does not have access to Database #{database}."
+    end
+  end
+  alias database []
+
+  def create # 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)
+    return_result result: result
+  end
+
+  def retrieve # TESTED
+    result = self.class.get("/_api/user/#{@user}", @@request)
+    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)
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    return true if @@async
+    result = result.parsed_response
+    if @@verbose
+      unless result["error"]
+        @password = password
+        @active = active.nil? || active
+        @extra = extra
+      end
+      result
+    else
+      return result["errorMessage"] if result["error"]
+      @password = password
+      @active = active.nil? || active
+      @extra = extra
+      self
+    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)
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    return true if @@async
+    result = result.parsed_response
+    if @@verbose
+      unless result["error"]
+        @password = password
+        @active = active.nil? || active
+        @extra = extra
+      end
+      result
+    else
+      return result["errorMessage"] if result["error"]
+      @password = password
+      @active = active.nil? || active
+      @extra = extra
+      self
+    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)
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    return true if @@async
+    result = result.parsed_response
+    if @@verbose || !result.is_a?(Hash)
+      unless result["error"]
+        @active = result["active"]
+        @extra = result["extra"]
+      end
+      result
+    else
+      return result["errorMessage"] if result["error"]
+      @active = result["active"]
+      @extra = result["extra"]
+      return true if caseTrue
+      key.nil? ? self : result[key]
+    end
+  end
+end

data/lib/ArangoRB_Ver.rb

@@ -1,147 +1,162 @@
-# === GRAPH VERTEX ===
-
-# ==== DOCUMENT ====
-
-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?(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
-    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
-    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
-    @idCache = "VER_#{@id}"
-  end
-
-  attr_reader :key, :id, :body, :idCache
-
-  # === RETRIEVE ===
-
-  def graph
-    ArangoGraph.new(graph: @graph, database: @database)
-  end
-
-  # === GET ===
-
-  def retrieve # TESTED
-    result = self.class.get("/_db/#{@database}/_api/gharial/#{@graph}/vertex/#{@id}", @@request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    result = result.parsed_response
-    if @@verbose
-      @body = result["vertex"] unless result["error"]
-      result
-    else
-      return result["errorMessage"] if result["error"]
-      @body = result["vertex"]
-      self
-    end
-  end
-
-# === POST ====
-
-  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?
-    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) # 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}/vertex/#{@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}/vertex/#{@id}", request)
-    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 = result["vertex"].body
-      end
-      result
-    else
-      return result["errorMessage"] if result["error"]
-      @key = result["vertex"]["_key"]
-      @id = "#{@collection}/#{@key}"
-      @body = @body.merge(body)
-      @body = @body.merge(result["vertex"])
-      self
-    end
-  end
-
-# === DELETE ===
-
-  def destroy(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}/vertex/#{@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"
-    result = result.parsed_response
-    if @@verbose
-      unless result["error"]
-        @key = result["vertex"]["_key"]
-        @id = "#{@collection}/#{@key}"
-        @body = result["vertex"].merge(body)
-      end
-      result
-    else
-      return result["errorMessage"] if result["error"]
-      return true if caseTrue
-      @key = result["vertex"]["_key"]
-      @id = "#{@collection}/#{@key}"
-      @body = result["vertex"].merge(body)
-      self
-    end
-  end
-end
+# === GRAPH VERTEX ===
+
+# ==== DOCUMENT ====
+
+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?(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
+    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
+    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
+    @idCache = "VER_#{@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}/vertex/#{@id}", @@request)
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    return true if @@async
+    result = result.parsed_response
+    if @@verbose
+      @body = result["vertex"] unless result["error"]
+      result
+    else
+      return result["errorMessage"] if result["error"]
+      @body = result["vertex"]
+      self
+    end
+  end
+
+# === POST ====
+
+  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?
+    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) # 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}/vertex/#{@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}/vertex/#{@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 = result["vertex"].body
+      end
+      result
+    else
+      return result["errorMessage"] if result["error"]
+      @key = result["vertex"]["_key"]
+      @id = "#{@collection}/#{@key}"
+      @body = @body.merge(body)
+      @body = @body.merge(result["vertex"])
+      self
+    end
+  end
+
+# === DELETE ===
+
+  def destroy(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}/vertex/#{@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["vertex"]["_key"]
+        @id = "#{@collection}/#{@key}"
+        @body = result["vertex"].merge(body)
+      end
+      result
+    else
+      return result["errorMessage"] if result["error"]
+      return true if caseTrue
+      @key = result["vertex"]["_key"]
+      @id = "#{@collection}/#{@key}"
+      @body = result["vertex"].merge(body)
+      self
+    end
+  end
+end