Merge pull request 'Refactored PayfastService.GenerateSignature()' (#104) from payments into master

Reviewed-on: #104

LiteCharms.Features.MidrandBooks/AuthorBooks/BooksService.cs

@@ -58,6 +58,30 @@ public sealed class BooksService(IDbContextFactory<MidrandBooksDbContext> contex
         }
     }
 
+    public async ValueTask<Result<AuthorBook>> GetBookByProductIdAsync(long productId, CancellationToken cancellationToken = default)
+    {
+        try
+        {
+            await using var context = await contextFactory.CreateDbContextAsync(cancellationToken);
+
+            var book = await context.Books
+                .AsNoTracking()
+                .Include(b => b.Author)
+                .Include(b => b.Product)
+                    .ThenInclude(b => b!.Prices)
+                .Include(b => b.Pages)
+                .FirstOrDefaultAsync(b => b.ProductId == productId, cancellationToken);
+
+            return book is null
+                ? Result.Fail<AuthorBook>(new Error($"Book with product ID {productId} not found"))
+                : Result.Ok(book.ToModel());
+        }
+        catch (Exception ex)
+        {
+            return Result.Fail<AuthorBook>(new Error(ex.Message).CausedBy(ex));
+        }
+    }
+
     public async ValueTask<Result<AuthorBook>> GetBookAsync(long bookId, CancellationToken cancellationToken = default)
     {
         try

LiteCharms.Features.MidrandBooks/Customers/CustomerService.cs

@@ -334,6 +334,28 @@ public sealed class CustomerService(IDbContextFactory<MidrandBooksDbContext> con
         }
     }
 
