QuinnBast commented 4 years ago

Description

Additional Flexibility

Updated the Api class to include more detailed information about network requests. THe Api now wraps all responses in a NetworkResponse<T> class. The templated class, T, is the class representation of the JSON object that is returned from the response. When the network response is returned, if a failure occurs, the NetworkResponse object now stores the original HttpResponseMessage as well as the raw string content of the request and the status code. This makes it easier for the frontend to be able to handle various failure cases. If the response is a success, the NetworkResponse class will attempt to cast the JSON string in the response into the templated type, T. If unsuccessfully able to cast to the templated type, a null object is set in the NetworkResponse.Response object.

This change also changes the API's URL to be a static member. This means that you no longer have to call Api api = new Api(serverUrl), you can simply set the URL once and it will remember the URL. This resolves #9

New Endpoints

Multiple new endpoints were also added to the Api class which reflect the backend API's endpoints. These endpoints include the ability to block other players, create group chats, as well as send and receive messages from a group. This resolves #8

Type of change

CLI

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] This change requires a documentation update
[ ] New dependencies/packages

Core

[ ] Bug fix (non-breaking change which fixes an issue)
[X] New feature (non-breaking change which adds functionality)
[X] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[X] This change requires a documentation update
[ ] New dependencies/packages

Testing

[ ] I have created automated tests for any new features
[ ] All automated tests pass
[X] I have performed manual tests

Checklist:

[X] I have performed a self-review of my own code
[X] I have commented my code according to C# standards
[X] I have made corresponding changes to the README (if required)
[X] I have added/updated articles in the documentation
[X] My changes generate no new warnings

This module contains breaking changes to Unity users. However, the respective changes to the Unity dll have been made on an appropraite branch and should be merged in to master when this PR is accepted.

QuinnBast commented 4 years ago

Updated API module to work with the latest backend updates.