arangorb 1.4.1 → 2.0.0

data/lib/ArangoRB_Task.rb

@@ -1,129 +0,0 @@
-# === AQL ===
-
-class ArangoTask < ArangoServer
-  def initialize(database: @@database, id: nil, name: nil, type: nil, period: nil, command: nil, params: {}, created: 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
-    @id = id
-    @name = name
-    @type = type
-    @period = period
-    @command = command
-    @params = params
-    @created = created
-    @idCache = "IND_#{@id}"
-  end
-
-  attr_reader :id, :name, :type, :period, :created, :command, :params, :idCache
-
-  def to_hash
-    {
-      "id" => @id,
-      "name" => @name,
-      "database" => @database,
-      "type" => @type,
-      "period" => @period,
-      "create" => @created,
-      "command" => @command,
-      "params" => @params,
-      "idCache" => @idCache
-    }.delete_if{|k,v| v.nil?}
-  end
-  alias to_h to_hash
-
-  def database
-    ArangoDatabase.new(database: @database)
-  end
-
-  def retrieve # TESTED
-    result = self.class.get("/_db/#{@database}/_api/tasks/#{@id}")
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    if @@verbose
-      unless result.is_a?(Hash) && result["error"]
-        @name = result["name"]
-        @type = result["type"]
-        @period = result["period"]
-        @created = result["created"]
-        @command = result["command"]
-        @database = result["database"]
-      end
-      result
-    else
-      if result.is_a?(Hash) && result["error"]
-        result["errorMessage"]
-      else
-        @name = result["name"]
-        @type = result["type"]
-        @period = result["period"]
-        @created = result["created"]
-        @command = result["command"]
-        @database = result["database"]
-        self
-      end
-    end
-  end
-
-  def self.tasks # TESTED
-    result = get("/_db/#{@@database}/_api/tasks", @@request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    @@verbose ? result : (result.is_a?(Hash) && result["error"]) ? result["errorMessage"] : result.map{|x| ArangoTask.new(id: x["id"], name: x["name"], type: x["type"], period: x["period"], created: x["created"], command: x["command"], database: x["database"])}
-  end
-
-  def create offset: nil # TESTED
-    body = {
-      "name" => @name,
-      "command" => @command,
-      "period" => @period,
-      "offset" => offset,
-      "params" => @params
-    }.delete_if{|k,v| v.nil?}.to_json
-    request = @@request.merge({ :body => body })
-    if @id.nil?
-      result = self.class.post("/_db/#{@database}/_api/tasks", request)
-    else
-      result = self.class.put("/_db/#{@database}/_api/tasks/#{@id}", request)
-    end
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    if @@verbose
-      unless result.is_a?(Hash) && result["error"]
-        @id = result["id"]
-        @name = result["name"]
-        @type = result["type"]
-        @period = result["period"]
-        @created = result["created"]
-        @command = result["command"]
-        @database = result["database"]
-      end
-      result
-    else
-      return result["errorMessage"] if result.is_a?(Hash) && result["error"]
-      @id = result["id"]
-      @name = result["name"]
-      @type = result["type"]
-      @period = result["period"]
-      @created = result["created"]
-      @command = result["command"]
-      @database = result["database"]
-      self
-    end
-  end
-
-  def destroy # TESTED
-    result = self.class.delete("/_db/#{@database}/_api/tasks/#{@id}", @@request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    @@verbose ? result : (result.is_a?(Hash) && result["error"]) ? result["errorMessage"] : true
-  end
-end

data/lib/ArangoRB_Tra.rb

@@ -1,169 +0,0 @@
-# === TRAVERSAL ===
-
-class ArangoTraversal < ArangoServer
-  def initialize(body: {}, database: @@database, graph: nil, edgeCollection: nil) # TESTED
-    @sort        = body["sort"]
-    @direction   = body["direction"]
-    @maxDepth    = body["maxDepth"]
-    @minDepth    = body["minDepth"]
-    @startVertex = body["startVertex"]
-    @visitor     = body["visitor"]
-    @itemOrder   = body["itemOrder"]
-    @strategy    = body["strategy"]
-    @filter      = body["filter"]
-    @init        = body["init"]
-    @maxiterations = body["maxiterations"]
-    @uniqueness  = body["uniqueness"]
-    @order       = body["order"]
-    @graphName   = body["graphName"].nil? ? graph : body["graphName"]
-    @expander    = body["expander"]
-    @edgeCollection = body["edgeCollection"].nil? ? edgeCollection : body["edgeCollection"]
-    @database = database
-    @vertices = nil
-    @paths = nil
-    @idCache = "ATR_#{@database}_#{@direction}_#{@startVertex}_" + (@graphName.nil? ? "#{@edgeCollection}" : "#{@graphName}")
-  end
-
-  attr_accessor :sort, :direction, :maxDepth, :minDepth, :visitor, :itemOrder, :strategy, :filter, :init, :maxiterations, :uniqueness, :order, :expander
-  attr_reader :idCache, :vertices, :paths
-
-  ### RETRIEVE ###
-
-  def to_hash
-    {
-      "database"    => @database,
-      "sort"        => @sort,
-      "direction"   => @direction,
-      "maxDepth"    => @maxDepth,
-      "minDepth"    => @minDepth,
-      "startVertex" => @startVertex,
-      "visitor"     => @visitor,
-      "itemOrder"   => @itemOrder,
-      "strategy"    => @strategy,
-      "filter"      => @filter,
-      "init"        => @init,
-      "maxiterations" => @maxiterations,
-      "uniqueness"  => @uniqueness,
-      "order"       => @order,
-      "graphName"   => @graphName,
-      "expander"    => @expander,
-      "edgeCollection" => @edgeCollection,
-      "vertices" => @vertices.map{|x| x.id},
-      "paths" => @paths.map{|x| {"edges" => x["edges"].map{|e| e.id}, "vertices" => x["vertices"].map{|v| v.id} } },
-      "idCache" => @idCache
-    }.delete_if{|k,v| v.nil?}
-  end
-  alias to_h to_hash
-
-  def startVertex
-    val = @startVertex.split("/")
-    ArangoDocument.new(database: @database, collection: val[0], key: val[1])
-  end
-
-  def edgeCollection
-    ArangoCollection.new(collection: @edgeCollection, database: @database)
-  end
-
-  def database
-    ArangoDatabase.new(database: @database)
-  end
-
-  def graphName
-    ArangoGraph.new(graph: @graphName, database: @database).retrieve
-  end
-
-  def startVertex=(startVertex) # TESTED
-    if startVertex.is_a?(String)
-      @startVertex = startVertex
-    elsif startVertex.is_a?(ArangoDocument)
-      @startVertex = startVertex.id
-    else
-      raise "startVertex should be a String or an ArangoDocument instance, not a #{startVertex.class}"
-    end
-    @idCache = "ATR_#{@database}_#{@direction}_#{@startVertex}_" + (@graphName.nil? ? "#{@edgeCollection}" : "#{@graphName}")
-  end
-
-  def graphName=(graphName) # TESTED
-    if graphName.is_a?(String) || graphName.nil?
-      @graphName = graphName
-    elsif graphName.is_a?(ArangoGraph)
-      @graphName = graphName.graph
-    else
-      raise "graphName should be a String or an ArangoGraph instance, not a #{graphName.class}"
-    end
-    @idCache = "ATR_#{@database}_#{@direction}_#{@startVertex}_" + (@graphName.nil? ? "#{@edgeCollection}" : "#{@graphName}")
-  end
-
-  def edgeCollection=(edgeCollection) # TESTED
-    if edgeCollection.is_a?(String) || edgeCollection.nil?
-      @edgeCollection = edgeCollection
-    elsif edgeCollection.is_a?(ArangoCollection)
-      @edgeCollection = edgeCollection.collection
-    else
-      raise "edgeCollection should be a String or an ArangoCollection instance, not a #{edgeCollection.class}"
-    end
-    @idCache = "ATR_#{@database}_#{@direction}_#{@startVertex}_" + (@graphName.nil? ? "#{@edgeCollection}" : "#{@graphName}")
-  end
-
-  def in # TESTED
-    @direction = "inbound"
-    @idCache = "ATR_#{@database}_#{@direction}_#{@startVertex}_" + (@graphName.nil? ? "#{@edgeCollection}" : "#{@graphName}")
-  end
-
-  def out # TESTED
-    @direction = "outbound"
-    @idCache = "ATR_#{@database}_#{@direction}_#{@startVertex}_" + (@graphName.nil? ? "#{@edgeCollection}" : "#{@graphName}")
-  end
-
-  def any # TESTED
-    @direction = "any"
-    @idCache = "ATR_#{@database}_#{@direction}_#{@startVertex}_" + (@graphName.nil? ? "#{@edgeCollection}" : "#{@graphName}")
-  end
-
-  alias vertex= startVertex=
-  alias vertex startVertex
-  alias max maxDepth
-  alias max= maxDepth=
-  alias min minDepth
-  alias min= minDepth=
-  alias collection edgeCollection
-  alias collection= edgeCollection=
-  alias graph graphName
-  alias graph= graphName=
-
-  def execute # TESTED
-    body = {
-      "sort"        => @sort,
-      "direction"   => @direction,
-      "maxDepth"    => @maxDepth,
-      "minDepth"    => @minDepth,
-      "startVertex" => @startVertex,
-      "visitor"     => @visitor,
-      "itemOrder"   => @itemOrder,
-      "strategy"    => @strategy,
-      "filter"      => @filter,
-      "init"        => @init,
-      "maxiterations" => @maxiterations,
-      "uniqueness"  => @uniqueness,
-      "order"       => @order,
-      "graphName"   => @graphName,
-      "expander"    => @expander,
-      "edgeCollection" => @edgeCollection
-    }.delete_if{|k,v| v.nil?}
-    request = @@request.merge({ :body => body.to_json })
-    result = self.class.post("/_db/#{@database}/_api/traversal", request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    return true if @@async
-    result = result.parsed_response
-    return @@verbose ? result : result["errorMessage"] if result["error"]
-    @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 )}
-      }
-    }
-    @idCache = "ATR_#{@database}_#{@direction}_#{@startVertex}_" + (@graphName.nil? ? "#{@edgeCollection}" : "#{@graphName}")
-    @@verbose ? result : self
-  end
-end

data/lib/ArangoRB_Tran.rb

@@ -1,68 +0,0 @@
-# === 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,157 +0,0 @@
-# === 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 grant_read(database: @@database) # TESTED
-    database = database.database if database.is_a?(ArangoDatabase)
-    body = { "grant" => "ro" }.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