arangorb 1.2.0 → 1.3.0

data/lib/ArangoRB_AQL.rb

@@ -1,160 +1,181 @@
-# === AQL ===
-
-class ArangoAQL < ArangoServer
-  def initialize(query: nil, batchSize: nil, ttl: nil, cache: nil, options: nil, bindVars: nil, database: @@database)  # TESTED
-    if query.is_a?(String)
-      @query = query
-    elsif query.is_a?(ArangoAQL)
-      @query = query.query
-    else
-      raise "query should be String or ArangoAQL instance, not a #{query.class}"
-    end
-
-    if database.is_a?(String)
-      @database = database
-    elsif database.is_a?(ArangoDatabase)
-      @database = database.database
-    else
-      raise "databaseshould be String or ArangoDatabase instance, not a #{database.class}"
-    end
-
-    @batchSize = batchSize
-    @ttl = ttl
-    @cache = cache
-    @options = options
-    @bindVars = bindVars
-
-    @count = 0
-    @hasMore = false
-    @id = ""
-    @result = []
-    @idCache = "AQL_#{@query}"
-  end
-
-  attr_accessor :query, :batchSize, :ttl, :cache, :options, :bindVars
-  attr_reader :count, :count, :hasMore, :id, :result, :idCache
-  alias size batchSize
-  alias size= batchSize=
-
-# === RETRIEVE ===
-
-  def database
-    ArangoDatabase.new(database: @database)
-  end
-
-# === EXECUTE QUERY ===
-
-  def execute(count: true) # TESTED
-    body = {
-      "query" => @query,
-      "count" => count,
-      "batchSize" => @batchSize,
-      "ttl" => @count,
-      "cache" => @cache,
-      "options" => @options,
-      "bindVars" => @bindVars
-    }.delete_if{|k,v| v.nil?}
-    request = @@request.merge({ :body => body.to_json })
-    result = self.class.post("/_db/#{@database}/_api/cursor", request)
-    return result.headers["x-arango-async-id"]if @@async == "store"
-    result = result.parsed_response
-    return @@verbose ? result : result["errorMessage"] if result["error"]
-    @count = result["count"]
-    @hasMore = result["hasMore"]
-    @id = result["id"]
-    if(result["result"][0].nil? || !result["result"][0].is_a?(Hash) || !result["result"][0].key?("_key"))
-      @result = result["result"]
-    else
-      @result = result["result"].map{|x| ArangoDocument.new(key: x["_key"], collection: x["_id"].split("/")[0], database: @database, body: x)}
-    end
-    return @@verbose ? result : self
-  end
-
-  def next  # TESTED
-    unless @hasMore
-      print "No other results"
-    else
-      result = self.class.put("/_db/#{@database}/_api/cursor/#{@id}", @@request)
-      return result.headers["x-arango-async-id"]if @@async == "store"
-      result = result.parsed_response
-      return @@verbose ? result : result["errorMessage"] if result["error"]
-      @count = result["count"]
-      @hasMore = result["hasMore"]
-      @id = result["id"]
-      if(result["result"][0].nil? || !result["result"][0].is_a?(Hash) || !result["result"][0].key?("_key"))
-        @result = result["result"]
-      else
-        @result = result["result"].map{|x| ArangoDocument.new(key: x["_key"], collection: x["_id"].split("/")[0], database: @database, body: x)}
-      end
-      return @@verbose ? result : self
-    end
-  end
-
-  # === PROPERTY QUERY ===
-
-  def explain  # TESTED
-    body = {
-      "query" => @query,
-      "options" => @options,
-      "bindVars" => @bindVars
-    }.delete_if{|k,v| v.nil?}
-    request = @@request.merge({ :body => body.to_json })
-    result = self.class.post("/_db/#{@database}/_api/explain", request)
-    return_result result: result
-  end
-
-  def parse # TESTED
-    body = { "query" => @query }
-    request = @@request.merge({ :body => body.to_json })
-    result = self.class.post("/_db/#{@database}/_api/query", request)
-    return_result result: result
-  end
-
-  def properties # TESTED
-    result = self.class.get("/_db/#{@database}/_api/query/properties", @@request)
-    return_result result: result
-  end
-
-  def current # TESTED
-    result = self.class.get("/_db/#{@database}/_api/query/current", @@request)
-    return_result result: result
-  end
-
-  def slow # TESTED
-    result = self.class.get("/_db/#{@database}/_api/query/slow", @@request)
-    return_result result: result
-  end
-
-# === DELETE ===
-
-  def stopSlow # TESTED
-    result = self.class.delete("/_db/#{@database}/_api/query/slow", @@request)
-    return_result result: result, caseTrue: true
-  end
-
-  def kill(id: @id) # TESTED
-    result = self.class.delete("/_db/#{@database}/_api/query/#{id}", @@request)
-    return_result result: result, caseTrue: true
-  end
-
-  def changeProperties(slowQueryThreshold: nil, enabled: nil, maxSlowQueries: nil, trackSlowQueries: nil, maxQueryStringLength: nil) # TESTED
-    body = {
-      "slowQueryThreshold" => slowQueryThreshold,
-      "enabled" => enabled,
-      "maxSlowQueries" => maxSlowQueries,
-      "trackSlowQueries" => trackSlowQueries,
-      "maxQueryStringLength" => maxQueryStringLength
-    }.delete_if{|k,v| v.nil?}
-    request = @@request.merge({ :body => body.to_json })
-    result = self.class.put("/_db/#{@database}/_api/query/properties", request)
-    return_result result: result
-  end
-
-# === UTILITY ===
-
-  def return_result(result:, caseTrue: false)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    result = result.parsed_response
-    @@verbose ? result : (result.is_a?(Hash) && result["error"]) ? result["errorMessage"] : caseTrue ? true : result
-  end
-end
+# === AQL ===
+
+class ArangoAQL < ArangoServer
+  def initialize(query: nil, batchSize: nil, ttl: nil, cache: nil, options: nil, bindVars: nil, database: @@database)  # TESTED
+    if query.is_a?(String)
+      @query = query
+    elsif query.is_a?(ArangoAQL)
+      @query = query.query
+    else
+      raise "query should be String or ArangoAQL instance, not a #{query.class}"
+    end
+
+    if database.is_a?(String)
+      @database = database
+    elsif database.is_a?(ArangoDatabase)
+      @database = database.database
+    else
+      raise "databaseshould be String or ArangoDatabase instance, not a #{database.class}"
+    end
+
+    @batchSize = batchSize
+    @ttl = ttl
+    @cache = cache
+    @options = options
+    @bindVars = bindVars
+
+    @count = true
+    @quantity = nil
+    @hasMore = false
+    @id = ""
+    @result = []
+    @idCache = "AQL_#{@query}"
+  end
+
+  attr_accessor :count, :query, :batchSize, :ttl, :cache, :options, :bindVars, :quantity
+  attr_reader :hasMore, :id, :result, :idCache
+  alias size batchSize
+  alias size= batchSize=
+
+# === RETRIEVE ===
+
+  def to_hash
+    {
+      "query" => @query,
+      "database" => @database,
+      "result" => @result.map{|x| x.is_a?(ArangoServer) ? x.to_h : x},
+      "count" => @count,
+      "quantity" => @quantity,
+      "ttl" => @ttl,
+      "cache" => @cache,
+      "batchSize" => @batchSize,
+      "bindVars" => @bindVars,
+      "options" => @options,
+      "idCache" => @idCache,
+    }.delete_if{|k,v| v.nil?}
+  end
+  alias to_h to_hash
+
+  def database
+    ArangoDatabase.new(database: @database)
+  end
+
+# === EXECUTE QUERY ===
+
+  def execute # TESTED
+    body = {
+      "query" => @query,
+      "count" => count,
+      "batchSize" => @batchSize,
+      "ttl" => @ttl,
+      "cache" => @cache,
+      "options" => @options,
+      "bindVars" => @bindVars
+    }.delete_if{|k,v| v.nil?}
+    request = @@request.merge({ :body => body.to_json })
+    result = self.class.post("/_db/#{@database}/_api/cursor", 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"]
+    @quantity = result["count"]
+    @hasMore = result["hasMore"]
+    @id = result["id"]
+    if(result["result"][0].nil? || !result["result"][0].is_a?(Hash) || !result["result"][0].key?("_key"))
+      @result = result["result"]
+    else
+      @result = result["result"].map{|x| ArangoDocument.new(key: x["_key"], collection: x["_id"].split("/")[0], database: @database, body: x)}
+    end
+    return @@verbose ? result : self
+  end
+
+  def next  # TESTED
+    unless @hasMore
+      print "No other results"
+    else
+      result = self.class.put("/_db/#{@database}/_api/cursor/#{@id}", @@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"]
+      @count = result["count"]
+      @hasMore = result["hasMore"]
+      @id = result["id"]
+      if(result["result"][0].nil? || !result["result"][0].is_a?(Hash) || !result["result"][0].key?("_key"))
+        @result = result["result"]
+      else
+        @result = result["result"].map{|x| ArangoDocument.new(key: x["_key"], collection: x["_id"].split("/")[0], database: @database, body: x)}
+      end
+      return @@verbose ? result : self
+    end
+  end
+
+  # === PROPERTY QUERY ===
+
+  def explain  # TESTED
+    body = {
+      "query" => @query,
+      "options" => @options,
+      "bindVars" => @bindVars
+    }.delete_if{|k,v| v.nil?}
+    request = @@request.merge({ :body => body.to_json })
+    result = self.class.post("/_db/#{@database}/_api/explain", request)
+    return_result result: result
+  end
+
+  def parse # TESTED
+    body = { "query" => @query }
+    request = @@request.merge({ :body => body.to_json })
+    result = self.class.post("/_db/#{@database}/_api/query", request)
+    return_result result: result
+  end
+
+  def properties # TESTED
+    result = self.class.get("/_db/#{@database}/_api/query/properties", @@request)
+    return_result result: result
+  end
+
+  def current # TESTED
+    result = self.class.get("/_db/#{@database}/_api/query/current", @@request)
+    return_result result: result
+  end
+
+  def slow # TESTED
+    result = self.class.get("/_db/#{@database}/_api/query/slow", @@request)
+    return_result result: result
+  end
+
+# === DELETE ===
+
+  def stopSlow # TESTED
+    result = self.class.delete("/_db/#{@database}/_api/query/slow", @@request)
+    return_result result: result, caseTrue: true
+  end
+
+  def kill(id: @id) # TESTED
+    result = self.class.delete("/_db/#{@database}/_api/query/#{id}", @@request)
+    return_result result: result, caseTrue: true
+  end
+
+  def changeProperties(slowQueryThreshold: nil, enabled: nil, maxSlowQueries: nil, trackSlowQueries: nil, maxQueryStringLength: nil) # TESTED
+    body = {
+      "slowQueryThreshold" => slowQueryThreshold,
+      "enabled" => enabled,
+      "maxSlowQueries" => maxSlowQueries,
+      "trackSlowQueries" => trackSlowQueries,
+      "maxQueryStringLength" => maxQueryStringLength
+    }.delete_if{|k,v| v.nil?}
+    request = @@request.merge({ :body => body.to_json })
+    result = self.class.put("/_db/#{@database}/_api/query/properties", request)
+    return_result result: result
+  end
+
+# === UTILITY ===
+
+  def return_result(result:, caseTrue: false)
+    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"] : caseTrue ? true : result
+  end
+end

data/lib/ArangoRB_Cache.rb

@@ -1,174 +1,174 @@
-# ==== CACHE ====
-
-class ArangoCache
-  @max  = {
-    "Database" => 1,
-    "Collection" => 20,
-    "Document" => 200,
-    "Graph" => 1,
-    "Vertex" => 50,
-    "Edge" => 100,
-    "Index" => 20,
-    "AQL" => 100,
-    "User" => 50,
-    "Task" => 20,
-    "Traversal" => 20,
-    "Transaction" => 20,
-    "Other" => 100
-  }
-  @cache = {
-    "Database" => {},
-    "Collection" => {},
-    "Document" => {},
-    "Graph" => {},
-    "Vertex" => {},
-    "Edge" => {},
-    "Index" => {},
-    "AQL" => {},
-    "User" => {},
-    "Task" => {},
-    "Traversal" => {},
-    "Transaction" => {},
-    "Other" => {}
-  }
-
-  class << self
-    attr_accessor :max
-
-    def max(type:, val:)
-      return nil if @max[type].nil?
-      while @cache[type].length > val
-        @cache[type].shift
-      end
-      @max[type] = val
-    end
-
-    def retrieve
-      @cache
-    end
-
-    def cache(id: nil, data:)
-      val_to_cache = []
-      data = [data] unless data.is_a? Array
-
-      if id.nil?
-        data.each do |d|
-          type = d.class.to_s
-          type.slice! "Arango"
-          if @max[type].nil?
-            type = "Other"
-            idCache = "OTH_#{d.class.to_s}_#{Random.rand(10^12)}"
-          else
-            idCache = d.idCache
-          end
-          val_to_cache << [type, idCache, d]
-        end
-      else
-        id = [id] unless id.is_a? Array
-        if data.length == id.length
-          for i in 0...id.length
-            type = data[i].class.to_s
-            type.slice! "Arango"
-            type = "Other" if @max[type].nil?
-            val_to_cache << [type, id[i], data[i]]
-          end
-        else
-          return "Id should be a String or an Array with the same size of the Data Array"
-        end
-      end
-
-      val_to_cache.each do |val|
-        @cache[val[0]][val[1]] = val[2]
-        @cache[val[0]].shift if @cache[val[0]].length > @max[val[0]]
-      end
-
-      val_to_cache
-    end
-
-    def uncache(type: nil, id: nil, data: nil)
-      if id.nil? && data.nil? && !type.nil?
-        val_to_uncache = @cache[type].map{|k,v| v}
-        val_to_uncache = val_to_uncache[0] if val_to_uncache.length == 1
-        return val_to_uncache
-      end
-
-      val_to_uncache = []
-      unless data.nil?
-        data = [data] unless data.is_a? Array
-        data.each do |d|
-          type = d.class.to_s
-          type.slice! "Arango"
-          next if @max[type].nil? || type == "Other"
-          idCache = d.idCache
-          val_to_uncache << [type, idCache]
-        end
-      end
-      unless type.nil? || id.nil?
-        id = [id] unless id.is_a? Array
-        if type.is_a? Array
-          if type.length == id.length
-            for i in 0...type.length
-              val_to_uncache << [type[i], id[i]]
-            end
-          else
-            return "Type should be a String or an Array with the same size of the Id Array"
-          end
-        elsif type.is_a? String
-          id.each do |idCache|
-            val_to_uncache << [type, idCache]
-          end
-        else
-          return "Type should be a String or an Array with the same size of the Id Array"
-        end
-      end
-      val_to_uncache = val_to_uncache.map{|val| @cache[val[0]][val[1]]}
-      val_to_uncache = val_to_uncache[0] if val_to_uncache.length == 1
-      val_to_uncache
-    end
-
-    def clear(type: nil, id: nil, data: nil)
-      if type.nil? && id.nil? && data.nil?
-        @cache = { "Database" => {}, "Collection" => {}, "Document" => {}, "Graph" => {}, "Vertex" => {}, "Edge" => {}, "Index" => {}, "Query" => {},"User" => {}, "Traversal" => {}, "Transaction" => {} }
-        return true
-      end
-
-      if !type.nil? && id.nil? && data.nil?
-        @cache[type] = {}
-        return true
-      end
-
-      val_to_clear = []
-      unless data.nil?
-        data = [data] unless data.is_a? Array
-        data.each do |d|
-          type = d.class.to_s
-          type.slice! "Arango"
-          next if @max[type].nil? || type == "Other"
-          val_to_clear <<  [type, d.idCache]
-        end
-      end
-
-      unless type.nil? || id.nil?
-        id = [id] unless id.is_a? Array
-        if type.is_a? Array
-          if type.length == id.length
-            for i in 0...type.length
-              val_to_clear << [type[i], id[i]]
-            end
-          else
-            return "Type should be a String or an Array with the same size of the Id Array"
-          end
-        elsif type.is_a? String
-          id.each do |idCache|
-            val_to_clear << [type, idCache]
-          end
-        else
-          return "Type should be a String or an Array with the same size of the Id Array"
-        end
-      end
-
-      val_to_clear.each{|val| @cache[val[0]].delete(val[1])}
-      true
-    end
-  end
-end
+# ==== CACHE ====
+
+class ArangoCache
+  @max  = {
+    "Database" => 1,
+    "Collection" => 20,
+    "Document" => 200,
+    "Graph" => 1,
+    "Vertex" => 50,
+    "Edge" => 100,
+    "Index" => 20,
+    "AQL" => 100,
+    "User" => 50,
+    "Task" => 20,
+    "Traversal" => 20,
+    "Transaction" => 20,
+    "Other" => 100
+  }
+  @cache = {
+    "Database" => {},
+    "Collection" => {},
+    "Document" => {},
+    "Graph" => {},
+    "Vertex" => {},
+    "Edge" => {},
+    "Index" => {},
+    "AQL" => {},
+    "User" => {},
+    "Task" => {},
+    "Traversal" => {},
+    "Transaction" => {},
+    "Other" => {}
+  }
+
+  class << self
+    attr_accessor :max
+
+    def max(type:, val:)
+      return nil if @max[type].nil?
+      while @cache[type].length > val
+        @cache[type].shift
+      end
+      @max[type] = val
+    end
+
+    def retrieve
+      @cache
+    end
+
+    def cache(id: nil, data:)
+      val_to_cache = []
+      data = [data] unless data.is_a? Array
+
+      if id.nil?
+        data.each do |d|
+          type = d.class.to_s
+          type.slice! "Arango"
+          if @max[type].nil?
+            type = "Other"
+            idCache = "OTH_#{d.class.to_s}_#{Random.rand(10^12)}"
+          else
+            idCache = d.idCache
+          end
+          val_to_cache << [type, idCache, d]
+        end
+      else
+        id = [id] unless id.is_a? Array
+        if data.length == id.length
+          for i in 0...id.length
+            type = data[i].class.to_s
+            type.slice! "Arango"
+            type = "Other" if @max[type].nil?
+            val_to_cache << [type, id[i], data[i]]
+          end
+        else
+          return "Id should be a String or an Array with the same size of the Data Array"
+        end
+      end
+
+      val_to_cache.each do |val|
+        @cache[val[0]][val[1]] = val[2]
+        @cache[val[0]].shift if @cache[val[0]].length > @max[val[0]]
+      end
+
+      val_to_cache
+    end
+
+    def uncache(type: nil, id: nil, data: nil)
+      if id.nil? && data.nil? && !type.nil?
+        val_to_uncache = @cache[type].map{|k,v| v}
+        val_to_uncache = val_to_uncache[0] if val_to_uncache.length == 1
+        return val_to_uncache
+      end
+
+      val_to_uncache = []
+      unless data.nil?
+        data = [data] unless data.is_a? Array
+        data.each do |d|
+          type = d.class.to_s
+          type.slice! "Arango"
+          next if @max[type].nil? || type == "Other"
+          idCache = d.idCache
+          val_to_uncache << [type, idCache]
+        end
+      end
+      unless type.nil? || id.nil?
+        id = [id] unless id.is_a? Array
+        if type.is_a? Array
+          if type.length == id.length
+            for i in 0...type.length
+              val_to_uncache << [type[i], id[i]]
+            end
+          else
+            return "Type should be a String or an Array with the same size of the Id Array"
+          end
+        elsif type.is_a? String
+          id.each do |idCache|
+            val_to_uncache << [type, idCache]
+          end
+        else
+          return "Type should be a String or an Array with the same size of the Id Array"
+        end
+      end
+      val_to_uncache = val_to_uncache.map{|val| @cache[val[0]][val[1]]}
+      val_to_uncache = val_to_uncache[0] if val_to_uncache.length == 1
+      val_to_uncache
+    end
+
+    def clear(type: nil, id: nil, data: nil)
+      if type.nil? && id.nil? && data.nil?
+        @cache = { "Database" => {}, "Collection" => {}, "Document" => {}, "Graph" => {}, "Vertex" => {}, "Edge" => {}, "Index" => {}, "Query" => {},"User" => {}, "Traversal" => {}, "Transaction" => {} }
+        return true
+      end
+
+      if !type.nil? && id.nil? && data.nil?
+        @cache[type] = {}
+        return true
+      end
+
+      val_to_clear = []
+      unless data.nil?
+        data = [data] unless data.is_a? Array
+        data.each do |d|
+          type = d.class.to_s
+          type.slice! "Arango"
+          next if @max[type].nil? || type == "Other"
+          val_to_clear <<  [type, d.idCache]
+        end
+      end
+
+      unless type.nil? || id.nil?
+        id = [id] unless id.is_a? Array
+        if type.is_a? Array
+          if type.length == id.length
+            for i in 0...type.length
+              val_to_clear << [type[i], id[i]]
+            end
+          else
+            return "Type should be a String or an Array with the same size of the Id Array"
+          end
+        elsif type.is_a? String
+          id.each do |idCache|
+            val_to_clear << [type, idCache]
+          end
+        else
+          return "Type should be a String or an Array with the same size of the Id Array"
+        end
+      end
+
+      val_to_clear.each{|val| @cache[val[0]].delete(val[1])}
+      true
+    end
+  end
+end