arangorb 1.4.1 → 2.0.0

data/lib/arangorb.rb

@@ -1,16 +1,24 @@
 require "httparty"
-require_relative "ArangoRB_Ser"
-require_relative "ArangoRB_DB"
-require_relative "ArangoRB_Col"
-require_relative "ArangoRB_Doc"
-require_relative "ArangoRB_Gra"
-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"
-require_relative "ArangoRB_Cache"
-require_relative "ArangoRB_Replication"
+require "oj"
+require "connection_pool"
+require_relative "helpers/Error"
+require_relative "helpers/Return"
+require_relative "AQL"
+require_relative "Batch"
+require_relative "Server"
+require_relative "Collection"
+require_relative "Database"
+require_relative "Document"
+require_relative "Edge"
+require_relative "Error"
+require_relative "Foxx"
+require_relative "Graph"
+require_relative "Index"
+require_relative "Task"
+require_relative "Transaction"
+require_relative "Traversal"
+require_relative "User"
+require_relative "Vertex"
+require_relative "View"
+require_relative "Cache"
+require_relative "Request"

data/lib/helpers/Error.rb

@@ -0,0 +1,28 @@
+module Arango
+  module Helper_Error
+    def satisfy_class?(object, classes=[String], array=false)
+      if array
+        object = [object] unless object.is_a?(Array)
+        object.each do |obj|
+          satisfy_class?(obj, classes, false)
+        end
+      else
+        return if classes.include?(object.class)
+        name ||= object.object_id.to_s
+        raise Arango::Error.new err: :wrong_class, data: {"wrong_value": name,
+          "wrong_class": object.class.to_s, "expected_class": classes.to_s}
+      end
+    end
+
+    def satisfy_category?(object, list)
+      return if list.include?(object)
+      name = object.object_id.to_s
+      raise Arango::Error.new err: :wrong_element, data: {"wrong_attribute": name,
+        "wrong_value": object, "list": list}
+    end
+
+    def warning_deprecated(warning, name)
+      puts "ARANGORB WARNING: #{name} function is deprecated" if warning
+    end
+  end
+end

data/lib/helpers/Return.rb

@@ -0,0 +1,53 @@
+module Arango
+  module Helper_Return
+    def return_directly?(result)
+      return @server.async != false || @server.return_output
+      return result == true
+    end
+
+    def return_element(result)
+      return result if @server.async != false
+      assign_attributes(result)
+      return return_directly?(result) ? result : self
+    end
+
+    def return_delete(result)
+      return result if @server.async != false
+      return return_directly?(result) ? result : true
+    end
+  end
+end
+
+module Arango
+  module Server_Return
+    def server=(server)
+      satisfy_class?(server, [Arango::Server])
+      @server = server
+    end
+    alias assign_server server=
+  end
+end
+
+module Arango
+  module Database_Return
+    def database=(database)
+      satisfy_class?(database, [Arango::Database])
+      @database = database
+      @server = @database.server
+    end
+    alias assign_database database=
+  end
+end
+
+module Arango
+  module Collection_Return
+    def collection=(collection)
+      satisfy_class?(collection, [Arango::Collection])
+      @collection = collection
+      @graph = @collection.graph
+      @database = @collection.database
+      @server = @database.server
+    end
+    alias assign_collection collection=
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arangorb
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Stefano Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-17 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -30,6 +30,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.11
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.11
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.11
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 description: Ruby driver for ArangoDB's HTTP API
 email:
 - stefano@seluxit.com
@@ -41,50 +81,29 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- lib/ArangoRB_AQL.rb
-- lib/ArangoRB_Cache.rb
-- lib/ArangoRB_Col.rb
-- lib/ArangoRB_DB.rb
-- lib/ArangoRB_Doc.rb
-- lib/ArangoRB_Edg.rb
-- lib/ArangoRB_Gra.rb
-- lib/ArangoRB_Index.rb
-- lib/ArangoRB_Replication.rb
-- lib/ArangoRB_Ser.rb
-- lib/ArangoRB_Task.rb
-- lib/ArangoRB_Tra.rb
-- lib/ArangoRB_Tran.rb
-- lib/ArangoRB_User.rb
-- lib/ArangoRB_Ver.rb
+- lib/AQL.rb
+- lib/Batch.rb
+- lib/Cache.rb
+- lib/Collection.rb
+- lib/Database.rb
+- lib/Document.rb
+- lib/Edge.rb
+- lib/Error.rb
+- lib/Foxx.rb
+- lib/Graph.rb
+- lib/Index.rb
+- lib/Replication.rb
+- lib/Request.rb
+- lib/Server.rb
+- lib/Task.rb
+- lib/Transaction.rb
+- lib/Traversal.rb
+- lib/User.rb
+- lib/Vertex.rb
+- lib/View.rb
 - lib/arangorb.rb
-- spec/arangoRB_helper.rb
-- spec/arangoRestart_helper.rb
-- spec/arangorb-1.3.0.gem
-- spec/lib/0.1.0/arangoAQL_helper.rb
-- spec/lib/0.1.0/arangoC_helper.rb
-- spec/lib/0.1.0/arangoDB_helper.rb
-- spec/lib/0.1.0/arangoDoc_helper.rb
-- spec/lib/0.1.0/arangoE_helper.rb
-- spec/lib/0.1.0/arangoG_helper.rb
-- spec/lib/0.1.0/arangoS_helper.rb
-- spec/lib/0.1.0/arangoT_helper.rb
-- spec/lib/0.1.0/arangoV_helper.rb
-- spec/lib/1.0.0/arangoC_helper.rb
-- spec/lib/1.0.0/arangoDB_helper.rb
-- spec/lib/1.0.0/arangoI_helper.rb
-- spec/lib/1.0.0/arangoS_helper.rb
-- spec/lib/1.0.0/arangoTa_helper.rb
-- spec/lib/1.0.0/arangoTr_helper.rb
-- spec/lib/1.0.0/arangoU_helper.rb
-- spec/lib/1.1.0/arangoRB_helper.rb
-- spec/lib/1.1.0/arangoRB_walks_helper.rb
-- spec/lib/1.2.0/arangoCache_helper.rb
-- spec/lib/1.3.0/arangoHash_helper.rb
-- spec/lib/arangoRB_0.1.0_helper.rb
-- spec/lib/arangoRB_1.0.0_helper.rb
-- spec/lib/arangoRB_1.1.0_helper.rb
-- spec/lib/arangoRB_1.2.0_helper.rb
-- spec/spec_helper.rb
+- lib/helpers/Error.rb
+- lib/helpers/Return.rb
 homepage: https://github.com/StefanoMartin/ArangoRB
 licenses:
 - MIT

data/lib/ArangoRB_AQL.rb

@@ -1,181 +0,0 @@
-# === 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 +0,0 @@
-# ==== 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