+    public async ValueTask<Result<Customer>> GetCustomerAsync(string email, CancellationToken cancellationToken = default)
+    {
+        try
+        {
+            await using var context = await contextFactory.CreateDbContextAsync(cancellationToken);
+
+            var customer = await context.Customers
+                .AsNoTracking()
+                .Include(c => c.Contacts)
+                .Include(c => c.Addresses)
+                .FirstOrDefaultAsync(c => c.Email == email, cancellationToken);
+
+            return customer is not null
+                ? Result.Ok(customer.ToModel())
+                : Result.Fail<Customer>(new Error($"Customer with email '{email}' does not exist."));
+        }
+        catch (Exception ex)
+        {
+            return Result.Fail<Customer>(new Error(ex.Message).CausedBy(ex));
+        }
+    }
+
     public async ValueTask<Result<Customer>> GetCustomerAsync(long customerId, CancellationToken cancellationToken = default)
     {
         try

LiteCharms.Features.MidrandBooks/Customers/Entities/CustomerConfiguration.cs

@@ -12,8 +12,8 @@ public sealed class CustomerConfiguration : IEntityTypeConfiguration<Customer>
         builder.Property(c => c.Company).IsRequired(false);
         builder.Property(c => c.VatNumber).IsRequired(false);
         builder.Property(c => c.Email).IsRequired();
-        builder.Property(c => c.Phone).IsRequired();
+        builder.Property(c => c.Phone).IsRequired(false);
-        builder.Property(c => c.Website).IsRequired();
+        builder.Property(c => c.Website).IsRequired(false);
         builder.Property(c => c.Enabled).HasDefaultValue(true);
 
         builder.OwnsMany(f => f.SocialMedia, b => { b.ToJson(); });

LiteCharms.Features.MidrandBooks/Orders/OrderService.cs

@@ -164,6 +164,27 @@ public sealed class OrderService(IDbContextFactory<MidrandBooksDbContext> contex
     public async ValueTask<Result> CancelOrderAsync(long orderId, CancellationToken cancellationToken = default) =>
         await UpdateOrderStatusAsync(orderId, OrderStatus.Cancelled, cancellationToken);
 
+    public async ValueTask<Result<Order>> GetPendingOrderAsync(long customerId, CancellationToken cancellationToken = default)
+    {
+        try
+        {
+            await using var context = await contextFactory.CreateDbContextAsync(cancellationToken);
+
+            var order = await context.Orders.AsNoTracking()
+                .Where(o => o.Status == OrderStatus.Pending && o.CustomerId == customerId)
+                .OrderByDescending(o => o.Id)
+                .FirstOrDefaultAsync(cancellationToken);
+
+            return order is not null
+                ? Result.Ok(order.ToModel())
+                : Result.Fail<Order>("Order not found.");
+        }
+        catch (Exception ex)
+        {
+            return Result.Fail<Order>(new Error(ex.Message).CausedBy(ex));
+        }
+    }
+
     public async ValueTask<Result<Order>> GetOrderAsync(long orderId, CancellationToken cancellationToken = default)
     {
         try

LiteCharms.Features.MidrandBooks/Payments/Events/Handlers/PayfastPaymentConfirmationReceivedEventHandler.cs

@@ -1,15 +1,16 @@
-using LiteCharms.Features.Hasher;
+using LiteCharms.Features.Api.Configuration;
-using LiteCharms.Features.Hasher.Configuration;
+using LiteCharms.Features.Hasher;
 using LiteCharms.Features.Mediator;
 using LiteCharms.Features.MidrandBooks.Orders;
 using LiteCharms.Features.MidrandBooks.Payments.Models;
 
 namespace LiteCharms.Features.MidrandBooks.Payments.Events.Handlers;
 
-public sealed class PayfastPaymentConfirmationReceivedEventHandler(IServiceProvider services, IOptions<HasherSettings> hasherOptions, ILogger<PayfastPaymentConfirmationReceivedEvent> logger) :
+public sealed class PayfastPaymentConfirmationReceivedEventHandler(IServiceProvider services, 
+    IOptions<PayfastSettings> payfastOptions, ILogger<PayfastPaymentConfirmationReceivedEvent> logger) :
     INotificationHandler<PayfastPaymentConfirmationReceivedEvent>
 {
-    private readonly HasherSettings hasherSettings = hasherOptions.Value;
+    private readonly PayfastSettings pasfastSettings = payfastOptions.Value;
 
     public async ValueTask Handle(PayfastPaymentConfirmationReceivedEvent notification, CancellationToken cancellationToken)
     {
@@ -25,7 +26,7 @@ public sealed class PayfastPaymentConfirmationReceivedEventHandler(IServiceProvi
         var payload = notification.Payload ?? throw new Exception("Payload metadata context context is null.");
 
         var dict = payload.ToParamDictionary();
-        var localSignature = PayfastService.GenerateSignature(dict, hasherSettings.PayfastPassphrase);
+        var localSignature = PayfastService.GenerateSignature(dict, pasfastSettings.Passphrase);
 
         if (localSignature.IsFailed)
             throw new Exception("Failed to generate local signature for incoming webhook payload.");
@@ -159,6 +160,5 @@ public sealed class PayfastPaymentConfirmationReceivedEventHandler(IServiceProvi
             logger.LogInformation("Webhook validation pipeline passed checks successfully, logged entry to ledger with status: {Status}", status);
         }
         activity?.SetStatus(ActivityStatusCode.Ok);
-
     }
 }

LiteCharms.Features.MidrandBooks/Payments/PayfastService.cs

@@ -1,4 +1,5 @@
 using LiteCharms.Features.Abstractions;
+using LiteCharms.Features.Api.Configuration;
 using LiteCharms.Features.Hasher;
 using LiteCharms.Features.MidrandBooks.Payments.Models;
 using LiteCharms.Features.MidrandBooks.Postgres;
@@ -6,13 +7,11 @@ using LiteCharms.Features.MidrandBooks.Postgres;
 namespace LiteCharms.Features.MidrandBooks.Payments;
 
 public sealed partial class PayfastService(IDbContextFactory<MidrandBooksDbContext> contextFactory, 
-    ILogger<PayfastService> logger, IHttpClientFactory httpClientFactory, IConfiguration configuration) : IService
+    IOptions<PayfastSettings> payfastOptions, ILogger<PayfastService> logger, IHttpClientFactory httpClientFactory) : IService
 {
     [GeneratedRegex(@"%[0-9A-Fa-f]{2}", RegexOptions.None, matchTimeoutMilliseconds: 1000)]
     public static partial Regex PercentEncodingRegex { get; }
 
-    public readonly string[] ValidHosts = configuration.GetSection("ValidPayfastHosts").Get<string[]>() ?? [];
-
     public async ValueTask<Result<long>> WriteLedgerEntryAsync(CreateGatewayLedgerEntry request, CancellationToken cancellationToken = default)
     {
         try
@@ -51,6 +50,9 @@ public sealed partial class PayfastService(IDbContextFactory<MidrandBooksDbConte
 
     public async ValueTask<Result<bool>> ValidateReferrerIpAsync(string remoteIpAddress, bool allowLoopback = false, CancellationToken cancellationToken = default)
     {
+        if(payfastOptions.Value?.ValidHosts?.Length == 0)
+            return Result.Fail<bool>("Valid payfast hosts not configured.");
+
         if (string.IsNullOrWhiteSpace(remoteIpAddress)) 
             return Result.Fail<bool>("Remote IP address is null or whitespace.");
 
@@ -58,7 +60,7 @@ public sealed partial class PayfastService(IDbContextFactory<MidrandBooksDbConte
         {
             var validIps = new HashSet<IPAddress>();
 
-            foreach (var host in ValidHosts)
+            foreach (var host in payfastOptions.Value!.ValidHosts!)
             {
                 try
                 {
@@ -150,11 +152,16 @@ public sealed partial class PayfastService(IDbContextFactory<MidrandBooksDbConte
             if (string.IsNullOrEmpty(kvp.Value))
                 continue;
 
+            if (kvp.Key.Equals("signature", StringComparison.OrdinalIgnoreCase))
+                continue;
+
             string key = kvp.Key;
 
+            // 1. Payfast requires spaces to be '+' signs. HttpUtility does this perfectly.
             string encodedVal = HttpUtility.UrlEncode(kvp.Value.Trim());
 
-            string val = PercentEncodingRegex.Replace(encodedVal, m => m.Value.ToLowerInvariant());
+            // 2. Payfast requires all OTHER percent-encoded hex arrays to be UPPERCASE (e.g., %3A instead of %3a)
+            string val = Regex.Replace(encodedVal, "%[0-9A-Fa-f]{2}", m => m.Value.ToUpperInvariant());
 
             pfOutput.Append($"{key}={val}&");
         }
@@ -165,13 +172,13 @@ public sealed partial class PayfastService(IDbContextFactory<MidrandBooksDbConte
 
         if (!string.IsNullOrWhiteSpace(passPhrase))
         {
+            // Apply the exact same encoding rule to your passphrase
             string encodedPassphrase = HttpUtility.UrlEncode(passPhrase.Trim());
-
+            string safePassphrase = Regex.Replace(encodedPassphrase, "%[0-9A-Fa-f]{2}", m => m.Value.ToUpperInvariant());
-            string safePassphrase = PercentEncodingRegex.Replace(encodedPassphrase, m => m.Value.ToLowerInvariant());
 
             getString += $"&passphrase={safePassphrase}";
         }
 
         return HashService.ToMd5Hash(getString);
-    }    
+    }
 }

LiteCharms.Features.MidrandBooks/Postgres/Migrations/20260612210020_OnlyEmailIsMandatoryOnCustomer.cs

@@ -0,0 +1,54 @@
+using Microsoft.EntityFrameworkCore.Migrations;
+
+#nullable disable
+
+namespace LiteCharms.Features.MidrandBooks.Postgres.Migrations
+{
+    /// <inheritdoc />
+    public partial class OnlyEmailIsMandatoryOnCustomer : Migration
+    {
+        /// <inheritdoc />
+        protected override void Up(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.AlterColumn<string>(
+                name: "Website",
+                table: "Customers",
+                type: "text",
+                nullable: true,
+                oldClrType: typeof(string),
+                oldType: "text");
+
+            migrationBuilder.AlterColumn<string>(
+                name: "Phone",
+                table: "Customers",
+                type: "text",
+                nullable: true,
+                oldClrType: typeof(string),
+                oldType: "text");
+        }
+
+        /// <inheritdoc />
+        protected override void Down(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.AlterColumn<string>(
+                name: "Website",
+                table: "Customers",
+                type: "text",
+                nullable: false,
+                defaultValue: "",
+                oldClrType: typeof(string),
+                oldType: "text",
+                oldNullable: true);
+
+            migrationBuilder.AlterColumn<string>(
+                name: "Phone",
+                table: "Customers",
+                type: "text",
+                nullable: false,
+                defaultValue: "",
+                oldClrType: typeof(string),
+                oldType: "text",
+                oldNullable: true);
+        }
+    }
+}

LiteCharms.Features.MidrandBooks/Postgres/Migrations/MidrandBooksDbContextModelSnapshot.cs

@@ -17,7 +17,7 @@ namespace LiteCharms.Features.MidrandBooks.Postgres.Migrations
         {
 #pragma warning disable 612, 618
             modelBuilder
-                .HasAnnotation("ProductVersion", "10.0.8")
+                .HasAnnotation("ProductVersion", "10.0.9")
                 .HasAnnotation("Relational:MaxIdentifierLength", 63);
 
             NpgsqlModelBuilderExtensions.UseIdentityByDefaultColumns(modelBuilder);
@@ -309,7 +309,6 @@ namespace LiteCharms.Features.MidrandBooks.Postgres.Migrations
                         .HasDefaultValue(true);
 
                     b.Property<string>("Phone")
-                        .IsRequired()
                         .HasColumnType("text");
 
                     b.Property<DateTime?>("UpdatedAt")
@@ -321,7 +320,6 @@ namespace LiteCharms.Features.MidrandBooks.Postgres.Migrations
                         .HasColumnType("text");
 
                     b.Property<string>("Website")
-                        .IsRequired()
                         .HasColumnType("text");
 
                     b.HasKey("Id");

LiteCharms.Features.Tests.Common/Fixture.cs

@@ -36,6 +36,7 @@ public class Fixture : IDisposable
             .AddHashServices(Configuration)
             .AddLiteCharmsApiSecurity(Configuration)
             .AddSecurityApiSdk(Configuration)
+            .AddPayfastServices(Configuration)
             .BuildServiceProvider(); ;
 
         Mediator = Services.GetRequiredService<IMediator>();

LiteCharms.Features.Tests.Common/appsettings.json

@@ -1,22 +1,25 @@
 {
+  "PayfastSettings": {
+    "CheckoutUrl": "https://sandbox.payfast.co.za/eng/process",
+    "ValidHosts": [
+      "www.payfast.co.za",
+      "sandbox.payfast.co.za",
+      "w1w.payfast.co.za",
+      "w2w.payfast.co.za",
+      "ips.payfast.co.za",
+      "api.payfast.co.za",
+      "payment.payfast.io"
+    ]
+  },
   "LiteCharmsSettings": {
     "Authority": "https://sts.security.khongisa.co.za",
     "Audience": "midrandbooks-api"
   },
   "LiteCharmsClientSettings": {
-    "Authority": "https://sts.security.khongisa.co.za",    
+    "Authority": "https://sts.security.khongisa.co.za",
     "GrantType": "client_credentials",
     "Scope": "midrandbooks-api"
   },
-  "ValidPayfastHosts": [
-    "www.payfast.co.za",
-    "sandbox.payfast.co.za",
-    "w1w.payfast.co.za",
-    "w2w.payfast.co.za",
-    "ips.payfast.co.za",
-    "api.payfast.co.za",
-    "payment.payfast.io"
-  ],
   "HasherSettings": {
     "MinHashLength": 11
   },

LiteCharms.Features.Tests/LiteCharms.Features.Tests.csproj

@@ -31,6 +31,7 @@
     <Using Include="System.Text" />
     <Using Include="Mediator" />
     <Using Include="Xunit.Abstractions" />
+    <Using Include="Microsoft.Extensions.Options" />
     <Using Include="Microsoft.Extensions.DependencyInjection" />
     <Using Include="Microsoft.Extensions.Configuration" />
   </ItemGroup>

LiteCharms.Features.Tests/PayfastFeatureTests.cs

@@ -0,0 +1,18 @@
+using LiteCharms.Features.Api.Configuration;
+using LiteCharms.Features.Tests.Common;
+
+namespace LiteCharms.Features.Tests;
+
+public sealed class PayfastFeatureTests(Fixture fixture) : IClassFixture<Fixture>
+{
+    private readonly PayfastSettings payfastSettings = fixture.Services.GetRequiredService<IOptions<PayfastSettings>>().Value;
+
+    [IntegrationFact]
+    public void PayfastSettings_ShouldFail_IfNotLoaded()
+    {
+        Assert.NotEmpty(payfastSettings.CheckoutUrl!);
+        Assert.NotEmpty(payfastSettings.MerchantId!);
+        Assert.NotEmpty(payfastSettings.MerchantKey!);
+        Assert.NotEmpty(payfastSettings.Passphrase!);
+    }
+}

LiteCharms.Features/Api/Configuration/PayfastSettings.cs

@@ -0,0 +1,14 @@
+namespace LiteCharms.Features.Api.Configuration;
+
+public sealed class PayfastSettings
+{
+    public string? CheckoutUrl { get; set; }
+
+    public string? Passphrase { get; set; }
+
+    public string? MerchantId { get; set; }
+
+    public string? MerchantKey { get; set; }
+
+    public string[]? ValidHosts { get; set; }
+}

LiteCharms.Features/Extensions/Api.cs

@@ -9,6 +9,15 @@ public static class Api
 {
     public const string Books = nameof(Books);
     public const string Payments = nameof(Payments);
+
+    public static IServiceCollection AddPayfastServices(this IServiceCollection services, IConfiguration configuration)
+    {
+        var configSection = configuration.GetSection(nameof(PayfastSettings));
+
+        services.Configure<PayfastSettings>(configSection);
+
+        return services;
+    }
     
     public static IServiceCollection AddSecurityApiSdk(this IServiceCollection services, IConfiguration configuration)
     {