arangodb-driver 3.10.4 → 3.10.4.1

data/lib/arango/requests/user/set_database_access_level.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # User Requests
     module User
+      # API: PUT {/dbcontext}/_api/user/{user}/database/{database}
       class SetDatabaseAccessLevel < Arango::Request
         self.request_method = :put
 

data/lib/arango/requests/user/update.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # User Requests
     module User
+      # API: PATCH {/dbcontext}/_api/user/{user}
       class Update < Arango::Request
         self.request_method = :patch
 

data/lib/arango/requests/view/create_search_view.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # View Requests
     module View
+      # API: POST {/dbcontext}/_api/view#arangosearch
       class CreateSearchView < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/view/delete.rb

@@ -1,8 +1,11 @@
 module Arango
+  # Arango Requests
   module Requests
+    # View Requests
     module View
+      # API: DELETE {/dbcontext}/_api/view/{name}
       class Delete < Arango::Request
-        self.request_method = :post
+        self.request_method = :delete
 
         self.uri_template = '{/dbcontext}/_api/view/{name}'
 

data/lib/arango/requests/view/get.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # View Requests
     module View
+      # API: GET {/dbcontext}/_api/view/{name}
       class Get < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/view/get_properties.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # View Requests
     module View
+      # API: GET {/dbcontext}/_api/view/{name}/properties
       class GetProperties < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/view/list_all.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # View Requests
     module View
+      # API: GET {/dbcontext}/_api/view
       class ListAll < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/view/rename.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # View Requests
     module View
+      # API: PUT {/dbcontext}/_api/view/{name}/rename
       class Rename < Arango::Request
         self.request_method = :put
 

data/lib/arango/requests/view/set_search_view_properties.rb

@@ -1,8 +1,10 @@
 module Arango
   module Requests
+    # View Requests
     module View
+      # API: PUT {/dbcontext}/_api/view/{name}/properties#ArangoSearch
       class SetSearchViewProperties < Arango::Request
-        self.request_method = :out
+        self.request_method = :put
 
         self.uri_template = '{/dbcontext}/_api/view/{name}/properties#ArangoSearch'
 

data/lib/arango/requests/view/update_search_view_properties.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # View Requests
     module View
+      # API: PATCH {/dbcontext}/_api/view/{name}/properties#ArangoSearch
       class UpdateSearchViewProperties < Arango::Request
         self.request_method = :patch
 

data/lib/arango/requests/wal/flush.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Wal Requests
     module Wal
+      # API: PUT /_admin/wal/flush
       class Flush < Arango::Request
         self.request_method = :put
 

data/lib/arango/requests/wal/get_properties.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Wal Requests
     module Wal
+      # API: GET /_admin/wal/properties
       class GetProperties < Arango::Request
         self.request_method = :get
 
@@ -8,6 +11,7 @@ module Arango
 
         code 200, :success
         code 405, "Invalid HTTP method!"
+        code 501, "Invalid: called on cluster coordinator"
       end
     end
   end

data/lib/arango/requests/wal/set_properties.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Wal Requests
     module Wal
+      # API: PUT /_admin/wal/properties
       class SetProperties < Arango::Request
         self.request_method = :put
 

data/lib/arango/requests/wal/transactions.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Wal Requests
     module Wal
+      # API: GET /_admin/wal/transactions
       class Transactions < Arango::Request
         self.request_method = :get
 

data/lib/arango/result.rb

@@ -1,4 +1,8 @@
 module Arango
+  #
+  # Arango Result
+  # implements result representation from Arango::Request
+  #
   class Result
     def initialize(result)
       @result = result ? result : {}

data/lib/arango/search_view.rb

@@ -1,4 +1,8 @@
 module Arango
+  #
+  # Arango SearchView
+  # - not implemented -
+  #
   class SearchView
     def initialize
 
@@ -20,4 +24,4 @@ module Arango
 
     end
   end
-end
+end

data/lib/arango/server/administration.rb

@@ -1,5 +1,9 @@
 module Arango
+  #
+  # Arango Server
+  #
   class Server
+    # Arango Server Administration
     module Administration
       # Check availability of the server.
       # @return [Boolean]
@@ -268,7 +272,7 @@ module Arango
       #                          A value of 0 means that write-throttling will not be triggered.
       # return [Arango::Result]
       def wal_properties
-        result = request(get: "_admin/wal/properties")
+        result = Arango::Requests::Wal::GetProperties.execute(server: self)
         raise "WAL properties not available." if result.response_code >= 500
         result
       end

data/lib/arango/server/agency.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Server
   class Server
