Code clean up

BREAKING CHANGE: fix: removed $databade argument from getDatabases()

docs: expanded user schema documentation

docs: expanded view schema documentation

BREAKING CHANGE: refactor: added HttpRequestOptions DTO to better typehinting of request options.
Requests now only support the query, headers, body and handlers options.

refactor: improved jsonEncode code.

tests: added tests some uncovered code

chore: composer update to the latest dependencies.

Author: LaravelFreelancerNL

composer.lock

@@ -16,37 +16,37 @@ Get the requested collection.
 $arangoClient->schema()->getCollection('_fishbowl');
 ```
 
-### getCollectionProperties(string $collection): array
+### getCollectionProperties(string $name): array
 Get the properties of the requested collection.
 ```
 $arangoClient->schema()->getCollectionProperties('_fishbowl');
 ```
 
-### getCollectionWithDocumentCount(string $collection): array
+### getCollectionWithDocumentCount(string $name): array
 Get the properties of the requested collection.
 ```
 $arangoClient->schema()->getCollectionWithDocumentCount('_fishbowl');
 ```
 
-### getCollectionDocumentCount(string $collection): int
+### getCollectionDocumentCount(string $name): int
 Get the number of documents within the requested collection.
 ```
 $arangoClient->schema()->getCollectionDocumentCount('users');
 ```
 
-### getCollectionStatistics(string $collection, bool $details = false): array
+### getCollectionStatistics(string $name, bool $details = false): array
 Get the properties of the requested collection.
 ```
 $arangoClient->schema()->getCollectionStatistics('_fishbowl');
 ```
 
-### hasCollection(string $collection): bool
+### hasCollection(string $name): bool
 Check if a collection exists.
 ```
 $arangoClient->schema()->hasCollection('_fishbowl');
 ```
 
-### createCollection(string $collection, array $config = [], $waitForSyncReplication = null, $enforceReplicationFactor = null): bool
+### createCollection(string $name, array $config = [], $waitForSyncReplication = null, $enforceReplicationFactor = null): bool
 Create a collection
 ```
 $arangoClient->schema()->createCollection('users');

docs/schema-collections.md

@@ -4,3 +4,74 @@ You can use the schema manager to perform CRUD actions on database users.
 ## User functions
 The schema manager supports the following index functions:
 
+### getUser(string $username): array
+Get user properties.
+```
+$arangoClient->schema()->getUser('kimiko');
+```
+
+### getUsers(): array
+Get user properties of all visible users.
+```
+$arangoClient->schema()->getUsers();
+```
+
+### hasUser(string $username): bool
+Check if a user exists.
+```
+$arangoClient->schema()->hasUser('kimiko');
+```
+
+### createUser(array $user): array
+Create a user.
+```
+$arangoClient->schema()->createUser([
+    'user' => 'kimiko',
+    'password' => 'highly secretive password'
+]);
+```
+
+### updateUser(string $username, array $properties): array
+Update a user's properties
+```
+$arangoClient->schema()->updateUser([
+    'user' => 'kimiko',
+    ['active => false]
+]);
+```
+
+### replaceUser(string $username, array $user): array
+Replace a user. Used to change the username.
+```
+$arangoClient->schema()->replaceUser([
+    'user' => 'kimiko',
+    [
+        'user' => 'newUserName',
+        'active' => true
+    ]
+]);
+```
+
+### deleteUser(string $username): bool
+Delete a user.
+```
+$arangoClient->schema()->deleteUser('newUserName');
+```
+
+### getDatabaseAccessLevel(string $username, string $database): string
+Get the access level a user has on a specific database.
+```
+$this->schemaManager->getDatabaseAccessLevel('root', '_system');
+```
+
+### setDatabaseAccessLevel(string $username, string $database, string $grant): array
+Set the access level a user has for a specific database.
+```
+$this->schemaManager->getDatabaseAccessLevel('kimiko', 'the_boys', 'rw');
+```
+
+### clearDatabaseAccessLevel(string $username, string $database): bool
+Remove the access level of a user for a specific database.
+```
+$this->schemaManager->clearDatabaseAccessLevel('kimiko', 'the_boys');
+```

docs/schema-users.md

@@ -4,3 +4,63 @@ You can use the schema manager to perform CRUD actions on indexes within a colle
 ## View functions
 The schema manager supports the following index functions:
 
