arangodb-driver 3.10.4 → 3.10.4.1

data/lib/arango/edge_collection/class_methods.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango EdgeCollection
   module EdgeCollection
+    # Arango EdgeCollection ClassMethods
     module ClassMethods
       def new(database: Arango.current_database, graph: nil,
               name:, id: nil, globally_unique_id: nil, is_system: false, status: nil, type: :edge,

data/lib/arango/edge_collection/edge_acces_2.rb

@@ -1,7 +1,11 @@
 module Arango
+  # Arango EdgeCollection
   module Collection
+    # Arango EdgeCollection EdgeAccess
     module EdgeAccess
-      # === GRAPH ===
+      #
+      # Set the graph of the EdgeAccess instance
+      #
       def graph=(graph)
         satisfy_module_or_nil?(graph, Arango::Graph::Mixin)
         if !graph.nil? && graph.database.name != @database.name
@@ -12,37 +16,41 @@ module Arango
       end
       alias assign_graph graph=
 
+      #
+      # Add a vertex to the graph
+      # If no graph is defined, create a Document
+      #
+      # @return: Vertex or Document
+      #
       def vertex(name: nil, body: {}, rev: nil, from: nil, to: nil)
         if @type == :edge
           raise Arango::Error.new err: :is_a_edge_collection, data: {type:  @type}
         end
         if @graph.nil?
-          Arango::Document::Base.new(name: name, body: body, rev: rev, collection: self)
+          Arango::Document::Base.new(name: name, body: body, rev: rev, collection: self, from: from, to: to)
         else
-          Arango::Vertex.new(name: name, body: body, rev: rev, collection: self)
+          Arango::Vertex.new(name: name, body: body, rev: rev, collection: self, from: from, to: to)
         end
       end
 
+      #
+      # Add an edge to the graph
+      # If no graph is defined, create a Document
+      #
+      # @return: Vertex or Document
+      #
       def edge(name: nil, body: {}, rev: nil, from: nil, to: nil)
         if @type == :document
           raise Arango::Error.new err: :is_a_document_collection, data: {type:  @type}
         end
         if @graph.nil?
-          Arango::Document::Base.new(name: name, body: body, rev: rev, collection: self)
+          Arango::Document::Base.new(name: name, body: body, rev: rev, from: from, to: to, collection: self)
         else
           Arango::Edge::Base.new(name: name, body: body, rev: rev, from: from, to: to,
                            collection: self)
         end
       end
 
-      def edge_exists?
-
-      end
-
-      def edge(name: nil, body: {}, rev: nil, from: nil, to: nil)
-        Arango::Document::Base.new(name: name, collection: self, body: body, rev: rev,
-                             from: from, to: to)
-      end
 
       def edges(type: "edge") # "path", "id", "key"
         @return_edge = false
@@ -63,14 +71,6 @@ module Arango
         end
       end
 
-      def insert_edge
-
-      end
-
-      def insert_edges
-
-      end
-
       def replace_edge
 
       end

data/lib/arango/edge_collection/edges.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango EdgeCollection
   module EdgeCollection
+    # Arango EdgeCollection Edges
     module Edges
       def new_edge(key: nil, attributes: {}, from: nil, to: nil, wait_for_sync: nil)
         Arango::Edge::Base.new(key: key, attributes: attributes, from: from, to: to, edge_collection: self, wait_for_sync: wait_for_sync)

data/lib/arango/edge_collection/instance_methods.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango EdgeCollection
   module EdgeCollection
+    # Arango EdgeCollection InstanceMethods
     module InstanceMethods
 
       # Instantiate a new collection.

data/lib/arango/edge_collection/mixin.rb

@@ -1,8 +1,10 @@
 module Arango
+  # Arango EdgeCollection
   module EdgeCollection
     STATES = %i[unknown new_born unloaded loaded being_unloaded deleted loading] # do not sort, index is used
     TYPES = %i[unknown unknown document edge] # do not sort, index is used
 
+    # Arango EdgeCollection Mixin
     module Mixin
       #@!visibility private
       def self.included(base)

data/lib/arango/error.rb

@@ -1,7 +1,11 @@
-# === ERROR ===
 
 module Arango
+  #
+  # Arango Error
+  #
   class Error < StandardError
+    # Hash of Arango-specific error codes and their respective messages
+    # Used if an error condition cannot be (fully) expressed by an http status code
     ARANGODB_ERRORS = {
       no_other_aql_next: {
         code: 10001, message: "No other values with AQL next"

data/lib/arango/error_db.rb

@@ -1,5 +1,11 @@
 module Arango
+  #
+  # Arango ErrorDB
+  #
   class ErrorDB < Arango::Error
+    #
+    # Create database error representation
+    #
     def initialize(message:, code:, data:, error_num:, action: nil, url: nil, request:)
       @message   = message
       @code      = code
@@ -11,6 +17,9 @@ module Arango
     end
     attr_reader :action, :code, :data, :error_num, :message, :request, :url
 
+    #
+    # convert to hash
+    # @return [Hash]
     def to_h
       {
         action: @action,

data/lib/arango/foxx.rb

@@ -1,6 +1,7 @@
-# === FOXX ===
-
 module Arango
+  #
+  # Arango Foxx
+  #
   class Foxx
     include Arango::Helper::Satisfaction
 

data/lib/arango/graph/base.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Graph
   module Graph
+    # Arango Graph Base
     class Base
       include Arango::Graph::Mixin
     end

data/lib/arango/graph/class_methods.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Graph
   module Graph
+    # Arango Graph ClassMethods
     module ClassMethods
+      # Create Arango::Graph from hash
       def from_h(graph_hash, database: Arango.current_database)
         graph_hash = graph_hash.transform_keys { |k| k.to_s.underscore.to_sym }
         graph_hash.merge!(database: database) unless graph_hash.has_key?(:database)
@@ -20,10 +23,10 @@ module Arango
         from_h(hash, database: database)
       end
 
+      # extend Arango::Graph with class methods
       def self.extended(base)
 
         # Retrieves all graphs from the database.
-        # @param exclude_system [Boolean] Optional, default true, exclude system graphs.
         # @param database [Arango::Database]
         # @return [Array<Arango::Graph::Base>]
         def all (database: Arango.current_database)
@@ -42,7 +45,6 @@ module Arango
         end
 
         # Retrieves a list of all graphs.
-        # @param exclude_system [Boolean] Optional, default true, exclude system graphs.
         # @param database [Arango::Database]
         # @return [Array<String>] List of graph names.
         def list (database: Arango.current_database)
@@ -70,6 +72,7 @@ module Arango
         end
       end
 
+      # Create Graph in database
       def create(is_smart: @is_smart, smart_graph_attribute: @smart_graph_attribute,
                  number_of_shards: @number_of_shards)
         body = {

data/lib/arango/graph/definition.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Graph
   module Graph
+    # Arango Graph EdgeAccess
     module EdgeAccess
       def edge_collection
 

data/lib/arango/graph/instance_methods.rb

@@ -1,12 +1,16 @@
 module Arango
+  # Arango Graph
   module Graph
+    # Arango Graph InstanceMethods
     module InstanceMethods
 
       # Instantiate a new collection.
-      # For param description see the attributes descriptions. All params except name and database are optional.
+      # For param description see the attributes descriptions. All params except name are optional.
       # @param name [String] The name of the collection.
-      # @param database [Arango::Database]
-      # @param status
+      # @param database [Arango::Database], defaults to Arango.current_database
+      # @param edge_definitions [Array] of edge definitions
+      # @param is_smart [Boolean], optional, defaults to false
+      # @param properties [Hash]
       # @return [Arango::Graph]
       def initialize(database: Arango.current_database,
                      name:, edge_definitions: [], is_smart: false,

data/lib/arango/graph/mixin.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Graph
   module Graph
+    # Arango Graph Mixin
     module Mixin
       #@!visibility private
       def self.included(base)

data/lib/arango/helper/database_assignment.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Helper
   module Helper
+    # Arango Helper DatabaseAssignment
     module DatabaseAssignment
 
       protected

data/lib/arango/helper/satisfaction.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Helper
   module Helper
+    # Arango Helper Satisfaction
     module Satisfaction
       def satisfy_class?(object, *classes)
         return true if classes.include?(object.class)

data/lib/arango/helper/server_assignment.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Helper
   module Helper
+    # Arango Helper ServerAssignment
     module ServerAssignment
 
       protected

data/lib/arango/index.rb

@@ -1,9 +1,13 @@
-  # === INDEXES ===
-
 module Arango
+  #
+  # Arango Index
+  #
   class Index
     include Arango::Helper::Satisfaction
     include Arango::Helper::DatabaseAssignment
+    # list indexes defined for collection
+    # @param collection [Arango::Collection]
+    # @return [Array of Arango::Index], or `nil` on error
     def self.list(collection:)
       params = { collection: collection.name }
       result = Arango::Requests::Index::ListAll.execute(server: collection.database.server, params: params)
@@ -17,12 +21,16 @@ module Arango
       nil
     end
 
-    # id is "CollectionName/XXXX"
+    # get collection for index
+    # @param collection [Arango::Collection]
+    # @param id [String] like "CollectionName/XXXX"
+    # @return [Arango::Result]
     def self.get collection:, id:
       c, i = id.split '/' # Requests would convert / to %2F
       Arango::Requests::Index::Get.execute(server: collection.database.server, args: {collection: c, id: i})
     end
 
+    # create new Arango::Index instance
     def initialize(collection:, fields:, cache_name: nil, deduplicate: nil, geo_json: nil, min_length: nil, sparse: nil,
                    type: "hash", unique: nil)
       @collection = collection
@@ -48,12 +56,16 @@ module Arango
     attr_accessor :cache_name, :deduplicate, :fields, :geo_json, :min_length, :sparse, :unique
     attr_reader :collection, :database, :server, :type, :name, :id, :key, :is_newly_created
 
+    # set index type
+    # @param type [String], one of hash skiplist persistent geo fulltext, or primary
     def type=(type)
       satisfy_category?(type, %w[hash skiplist persistent geo fulltext primary])
       @type = type
     end
     alias assign_type type=
 
+    # set index attributes from hash
+    # @param result [Hash]
     def assign_attributes(result)
       @id          = result[:id] || @id
       @name        = result[:name] || @name
@@ -71,6 +83,8 @@ module Arango
 
 # === DEFINE ===
 
+    # convert index to hash
+    # @return [Hash]
     def to_h
       {
         key: @key,
@@ -91,6 +105,7 @@ module Arango
 
 # === COMMANDS ===
 
+    # create Index in database
     def create
       body = {
         fields:      @fields,
@@ -128,10 +143,12 @@ module Arango
       self
     end
 
+    # String representation
     def to_s
       "Index(#{@id}:#{@type.to_sym}-#{@fields})"
     end
 
+    # delete datbase index
     def delete
       c, i = @id.split '/' # Requests would convert / to %2F
       Arango::Requests::Index::Delete.execute(server: @database.server, args: { collection: c, id: i})

data/lib/arango/replication.rb

@@ -1,6 +1,7 @@
-# === REPLICATION ===
-
 module Arango
+  #
+  # Arango Replication
+  #
   class Replication
     include Arango::Helper::Satisfaction
 

data/lib/arango/request.rb

@@ -1,23 +1,41 @@
 require "addressable/template"
 module Arango
+  #
+  # Arango Request
+  # Implements REST API to Arango
+  # Used to define accessor classes to run `execute`
+  # Strictly internal. Not user accessible. Used to implement REST API representation classes.
+  #
   class Request
     class << self
+      # execute Arango::Request
+      # @return [Arango::Result]
       def execute(**args)
         self.new(**args).execute
       end
 
+      # check if body exists
+      # @return [Boolean]
       def has_body?
         @has_body
       end
 
+      # check if body is an Array
+      # @return [Boolean]
       def body_is_array?
         @body_is_array
       end
 
+      # get body keys
+      # sets @body_keys to empty Hash (if unset)
+      # @return [Hash]
       def body_keys
         @body_keys ||= Hash.new
       end
 
+      # define body element
+      # @param name [String]
+      # @param option [Symbol] `:required` or `:optional`, defaults to `nil`
       def body(name, option = nil, &block)
         @has_body = true
         camel_name = name.to_s.camelize(:lower)
@@ -37,20 +55,26 @@ module Arango
         @current_nested_body = nil
       end
 
+      # make body an Array
       def body_array
         body_any
         @body_is_array = true
       end
 
+      # allow any body content
       def body_any
         @has_body = true
         @body_any_key_allowed = true
       end
 
+      # allow any body keys
       def body_any_key_allowed
         @body_any_key_allowed
       end
 
+      # define body key
+      # @param name [String]
+      # @param option [Symbol] `:required` or `:optional`, defaults to `nil`
       def key(name, option = nil)
         raise Arango::Error.new("No body context!") unless @current_nested_body
         camel_name = name.to_s.camelize(:lower)
@@ -64,14 +88,22 @@ module Arango
         @current_nested_body[name] = value
       end
 
+      # if request has a header defined
+      # @return [Boolean]
       def has_header?
         @has_header
       end
 
+      # get defined headers
+      # sets headers to empty Hash if undefined
+      # @return [Hash]
       def headers
         @headers ||= Hash.new
       end
 
+      # define header element
+      # @param name [String]
+      # @param option [Symbol] `:required` or `:optional`, defaults to `nil`
       def header(name, option = nil)
         @has_header = true
         key = name.underscore.downcase.to_sym
@@ -84,14 +116,22 @@ module Arango
         end
       end
 
+      # parameters defined ?
+      # @return [Boolean]
       def has_param?
         @has_param
       end
 
+      # get defined parameters
+      # sets parameters to empty Hash if undefined
+      # @return [Hash]
       def params
         @params ||= Hash.new
       end
 
+      # define parameter element
+      # @param name [String]
+      # @param option [Symbol] `:required` or `:optional`, defaults to `nil`
       def param(name, option = nil)
         @has_param = true
         camel_name = name.to_s.camelize(:lower)
@@ -104,26 +144,39 @@ module Arango
         end
       end
 
+      # define request method
+      # @param name [String] http request method (:GET, :PUT, :POST, :PATCH, :DELETE)
       def request_method= name
         @request_method = name
       end
 
+      # get request method
       def reqm
         @request_method
       end
 
+      # define uri template for API call
+      # @param template [String]
+      # see https://rubydoc.info/gems/addressable/Addressable/Template
       def uri_template= template
         @uri_template = Addressable::Template.new(template)
       end
 
+      # get uri template
       def uri_template
         @uri_template
       end
 
+      # get known http return codes and their meanings
+      # sets codes to empty hash if undefined
+      # @return [Hash]
       def codes
         @codes ||= {}
       end
 
+      # define known http code and its meaning
+      # @param number [Integer]
+      # @param message [String]
       def code(number, message)
         codes[number] = message
       end
@@ -136,6 +189,7 @@ module Arango
     attr_reader :formatted_body
     attr_reader :server
 
+    # create expanded URI, (from template, including keys) and http:// prefix
     def formatted_uri
       hash = {}
       hash['db_context'] = ['_db', database] if database
@@ -143,6 +197,12 @@ module Arango
       server.driver_instance.base_uri + self.class.uri_template.expand(hash)
     end
 
+    # create Arango::Request instance
+    # @param body [Hash] optional
+    # @param params [Hash] optional
+    # @param headers [Hash] optional
+    # @param args [Hash] optional
+    # @param server [Arango::Server] use to target correct server (and driver)
     def initialize(body: nil, params: {}, headers: nil, args: nil, server:)
       @server = server
       if args
@@ -158,6 +218,9 @@ module Arango
                         end
     end
 
+    # execute request
+    # @return [Arango::Result]
+    # @raise [Arango::Error]
     def execute
       response, response_code = server.driver_instance.execute_request(self.class.reqm, formatted_uri, formatted_headers, formatted_params, formatted_body)
 
@@ -181,6 +244,7 @@ module Arango
 
     private
 
+    # validate header according to defined header elements
     def validate_and_format_header!(headers)
       result = {}
       headers ||= {} #raise Arango::Error.new("No headers given!") unless headers
@@ -205,6 +269,7 @@ module Arango
       result
     end
 
+    # validate parameters according to defined parameters
     def validate_and_format_params!(params)
       result = {}
       params ||= {} #raise Arango::Error.new("No params given!") unless params
@@ -231,6 +296,7 @@ module Arango
       result
     end
 
+    # validate body according to defined body keys
     def validate_and_format_body!(body)
       result = {}
       body ||= {}
@@ -265,6 +331,7 @@ module Arango
       result
     end
 
+    # validate nested body
     def validate_and_format_nested!(nested_body, body_key, nested_keys)
       result = {}
       nested_keys.each do |key, options|

data/lib/arango/requests/administration/availability.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_admin/server/availability
       class Availability < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/cluster_endpoints.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_api/cluster/endpoints
       class ClusterEndpoints < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/create_task.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Administration Requests
     module Administration
+      # API: POST /_api/tasks
       class CreateTask < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/administration/create_task_id.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Administration Requests
     module Administration
+      # API: PUT /_api/tasks/{id}
       class CreateTaskId < Arango::Request
         self.request_method = :put
 

data/lib/arango/requests/administration/delete_task.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Administration Requests
     module Administration
+      # API: DELETE /_api/tasks/{id}
       class DeleteTasks < Arango::Request
         self.request_method = :delete
 

data/lib/arango/requests/administration/echo.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Administration Requests
     module Administration
+      # API: POST /_admin/echo
       class Echo < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/administration/endpoints.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_api/endpoint
       class Endpoints < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/engine.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_api/engine
       class Engine < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/execute.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Administration Requests
     module Administration
+      # API: POST /_admin/execute
       class Execute < Arango::Request
         self.request_method = :post