+    # Arango Server Agency
     module Agency
       def agency_config
         request("GET", "_api/agency/config")

data/lib/arango/server/async.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Server
   class Server
+    # Arango Server Async
     module Async
       # === ASYNC ===
 
@@ -48,4 +50,4 @@ module Arango
       end
     end
   end
-end
+end

data/lib/arango/server/databases.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Server
   class Server
+    # Arango Server Databases
     module Databases
       # Retrieves all databases.
       # @return [Array<Arango::Database>]

data/lib/arango/server/monitoring.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Server
   class Server
+    # Arango Server Monitoring
     module Monitoring
       # === MONITORING ===
 

data/lib/arango/server/opal_support.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Server
   class Server
+    # Arango Server OpalSupport
     module OpalSupport
       # From the Arango 2.8 documentation:
       #

data/lib/arango/server/tasks.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Server
   class Server
+    # Arango Server Tasks
     module Tasks
 
       # Get all tasks.

data/lib/arango/server/user.rb

@@ -1,5 +1,7 @@
 module Arango
+  # Arango Server
   class Server
+    # Arango Server User
     module User
       # Retrieves all users.
       # @return [Array<Arango::User>]

data/lib/arango/server.rb

@@ -1,6 +1,7 @@
-# === SERVER ===
-
 module Arango
+  #
+  # Arango Server
+  #
   class Server
     include Arango::Helper::Satisfaction
     include Arango::Server::Administration

data/lib/arango/task.rb

@@ -1,6 +1,7 @@
-# === TASK ===
-
 module Arango
+  #
+  # Arango Task
+  #
   class Task
     include Arango::Helper::Satisfaction
     include Arango::Helper::DatabaseAssignment

data/lib/arango/transaction.rb

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

data/lib/arango/user.rb

@@ -1,4 +1,7 @@
 module Arango
+  #
+  # Arango User
+  #
   class User
     include Arango::Helper::Satisfaction
 
@@ -11,24 +14,45 @@ module Arango
         result.map { |u| self.new(server: server, **u) }
       end
 
+      # Create new user
+      # @param name [String]
+      # @param password [String]
+      # @param extra
+      # @param server [Arango::Server], defaults to {current_server}
+      # @return [Arango::User]
       def create(name:, password: "", extra: {}, active: nil, server: Arango.current_server)
         self.new.create(server: server, password: password, extra: extra, active: active)
       end
 
+      # Get user by name
+      # @param name [String]
+      # @param server [Arango::Server], defaults to {current_server}
+      # @return [Arango::User]
       def get(name:, server: Arango.current_server)
         result = Arango::Requests::User::Get.execute(server: server, args: { user: name })
         self.new(server: server, **result)
       end
 
+      # List users
+      # # @param server [Arango::Server], defaults to {current_server}
+      # @return [Array] of user names
       def list(server: Arango.current_server)
-        result = Arango::Requests::User::List.execcute(server: server)
+        result = Arango::Requests::User::List.execute(server: server)
         result.map { |u| u.name }
       end
 
+      # Delete user by name
+      # @param name [String]
+      # @param server [Arango::Server], defaults to {current_server}
+      # @return [Arango::Result]
       def drop(name:, server: Arango.current_server)
-        Arango::Requests::User::Delete.exceute(server: server, args: { user: name })
+        Arango::Requests::User::Delete.execute(server: server, args: { user: name })
       end
 
+      # Check if user exists
+      # @param name [String]
+      # @param server [Arango::Server], defaults to {current_server}
+      # @return [Boolean]
       def exists?(name:, server: Arango.current_server)
         !!Arango::Requests::User::Get.execute(server: server, args: { user: name })
       rescue
@@ -36,41 +60,20 @@ module Arango
       end
     end
 
-    def initialize(server:, password: "", name:, extra: {}, active: nil)
-      @server = server
-      @password = password
-      @name     = name
-      @extra    = extra
-      @active   = active
-    end
-
     attr_accessor :name, :extra, :active
     attr_writer :password
     attr_reader :server
 
-    def create
-      body = {
-        user: name,
-        passwd: password,
-        extra: extra,
-        active: active
-      }
-      Arango::Requests::User::Create.new(server: server, body: body).execute
-      self
-    end
-
-    def reload
-      result = @server.request("GET", "_api/user/#{@name}", body: body)
-      return_element(result)
-    end
-
+    #
+    # Replace user record
+    #
     def replace(password: @password, active: @active, extra: @extra)
       body = {
         passwd: password,
         active: active,
         extra: extra
       }
