arangodb-driver 3.10.4 → 3.10.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a2b41f2d171312b42060c35661e16339cea0c932339db26eae7a40e0e1b2b54
-  data.tar.gz: 520ad0f13d405d6a6ebc6012514e5de4b9105856e3510e8540886b6d6ca088f2
+  metadata.gz: 6b0e45b676274654db012747ff27323c0f2b9e0e6ef02d7eed84e042dd5c68bb
+  data.tar.gz: 9c9e8b171d889b19d4b433c5e2f25b096abf8eec372f5dc8001d8ab150bd1f18
 SHA512:
-  metadata.gz: bfe5232d7621188434f82606d8794a27ec6ce0ad1cc04e313bc7d5702c92e21f9207eb964c361b14b86696cdfa9b75e7b81912c55eb5a6adaa507c0e20db3fb3
-  data.tar.gz: 63c288da51f0395401d6a56fb3ad67287390af356006f94d16156a478cde9ed3d0c6ef47b4c987dedb32f805e9e79be85fb0fd2e93ff7bbe9f996aa12672113f
+  metadata.gz: 656efbd84747f9b0beeadaac4d81e47da2418b46ddcf9d56eccdc34c74aa32613b5479e0d04ce854b3fdd7676e0e6d955c67e058fabe5eb037f058773434d36f
+  data.tar.gz: 42c306840713aec3f08e287ec09419c97b8995ae7e86a8c3f7bb5450ca39dc7fe4a9e8ac41464c66fa581c29bda44d8b4527527441025b9bf42a45fd075788dd

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 StefanoMartin, 2019 Jan Biedermann
+Copyright (c) 2016 StefanoMartin, 2019 Jan Biedermann, 2023 Klaus Kämpf
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -2,7 +2,7 @@
   arangodb-driver
   <br/>
   <br/>
