Skip to content

Add deposits and withdrawals to Merchant Statement system #816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 19, 2025
Merged

Add deposits and withdrawals to Merchant Statement system #816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26647e4
Add deposits and withdrawals to Merchant Statement system
StuartFerguson May 19, 2025
8984752
code review fixes
StuartFerguson May 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
306 changes: 0 additions & 306 deletions TransactionProcessor.Aggregates.Tests/MerchantStatementAggregateTests.cs
View file
Open in desktop

Large diffs are not rendered by default.

259 changes: 259 additions & 0 deletions TransactionProcessor.Aggregates.Tests/MerchantStatementForDateAggregateTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,259 @@
using Shouldly;
using TransactionProcessor.Models.Merchant;
using TransactionProcessor.Testing;

namespace TransactionProcessor.Aggregates.Tests;

public class MerchantStatementForDateAggregateTests
{
[Fact]
public void MerchantStatementForDateAggregate_CanBeCreated_IsCreated()
{
MerchantStatementForDateAggregate merchantStatementForDateAggregate = MerchantStatementForDateAggregate.Create(TestData.MerchantStatementForDateId1);

merchantStatementForDateAggregate.ShouldNotBeNull();
merchantStatementForDateAggregate.AggregateId.ShouldBe(TestData.MerchantStatementForDateId1);
}

[Fact]
public void MerchantStatementForDateAggregate_AddTransactionToStatement_TransactionAddedToStatement()
{
MerchantStatementForDateAggregate merchantStatementForDateAggregate = MerchantStatementForDateAggregate.Create(TestData.MerchantStatementForDateId1);
merchantStatementForDateAggregate.AddTransactionToStatement(TestData.MerchantStatementId,
TestData.StatementDate,
TestData.EventId1,
TestData.EstateId,
TestData.MerchantId, TestData.Transaction1);

MerchantStatementForDate merchantStatementForDate = merchantStatementForDateAggregate.GetStatement(true);
List<MerchantStatementLine>? statementLines = merchantStatementForDate.GetStatementLines();
statementLines.ShouldNotBeNull();
statementLines.ShouldNotBeEmpty();
statementLines.Count.ShouldBe(1);
}

[Fact]
public void MerchantStatementForDateAggregate_AddTransactionToStatement_DuplicateTransaction_SilentlyHandled()
{
MerchantStatementForDateAggregate merchantStatementForDateAggregate = MerchantStatementForDateAggregate.Create(TestData.MerchantStatementForDateId1);
merchantStatementForDateAggregate.AddTransactionToStatement(TestData.MerchantStatementId,
TestData.StatementDate,
TestData.EventId1,
TestData.EstateId,
TestData.MerchantId, TestData.Transaction1);

merchantStatementForDateAggregate.AddTransactionToStatement(TestData.MerchantStatementId,
TestData.StatementDate,
TestData.EventId1,
TestData.EstateId,
TestData.MerchantId, TestData.Transaction1);

MerchantStatementForDate merchantStatementForDate = merchantStatementForDateAggregate.GetStatement(true);
List<MerchantStatementLine>? statementLines = merchantStatementForDate.GetStatementLines();
statementLines.ShouldNotBeNull();
statementLines.ShouldNotBeEmpty();
statementLines.Count.ShouldBe(1);
}

[Fact]
public void MerchantStatementForDateAggregate_AddSettledFeeToStatement_FeeAddedToStatement()
{
MerchantStatementForDateAggregate merchantStatementForDateAggregate = MerchantStatementForDateAggregate.Create(TestData.MerchantStatementForDateId1);
merchantStatementForDateAggregate.AddSettledFeeToStatement(TestData.MerchantStatementId, TestData.StatementDate, TestData.EventId1, TestData.EstateId, TestData.MerchantId, TestData.SettledFee1);

MerchantStatementForDate merchantStatementForDate = merchantStatementForDateAggregate.GetStatement(true);
List<MerchantStatementLine>? statementLines = merchantStatementForDate.GetStatementLines();
statementLines.ShouldNotBeNull();
statementLines.ShouldNotBeEmpty();
statementLines.Count.ShouldBe(1);
}

[Fact]
public void MerchantStatementForDateAggregate_AddSettledFeeToStatement_DuplicateFee_Silentlyhandled()
{
MerchantStatementForDateAggregate merchantStatementForDateAggregate = MerchantStatementForDateAggregate.Create(TestData.MerchantStatementForDateId1);
merchantStatementForDateAggregate.AddSettledFeeToStatement(TestData.MerchantStatementId, TestData.StatementDate, TestData.EventId1, TestData.EstateId, TestData.MerchantId, TestData.SettledFee1);
merchantStatementForDateAggregate.AddSettledFeeToStatement(TestData.MerchantStatementId, TestData.StatementDate, TestData.EventId1, TestData.EstateId, TestData.MerchantId, TestData.SettledFee1);

MerchantStatementForDate merchantStatementForDate = merchantStatementForDateAggregate.GetStatement(true);
List<MerchantStatementLine>? statementLines = merchantStatementForDate.GetStatementLines();
statementLines.ShouldNotBeNull();
statementLines.ShouldNotBeEmpty();
statementLines.Count.ShouldBe(1);
}

[Theory]
[InlineData(MerchantDepositSource.Manual)]
[InlineData(MerchantDepositSource.Automatic)]
public void MerchantStatementForDateAggregate_AddDepositToStatement_DepositAddedToStatement(MerchantDepositSource source)
{
MerchantStatementForDateAggregate merchantStatementForDateAggregate = MerchantStatementForDateAggregate.Create(TestData.MerchantStatementForDateId1);
merchantStatementForDateAggregate.AddDepositToStatement(TestData.MerchantStatementId,
TestData.StatementDate,
TestData.EventId1,
TestData.EstateId,
TestData.MerchantId, new Deposit {
DepositDateTime = TestData.DepositDateTime,
Amount = TestData.DepositAmount.Value,
DepositId = TestData.DepositId,
Reference = TestData.DepositReference,
Source = source
});

MerchantStatementForDate merchantStatementForDate = merchantStatementForDateAggregate.GetStatement(true);
List<MerchantStatementLine>? statementLines = merchantStatementForDate.GetStatementLines();
statementLines.ShouldNotBeNull();
statementLines.ShouldNotBeEmpty();
statementLines.Count.ShouldBe(1);
}

[Fact]
public void MerchantStatementForDateAggregate_AddWithdrawalToStatement_WithdrawalAddedToStatement()
{
MerchantStatementForDateAggregate merchantStatementForDateAggregate = MerchantStatementForDateAggregate.Create(TestData.MerchantStatementForDateId1);
merchantStatementForDateAggregate.AddWithdrawalToStatement(TestData.MerchantStatementId,
TestData.StatementDate,
TestData.EventId1,
TestData.EstateId,
TestData.MerchantId, new Withdrawal
{
WithdrawalDateTime = TestData.WithdrawalDateTime,
Amount = TestData.WithdrawalAmount.Value,
WithdrawalId = TestData.WithdrawalId
});

MerchantStatementForDate merchantStatementForDate = merchantStatementForDateAggregate.GetStatement(true);
List<MerchantStatementLine>? statementLines = merchantStatementForDate.GetStatementLines();
statementLines.ShouldNotBeNull();
statementLines.ShouldNotBeEmpty();
statementLines.Count.ShouldBe(1);
}


[Fact]
public void MerchantStatementAggregate_AddDailySummaryRecord_RecordIsAdded() {
MerchantStatementAggregate merchantStatementAggregate = MerchantStatementAggregate.Create(TestData.MerchantStatementId);
Should.NotThrow(() => { merchantStatementAggregate.AddDailySummaryRecord(TestData.TransactionDateTime.Date, 1, 100.00m, 1, 0.10m,
1, 1000, 1, 200); });
}

[Fact]
public void MerchantStatementAggregate_AddDailySummaryRecord_DuplicateAdd_ExceptionIsThrown()
{
MerchantStatementAggregate merchantStatementAggregate = MerchantStatementAggregate.Create(TestData.MerchantStatementId);
merchantStatementAggregate.AddDailySummaryRecord(TestData.TransactionDateTime.Date, 1, 100.00m, 1, 0.10m,
1, 1000, 1, 200);
Should.Throw<InvalidOperationException>(() => { merchantStatementAggregate.AddDailySummaryRecord(TestData.TransactionDateTime.Date, 1, 100.00m, 1, 0.10m,
1, 1000, 1, 200); });
}


[Fact]
public void MerchantStatementAggregate_GenerateStatement_StatementIsGenerated()
{
MerchantStatementAggregate merchantStatementAggregate = MerchantStatementAggregate.Create(TestData.MerchantStatementId);
merchantStatementAggregate.AddDailySummaryRecord(TestData.TransactionDateTime.Date, 1, 100.00m, 1, 0.10m,
1, 1000, 1, 200);
merchantStatementAggregate.GenerateStatement(TestData.StatementGeneratedDate);

MerchantStatement merchantStatement = merchantStatementAggregate.GetStatement();
merchantStatement.IsGenerated.ShouldBeTrue();
}

[Fact]
public void MerchantStatementAggregate_GenerateStatement_StatementIsAlreadyGenerated_ExceptionThrown()
{
MerchantStatementAggregate merchantStatementAggregate = MerchantStatementAggregate.Create(TestData.MerchantStatementId);
merchantStatementAggregate.AddDailySummaryRecord(TestData.TransactionDateTime.Date, 1, 100.00m, 1, 0.10m, 1, 1000, 1, 200);
merchantStatementAggregate.GenerateStatement(TestData.StatementGeneratedDate);
Should.Throw<InvalidOperationException>(() => {
merchantStatementAggregate.GenerateStatement(TestData.StatementGeneratedDate);
});
}

[Fact]
public void MerchantStatementAggregate_GenerateStatement_NoSummaries_ExceptionThrown()
{
MerchantStatementAggregate merchantStatementAggregate = MerchantStatementAggregate.Create(TestData.MerchantStatementId);

Should.Throw<InvalidOperationException>(() => {
merchantStatementAggregate.GenerateStatement(TestData.StatementGeneratedDate);
});
}

[Fact]
public void MerchantStatementAggregate_BuildStatement_StatementIsBuilt()
{
MerchantStatementAggregate merchantStatementAggregate = MerchantStatementAggregate.Create(TestData.MerchantStatementId);
merchantStatementAggregate.AddDailySummaryRecord(TestData.TransactionDateTime.Date, 1, 100.00m, 1, 0.10m, 1, 1000, 1, 200);
merchantStatementAggregate.GenerateStatement(TestData.StatementGeneratedDate);
merchantStatementAggregate.BuildStatement(TestData.StatementBuiltDate,TestData.StatementData);

MerchantStatement merchantStatement = merchantStatementAggregate.GetStatement();
merchantStatement.BuiltDateTime.ShouldBe(TestData.StatementBuiltDate);
}

[Fact]
public void MerchantStatementAggregate_BuildStatement_StatementIsAlreadyBuilt_ExceptionThrown()
{
MerchantStatementAggregate merchantStatementAggregate = MerchantStatementAggregate.Create(TestData.MerchantStatementId);
merchantStatementAggregate.AddDailySummaryRecord(TestData.TransactionDateTime.Date, 1, 100.00m, 1, 0.10m, 1, 1000, 1, 200);
merchantStatementAggregate.GenerateStatement(TestData.StatementGeneratedDate);
merchantStatementAggregate.BuildStatement(TestData.StatementBuiltDate, TestData.StatementData);

Should.Throw<InvalidOperationException>(() => {
merchantStatementAggregate.BuildStatement(TestData.StatementBuiltDate, TestData.StatementData);
});
}

[Fact]
public void MerchantStatementAggregate_BuildStatement_StatementIsNotGenerated_ExceptionThrown()
{
MerchantStatementAggregate merchantStatementAggregate = MerchantStatementAggregate.Create(TestData.MerchantStatementId);
merchantStatementAggregate.AddDailySummaryRecord(TestData.TransactionDateTime.Date, 1, 100.00m, 1, 0.10m, 1, 1000, 1, 200);

Should.Throw<InvalidOperationException>(() => {
merchantStatementAggregate.BuildStatement(TestData.StatementBuiltDate, TestData.StatementData);
});
}

[Fact]
public void MerchantStatementAggregate_EmailStatement_StatementIsEmailed()
{
MerchantStatementAggregate merchantStatementAggregate = MerchantStatementAggregate.Create(TestData.MerchantStatementId);
merchantStatementAggregate.AddDailySummaryRecord(TestData.TransactionDateTime.Date, 1, 100.00m, 1, 0.10m, 1, 1000, 1, 200);
merchantStatementAggregate.GenerateStatement(TestData.StatementGeneratedDate);
merchantStatementAggregate.BuildStatement(TestData.StatementBuiltDate, TestData.StatementData);

merchantStatementAggregate.EmailStatement(TestData.StatementEmailedDate, TestData.MessageId);

MerchantStatement merchantStatement = merchantStatementAggregate.GetStatement();
merchantStatement.HasBeenEmailed.ShouldBeTrue();
}

[Fact]
public void MerchantStatementAggregate_EmailStatement_StatementIsAlreadyEmailed_ExceptionThrown()
{
MerchantStatementAggregate merchantStatementAggregate = MerchantStatementAggregate.Create(TestData.MerchantStatementId);
merchantStatementAggregate.AddDailySummaryRecord(TestData.TransactionDateTime.Date, 1, 100.00m, 1, 0.10m, 1, 1000, 1, 200);
merchantStatementAggregate.GenerateStatement(TestData.StatementGeneratedDate);
merchantStatementAggregate.BuildStatement(TestData.StatementBuiltDate, TestData.StatementData);
merchantStatementAggregate.EmailStatement(TestData.StatementEmailedDate, TestData.MessageId);

Should.Throw<InvalidOperationException>(() => {
merchantStatementAggregate.EmailStatement(TestData.StatementEmailedDate, TestData.MessageId);
});
}

[Fact]
public void MerchantStatementAggregate_EmailStatement_StatementIsNotBuilt_ExceptionThrown()
{
MerchantStatementAggregate merchantStatementAggregate = MerchantStatementAggregate.Create(TestData.MerchantStatementId);
merchantStatementAggregate.AddDailySummaryRecord(TestData.TransactionDateTime.Date, 1, 100.00m, 1, 0.10m, 1, 1000, 1, 200);
merchantStatementAggregate.GenerateStatement(TestData.StatementGeneratedDate);

Should.Throw<InvalidOperationException>(() => {
merchantStatementAggregate.EmailStatement(TestData.StatementEmailedDate, TestData.MessageId);
});
}
}
16 changes: 6 additions & 10 deletions TransactionProcessor.Aggregates/MerchantStatementAggregate.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,14 +213,6 @@ public static void GenerateStatement(this MerchantStatementAggregate aggregate,
aggregate.ApplyAndAppend(statementGeneratedEvent);
}