-      result = @server.request("PUT", "_api/user/#{@name}", body: body)
+      result = Arango::Requests::User::Replace.execute(body: body)
       @password = password
       return_element(result)
     end
@@ -81,31 +84,55 @@ module Arango
         active: active,
         extra: extra
       }
-      result = @server.request("PATCH", "_api/user/#{@name}", body: body)
+      result = Arango::Requests::User::Update.execute(body: body)
       @password = password
       return_element(result)
     end
 
-    def destroy
-      result = @server.request("DELETE", "_api/user/#{@name}")
-      return return_directly?(result) ? result : true
+    # Create new user
+    def initialize(server:, password: "", name:, extra: {}, active: nil)
+      @server = server
+      @password = password
+      @name     = name
+      @extra    = extra
+      @active   = active
     end
 
-  # == ACCESS ==
+    def create
+      body = {
+        user: name,
+        passwd: password,
+        extra: extra,
+        active: active
+      }
+      Arango::Requests::User::Create.new(server: server, body: body).execute
+      self
+    end
 
+    # Grant access to database
+    # @param grant [String] one of `rw`, `ro`, `none`
+    # @param database [String] or [Arango::Database]
+    # @return
     def add_database_access(grant:, database:)
       satisfy_category?(grant, %w[rw ro none])
       satisfy_class_or_string?(database, Arango::Database)
       database = database.name if database.is_a?(Arango::Database)
       body = { grant: grant }
-      result = @server.request("PUT", "_api/user/#{@name}/database/#{database}", body: body)
+      result = Arango::Requests::User::SetDatabaseAccessLevel.execute(user: self.name, database: database, body: body)
       return return_directly?(result) ? result : result[database.to_sym]
     end
 
+    # Grant read-write access to database
+    # @param database [String] or [Arango::Database]
     def grant(database:)
       add_database_access(grant: "rw", database: database)
     end
 
+    # Grant access to database collection
+    # @param grant [String] one of `rw`, `ro`, `none`
+    # @param database [String] or [Arango::Database]
+    # @param database [String] or [Arango::DocumentCollection]
+    # @return
     def add_collection_access(grant:, database:, collection:)
       satisfy_category?(grant, %w[rw ro none])
       satisfy_class_or_string?(database, Arango::Database)
@@ -113,47 +140,59 @@ module Arango
       database = database.name     if database.is_a?(Arango::Database)
       collection = collection.name if collection.is_a?(Arango::DocumentCollection)
       body = { grant: grant }
-      result = @server.request("PUT", "_api/user/#{@name}/database/#{database}/#{collection}", body: body)
+      result = Arango::Requests::User::SetCollectionAccessLevel.execute(user: self.name, database: database, collection: collection, body: body)
       return return_directly?(result) ? result : result[:"#{database}/#{collection}"]
     end
 
+    # Revoke user access to database
+    # @param database [String] or [Arango::Database]
     def revoke_database_access(database:)
       satisfy_class_or_string?(database, Arango::Database)
       database = database.name if database.is_a?(Arango::Database)
-      result = @server.request("DELETE", "_api/user/#{@name}/database/#{database}")
+      result = Arango::Requests::User::ClearDatabaseAccessLevel.execute(user: self.name, database: database)
       return return_directly?(result) ? result : true
     end
     alias revoke revoke_database_access
 
+    # Revoke user access to database collection
+    # @param database [String] or [Arango::Database]
+    # @param database [String] or [Arango::DocumentCollection]
     def revoke_collection_access(database:, collection:)
       satisfy_class_or_string?(database, Arango::Database)
       satisfy_module_or_string?(collection, Arango::DocumentCollection)
       database = database.name     if database.is_a?(Arango::Database)
       collection = collection.name if collection.is_a?(Arango::DocumentCollection)
-      result = @server.request("DELETE", "_api/user/#{@name}/database/#{database}/#{collection}")
+      result = Arango::Requests::User::ClearCollectionAccessLevel.execute(user: self.name, database: database, collection: collection)
       return return_directly?(result) ? result : true
     end
 
+    # List databases a user has access to
+    # @param: full
     def list_access(full: nil)
       query = { full: full }
-      result = @server.request("GET", "_api/user/#{@name}/database", query: query)
+      result = Arango::Requests::User::ListDatabases.execute(body: query)
       return return_directly?(result) ? result : result[:result]
     end
     alias databases list_access
 
+    # Get user access level for database
+    # @param database [String] or [Arango::Database]
     def database_access(database:)
       satisfy_class_or_string?(database, Arango::Database)
       database = database.name if database.is_a?(Arango::Database)