-  <img src="https://raw.githubusercontent.com/isomorfeus/arango-driver/master/docs/arango-driver.png" align="center"/>
+  <img src="https://raw.githubusercontent.com/kkaempf/arangodb-driver/master/docs/arangodb-driver.png" align="center"/>
 </h1>
 
 arangodb-driver is a drop-in replacement for the (archived) [arango-driver](https://github.com/janbiedermann/arango-driver).
@@ -21,14 +21,12 @@ The history of arangodb-driver is long and twisted.
 It started with [ArangoRB](https://github.com/StefanoMartin/ArangoRB), converted to [arango-driver](https://github.com/janbiedermann/arango-driver)
 and converted again to [arangodb-driver](https://github.com/kkaempf/arangodb-driver).
 
-The main purpose of the last rename was to get it published at [rubygems.org](https://rubygems.org)
+The main purpose of the last rename was to get it published at [rubygems.org](https://rubygems.org/gems/arangodb-driver)
 
 ## Installation
 
-This doesnt work yet, gem not published yet:
 To install arangodb-driver: `gem install arangodb-driver` 
 To use it in your application: `require "arangodb-driver"`
-Please install from the repo instead.
 
 ## Community and Support
 
@@ -90,7 +88,7 @@ Password is a mandatory field.
 
 ### Returning results
 
-arangodb-driver try always to store the information obtained from ArangoDB in an instance.
+arangodb-driver tries always to store the information obtained from ArangoDB in an instance.
 If you need to receive the output, you can return it with:
 
 ``` ruby
@@ -440,11 +438,11 @@ It means that we skip the first three Documents, we can retrieve the next 100 Do
 To retrieve specific Document you can use:
 
 ``` ruby
-myCollection.documentsMatch match: {value:  4}   # All Documents of the Collection with value equal to 4
-myCollection.documentMatch match: {value:  4}    # The first Document of the Collection with value equal to 4
-myCollection.documentByKeys keys: ["4546", "4646"] # Documents of the Collection with the keys in the Array
+myCollection.documentsMatch match: {value: 4}       # All Documents of the Collection with value equal to 4
+myCollection.documentMatch match: {value: 4}        # The first Document of the Collection with value equal to 4
+myCollection.documentByKeys keys: ["4546", "4646"]  # Documents of the Collection with the keys in the Array
 myCollection.documentByName names: ["4546", "4646"] # Documents of the Collection with the name in the Array
-myCollection.random # A random Document of the Collection
+myCollection.random                                 # A random Document of the Collection
 ```
 
 #### Modifying multiple documents
@@ -476,7 +474,7 @@ One-to-more with one Edge class (and More-to-one with one Edge class)
  * [myDocA] --(myEdge)--> [myDocB]
  * [myDocA] --(myEdge)--> [myDocC]
 
- ``` ruby
+``` ruby
 myEdgeCollection.createEdges document: myEdge, from: myDocA, to: [myDocB, myDocC]
 ```
 
@@ -487,7 +485,7 @@ More-to-More with one Edge class
  * [myDocA] --(myEdge)--> [myDocD]
  * [myDocB] --(myEdge)--> [myDocD]
 
- ``` ruby
+``` ruby
 myEdgeCollection.createEdges document: myEdge, from: [myDocA, myDocB], to: [myDocC, myDocD]
 ```
 

data/lib/arango/aql.rb

@@ -1,18 +1,21 @@
-# === AQL ===
-
 module Arango
+  #
+  # Arango Query Language
+  #
   class AQL
     include Arango::Helper::Satisfaction
 
     class << self
 
-      # id: the query’s id
-      # query: the query string (potentially truncated)
-      # bindVars: the bind parameter values used by the query
-      # started: the date and time when the query was started
-      # runTime: the query’s run time up to the point the list of queries was queried
-      # state: the query’s current execution state (as a string)
-      # stream: whether or not the query uses a streaming cursor
+      # @param query_hash [Hash]
+      # * id: the query's id
+      # * query: the query string (potentially truncated)
+      # * bindVars: the bind parameter values used by the query
+      # * started: the date and time when the query was started
+      # * runTime: the query's run time up to the point the list of queries was queried
+      # * state: the query's current execution state (as a string)
+      # * stream: whether or not the query uses a streaming cursor
+      # @return [Arango::AQL]
       def from_result_hash(query_hash)
         new_query_hash = query_hash.transform_keys { |k| k.to_s.underscore.to_sym }
         new_query_hash[:query_id] = query_hash.delete(:id)
@@ -20,6 +23,33 @@ module Arango
       end
     end
 
+    # Create a new AQL query
+    # @param query
+    # @param database
+    # @param batch_size
+    # @param bind_vars
+    # @param cache
+    # @param count
+    # @param fail_on_warning
+    # @param full_count
+    # @param intermediate_commit_count
+    # @param intermediate_commit_size
+    # @param max_plans
+    # @param max_transaction_size
+    # @param max_warning_count
+    # @param memory_limit
+    # @param optimizer_rules
+    # @param profile
+    # @param satellite_sync_wait
+    # @param skip_inaccessible_collections
+    # @param ttl
+    # @param query_id
+    # @param run_time
+    # @param started
+    # @param state
+    # @param stream
+    # @param block
+    # @param &ruby_block
     def initialize(query:, database:, batch_size: nil, bind_vars: nil, cache: nil, count: nil, fail_on_warning: nil, full_count: nil,
                    intermediate_commit_count: nil, intermediate_commit_size: nil, max_plans: nil, max_transaction_size: nil,
                    max_warning_count: nil, memory_limit: nil, optimizer_rules: nil, profile: nil, satellite_sync_wait: nil,
@@ -65,6 +95,8 @@ module Arango
       send(:optimizer_rules=, optimizer_rules) if optimizer_rules
     end
 
+    # set optimizer rules
+    # @param attrs [Hash]
     def optimizer_rules=(attrs)
       @optimizer_rules = attrs
       if attrs.nil?
@@ -74,6 +106,26 @@ module Arango
       end
     end
 
+    # @!attribute [r] failOnWarning
+    #   @return [Boolean] fail on warning
+    # @!attribute [r] fullCount
+    #   @return [Integer] full count
+    # @!attribute [r] intermediateCommitCount
+    #   @return [Integer] intermediate commit count
+    # @!attribute [r] intermediateCommitSize
+    #   @return [Integer] intermediate commit size
+    # @!attribute [r] maxPlans
+    #   @return [Integer] max plans
+    # @!attribute [r] maxTransactionSize
+    #   @return [Integer] max transaction size
+    # @!attribute [r] maxWarningCount
+    #   @return [Integer] max warning count
+    # @!attribute [r] profile
+    #   @return [Hash] profile
+    # @!attribute [r] satelliteSyncWait
+    #   @return [Boolean] satellite sync wait
+    # @!attribute [r] skipInaccessibleCollections
+    #   @return [Boolean] skip inaccessible collections 
     %w[failOnWarning fullCount intermediateCommitCount intermediateCommitSize maxPlans maxTransactionSize maxWarningCount
      profile satelliteSyncWait skipInaccessibleCollections].each do |param_name|
       var_name = param_name.underscore.to_sym
@@ -88,10 +140,14 @@ module Arango
     attr_reader :server, :cached, :database, :extra, :id, :id_cache, :optimizer_rules, :result
     attr_reader :run_time, :started, :state, :stream
 
+    # check if more results are pending
+    # @return [Boolean]
     def has_more?
       @has_more
     end
 
+    # return Hash representation
+    # @return [Hash]
     def to_h
       {
         batchSize:   @batch_size,
@@ -108,6 +164,9 @@ module Arango
       }.delete_if{|_,v| v.nil?}
     end
 
+    # run an AQL request
+    # @param &block
+    # @return [Arango::AQL] (if no block passed)
     def request
       body = {
           batchSize:   @batch_size,
@@ -125,10 +184,13 @@ module Arango
       @block ? @block.call(self, result) : self
     end
 
+    # see {request}
     def execute
       request
     end
 
+    # get next result of query
+    # @return [Arango::AQL]
     def next
       if @has_more
         result = Arango::Requests::Cursor::NextBatch.execute(server: @server, args: { id: @id })
@@ -139,11 +201,13 @@ module Arango
       end
     end
 
+    # delete current query
     def delete
       Arango::Requests::Cursor::Delete.execute(server: @server, args: { id: @id })
       true
     end
 
+    # kill current query
     def kill
       Arango::Requests::AQL::KillQuery.execute(server: @server, args: { id: @query_id })
       true
@@ -151,6 +215,7 @@ module Arango
 
 # === PROPERTY QUERY ===
 
+    # explain current query
     def explain
       body = {
         query:    @query,
@@ -160,6 +225,7 @@ module Arango
       Arango::Requests::AQL::Explain.execute(server: @server, body: body)
     end
 
+    # parse current query
     def parse
       Arango::Requests::AQL::Parse.execute(server: @server, body: { query: @query })
     end

data/lib/arango/cursor.rb

@@ -1,4 +1,9 @@
+
 module Arango
+  #
+  # Arango Cursor
+  # - not implemented -
+  #
   class Cursor
     def has_next?
 
@@ -64,4 +69,4 @@ module Arango
 
     end
   end
-end
+end

data/lib/arango/database/analyzer.rb

@@ -1,5 +1,8 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database Analyzer
+    # - not implemented -
     module Analyzer
       def create_analyzer
         # TODO

data/lib/arango/database/aql_functions.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database AQLFunctions
     module AQLFunctions
 
       def list_aql_functions(namespace: nil)

data/lib/arango/database/aql_queries.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database AQLQueries
     module AQLQueries
       def new_aql(query:, batch_size: nil, bind_vars: nil, cache: nil, count: nil, fail_on_warning: nil, full_count: nil,
                   intermediate_commit_count: nil, intermediate_commit_size: nil, max_plans: nil, max_transaction_size: nil,

data/lib/arango/database/aql_query_cache.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database AQLQueryCache
     module AQLQueryCache
 
       def clear_query_cache

data/lib/arango/database/collections.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database Collections
     module Collections
       # Retrieves all collections from the database.
       # @param exclude_system [Boolean] Optional, default true, exclude system collections.

data/lib/arango/database/document_collections.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database DocumentCollections
     module DocumentCollections
       # Retrieves all document collections from the database.
       # @param exclude_system [Boolean] Optional, default true, exclude system collections.
@@ -13,9 +15,9 @@ module Arango
 
       # Creates a new document collection.
       # @param name [String] The name of the collection.
-      # @param type [Symbol] One of :document or :edge, the collection type, optional, default: :document.
+      # @param is_system [Boolean] set true to create a system collection, defaults to false
       # @return [Arango::DocumentCollection::Base] The instance of the collection created.
-      def create_document_collection(name:, is_system: false)
+      def create_document_collection(name:, type: :document, is_system: false)
         Arango::DocumentCollection::Base.new(name: name, database: self, is_system: is_system).create
       end
       def batch_create_document_collection(name:, is_system: false)

data/lib/arango/database/edge_collections.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database EdgeCollections
     module EdgeCollections
       # Retrieves all edge collections from the database.
       # @param exclude_system [Boolean] Optional, default true, exclude system collections.

data/lib/arango/database/foxx_services.rb

@@ -1,5 +1,8 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database FoxxServices
+    # - not implemented -
     module FoxxServices
       # === FOXX ===
       def install_service

data/lib/arango/database/graphs.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database Graphs
     module Graphs
       def all_graphs
         Arango::Graph::Base.all(database: self)

data/lib/arango/database/http_route.rb

@@ -1,9 +1,12 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database HTTPRoute
+    # - not implemented -
     module HTTPRoute
       def route
         # TODO
       end
     end
   end
-end
+end

data/lib/arango/database/replication.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database Replication
     module Replication
       # === REPLICATION ===
 
@@ -93,4 +95,4 @@ module Arango
 
     end
   end
-end
+end

data/lib/arango/database/stream_transactions.rb

@@ -1,5 +1,8 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database StreamTransactions
+    # - not implemented -
     module StreamTransactions
       def begin_stream_transaction
 

data/lib/arango/database/system_collections.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database SystemCollections
     module SystemCollections
       # Retrieves all collections from the database.
       # @param exclude_system [Boolean] Optional, default true, exclude system collections.

data/lib/arango/database/tasks.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database Tasks
     module Tasks
       # Get all tasks.
       # @return [Array<Arango::Task>]

data/lib/arango/database/transactions.rb

@@ -1,5 +1,8 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database Transactions
+    # - not implemented -
     module Transactions
       # === TRANSACTION ===
 
@@ -12,4 +15,4 @@ module Arango
       end
     end
   end
-end
+end

data/lib/arango/database/user.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database User
     module User
       def check_user(user)
         user = Arango::User.new(user: user) if user.is_a?(String)

data/lib/arango/database/view_access.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Database
   class Database
+    # Arango Database ViewAccess
     module ViewAccess
       def create_search_view
         # TODO

data/lib/arango/database.rb

@@ -1,6 +1,7 @@
-# === DATABASE ===
-
 module Arango
+  #
+  # Arango Database
+  #
   class Database
     include Arango::Helper::Satisfaction
 
@@ -34,6 +35,7 @@ module Arango
         list_user_databases(server: server).map{ |db| Arango::Database.new(name: db, server: server).reload }
       end
 
+      # Create a new instance of self
       def create()
         self.new.create
       end

data/lib/arango/document/base.rb

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

data/lib/arango/document/class_methods.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Document
   module Document
+    # Arango Document ClassMethods
     module ClassMethods
       #@!visibility private
       def self.extended(base)

data/lib/arango/document/instance_methods.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Document
   module Document
+    # Arango Document InstanceMethods
     module InstanceMethods
 
       attr_accessor :ignore_revs, :wait_for_sync

data/lib/arango/document/mixin.rb

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

data/lib/arango/document.rb

@@ -1,4 +1,7 @@
 module Arango
+  #
+  # Arango Document
+  #
   module Document
     include Arango::Document::Mixin
   end

data/lib/arango/document_collection/base.rb

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

data/lib/arango/document_collection/class_methods.rb

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

data/lib/arango/document_collection/documents.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango DocumentCollection
   module DocumentCollection
+    # Arango DocumentCollection Documents
     module Documents
       def new_document(key: nil, attributes: {}, wait_for_sync: nil)
         Arango::Document::Base.new(key: key, attributes: attributes, collection: self, wait_for_sync: wait_for_sync)

data/lib/arango/document_collection/importing.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango DocumentCollection
   module DocumentCollection
+    # Arango DocumentCollection Importing
     module Importing
       # === IMPORT ===
 

data/lib/arango/document_collection/indexes.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango DocumentCollection
   module DocumentCollection
+    # Arango DocumentCollection Indexes
     module Indexes
       # === INDEXES ===
       def create_index(type: "hash", fields:, unique: nil, sparse: nil,

data/lib/arango/document_collection/instance_methods.rb

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

data/lib/arango/document_collection/mixin.rb

@@ -1,8 +1,10 @@
 module Arango
+  # Arango DocumentCollection
   module DocumentCollection
     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 DocumentCollection Mixin
     module Mixin
       #@!visibility private
       def self.included(base)

data/lib/arango/document_collection/replication.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango DocumentCollection
   module DocumentCollection
+    # Arango DocumentCollection Replication
     module Replication
       # === REPLICATION ===
 

data/lib/arango/document_collection/user.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango DocumentCollection
   module DocumentCollection
+    # Arango DocumentCollection User
     module User
       # === USER ACCESS ===
 

data/lib/arango/driver/typhoeus.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Driver
   module Driver
+    # Arango Driver Typhoeus
     class Typhoeus
       def initialize(base_uri:, options:)
         @base_uri = base_uri

data/lib/arango/edge/base.rb

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

data/lib/arango/edge/class_methods.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Edge
   module Edge
+    # Arango Edge ClassMethods
     module ClassMethods
       #@!visibility private
       def self.extended(base)

data/lib/arango/edge/instance_methods.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Edge
   module Edge
+    # Arango Edge InstanceMethods
     module InstanceMethods
 
       def initialize(key: nil, attributes: {}, from: nil, to: nil, edge_collection:, ignore_revs: false, wait_for_sync: false)

data/lib/arango/edge/mixin.rb

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

data/lib/arango/edge_collection/base.rb

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