Merge pull request #123 from PinguApps/90-feat-account-create-2fa-cha…

…llenge

Implemented create 2fa challenge

README.md

@@ -138,14 +138,14 @@ string emailAddressOrErrorMessage = userResponse.Result.Match(
 ```
 
 ## ⌛ Progress
-<!-- ![22 / 288](https://progress-bar.dev/22/?scale=288&suffix=%20/%20288&width=500) -->
-![Server & Client - 22 / 288](https://img.shields.io/badge/Server_&_Client-22%20%2F%20288-red?style=for-the-badge)
+<!-- ![23 / 288](https://progress-bar.dev/23/?scale=288&suffix=%20/%20288&width=500) -->
+![Server & Client - 23 / 288](https://img.shields.io/badge/Server_&_Client-23%20%2F%20288-red?style=for-the-badge)
 
 <!-- ![2 / 195](https://progress-bar.dev/2/?scale=195&suffix=%20/%20195&width=300) -->
 ![Server - 2 / 195](https://img.shields.io/badge/Server-2%20%2F%20195-red?style=for-the-badge)
 
-<!-- ![20 / 93](https://progress-bar.dev/20/?scale=93&suffix=%20/%2093&width=300) -->
-![Client - 20 / 93](https://img.shields.io/badge/Client-20%20%2F%2093-red?style=for-the-badge)
+<!-- ![21 / 93](https://progress-bar.dev/21/?scale=93&suffix=%20/%2093&width=300) -->
+![Client - 21 / 93](https://img.shields.io/badge/Client-21%20%2F%2093-red?style=for-the-badge)
 
 ### 🔑 Key
 | Icon | Definition |
@@ -155,8 +155,8 @@ string emailAddressOrErrorMessage = userResponse.Result.Match(
 | ❌ | There is currently no intention to implement the endpoint for the given SDK type (client or server) |
 
 ### Account
-<!-- ![22 / 52](https://progress-bar.dev/22/?scale=52&suffix=%20/%2052&width=120) -->
-![Account - 22 / 52](https://img.shields.io/badge/Account-22%20%2F%2052-yellow?style=for-the-badge)
+<!-- ![23 / 52](https://progress-bar.dev/23/?scale=52&suffix=%20/%2052&width=120) -->
+![Account - 23 / 52](https://img.shields.io/badge/Account-23%20%2F%2052-yellow?style=for-the-badge)
 
 | Endpoint | Client | Server |
 |:-:|:-:|:-:|
@@ -171,7 +171,7 @@ string emailAddressOrErrorMessage = userResponse.Result.Match(
 | [Add Authenticator](https://appwrite.io/docs/references/1.5.x/client-rest/account#createMfaAuthenticator) | ✅ | ❌ |
 | [Verify Authenticator](https://appwrite.io/docs/references/1.5.x/client-rest/account#updateMfaAuthenticator) | ✅ | ❌ |
 | [Delete Authenticator](https://appwrite.io/docs/references/1.5.x/client-rest/account#deleteMfaAuthenticator) | ✅ | ❌ |
-| [Create 2FA Challenge](https://appwrite.io/docs/references/1.5.x/client-rest/account#createMfaChallenge) | ⬛ | ❌ |
+| [Create 2FA Challenge](https://appwrite.io/docs/references/1.5.x/client-rest/account#createMfaChallenge) | ✅ | ❌ |
 | [Create MFA Challenge (confirmation)](https://appwrite.io/docs/references/1.5.x/client-rest/account#updateMfaChallenge) | ⬛ | ❌ |
 | [List Factors](https://appwrite.io/docs/references/1.5.x/client-rest/account#listMfaFactors) | ⬛ | ❌ |
 | [Get MFA Recovery Codes](https://appwrite.io/docs/references/1.5.x/client-rest/account#getMfaRecoveryCodes) | ⬛ | ❌ |

src/PinguApps.Appwrite.Client/Clients/AccountClient.cs

@@ -365,4 +365,21 @@ public async Task<AppwriteResult> DeleteAuthenticator(DeleteAuthenticatorRequest
             return e.GetExceptionResponse();
         }
     }
+
+    /// <inheritdoc/>
+    public async Task<AppwriteResult<MfaChallenge>> Create2faChallenge(Create2faChallengeRequest request)
+    {
+        try
+        {
+            request.Validate(true);
+
+            var result = await _accountApi.Create2faChallenge(Session, request);
+
+            return result.GetApiResponse();
+        }
+        catch (Exception e)
+        {
+            return e.GetExceptionResponse<MfaChallenge>();
+        }
+    }
 }

src/PinguApps.Appwrite.Client/Clients/IAccountClient.cs

@@ -174,4 +174,12 @@ public interface IAccountClient
     /// <param name="request">The request content</param>
     /// <returns>The result</returns>
     Task<AppwriteResult> DeleteAuthenticator(DeleteAuthenticatorRequest request);
+
+    /// <summary>
+    /// Begin the process of MFA verification after sign-in. Finish the flow with updateMfaChallenge method
+    /// <para><see href="https://appwrite.io/docs/references/1.5.x/client-rest/account#createMfaChallenge">Appwrite Docs</see></para>
+    /// </summary>
+    /// <param name="request">The request content</param>
+    /// <returns>The Mfa Challenge</returns>
+    Task<AppwriteResult<MfaChallenge>> Create2faChallenge(Create2faChallengeRequest request);
 }

src/PinguApps.Appwrite.Client/Internals/IAccountApi.cs

@@ -68,4 +68,7 @@ internal interface IAccountApi : IBaseApi
 
     [Delete("/account/mfa/authenticators/{type}")]
     Task<IApiResponse> DeleteAuthenticator([Header("x-appwrite-session")] string? session, string type, [Body] DeleteAuthenticatorRequest request);
+
+    [Post("/account/mfa/challenge")]
+    Task<IApiResponse<MfaChallenge>> Create2faChallenge([Header("x-appwrite-session")] string? session, Create2faChallengeRequest request);
 }

src/PinguApps.Appwrite.Playground/App.cs

@@ -21,10 +21,9 @@ public async Task Run(string[] args)
         _client.SetSession(_session);
 
         //var response = await _client.Account.AddAuthenticator();
-        var response = await _client.Account.DeleteAuthenticator(new Shared.Requests.DeleteAuthenticatorRequest
+        var response = await _client.Account.Create2faChallenge(new Shared.Requests.Create2faChallengeRequest
         {
-            Type = "totp",
-            Otp = "413526"
+            Factor = Shared.Enums.SecondFactor.Email
         });
 
         Console.WriteLine(response.Result.Match(

src/PinguApps.Appwrite.Shared/Enums/SecondFactor.cs

@@ -0,0 +1,30 @@
+using System.Runtime.Serialization;
+
+namespace PinguApps.Appwrite.Shared.Enums;
+
+/// <summary>
+/// The type of second factor
+/// </summary>
+public enum SecondFactor
+{
+    /// <summary>
+    /// Email 2fa
+    /// </summary>
+    [EnumMember(Value = "email")]
+    Email,
+    /// <summary>
+    /// Phone 2fa
+    /// </summary>
+    [EnumMember(Value = "phone")]
+    Phone,
+    /// <summary>
+    /// Authenticator App 2fa
+    /// </summary>
+    [EnumMember(Value = "totp")]
+    Totp,
+    /// <summary>
+    /// 2fa Recovery Code
+    /// </summary>
+    [EnumMember(Value = "recoveryCode")]
+    RecoveryCode
+}

src/PinguApps.Appwrite.Shared/Requests/Create2faChallengeRequest.cs

@@ -0,0 +1,18 @@
+using System.Text.Json.Serialization;
+using PinguApps.Appwrite.Shared.Enums;
+using PinguApps.Appwrite.Shared.Requests.Validators;
+
+namespace PinguApps.Appwrite.Shared.Requests;
+public class Create2faChallengeRequest : BaseRequest<Create2faChallengeRequest, Create2faChallengeRequestValidator>
+{
+    /// <summary>
+    /// Factor used for verification. Must be one of following: <list type="bullet">
+    /// <item><description>email</description></item>
+    /// <item><description>phone</description></item>
+    /// <item><description>totp</description></item>
+    /// <item><description>recoveryCode</description></item>
+    /// </list>
+    /// </summary>
+    [JsonPropertyName("factor")]
+    public SecondFactor Factor { get; set; }
+}

src/PinguApps.Appwrite.Shared/Requests/Validators/Create2faChallengeRequestValidator.cs

@@ -0,0 +1,10 @@
+using FluentValidation;
+
+namespace PinguApps.Appwrite.Shared.Requests.Validators;
+public class Create2faChallengeRequestValidator : AbstractValidator<Create2faChallengeRequest>
+{
+    public Create2faChallengeRequestValidator()
+    {
+        RuleFor(x => x.Factor).IsInEnum();
+    }
+}

src/PinguApps.Appwrite.Shared/Responses/MfaChallenge.cs

@@ -0,0 +1,18 @@
+using System;
+using System.Text.Json.Serialization;
+
+namespace PinguApps.Appwrite.Shared.Responses;
+
+/// <summary>
+/// An Appwrite Mfa Challenge object
+/// </summary>
+/// <param name="Id">Token ID</param>
+/// <param name="CreatedAt">Token creation date in ISO 8601 format</param>
+/// <param name="UserId">User ID</param>
+/// <param name="Expire">Token expiration date in ISO 8601 format</param>
+public record MfaChallenge(
+    [property: JsonPropertyName("$id")] string Id,
+    [property: JsonPropertyName("$createdAt")] DateTime CreatedAt,
+    [property: JsonPropertyName("userId")] string UserId,
+    [property: JsonPropertyName("expire")] DateTime Expire
+);

tests/PinguApps.Appwrite.Client.Tests/Clients/Account/AccountClientTests.Create2faChallenge.cs

@@ -0,0 +1,82 @@
+using System.Net;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using PinguApps.Appwrite.Shared.Requests;
+using PinguApps.Appwrite.Shared.Tests;
+using RichardSzalay.MockHttp;
+
+namespace PinguApps.Appwrite.Client.Tests.Clients.Account;
+public partial class AccountClientTests
+{
+    [Fact]
+    public async Task Create2faChallenge_ShouldReturnSuccess_WhenApiCallSucceeds()
+    {
+        // Arrange
+        var request = new Create2faChallengeRequest();
+
+        var options = new JsonSerializerOptions();
+        options.Converters.Add(new JsonStringEnumConverter(JsonNamingPolicy.CamelCase, false));
+
+        _mockHttp.Expect(HttpMethod.Post, $"{Constants.Endpoint}/account/mfa/challenge")
+            .ExpectedHeaders(true)
+            .WithJsonContent(request, options)
+            .Respond(Constants.AppJson, Constants.MfaTypeResponse);
+
+        _appwriteClient.SetSession(Constants.Session);
+
+        // Act
+        var result = await _appwriteClient.Account.Create2faChallenge(request);
+
+        // Assert
+        Assert.True(result.Success);
+    }
+
+    [Fact]
+    public async Task Create2faChallenge_ShouldHandleException_WhenApiCallFails()
+    {
+        // Arrange
+        var request = new Create2faChallengeRequest();
+
+        var options = new JsonSerializerOptions();
+        options.Converters.Add(new JsonStringEnumConverter(JsonNamingPolicy.CamelCase, false));
+
+        _mockHttp.Expect(HttpMethod.Post, $"{Constants.Endpoint}/account/mfa/challenge")
+            .ExpectedHeaders(true)
+            .WithJsonContent(request, options)
+            .Respond(HttpStatusCode.BadRequest, Constants.AppJson, Constants.AppwriteError);
+
+        _appwriteClient.SetSession(Constants.Session);
+
+        // Act
+        var result = await _appwriteClient.Account.Create2faChallenge(request);
+
+        // Assert
+        Assert.True(result.IsError);
+        Assert.True(result.IsAppwriteError);
+    }
+
+    [Fact]
+    public async Task Create2faChallenge_ShouldReturnErrorResponse_WhenExceptionOccurs()
+    {
+        // Arrange
+        var request = new Create2faChallengeRequest();
+
+        var options = new JsonSerializerOptions();
+        options.Converters.Add(new JsonStringEnumConverter(JsonNamingPolicy.CamelCase, false));
+
+        _mockHttp.Expect(HttpMethod.Post, $"{Constants.Endpoint}/account/mfa/challenge")
+            .ExpectedHeaders(true)
+            .WithJsonContent(request, options)
+            .Throw(new HttpRequestException("An error occurred"));
+
+        _appwriteClient.SetSession(Constants.Session);
+
+        // Act
+        var result = await _appwriteClient.Account.Create2faChallenge(request);
+
+        // Assert
+        Assert.False(result.Success);
+        Assert.True(result.IsInternalError);
+        Assert.Equal("An error occurred", result.Result.AsT2.Message);
+    }
+}

tests/PinguApps.Appwrite.Shared.Tests/Constants.cs

@@ -170,4 +170,13 @@ public static class Constants
             "uri": "otpauth://totp/Appwrite%20Test%3Apingu%40appwrite.com?issuer=Appwrite%20Test&secret=The_Secret"
         }
         """;
+
+    public const string MfaChallengeResponse = """
+        {
+            "$id": "bb8ea5c16897e",
+            "$createdAt": "2020-10-15T06:38:00.000+00:00",
+            "userId": "5e5ea5c168bb8",
+            "expire": "2020-10-15T06:38:00.000+00:00"
+        }
+        """;
 }

tests/PinguApps.Appwrite.Shared.Tests/Requests/Create2faChallengeRequestTests.cs

@@ -0,0 +1,98 @@
+using FluentValidation;
+using PinguApps.Appwrite.Shared.Enums;
+using PinguApps.Appwrite.Shared.Requests;
+
+namespace PinguApps.Appwrite.Shared.Tests.Requests;
+public class Create2faChallengeRequestTests
+{
+    [Fact]
+    public void Constructor_InitializesWithExpectedValues()
+    {
+        // Arrange & Act
+        var request = new Create2faChallengeRequest();
+
+        // Assert
+        Assert.Equal(SecondFactor.Email, request.Factor);
+    }
+
+    [Fact]
+    public void Properties_CanBeSet()
+    {
+        // Arrange
+        var request = new Create2faChallengeRequest();
+
+        // Act
+        request.Factor = SecondFactor.Phone;
+
+        // Assert
+        Assert.Equal(SecondFactor.Phone, request.Factor);
+    }
+
+    [Theory]
+    [InlineData(SecondFactor.Email)]
+    [InlineData(SecondFactor.Phone)]
+    [InlineData(SecondFactor.Totp)]
+    [InlineData(SecondFactor.RecoveryCode)]
+    public void IsValid_WithValidInputs_ReturnsTrue(SecondFactor factor)
+    {
+        // Arrange
+        var request = new Create2faChallengeRequest
+        {
+            Factor = factor
+        };
+
+        // Act
+        var isValid = request.IsValid();
+
+        // Assert
+        Assert.True(isValid);
+    }
+
+    [Theory]
+    [InlineData((SecondFactor)999)]
+    public void IsValid_WithInvalidInputs_ReturnsFalse(SecondFactor factor)
+    {
+        // Arrange
+        var request = new Create2faChallengeRequest
+        {
+            Factor = factor
+        };
+
+        var ggg = (int)factor;
+
+        // Act
+        var isValid = request.IsValid();
+
+        // Assert
+        Assert.False(isValid);
+    }
+
+    [Fact]
+    public void Validate_WithThrowOnFailuresTrue_ThrowsValidationExceptionOnFailure()
+    {
+        // Arrange
+        var request = new Create2faChallengeRequest
+        {
+            Factor = (SecondFactor)999
+        };
+
+        // Assert
+        Assert.Throws<ValidationException>(() => request.Validate(true));
+    }
+
+    [Fact]
+    public void Validate_WithThrowOnFailuresFalse_ReturnsInvalidResultOnFailure()
+    {
+        // Arrange
+        var request = new Create2faChallengeRequest
+        {
+            Factor = (SecondFactor)999
+        };
+
+        // Act
+        var result = request.Validate(false);
+
+        // Assert
+        Assert.False(result.IsValid);
+    }
+}