From 86567eb005863379e0601e549de6b7864c8c7cf7 Mon Sep 17 00:00:00 2001 From: Matthew Parker Date: Tue, 8 Oct 2024 18:10:07 +0100 Subject: [PATCH 1/3] implemented create user with sha password --- src/PinguApps.Appwrite.Playground/App.cs | 10 ++++------ .../Clients/IUsersClient.cs | 8 +++++++- .../Clients/UsersClient.cs | 17 +++++++++++++++-- 3 files changed, 26 insertions(+), 9 deletions(-) diff --git a/src/PinguApps.Appwrite.Playground/App.cs b/src/PinguApps.Appwrite.Playground/App.cs index 452e697e..0a6ac28e 100644 --- a/src/PinguApps.Appwrite.Playground/App.cs +++ b/src/PinguApps.Appwrite.Playground/App.cs @@ -17,16 +17,14 @@ public App(Client.IAppwriteClient client, Server.Clients.IAppwriteClient server, public async Task Run(string[] args) { - var request = new CreateUserWithScryptModifiedPasswordRequest() + var request = new CreateUserWithShaPasswordRequest() { Email = "pingu@example.com", - Password = "dbb97714c09bad417bb51288abd2c049c557e5e617839a7bc8c615492db859b57624366de72f04b9d4c3e6452a497a67a36f1afcc481d6d69f6da9e5f03598d7", - PasswordSalt = "MySuperSalt", - PasswordSaltSeparator = ";", - PasswordSignerKey = "MySuperSignerKey" + Password = "89e01536ac207279409d4de1e5253e01f4a1769e696db0d6062ca9b8f56767c8", + PasswordVersion = "sha256" }; - var response = await _server.Users.CreateUserWithScryptModifiedPassword(request); + var response = await _server.Users.CreateUserWithShaPassword(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 index 59d3a6de..f9e3f30b 100644 --- a/src/PinguApps.Appwrite.Server/Clients/IUsersClient.cs +++ b/src/PinguApps.Appwrite.Server/Clients/IUsersClient.cs @@ -92,7 +92,13 @@ public interface IUsersClient /// The request content /// The user Task> CreateUserWithScryptModifiedPassword(CreateUserWithScryptModifiedPasswordRequest request); - [Obsolete("This method hasn't yet been implemented.", true)] + + /// + /// Create a new user. Password provided must be hashed with the SHA algorithm. Use to create users with a plain text password. + /// Appwrite Docs + /// + /// The request content + /// The user Task> CreateUserWithShaPassword(CreateUserWithShaPasswordRequest request); [Obsolete("This method hasn't yet been implemented.", true)] Task DeleteUser(DeleteUserRequest request); diff --git a/src/PinguApps.Appwrite.Server/Clients/UsersClient.cs b/src/PinguApps.Appwrite.Server/Clients/UsersClient.cs index 9a9b6f7c..0f02f73b 100644 --- a/src/PinguApps.Appwrite.Server/Clients/UsersClient.cs +++ b/src/PinguApps.Appwrite.Server/Clients/UsersClient.cs @@ -196,9 +196,22 @@ public async Task> CreateUserWithScryptModifiedPassword(Cre } } - [ExcludeFromCodeCoverage] /// - public Task> CreateUserWithShaPassword(CreateUserWithShaPasswordRequest request) => throw new NotImplementedException(); + public async Task> CreateUserWithShaPassword(CreateUserWithShaPasswordRequest request) + { + try + { + request.Validate(true); + + var result = await _usersApi.CreateUserWithShaPassword(request); + + return result.GetApiResponse(); + } + catch (Exception e) + { + return e.GetExceptionResponse(); + } + } [ExcludeFromCodeCoverage] /// From 81006817c8ae0ccf0200a656eb9679e4a7cc0a0d Mon Sep 17 00:00:00 2001 From: Matthew Parker Date: Tue, 8 Oct 2024 18:19:16 +0100 Subject: [PATCH 2/3] added tests for create user with sha password --- ...rsClientTests.CreateUserWithShaPassword.cs | 80 +++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 tests/PinguApps.Appwrite.Server.Tests/Clients/Users/UsersClientTests.CreateUserWithShaPassword.cs diff --git a/tests/PinguApps.Appwrite.Server.Tests/Clients/Users/UsersClientTests.CreateUserWithShaPassword.cs b/tests/PinguApps.Appwrite.Server.Tests/Clients/Users/UsersClientTests.CreateUserWithShaPassword.cs new file mode 100644 index 00000000..added3c2 --- /dev/null +++ b/tests/PinguApps.Appwrite.Server.Tests/Clients/Users/UsersClientTests.CreateUserWithShaPassword.cs @@ -0,0 +1,80 @@ +using System.Net; +using PinguApps.Appwrite.Shared.Requests.Users; +using PinguApps.Appwrite.Shared.Tests; +using RichardSzalay.MockHttp; + +namespace PinguApps.Appwrite.Server.Tests.Clients.Users; +public partial class UsersClientTests +{ + [Fact] + public async Task CreateUserWithShaPassword_ShouldReturnSuccess_WhenApiCallSucceeds() + { + // Arrange + var request = new CreateUserWithShaPasswordRequest + { + Email = "test@example.com", + Password = "password123", + PasswordVersion = "sha256" + }; + + _mockHttp.Expect(HttpMethod.Post, $"{Constants.Endpoint}/users/sha") + .WithJsonContent(request) + .ExpectedHeaders() + .Respond(Constants.AppJson, Constants.UserResponse); + + // Act + var result = await _appwriteClient.Users.CreateUserWithShaPassword(request); + + // Assert + Assert.True(result.Success); + } + + [Fact] + public async Task CreateUserWithShaPassword_ShouldHandleException_WhenApiCallFails() + { + // Arrange + var request = new CreateUserWithShaPasswordRequest + { + Email = "test@example.com", + Password = "password123", + PasswordVersion = "sha256" + }; + + _mockHttp.Expect(HttpMethod.Post, $"{Constants.Endpoint}/users/sha") + .WithJsonContent(request) + .ExpectedHeaders() + .Respond(HttpStatusCode.BadRequest, Constants.AppJson, Constants.AppwriteError); + + // Act + var result = await _appwriteClient.Users.CreateUserWithShaPassword(request); + + // Assert + Assert.True(result.IsError); + Assert.True(result.IsAppwriteError); + } + + [Fact] + public async Task CreateUserWithShaPassword_ShouldReturnErrorResponse_WhenExceptionOccurs() + { + // Arrange + var request = new CreateUserWithShaPasswordRequest + { + Email = "test@example.com", + Password = "password123", + PasswordVersion = "sha256" + }; + + _mockHttp.Expect(HttpMethod.Post, $"{Constants.Endpoint}/users/sha") + .WithJsonContent(request) + .ExpectedHeaders() + .Throw(new HttpRequestException("An error occurred")); + + // Act + var result = await _appwriteClient.Users.CreateUserWithShaPassword(request); + + // Assert + Assert.False(result.Success); + Assert.True(result.IsInternalError); + Assert.Equal("An error occurred", result.Result.AsT2.Message); + } +} From 9bc5ce631de4abb825e6b44b2a49f37fc0f823ed Mon Sep 17 00:00:00 2001 From: Matthew Parker Date: Tue, 8 Oct 2024 18:20:01 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 93732495..e2e13767 100644 --- a/README.md +++ b/README.md @@ -140,9 +140,9 @@ string emailAddressOrErrorMessage = userResponse.Result.Match( ``` ## ⌛ Progress -![Server & Client - 65 / 291](https://img.shields.io/badge/Server_&_Client-65%20%2F%20291-red?style=for-the-badge) +![Server & Client - 66 / 291](https://img.shields.io/badge/Server_&_Client-66%20%2F%20291-red?style=for-the-badge) -![Server - 21 / 201](https://img.shields.io/badge/Server-21%20%2F%20201-red?style=for-the-badge) +![Server - 22 / 201](https://img.shields.io/badge/Server-22%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 - 10 / 41](https://img.shields.io/badge/Users-10%20%2F%2041-red?style=for-the-badge) +![Account - 11 / 41](https://img.shields.io/badge/Users-11%20%2F%2041-red?style=for-the-badge) | Endpoint | Client | Server | |:-:|:-:|:-:| @@ -221,7 +221,7 @@ string emailAddressOrErrorMessage = userResponse.Result.Match( | [Create User with PHPass Password](https://appwrite.io/docs/references/1.6.x/server-rest/users#createPHPassUser) | ❌ | ✅ | | [Create User with Scrypt Password](https://appwrite.io/docs/references/1.6.x/server-rest/users#createScryptUser) | ❌ | ✅ | | [Create User with Scrypt Modified Password](https://appwrite.io/docs/references/1.6.x/server-rest/users#createScryptModifiedUser) | ❌ | ✅ | -| [Create User with SHA Password](https://appwrite.io/docs/references/1.6.x/server-rest/users#createSHAUser) | ❌ | ⬛ | +| [Create User with SHA Password](https://appwrite.io/docs/references/1.6.x/server-rest/users#createSHAUser) | ❌ | ✅ | | [Get User](https://appwrite.io/docs/references/1.6.x/server-rest/users#get) | ❌ | ⬛ | | [Delete User](https://appwrite.io/docs/references/1.6.x/server-rest/users#delete) | ❌ | ⬛ | | [Update Email](https://appwrite.io/docs/references/1.6.x/server-rest/users#updateEmail) | ❌ | ⬛ |