private static void EnsureStatementHasBeenCreated(this MerchantStatementAggregate aggregate)
{
if (aggregate.IsCreated == false)
{
throw new InvalidOperationException("Statement header has not been created");
}
}

private static void EnsureStatementHasBeenGenerated(this MerchantStatementAggregate aggregate)
{
if (aggregate.IsGenerated == false)
Expand Down Expand Up @@ -261,15 +253,19 @@ private static void EnsureStatementHasNotAlreadyBeenEmailed(this MerchantStateme
}
}

public static void AddDailySummaryRecord(this MerchantStatementAggregate aggregate, DateTime activityDate, Int32 numberOfTransactions, Decimal valueOfTransactions, Int32 numberOfSettledFees, Decimal valueOfSettledFees) {
public static void AddDailySummaryRecord(this MerchantStatementAggregate aggregate, DateTime activityDate,
Int32 numberOfTransactions, Decimal valueOfTransactions,
Int32 numberOfSettledFees, Decimal valueOfSettledFees,
Int32 numberOfDepoits, Decimal valueOfDepoits,
Int32 numberOfWithdrawals, Decimal valueOfWithdrawals) {
if (aggregate.MerchantStatementSummaries.Any(s => s.ActivityDate == activityDate)) {
throw new InvalidOperationException($"Summary Data for Activity Date {activityDate:yyyy-MM-dd} already exists");
}

// TODO: should this check the date has been added to the statement, before allowing the summary?

MerchantStatementDomainEvents.StatementSummaryForDateEvent statementSummaryForDateEvent = new(aggregate.AggregateId, aggregate.EstateId, aggregate.MerchantId, activityDate,aggregate.MerchantStatementSummaries.Count +1
,numberOfTransactions, valueOfTransactions, numberOfSettledFees, valueOfSettledFees);
,numberOfTransactions, valueOfTransactions, numberOfSettledFees, valueOfSettledFees, numberOfDepoits, valueOfDepoits, numberOfWithdrawals, valueOfWithdrawals);
aggregate.ApplyAndAppend(statementSummaryForDateEvent);
}
}
Expand Down
Loading
Loading