arangodb-community/arangodb-net-standard

A consistent, comprehensive, minimal interface to enable .NET applications to use the complete range of features exposed by the ArangoDB REST API.

arangodb-net-standard's Issues

GetCollectionProperties test failure on ArangoDB 3.4.6

ObjectId property is null in response, test fails because it asserts NotNull.

It seems to be a new property introduced in a later version of ArangoDB. For now, let's just not call Assert.NotNull on it.

URL encode cursor ID path parameter in cursor API client

Add Database API endpoint to get database information (GET/_api/database/current)

GetCollectionCountAsync should accept string param for collection name

Our convention dicates the collectionname path parameter in GetCollectionCountAsync should be accepted as a string argument.

Add comment and check for DeleteDatabaseAsync

Add PatchDocumentsAsync PATCH/_api/document/{collection} Update documents

Add ReadAllDocumentsAsync PUT/_api/simple/all-keys

Change ErrorNum to Enum

Add PostVertexCollectionAsync POST/_api/gharial/{graph}/vertex Add vertex collection

Add get Collections Figures Async

Rename ListDatabaseResponse -> GetDatabaseResponse

Rename ListDatabasesAsync to GetDatabasesAsync in DatabaseApiClient

Follow up to this conversation: #30 (comment)

According to the naming scheme we have, it makes more sense to use Get as a prefix rather than List.

Add Get Collection Count Endpoint

Use HttpStatusCode instead of int for Code property

Add PostGraphEdgeAsync POST/_api/gharial/{graph}/edge/{collection} Create an edge

URL Encode path and query parameters

Path parameters and any string-typed query parameters should be URL encoded using https://docs.microsoft.com/en-us/dotnet/api/system.net.webutility.urlencode?view=netframework-4.8#System_Net_WebUtility_UrlEncode_System_String_

Complete Post Graphs Async

Needs tests

Add Database API client method to list databases

Implement methods in DatabaseApiClient for the following endpoints:

• GET/_api/database
• GET/_api/database/user

Add tests for Truncate Collection (PUT/_api/collection/{collection-name}/truncate)

Truncate collection is implemented for use in tests but no specific tests exist for it.

Implement PostCursorOptions

PostCursorOptions is currently not implemented

Add GetGraphAsync

Add GetCurrentDatabaseAsync

Remove camel case and null value handling parameters from the deserialization

Follow up to this discussion: #38 (comment)

Let's remove bool useCamelCasePropertyNames = false, bool ignoreNullValues = false from the DeserializeJsonFromStream method. They do not seem to do anything for deserialization.

Consider changing the naming used for data model carrying parameters

I got confused by the naming of the data models that carry parameters for the client methods. I didn't realize at first the distinction between the models for body parameters and the other for query parameters.

Example: PostCollectionRequest (JSON body parameters) and PostCollectionOptions (query parameters)

What about renaming them to make that distinction more obvious?

Example: PostCollectionBodyParams and PostCollectionQueryParams?

I find using the term Options especially confusing.

Maybe when using the client in code the distinction is more natural. I made this consideration while looking at the classes rather than actually using one of the client.

Implement properties of PostGraphResponse model

Bug remove ObjectId

Appears to be undocumented property that is not consistent across arangodb versions

Add PostGraphEdgeDefinitionAsync POST/_api/gharial/{graph}/edge

Create getCollectionRevisionAsync

Add get collection properties async

Add GetGraphEdgesAsync GET/_api/gharial/{graph}/edge

Create Read All Collections

Add delete graph async

Create PUT collection properties /_api/collection/{collection-name}/properties

Complete getGraphs

Some small things to add such as comments and suffix with Async

Rename the PostGraphQuery class used in PostGraphBody

In the namespace ArangoDBNetStandard.GraphApi, the PostGraphQuery represents the graph options inside the PostGraphBody.

It is not a model that represents query parameters. I think we should rename it to PostGraphOptions or PostGraphBodyOptions.

Implement Graph API "List all graphs"

Consider implementing a generic ToQueryString() method

