Merge pull request #268 from PinguApps/208-get-user-preferences

Implemented get user preferences
PinguApps · Oct 10, 2024 · 4a4d556 · 4a4d556
2 parents 8f5c12f + bebf058
commit 4a4d556
Show file tree

Hide file tree

Showing 5 changed files with 101 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -140,9 +140,9 @@ string emailAddressOrErrorMessage = userResponse.Result.Match(
 ```
 
 ## ⌛ Progress
-![Server & Client - 82 / 291](https://img.shields.io/badge/Server_&_Client-82%20%2F%20291-red?style=for-the-badge)
+![Server & Client - 83 / 291](https://img.shields.io/badge/Server_&_Client-32%20%2F%20291-red?style=for-the-badge)
 
-![Server - 38 / 201](https://img.shields.io/badge/Server-38%20%2F%20201-red?style=for-the-badge)
+![Server - 39 / 201](https://img.shields.io/badge/Server-39%20%2F%20201-red?style=for-the-badge)
 
 ![Client - 44 / 90](https://img.shields.io/badge/Client-44%20%2F%2090-gold?style=for-the-badge)
 
@@ -207,7 +207,7 @@ string emailAddressOrErrorMessage = userResponse.Result.Match(
 | [Create Phone Verification (Confirmation)](https://appwrite.io/docs/references/1.6.x/client-rest/account#updatePhoneVerification) | ✅ | ❌ |  |
 
 ### Users
-![Account - 27 / 41](https://img.shields.io/badge/Users-27%20%2F%2041-gold?style=for-the-badge)
+![Account - 28 / 41](https://img.shields.io/badge/Users-28%20%2F%2041-gold?style=for-the-badge)
 
 | Endpoint | Client | Server |
 |:-:|:-:|:-:|
@@ -238,7 +238,7 @@ string emailAddressOrErrorMessage = userResponse.Result.Match(
 | [Update Name](https://appwrite.io/docs/references/1.6.x/server-rest/users#updateName) | ❌ | ✅ |
 | [Update Password](https://appwrite.io/docs/references/1.6.x/server-rest/users#updatePassword) | ❌ | ✅ |
 | [Update Phone](https://appwrite.io/docs/references/1.6.x/server-rest/users#updatePhone) | ❌ | ✅ |
-| [Get User Preferences](https://appwrite.io/docs/references/1.6.x/server-rest/users#getPrefs) | ❌ | ⬛ |
+| [Get User Preferences](https://appwrite.io/docs/references/1.6.x/server-rest/users#getPrefs) | ❌ | ✅ |
 | [Update User Preferences](https://appwrite.io/docs/references/1.6.x/server-rest/users#updatePrefs) | ❌ | ⬛ |
 | [List User Sessions](https://appwrite.io/docs/references/1.6.x/server-rest/users#listSessions) | ❌ | ⬛ |
 | [Create Session](https://appwrite.io/docs/references/1.6.x/server-rest/users#createSession) | ❌ | ⬛ |

diff --git a/src/PinguApps.Appwrite.Playground/App.cs b/src/PinguApps.Appwrite.Playground/App.cs
@@ -17,13 +17,12 @@ public App(Client.IAppwriteClient client, Server.Clients.IAppwriteClient server,
 
     public async Task Run(string[] args)
     {
-        var request = new UpdatePhoneRequest()
+        var request = new GetUserPreferencesRequest()
         {
-            UserId = "664aac1a00113f82e620",
-            PhoneNumber = "+447501234567"
+            UserId = "664aac1a00113f82e620"
         };
 
-        var response = await _server.Users.UpdatePhone(request);
+        var response = await _server.Users.GetUserPreferences(request);
 
         Console.WriteLine(response.Result.Match(
             result => result.ToString(),

diff --git a/src/PinguApps.Appwrite.Server/Clients/IUsersClient.cs b/src/PinguApps.Appwrite.Server/Clients/IUsersClient.cs
@@ -229,7 +229,13 @@ public interface IUsersClient
     /// <param name="request">The request content</param>
     /// <returns>The user</returns>
     Task<AppwriteResult<User>> UpdatePhone(UpdatePhoneRequest request);
-    [Obsolete("This method hasn't yet been implemented.", true)]
+
+    /// <summary>
+    /// Get the user preferences by its unique ID
+    /// <para><see href="https://appwrite.io/docs/references/1.6.x/server-rest/users#getPrefs">Appwrite Docs</see></para>
+    /// </summary>
+    /// <param name="request">The request content</param>
+    /// <returns>The user preferences</returns>
     Task<AppwriteResult<IReadOnlyDictionary<string, string>>> GetUserPreferences(GetUserPreferencesRequest request);
     [Obsolete("This method hasn't yet been implemented.", true)]
     Task<AppwriteResult<IReadOnlyDictionary<string, string>>> UpdateUserPreferences(UpdateUserPreferencesRequest request);

diff --git a/src/PinguApps.Appwrite.Server/Clients/UsersClient.cs b/src/PinguApps.Appwrite.Server/Clients/UsersClient.cs
@@ -480,9 +480,22 @@ public async Task<AppwriteResult<User>> UpdatePhone(UpdatePhoneRequest request)
         }
     }
 
-    [ExcludeFromCodeCoverage]
     /// <inheritdoc/>
-    public Task<AppwriteResult<IReadOnlyDictionary<string, string>>> GetUserPreferences(GetUserPreferencesRequest request) => throw new NotImplementedException();
+    public async Task<AppwriteResult<IReadOnlyDictionary<string, string>>> GetUserPreferences(GetUserPreferencesRequest request)
+    {
+        try
+        {
+            request.Validate(true);
+
+            var result = await _usersApi.GetUserPreferences(request.UserId);
+
+            return result.GetApiResponse();
+        }
+        catch (Exception e)
+        {
+            return e.GetExceptionResponse<IReadOnlyDictionary<string, string>>();
+        }
+    }
 
     [ExcludeFromCodeCoverage]
     /// <inheritdoc/>

diff --git a/tests/PinguApps.Appwrite.Server.Tests/Clients/Users/UsersClientTests.GetUserPreferences.cs b/tests/PinguApps.Appwrite.Server.Tests/Clients/Users/UsersClientTests.GetUserPreferences.cs
@@ -0,0 +1,72 @@
+using System.Net;
+using PinguApps.Appwrite.Shared.Requests.Users;
+using PinguApps.Appwrite.Shared.Tests;
+using PinguApps.Appwrite.Shared.Utils;
+using RichardSzalay.MockHttp;
+
+namespace PinguApps.Appwrite.Server.Tests.Clients.Users;
+public partial class UsersClientTests
+{
+    [Fact]
+    public async Task GetUserPreferences_ShouldReturnSuccess_WhenApiCallSucceeds()
+    {
+        // Arrange
+        var request = new GetUserPreferencesRequest
+        {
+            UserId = IdUtils.GenerateUniqueId()
+        };
+
+        _mockHttp.Expect(HttpMethod.Get, $"{Constants.Endpoint}/users/{request.UserId}/prefs")
+            .ExpectedHeaders()
+            .Respond(Constants.AppJson, Constants.PreferencesResponse);
+
+        // Act
+        var result = await _appwriteClient.Users.GetUserPreferences(request);
+
+        // Assert
+        Assert.True(result.Success);
+    }
+
+    [Fact]
+    public async Task GetUserPreferences_ShouldHandleException_WhenApiCallFails()
+    {
+        // Arrange
+        var request = new GetUserPreferencesRequest
+        {
+            UserId = IdUtils.GenerateUniqueId()
+        };
+
+        _mockHttp.Expect(HttpMethod.Get, $"{Constants.Endpoint}/users/{request.UserId}/prefs")
+            .ExpectedHeaders()
+            .Respond(HttpStatusCode.BadRequest, Constants.AppJson, Constants.AppwriteError);
+
+        // Act
+        var result = await _appwriteClient.Users.GetUserPreferences(request);
+
+        // Assert
+        Assert.True(result.IsError);
+        Assert.True(result.IsAppwriteError);
+    }
+
+    [Fact]
+    public async Task GetUserPreferences_ShouldReturnErrorResponse_WhenExceptionOccurs()
+    {
+        // Arrange
+        var request = new GetUserPreferencesRequest
+        {
+            UserId = IdUtils.GenerateUniqueId()
+        };
+
+        _mockHttp.Expect(HttpMethod.Get, $"{Constants.Endpoint}/users/{request.UserId}/prefs")
+            .ExpectedHeaders()
+            .Throw(new HttpRequestException("An error occurred"));
+
+        // Act
+        var result = await _appwriteClient.Users.GetUserPreferences(request);
+
+        // Assert
+        Assert.False(result.Success);
+        Assert.True(result.IsInternalError);
+        Assert.Equal("An error occurred", result.Result.AsT2.Message);
+    }
+}