arangorb 1.2.0 → 1.3.0

data/lib/ArangoRB_Index.rb

@@ -1,115 +1,135 @@
-# === INDEXES ===
-
-class ArangoIndex < ArangoServer
-  def initialize(collection: @@collection, database: @@database, body: {}, id: nil, type: nil, unique: nil, fields:, sparse: nil) # TESTED
-    if collection.is_a?(String)
-      @collection = collection
-    elsif collection.is_a?(ArangoCollection)
-      @collection = collection.collection
-    else
-      raise "collection should be a String or a ArangoCollection instance, not a #{collection.class}"
-    end
-
-    if database.is_a?(String)
-      @database = database
-    elsif database.is_a?(ArangoDatabase)
-      @database = database.database
-    else
-      raise "database should be a String or a ArangoDatabase instance, not a #{database.class}"
-    end
-
-    if body.is_a?(Hash)
-      @body = body
-    else
-      raise "body should be a Hash, not a #{body.class}"
-    end
-
-    unless id.nil?
-      @key = id.split("/")[1]
-      @id = id
-    end
-    @type = type
-    @sparse = sparse
-    @unique = unique unless unique.nil?
-
-    if fields.is_a?(String)
-      @fields = [fields]
-    elsif fields.is_a?(Array)
-      @fields = fields
-    else
-      raise "fields should be a String or an Array, not a #{database.class}"
-    end
-
-    @idCache = "IND_#{@id}"
-  end
-
-  attr_reader :body, :type, :id, :unique, :fields, :key, :sparse, :idCache
-
-  ### RETRIEVE ###
-
-  def database
-    ArangoDatabase.new(database: @database)
-  end
-
-  def collection
-    ArangoCollection.new(collection: @collection, database: @database)
-  end
-
-  def retrieve # TESTED
-    result = self.class.get("/_db/#{@database}/_api/index/#{@id}", @@request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    result = result.parsed_response
-    return result if @@verbose
-    return result["errorMessage"] if result["error"]
-    result.delete_if{|k,v| k == "error" || k == "code"}
-    @body = result
-    @type = result["type"]
-    @unique = result["unique"]
-    @fields = result["fields"]
-    @sparse = result["sparse"]
-    self
-  end
-
-  def self.indexes(database: @@database, collection: @@collection) # TESTED
-    database = database.database if database.is_a?(ArangoDatabase)
-    collection = collection.collection if collection.is_a?(ArangoCollection)
-    query = { "collection": collection }
-    request = @@request.merge({ :query => query })
-    result = get("/_db/#{database}/_api/index", request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    result = result.parsed_response
-    return result if @@verbose
-    return result["errorMessage"] if result["error"]
-    result.delete_if{|k,v| k == "error" || k == "code"}
-    result["indexes"] = result["indexes"].map{|x| ArangoIndex.new(body: x, id: x["id"], database: database, collection: collection, type: x["type"], unique: x["unique"], fields: x["fields"], sparse: x["sparse"])}
-    result
-  end
-
-  def create # TESTED
-    body = @body.merge({
-      "fields" => @fields,
-      "unique" => @unique,
-      "type" => @type,
-      "id" => @id
-    }.delete_if{|k,v| v.nil?})
-    query = { "collection": @collection }
-    request = @@request.merge({ :body => body.to_json, :query => query })
-    result = self.class.post("/_db/#{@database}/_api/index", request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    result = result.parsed_response
-    return result if @@verbose
-    return result["errorMessage"] if result["error"]
-    result.delete_if{|k,v| k == "error" || k == "code"}
-    @body = result
-    @id = result["id"]
-    @key = @id.split("/")[1]
-    self
-  end
-
-  def destroy # TESTED
-    result = self.class.delete("/_db/#{@database}/_api/index/#{id}", @@request)
-    return result.headers["x-arango-async-id"] if @@async == "store"
-    result = result.parsed_response
-    @@verbose ? result : result["error"] ? result["errorMessage"] : true
-  end
-end
+# === INDEXES ===
+
+class ArangoIndex < ArangoServer
+  def initialize(collection: @@collection, database: @@database, body: {}, id: nil, type: nil, unique: nil, fields:, sparse: nil) # TESTED
+    if collection.is_a?(String)
+      @collection = collection
+    elsif collection.is_a?(ArangoCollection)
+      @collection = collection.collection
+    else
+      raise "collection should be a String or a ArangoCollection instance, not a #{collection.class}"
+    end
+
+    if database.is_a?(String)
+      @database = database
+    elsif database.is_a?(ArangoDatabase)
+      @database = database.database
+    else
+      raise "database should be a String or a ArangoDatabase instance, not a #{database.class}"
+    end
+
+    if body.is_a?(Hash)
+      @body = body
+    else
+      raise "body should be a Hash, not a #{body.class}"
+    end
+
+    unless id.nil?
+      @key = id.split("/")[1]
+      @id = id
+    end
+    @type = type
+    @sparse = sparse
+    @unique = unique unless unique.nil?
+
+    if fields.is_a?(String)
+      @fields = [fields]
+    elsif fields.is_a?(Array)
+      @fields = fields
+    else
+      raise "fields should be a String or an Array, not a #{database.class}"
+    end
+
+    @idCache = "IND_#{@id}"
+  end
+
+  attr_reader :body, :type, :id, :unique, :fields, :key, :sparse, :idCache
+
+  ### RETRIEVE ###
+
+  def to_hash
+    {
+      "key" => @key,
+      "id" => @id,
+      "collection" => @collection,
+      "database" => @database,
+      "body" => @body,
+      "type" => @type,
+      "sparse" => @sparse,
+      "unique" => @unique,
+      "fields" => @fields,
+      "idCache" => @idCache
+    }.delete_if{|k,v| v.nil?}
+  end
+  alias to_h to_hash
+
+  def database
+    ArangoDatabase.new(database: @database)
+  end
+
+  def collection
+    ArangoCollection.new(collection: @collection, database: @database)
+  end
+
+  def retrieve # TESTED
+    result = self.class.get("/_db/#{@database}/_api/index/#{@id}", @@request)
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    return true if @@async
+    result = result.parsed_response
+    return result if @@verbose
+    return result["errorMessage"] if result["error"]
+    result.delete_if{|k,v| k == "error" || k == "code"}
+    @body = result
+    @type = result["type"]
+    @unique = result["unique"]
+    @fields = result["fields"]
+    @sparse = result["sparse"]
+    self
+  end
+
+  def self.indexes(database: @@database, collection: @@collection) # TESTED
+    database = database.database if database.is_a?(ArangoDatabase)
+    collection = collection.collection if collection.is_a?(ArangoCollection)
+    query = { "collection": collection }
+    request = @@request.merge({ :query => query })
+    result = get("/_db/#{database}/_api/index", request)
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    return true if @@async
+    result = result.parsed_response
+    return result if @@verbose
+    return result["errorMessage"] if result["error"]
+    result.delete_if{|k,v| k == "error" || k == "code"}
+    result["indexes"] = result["indexes"].map{|x| ArangoIndex.new(body: x, id: x["id"], database: database, collection: collection, type: x["type"], unique: x["unique"], fields: x["fields"], sparse: x["sparse"])}
+    result
+  end
+
+  def create # TESTED
+    body = @body.merge({
+      "fields" => @fields,
+      "unique" => @unique,
+      "type" => @type,
+      "id" => @id
+    }.delete_if{|k,v| v.nil?})
+    query = { "collection": @collection }
+    request = @@request.merge({ :body => body.to_json, :query => query })
+    result = self.class.post("/_db/#{@database}/_api/index", request)
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    return true if @@async
+    result = result.parsed_response
+    return result if @@verbose
+    return result["errorMessage"] if result["error"]
+    result.delete_if{|k,v| k == "error" || k == "code"}
+    @body = result
+    @id = result["id"]
+    @key = @id.split("/")[1]
+    self
+  end
+
+  def destroy # TESTED
+    result = self.class.delete("/_db/#{@database}/_api/index/#{id}", @@request)
+    return result.headers["x-arango-async-id"] if @@async == "store"
+    return true if @@async
+    result = result.parsed_response
+    @@verbose ? result : result["error"] ? result["errorMessage"] : true
+  end
+end

data/lib/ArangoRB_Replication.rb

@@ -0,0 +1,261 @@
+# === REPLICATION ===
+
+class ArangoReplication < ArangoServer
+  def initialize(endpoint:, username:, password:, database: nil, includeSystem: true, initialSyncMaxWaitTime: nil, incremental: nil, restrictCollections: nil, verbose: false, connectTimeout: nil, autoResync: nil, idleMinWaitTime: nil, requestTimeout: nil, requireFromPresent: nil, idleMaxWaitTime: nil, restrictType: nil, maxConnectRetries: nil, adaptivePolling: nil, connectionRetryWaitTime: nil, autoResyncRetries: nil, chunkSize: nil)
+    if database.is_a?(String) || database.nil?
+      @database = database
+    elsif database.is_a?(ArangoDatabase)
+      @database = database.database
+    else
+      raise "database should be nil, a String or an ArangoDatabase instance, not a #{database.class}"
+    end
+
+    if restrictType == "include" || restrictType == "exclude" || restrictType.nil?
+      @restrictType = restrictType
+    else
+      raise "restrictType can be only \"include\" or \"exclude\"."
+    end
+
+    if restrictCollections.nil?
+      @restrictCollections = nil
+    else
+      @restrictCollections = []
+      restrictCollections.each do |v|
+        if v.is_a? (String)
+          @restrictCollections << v
+        elsif v.is_a? (ArangoCollection)
+          @restrictCollections << v.name
+        end
+      end
+    end
+
+    @endpoint = endpoint
+    @username = username
+    @password = password
+    @includeSytem = includeSystem
+    @initialSyncMaxWaitTime = initialSyncMaxWaitTime,
+    @incremental = incremental
+    @verbose = verbose,
+    @connectTimeout = connectTimeout
+    @autoResync = autoResync
+    @idleMinWaitTime = idleMinWaitTime
+    @requestTimeout = requestTimeout
+    @requireFromPresent = requireFromPresent
+    @idleMaxWaitTime = idleMaxWaitTime
+    @maxConnectRetries = maxConnectRetries
+    @adaptivePolling = adaptivePolling
+    @connectionRetryWaitTime = connectionRetryWaitTime
+    @autoResyncRetries = autoResyncRetries
+    @chunkSize = chunkSize
+  end
+
+  def master(endpoint:, username:, password:, database: nil)
+    if database.is_a?(String) || database.nil?
+      @database = database
+    elsif database.is_a?(ArangoDatabase)
+      @database = database.database
+    else
+      raise "database should be nil, a String or an ArangoDatabase instance, not a #{database.class}"
+    end
+
+    @endpoint = endpoint
+    @username = username
+    @password = password
+  end
+
+  attr_accessor :endpoint, :username, :password, :includeSystem, :initialSyncMaxWaitTime, :incremental, :verbose, :connectTimeout, :autoResync, :idleMinWaitTime, :requestTimeout, :requireFromPresent, :idleMaxWaitTime, :maxConnectRetries, :adaptivePolling, :connectionRetryWaitTime, :autoResyncRetries, :chunkSize
+  attr_reader :database, :restrictType, :restrictCollections
+
+  def restrictType=(value)
+    if value == "include" || value == "exclude" || value.nil?
+      @restrictType = value
+    else
+      raise "restrictType can be only \"include\" or \"exclude\"."
+    end
+  end
+
+  def restrictCollections=(value)
+    if value.nil?
+      @restrictCollections = nil
+    else
+      value = [value] unless value.is_a? Array
+      @restrictCollections = []
+      value.each do |v|
+        if v.is_a? (String)
+          @restrictCollections << v
+        elsif v.is_a? (ArangoCollection)
+          @restrictCollections << v.name
+        end
+      end
+    end
+  end
+
+  def to_hash
+    master
+    {
+      "master" => {
+        "endpoint" => @endpoint,
+        "username" => @username,
+        "password" => @password,
+        "database" => @database
+      }.delete_if{|k,v| v.nil?},
+      "options" => {
+        "includeSytem" => @includeSystem,
+        "initialSyncMaxWaitTime" => @initialSyncMaxWaitTime,
+        "restrictType" => @restrictType,
+        "incremental" => @incremental,
+        "restrictCollections" => @restrictCollections,
+        "verbose" => @verbose,
+        "connectTimeout" => @connectTimeout,
+        "autoResync" => @autoResync,
+        "idleMinWaitTime" => @idleMinWaitTime,
+        "requestTimeout" => @requestTimeout,
+        "requireFromPresent" => @requireFromPresent,
+        "idleMaxWaitTime" => @idleMaxWaitTime,
+        "maxConnectRetries" => @maxConnectRetries,
+        "adaptivePolling" => @adaptivePolling,
+        "connectionRetryWaitTime" => @connectionRetryWaitTime,
+        "autoResyncRetries" => @autoResyncRetries,
+        "chunkSize" => @chunkSize
+      }.delete_if{|k,v| v.nil?}
+    }
+  end
+  alias to_h to_hash
+
+# SYNCRONISATION
+
+  def sync
+    body = {
+      "username" => @username,
+      "password" => @password,
+      "endpoint" => @endpoint,
+      "database" => @database,
+      "includeSystem" => @includeSystem,
+      "initialSyncMaxWaitTime" => @initialSyncMaxWaitTime,
+      "restrictType" => @restrictType,
+      "incremental" => @incremental,
+      "restrictCollections" => @restrictCollections
+    }.delete_if{|k,v| v.nil?}
+    request = @@request.merge({ :body => body.to_json })
+    result = self.class.put("/_api/replication/sync", request)
+    self.class.return_result result: result
+  end
+
+# ENSLAVE
+
+  def enslave
+    body = {
+      "username" => @username,
+      "password" => @password,
+      "endpoint" => @endpoint,
+      "database" => @database,
+      "includeSystem" => @includeSystem,
+      "initialSyncMaxWaitTime" => @initialSyncMaxWaitTime,
+      "verbose" => @verbose,
+      "connectTimeout" => @connectTimeout,
+      "autoResync" => @autoResync,
+      "idleMinWaitTime" => @idleMinWaitTime,
+      "requestTimeout" => @requestTimeout,
+      "requireFromPresent" => @requireFromPresent,
+      "idleMaxWaitTime" => @idleMaxWaitTime,
+      "restrictType" => @restrictType,
+      "maxConnectRetries" => @maxConnectRetries,
+      "adaptivePolling" => @adaptivePolling,
+      "connectionRetryWaitTime" => @connectionRetryWaitTime,
+      "restrictCollections" =>  @restrictCollections,
+      "autoResyncRetries" => @autoResyncRetries,
+      "chunkSize" => @chunkSize
+    }.delete_if{|k,v| v.nil?}
+    request = @@request.merge({ :body => body.to_json })
+    result = self.class.put("/_api/replication/make-slave", request)
+    self.class.return_result result: result
+  end
+
+# MANAGE CONFIGURATION
+
+  def stateReplication # TESTED
+    result = self.class.get("/_db/#{@database}/_api/replication/applier-state", @@request)
+    self.class.return_result result: result
+  end
+
+  def configurationReplication
+    result = self.class.get("/_api/replication/applier-config", @@request)
+    self.class.return_result result: result
+  end
+
+  def modifyConfigurationReplication
+    body = {
+      "username" => @username,
+      "password" => @password,
+      "includeSystem" => @includeSystem,
+      "endpoint" => @endpoint,
+      "initialSyncMaxWaitTime" => @initialSyncMaxWaitTime,
+      "database" => @database,
+      "verbose" => @verbose,
+      "connectTimeout" => @connectTimeout,
+      "autoResync" => @autoResync,
+      "idleMinWaitTime" => @idleMinWaitTime,
+      "requestTimeout" => @requestTimeout,
+      "requireFromPresent" => @requireFromPresent,
+      "idleMaxWaitTime" => @idleMaxWaitTime,
+      "restrictType" => @restrictType,
+      "maxConnectRetries" => @maxConnectRetries,
+      "autoStart" => @autoStart,
+      "adaptivePolling" => @adaptivePolling,
+      "connectionRetryWaitTime" => @connectionRetryWaitTime,
+      "restrictCollections" => @restrictCollections,
+      "autoResyncRetries" => @autoResyncRetries,
+      "chunkSize" => @chunkSize
+    }.delete_if{|k,v| v.nil?}
+    request = @@request.merge({ :body => body.to_json })
+    result = self.class.put("/_api/replication/applier-config", request)
+    self.class.return_result result: result
+  end
+  alias modifyReplication modifyConfigurationReplication
+
+  def startReplication(from: nil) # TESTED
+    query = {from: from}.delete_if{|k,v| v.nil?}
+    request = @@request.merge({ :query => query })
+    result = self.class.put("/_api/replication/applier-start", request)
+    self.class.return_result result: result
+  end
+
+  def stopReplication # TESTED
+    result = self.class.put("/_api/replication/applier-stop", @@request)
+    self.class.return_result result: result
+  end
+
+# INFO
+
+  def serverId # TESTED
+    result = self.class.get("/_db/#{@database}/_api/replication/server-id", @@request)
+    self.class.return_result result: result, key: "serverId"
+  end
+
+  def logger # TESTED
+    result = self.class.get("/_db/#{@database}/_api/replication/logger-state")
+    self.class.return_result result: result
+  end
+
+  def loggerFollow(from: nil, to: nil, chunkSize: nil, includeSystem: false) # TESTED
+    query = {
+      "from": from,
+      "to": to,
+      "chunkSize": chunkSize,
+      "includeSystem": includeSystem
+    }.delete_if{|k,v| v.nil?}
+    request = @@request.merge({ :query => query })
+    result = self.class.get("/_db/#{@database}/_api/replication/logger-follow", request)
+    self.class.return_result result: result
+  end
+
+  def firstTick # TESTED
+    result = self.class.get("/_db/#{@database}/_api/replication/logger-first-tick")
+    self.class.return_result result: result, key: "firstTick"
+  end
+
+  def rangeTick # TESTED
+    result = self.class.get("/_db/#{@database}/_api/replication/logger-tick-ranges")
+    self.class.return_result result: result
+  end
+end