+###  createView(array $view): array
+```
+$arangoClient->schema()->createView([
+        'name' => 'testViewBasics',
+        'type' => 'arangosearch'
+    ]);
+```
+
+###  getView(string $name): array
+```
+$arangoClient->schema()->getView('testViewBasics');
+```
+
+###  getViews(): array
+```
+$arangoClient->schema()->getViews();
+```
+
+###  hasView(string $name): bool
+```
+$arangoClient->schema()->hasView('testViewBasics');
+```
+
+
+###  getViewProperties(string $name): array
+```
+$arangoClient->schema()->getViewProperties('testViewBasics');
+```
+
+###  renameView(string $old, string $new): array
+```
+$arangoClient->schema()->renameView('testViewBasics', 'pages');
+```
+
+###  updateView(string $name, array $properties): array
+```
+$arangoClient->schema()->updateView('pages', [
+        'cleanupIntervalStep' => 3
+    ]);
+```
+
+###  replaceView(string $name, array $newView)
+Use replaceView if you want to update the primarySort or primarySortCompression.
+This will delete the old view and create a new one. The new view will need to be build from the data so might
+not be available right away.
+```
+$arangoClient->schema()->updateView('pages', [
+        'cleanupIntervalStep' => 3,
+        'primarySort' => [[
+            'field' => 'email',
+            'direction' => 'desc'
+        ]]
+    ]);
+```
+
+###  deleteView(string $name): bool
+```
+$arangoClient->schema()->deleteView('testViewBasics');
+```
+

docs/schema-views.md

@@ -6,6 +6,7 @@
 
 use ArangoClient\Exceptions\ArangoException;
 use ArangoClient\Http\HttpClientConfig;
+use ArangoClient\Http\HttpRequestOptions;
 use ArangoClient\Statement\Statement;
 use ArangoClient\Transactions\SupportsTransactions;
 use GuzzleHttp\Client as GuzzleClient;
@@ -72,25 +73,43 @@ public function generateEndpoint(array $config): string
      *
      * @param  string  $method
      * @param  string  $uri
-     * @param  array<mixed>  $options
+     * @param  array<mixed>|HttpRequestOptions  $options
      * @param  string|null  $database
      * @return array<mixed>
      * @throws ArangoException
      */
-    public function request(string $method, string $uri, array $options = [], ?string $database = null): array
+    public function request(string $method, string $uri, $options = [], ?string $database = null): array
     {
         $uri = $this->prependDatabaseToUri($uri, $database);
 
+        if (is_array($options)) {
+            $options = $this->prepareRequestOptions($options);
+        }
+
         $response = null;
         try {
-            $response = $this->httpClient->request($method, $uri, $options);
+            $response = $this->httpClient->request($method, $uri, $options->all());
         } catch (Throwable $e) {
             $this->handleGuzzleException($e);
         }
 
         return $this->cleanupResponse($response);
     }
 
+    /**
+     * @param array<mixed> $options
+     * @return HttpRequestOptions
+     * @throws ArangoException
+     */
+    protected function prepareRequestOptions(array $options): HttpRequestOptions
+    {
+        if (isset($options['body'])) {
+            $options['body'] = $this->jsonEncode($options['body']);
+        }
+
+        return new HttpRequestOptions($options);
+    }
+
     /**
      * Return the response with debug information (for internal testing purposes).
      *
@@ -186,24 +205,23 @@ protected function decodeResponse(?ResponseInterface $response): array
     }
 
     /**
-     * @param  array<mixed>  $data
+     * @param  mixed  $data
      * @return string
      * @throws ArangoException
      */
-    public function jsonEncode(array $data): string
+    public function jsonEncode($data): string
     {
-        $response = '';
-
-        if (! empty($data)) {
-            $response = json_encode($data);
-        }
+        $options = 0;
         if (empty($data)) {
-            $response = json_encode($data, JSON_FORCE_OBJECT);
+            $options = JSON_FORCE_OBJECT;
         }
 
+        $response = json_encode($data, $options);
+
         if ($response === false) {
             throw new ArangoException('JSON encoding failed with error: ' . json_last_error_msg(), json_last_error());
         }
+
         return $response;
     }
 

src/ArangoClient.php

@@ -4,7 +4,7 @@
 
 namespace ArangoClient\Http;
 
-use Spatie\DataTransferObject\DataTransferObject;
+use Spatie\DataTransferObject\FlexibleDataTransferObject;
 
 /**
  * Class HttpClientConfig
@@ -14,7 +14,7 @@
  *
  * @package ArangoClient\Http
  */
-class HttpClientConfig extends DataTransferObject
+class HttpClientConfig extends FlexibleDataTransferObject
 {
     /**
      * @var string