Events added for #31 - money transfer example

Author: Duncan-at-Hedgefacts

examples/bank-account/RetailBank.AzureFunctionApp/RetailBank.AzureFunctionApp.csproj

@@ -56,4 +56,8 @@
       <Private>true</Private>
     </ProjectReference>
   </ItemGroup>
+  <ItemGroup>
+    <Folder Include="Transfer\Functions\" />
+    <Folder Include="Transfer\Projections\" />
+  </ItemGroup>
 </Project>

examples/bank-account/RetailBank.AzureFunctionApp/Transfer/Events/RefundFailed.cs

@@ -0,0 +1,18 @@
+using EventSourcingOnAzureFunctions.Common.EventSourcing;
+
+namespace RetailBank.AzureFunctionApp.Transfer.Events
+{
+    
+    [EventName("Refund Failed")]
+    public sealed class RefundFailed
+    {
+
+        public string Reason { get; set; }
+
+        /// <summary>
+        /// Additional commentary on the refund failure
+        /// </summary>
+        public string Commentary { get; set; }
+
+    }
+}

examples/bank-account/RetailBank.AzureFunctionApp/Transfer/Events/RefundInitiated.cs

@@ -0,0 +1,23 @@
+using EventSourcingOnAzureFunctions.Common.EventSourcing;
+
+namespace RetailBank.AzureFunctionApp.Transfer.Events
+{
+    [EventName("Refund Initiated")]
+    public sealed class RefundInitiated
+    {
+
+        /// <summary>
+        /// The amount to refund to the source
+        /// </summary>
+        /// <remarks>
+        /// This may not be the same as the original transfer
+        /// request if there were non-refundable charges etc
+        /// </remarks>
+        public decimal AmountToRefund { get; set; }
+
+        /// <summary>
+        /// The reason that this refund was initiated
+        /// </summary>
+        public string Reason { get; set; }
+    }
+}

examples/bank-account/RetailBank.AzureFunctionApp/Transfer/Events/SourceFundsRefunded.cs

@@ -0,0 +1,22 @@
+using EventSourcingOnAzureFunctions.Common.EventSourcing;
+
+namespace RetailBank.AzureFunctionApp.Transfer.Events
+{
+    [EventName("Source Funds Refunded")]
+    public sealed class SourceFundsRefunded
+    {
+
+        /// <summary>
+        /// The amount refunded to the source account
+        /// </summary>
+        public decimal AmountRefunded { get; set; }
+
+        /// <summary>
+        /// For an internal source, the sequence number as at which the refund was performed
+        /// (Will be zero for an external account as this has no meaning for data we do not control)
+        /// </summary>
+        public int AsOfSequenceNumber { get; set; }
+
+
+    }
+}

examples/bank-account/RetailBank.AzureFunctionApp/Transfer/Events/SourceFundsWithdrawn.cs

@@ -0,0 +1,36 @@
+using EventSourcingOnAzureFunctions.Common.EventSourcing;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace RetailBank.AzureFunctionApp.Transfer.Events
+{
+
+    /// <summary>
+    /// Funds for this transfer were withdrawn from the source account
+    /// </summary>
+    [EventName("Source Funds Withdrawn")]
+    public sealed class SourceFundsWithdrawn
+    {
+
+        /// <summary>
+        /// The amount withdrawn fro the source account
+        /// </summary>
+        /// <remarks>
+        /// This may be different to the requested transfer if the transfer process 
+        /// allows for partial transfers
+        /// </remarks>
+        public decimal AmountWithdrawn { get; set; }
+
+        /// <summary>
+        /// For an internal source, the sequence number as at which the withdrawal was performed
+        /// (Will be zero for an external account as this has no meaning for data we do not control)
+        /// </summary>
+        public int AsOfSequenceNumber { get; set; }
+
+        /// <summary>
+        /// Additional commentary on the funds withdrawal
+        /// </summary>
+        public string Commentary { get; set; }
+    }
+}

examples/bank-account/RetailBank.AzureFunctionApp/Transfer/Events/TargetFundsDeposited.cs

@@ -0,0 +1,32 @@
+using EventSourcingOnAzureFunctions.Common.EventSourcing;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace RetailBank.AzureFunctionApp.Transfer.Events
+{
+    [EventName("Target Funds Deposited")]
+    public sealed class TargetFundsDeposited
+    {
+
+        /// <summary>
+        /// The amount deposited in the target account
+        /// </summary>
+        /// <remarks>
+        /// This may be different to the requested transfer if the transfer process 
+        /// allows for partial transfers
+        /// </remarks>
+        public decimal AmountDeposited { get; set; }
+
+        /// <summary>
+        /// For an internal source, the sequence number as at which the deposit was performed
+        /// (Will be zero for an external account as this has no meaning for data we do not control)
+        /// </summary>
+        public int AsOfSequenceNumber { get; set; }
+
+        /// <summary>
+        /// Additional commentary on the funds deposit
+        /// </summary>
+        public string Commentary { get; set; }
+    }
+}

examples/bank-account/RetailBank.AzureFunctionApp/Transfer/Events/TransferInitiated.cs

@@ -0,0 +1,41 @@
+using EventSourcingOnAzureFunctions.Common.EventSourcing;
+
+namespace RetailBank.AzureFunctionApp.Transfer.Events
+{
+    /// <summary>
+    /// A money transfer between the source and target accounts has been initiated
+    /// </summary>
+    [EventName("Money Transfer Initiated")]
+    public sealed class TransferInitiated
+    {
+
+        /// <summary>
+        /// The amount being transfered
+        /// </summary>
+        /// <remarks>
+        /// This is currently a "same currency" transfer - we may consider expanding the example
+        /// to include FX rates at a later date
+        /// </remarks>
+        public decimal Amount { get; set; }
+
+        /// <summary>
+        /// The account number the transfer is coming from
+        /// </summary>
+        public string SourceAccountNumber { get; set; }
+
+        /// <summary>
+        /// True if the account we are transfering from is in our bank
+        /// </summary>
+        public bool SourceIsInternal { get; set; }
+
+        /// <summary>
+        /// The account the transfer is going to
+        /// </summary>
+        public string TargetAccountNumber { get; set; }
+
+        /// <summary>
+        /// True if the account we are transfering to is in our bank
+        /// </summary>
+        public bool TargetIsInternal { get; set; }
+    }
+}

examples/bank-account/RetailBank.AzureFunctionApp/Transfer/Transfer.ReadMe.txt

@@ -0,0 +1,8 @@
+Transfers
+=========
+
+A transfer is a money movement between accounts.  
+It is used to demonstrate the idea of saga-based actions as replacements for the traditional database concept of transactions.
+
+A transfer can succeed or fail due to the conditions of source and target account (assuming both are "ours") 
+and a failed transfer should set back the accounts to the state they were in before it.