-      result = @server.request("GET", "_api/user/#{@name}/database/#{database}")
+      result = Arango::Requests::User::GetDatabaseAccessLevel.execute(name: self.name, database: database)
       return return_directly?(result) ? result : result[:result]
     end
 
+    # Get user access level for database collection
+    # @param database [String] or [Arango::Database]
+    # @param database [String] or [Arango::DocumentCollection]
     def collection_access(database:, collection:)
       satisfy_class_or_string?(database, Arango::Database)
       satisfy_module_or_string?(collection, Arango::DocumentCollection::Mixin)
       database = database.name     if database.is_a?(Arango::Database)
       collection = collection.name if collection.is_a?(Arango::DocumentCollection)
-      result = @server.request("GET", "_api/user/#{@name}/database/#{database}/#{collection}", body: body)
+      result = Arango::Requests::User::GetCollectionAccessLevel.execute(name: self.name, database: database, collection: collection)
       return return_directly?(result) ? result : result[:result]
     end
   end

data/lib/arango/version.rb

@@ -1,3 +1,4 @@
 module Arango
-  VERSION = '3.10.4'
+  # version of arangodb-driver
+  VERSION = '3.10.4.1'
 end

data/lib/arango/view/basics.rb

@@ -1,5 +1,11 @@
 module Arango
+  #
+  # Arango View
+  #
   module View
+    #
+    # Arango View Basics
+    #
     module Basics
       def exists?
 

data/lib/arango/view.rb

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

data/lib/arango.rb

@@ -1,31 +1,64 @@
+#
+# Arango toplevel module
+#
+
 module Arango
   class << self
+    # get current backend driver
+    # @return [Arango::Driver]
     def driver
       @driver_class
     end
 
+    # set backend driver
+    # @param dc [Arango::Driver]
     def driver=(dc)
       @driver_class = dc
     end
 
+    # get current server
+    # @return [Arango::Server]
     def current_server
       @current_server
     end
 
+    # get current server's database
+    # @return [Arango::Database]
     def current_database
       @current_server.current_database
     end
 
+    # set current server
+    # @param s [Arango::Server]
     def current_server=(s)
       @current_server = s
     end
 
+    # connect to database of current server
+    # sets current_database
+    # @param username [String] defaults to 'root'
+    # @param password [String]
+    # @param host [String] defaults to 'localhost'
+    # @param port [String] defaults to '8529'
+    # @param tls [Boolean] 'true' for a secure (https) connection, default to false
+    # @param database [String] name of database to connect to
+    # @param driver_options [Hash] driver specific options, defaults to nil
+    # @return [Arango::Database]
     def connect_to_database(username: "root", password:, host: "localhost", port: "8529", tls: false, database:, driver_options: nil)
       server = connect_to_server(username: username, password: password, host: host, port: port, tls: false, driver_options: driver_options)
       database = server.get_database(database)
       server.current_database = database
     end
 
+    # connect to server
+    # sets current_server (if not set !)
+    # @param username [String] defaults to 'root'
+    # @param password [String]
+    # @param host [String] defaults to 'localhost'
+    # @param port [String] defaults to '8529'
+    # @param tls [Boolean] 'true' for a secure (https) connection, default to false
+    # @param driver_options [Hash] driver specific options, defaults to nil
+    # @return [Arango::Server]
     def connect_to_server(username: "root", password:, host: "localhost", port: "8529", tls: false, driver_options: nil)
       server = Arango::Server.new(username: username, password: password, host: host, port: port, tls: tls, driver_options: driver_options)
       @current_server = server unless @current_server
@@ -33,6 +66,9 @@ module Arango
     end
   end
 
+  # define batch_ variant
+  # @param target_class [Class]
+  # @param method_name [String]
   def self.request_class_method(target_class, method_name, &block)
     promise_method_name = "batch_#{method_name}".to_sym
     target_class.define_singleton_method(method_name) do |*args|
@@ -59,6 +95,9 @@ module Arango
     end
   end
 
+  # define batch_ variant
+  # @param target_class [Class]
+  # @param method_name [String]
   def self.multi_request_class_method(target_class, method_name, &block)
     promise_method_name = "batch_#{method_name}".to_sym
     target_class.define_singleton_method(method_name) do |*args|
@@ -89,6 +128,9 @@ module Arango
     end
   end
 
+  # define batch_ variant
+  # @param target_class [Class]
+  # @param method_name [String]
   def self.aql_request_class_method(target_class, method_name, &block)
     promise_method_name = "batch_#{method_name}".to_sym
     target_class.define_singleton_method(method_name) do |*args|