So currently you have to define every property to be added to a query. Perhaps we can refactor to be more generic. This was my solution but perhaps we can find a way that does not use Reflection:

`private object GetPropertyValue(T src, string propName)
{
return src.GetType().GetProperty(propName).GetValue(src, null);
}

    private string ToCamelCaseString(string value)
    {
        return Char.ToLowerInvariant(value[0]) + value.Substring(1);
    }

    protected string ToQueryString<T>(T parameters)
    {
        List<string> query = new List<string>();
        foreach (var property in parameters.GetType().GetProperties())
        {
            var value = GetPropertyValue(parameters, property.Name);
            if (GetPropertyValue(parameters, property.Name) != null)
            {
                var queryItem = ToCamelCaseString(property.Name) + "=";
                if (value.GetType().Name == "Boolean")
                {
                    query.Add(queryItem + value.ToString().ToLower());
                }
                else
                {
                    query.Add(queryItem + value.ToString());
                }
            }
        }
        return string.Join("&", query);
    }`

Add RenameCollectionAsync

Update XUnit version from 2.4.0 to 2.4.1

Ground work for #16

Implement properties for DeleteCursorResponse model

Endpoint: DELETE /_api/cursor/{cursor-identifier}

When successful, response is:

{
    "id": "3936323",
    "error": false,
    "code": 202
}

When not found, response is:

{
    "error": true,
    "errorMessage": "cursor not found",
    "code": 404,
    "errorNum": 1600
}

Group related API models in dedicated namespace

This is a proposal to group models that belongs to the same API to a common namespace.

Right now each API has its own namespace, e.g. GraphApiClient in ArangoDBNetStandard.GraphApi. However all models are alongside the client classes which makes the namespace a bit messy.

I propose to group models in each API namespace into Models, like so: ArangoDBNetStandard.GraphApi.Models.

I remember discussing about this with @AlistairB99124 and he suggested that we could even group models across all API clients into one namespace, like ArangoDBNetStandard.Models. However, doing so may create some restriction, like prevent us from using 2 models with the same name but different properties (to use in 2 different API client).

What are your thoughts about this?

Use asynchronous test fixtures

Currently, we wait for tasks in the constructor and Dispose method of our test fixtures, e.g. CollectionApiClientTestFixture. This causes deadlocks when running tests in parallels with a fixed limited number of threads.

XUnit provides IAsyncLifetime to support for asynchronous initialization and cleanup operations. We should use that and support async all the way.

Add test for Delete Collection Async

List vertex collections (GET/_api/gharial/{graph}/vertex)

Add new endpoint method in GraphApiClient to list vertex collections.

Complete DeleteDatabaseAsync

The property _dbName in CursorApiClientTest is not used and creates warnings

The build for ArangoDBNetStandardTest has a warning:

1>------ Build started: Project: ArangoDBNetStandard, Configuration: Debug Any CPU ------
1>ArangoDBNetStandard -> C:\Users\pfare\Desktop\Centro workspace\arangodb-net-standard\arangodb-net-standard\bin\Debug\netstandard2.0\ArangoDBNetStandard.dll
2>------ Build started: Project: ArangoDBNetStandardTest, Configuration: Debug Any CPU ------
2>CursorApi\CursorApiClientTest.cs(16,33,16,40): warning CS0414: The field 'CursorApiClientTest._dbName' is assigned but its value is never used
2>ArangoDBNetStandardTest -> C:\Users\pfare\Desktop\Centro workspace\arangodb-net-standard\arangodb-net-standard.Test\bin\Debug\netcoreapp2.2\ArangoDBNetStandardTest.dll
2>Done building project "ArangoDBNetStandardTest.csproj".
========== Build: 2 succeeded, 0 failed, 0 up-to-date, 0 skipped ==========

Complete implementation of endpoint to create database (POST /_api/database)

Follow-up to this discusson: #30 (comment)

We need to finish the implementation for the POST /_api/database endpoint, including models and tests.

Create contribution guide document

Add ReadDocumentHeaderAsync HEAD/_api/document/{document-handle}

Add GetCollectionAsync