Merge pull request pauldragoslav#1 from Nayananga/main

Add support for new APIs

Author: pauldragoslav

Banking.postman_collection.json

@@ -1,14 +1,14 @@
 {
 	"info": {
-		"_postman_id": "527d1a6d-ae07-4484-947b-e7f5501c1c6b",
+		"_postman_id": "485cda16-0d43-4aa6-ac55-116fb41d8f17",
 		"name": "Banking",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
 	},
 	"item": [
 		{
-			"name": "Account Balance",
+			"name": "Create Account",
 			"request": {
-				"method": "POST",
+				"method": "PUT",
 				"header": [
 					{
 						"key": "Content-Type",
@@ -19,7 +19,7 @@
 				],
 				"body": {
 					"mode": "raw",
-					"raw": "{\n\t\"sortCode\": \"53-68-92\",\n\t\"accountNumber\": \"73084635\"\n}\n\n"
+					"raw": "{\n\t\"bankName\": \"Bank of Ceyloan\",\n\t\"ownerName\": \"Nayananga Muhandiram\"\n}\n"
 				},
 				"url": {
 					"raw": "localhost:8080/api/v1/accounts",
@@ -66,6 +66,99 @@
 				}
 			},
 			"response": []
+		},
+		{
+			"name": "Check Balance",
+			"request": {
+				"method": "POST",
+				"header": [
+					{
+						"key": "Content-Type",
+						"name": "Content-Type",
+						"value": "application/json",
+						"type": "text"
+					}
+				],
+				"body": {
+					"mode": "raw",
+					"raw": "{\n\t\"sortCode\": \"35-16-67\",\n\t\"accountNumber\": \"95753174\"\n}\n"
+				},
+				"url": {
+					"raw": "localhost:8080/api/v1/accounts",
+					"host": [
+						"localhost"
+					],
+					"port": "8080",
+					"path": [
+						"api",
+						"v1",
+						"accounts"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Withdraw",
+			"request": {
+				"method": "POST",
+				"header": [
+					{
+						"key": "Content-Type",
+						"name": "Content-Type",
+						"type": "text",
+						"value": "application/json"
+					}
+				],
+				"body": {
+					"mode": "raw",
+					"raw": "{\n\t\"sortCode\": \"35-16-67\",\n\t\"accountNumber\": \"95753174\",\n    \"amount\": 100.00\n}\n"
+				},
+				"url": {
+					"raw": "localhost:8080/api/v1/withdraw",
+					"host": [
+						"localhost"
+					],
+					"port": "8080",
+					"path": [
+						"api",
+						"v1",
+						"withdraw"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Deposit",
+			"request": {
+				"method": "POST",
+				"header": [
+					{
+						"key": "Content-Type",
+						"name": "Content-Type",
+						"type": "text",
+						"value": "application/json"
+					}
+				],
+				"body": {
+					"mode": "raw",
+					"raw": "{\n\t\"targetAccountNo\": \"95753174\",\n    \"amount\": 1000.00\n}\n"
+				},
+				"url": {
+					"raw": "localhost:8080/api/v1/deposit",
+					"host": [
+						"localhost"
+					],
+					"port": "8080",
+					"path": [
+						"api",
+						"v1",
+						"deposit"
+					]
+				}
+			},
+			"response": []
 		}
 	]
 }

README.md

@@ -3,18 +3,53 @@ Example project demonstrating the use of Java and Spring-boot to build a microse
 
 ## Running locally
 ```
-./mvnw clean package
+./mvnw clean install -DskipTests=true
+```
+
+```
 java -jar target/Banking-0.0.1.jar
 ```
 
 ## Running on Docker
 ```
 docker build -t "spring-boot:banking" .
+```
+
+```
 docker run -p 8080:8080 spring-boot:banking
 ```
 
 ## Testing
-1. Import the Postman collection file into the application or copy the request body from there
+Import the Postman collection file into the application or copy the request body from there
+
+### How to test
+1. Create account
+   > Use create account API to create an account by providing a `bankName` and `ownerName`
+   > 
+   ![Create Account](screenshots/create_account.png)
+
+> Make sure to write down the `sortCode` and the `accountNumber` to proceed with other APIs
+
+2. Deposit Cash
+   >Use noted `accountNumber` as `targetAccountNo` and provide amount greater than zero to deposit cash into an account
+   
+   ![Deposit cash](screenshots/deposit.png)
+
+3. Check Balance
+   >Use noted `accountNumber` and `sortCode` to check account balance
+
+   ![Check Balance](screenshots/check_balance.png)
+   
+4. Withdraw Cash
+   >Use noted `accountNumber` and `sortCode` and `amount` grater than zero to withdraw cash from an account
+
+   ![Withdraw cash](screenshots/withdraw.png)
+    
+5. Check Balance again to verify withdrawal
+
+   ![Check Balance](screenshots/check_balance_2.png)
+   
+
 
 ### Extensions
 1. Use of persisted database

mvnw

@@ -32,6 +32,11 @@
 			<artifactId>spring-boot-starter-web</artifactId>
 		</dependency>
 
+		<dependency>
+			<groupId>com.github.mifmif</groupId>
+			<artifactId>generex</artifactId>
+			<version>1.0.2</version>
+		</dependency>
 		<dependency>
 			<groupId>com.h2database</groupId>
 			<artifactId>h2</artifactId>

pom.xml

@@ -0,0 +1,6 @@
+package com.example.paul.constants;
+
+public enum ACTION {
+    DEPOSIT,
+    WITHDRAW
+}

screenshots/check_balance.png

@@ -0,0 +1,27 @@
+package com.example.paul.constants;
+
+import java.util.regex.Pattern;
+
+public class constants {
+
+    public static final String SUCCESS =
+            "Operation completed successfully";
+    public static final String NO_ACCOUNT_FOUND =
+            "Unable to find an account matching this sort code and account number";
+    public static final String INVALID_SEARCH_CRITERIA =
+            "The provided sort code or account number did not match the expected format";
+
+    public static final String INSUFFICIENT_ACCOUNT_BALANCE =
+            "Your account does not have sufficient balance";
+
+    public static final String SORT_CODE_PATTERN_STRING = "[0-9]{2}-[0-9]{2}-[0-9]{2}";
+
+    public static final String ACCOUNT_NUMBER_PATTERN_STRING = "[0-9]{8}";
+    public static final Pattern SORT_CODE_PATTERN = Pattern.compile("^[0-9]{2}-[0-9]{2}-[0-9]{2}$");
+    public static final Pattern ACCOUNT_NUMBER_PATTERN = Pattern.compile("^[0-9]{8}$");
+
+    public static final String INVALID_TRANSACTION =
+            "Account information is invalid or transaction has been denied for your protection. Please try again.";
+    public static final String CREATE_ACCOUNT_FAILED =
+            "Error happened during creating new account";
+}

screenshots/check_balance_2.png

@@ -1,8 +1,10 @@
 package com.example.paul.controllers;
 
+import com.example.paul.constants.constants;
 import com.example.paul.models.Account;
 import com.example.paul.services.AccountService;
 import com.example.paul.utils.AccountInput;
+import com.example.paul.utils.CreateAccountInput;
 import com.example.paul.utils.InputValidator;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -24,12 +26,6 @@ public class AccountRestController {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(AccountRestController.class);
 
-    private static final String INVALID_SEARCH_CRITERIA =
-            "The provided sort code or account number did not match the expected format";
-
-    private static final String NO_ACCOUNT_FOUND =
-            "Unable to find an account matching this sort code and account number";
-
     private final AccountService accountService;
 
     @Autowired
@@ -53,12 +49,37 @@ public ResponseEntity<?> checkAccountBalance(
 
             // Return the account details, or warn that no account was found for given input
             if (account == null) {
-                return new ResponseEntity<>(NO_ACCOUNT_FOUND, HttpStatus.NO_CONTENT);
+                return new ResponseEntity<>(constants.NO_ACCOUNT_FOUND, HttpStatus.OK);
+            } else {
+                return new ResponseEntity<>(account, HttpStatus.OK);
+            }
+        } else {
+            return new ResponseEntity<>(constants.INVALID_SEARCH_CRITERIA, HttpStatus.BAD_REQUEST);
+        }
+    }
+
+
+    @PutMapping(value = "/accounts",
+            consumes = MediaType.APPLICATION_JSON_VALUE,
+            produces = MediaType.APPLICATION_JSON_VALUE)
+    public ResponseEntity<?> createAccount(
+            @Valid @RequestBody CreateAccountInput createAccountInput) {
+        LOGGER.debug("Triggered AccountRestController.createAccountInput");
+
+        // Validate input
+        if (InputValidator.isCreateAccountCriteriaValid(createAccountInput)) {
+            // Attempt to retrieve the account information
+            Account account = accountService.createAccount(
+                    createAccountInput.getBankName(), createAccountInput.getOwnerName());
+
+            // Return the account details, or warn that no account was found for given input
+            if (account == null) {
+                return new ResponseEntity<>(constants.CREATE_ACCOUNT_FAILED, HttpStatus.OK);
             } else {
                 return new ResponseEntity<>(account, HttpStatus.OK);
             }
         } else {
-            return new ResponseEntity<>(INVALID_SEARCH_CRITERIA, HttpStatus.BAD_REQUEST);
+            return new ResponseEntity<>(constants.INVALID_SEARCH_CRITERIA, HttpStatus.BAD_REQUEST);
         }
     }
 

screenshots/create_account.png

@@ -1,8 +1,10 @@
 package com.example.paul.controllers;
 
+import com.example.paul.constants.ACTION;
+import com.example.paul.models.Account;
+import com.example.paul.services.AccountService;
 import com.example.paul.services.TransactionService;
-import com.example.paul.utils.InputValidator;
-import com.example.paul.utils.TransactionInput;
+import com.example.paul.utils.*;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -17,19 +19,20 @@
 import java.util.HashMap;
 import java.util.Map;
 
+import static com.example.paul.constants.constants.*;
+
 @RestController
 @RequestMapping("api/v1")
 public class TransactionRestController {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(TransactionRestController.class);
 
-    private static final String INVALID_TRANSACTION =
-            "Account information is invalid or transaction has been denied for your protection. Please try again.";
-
+    private final AccountService accountService;
     private final TransactionService transactionService;
 
     @Autowired
-    public TransactionRestController(TransactionService transactionService) {
+    public TransactionRestController(AccountService accountService, TransactionService transactionService) {
+        this.accountService = accountService;
         this.transactionService = transactionService;
     }
 
@@ -47,6 +50,59 @@ public ResponseEntity<?> makeTransfer(
         }
     }
 
+    @PostMapping(value = "/withdraw",
+            consumes = MediaType.APPLICATION_JSON_VALUE,
+            produces = MediaType.APPLICATION_JSON_VALUE)
+    public ResponseEntity<?> withdraw(
+            @Valid @RequestBody WithdrawInput withdrawInput) {
+        LOGGER.debug("Triggered AccountRestController.withdrawInput");
+
+        // Validate input
+        if (InputValidator.isSearchCriteriaValid(withdrawInput)) {
+            // Attempt to retrieve the account information
+            Account account = accountService.getAccount(
+                    withdrawInput.getSortCode(), withdrawInput.getAccountNumber());
+
+            // Return the account details, or warn that no account was found for given input
+            if (account == null) {
+                return new ResponseEntity<>(NO_ACCOUNT_FOUND, HttpStatus.OK);
+            } else {
+                if (transactionService.isAmountAvailable(withdrawInput.getAmount(), account.getCurrentBalance())) {
+                    transactionService.updateAccountBalance(account, withdrawInput.getAmount(), ACTION.WITHDRAW);
+                    return new ResponseEntity<>(SUCCESS, HttpStatus.OK);
+                }
+                return new ResponseEntity<>(INSUFFICIENT_ACCOUNT_BALANCE, HttpStatus.OK);
+            }
+        } else {
+            return new ResponseEntity<>(INVALID_SEARCH_CRITERIA, HttpStatus.BAD_REQUEST);
+        }
+    }
+
+
+    @PostMapping(value = "/deposit",
+            consumes = MediaType.APPLICATION_JSON_VALUE,
+            produces = MediaType.APPLICATION_JSON_VALUE)
+    public ResponseEntity<?> deposit(
+            @Valid @RequestBody DepositInput depositInput) {
+        LOGGER.debug("Triggered AccountRestController.depositInput");
+
+        // Validate input
+        if (InputValidator.isAccountNoValid(depositInput.getTargetAccountNo())) {
+            // Attempt to retrieve the account information
+            Account account = accountService.getAccount(depositInput.getTargetAccountNo());
+
+            // Return the account details, or warn that no account was found for given input
+            if (account == null) {
+                return new ResponseEntity<>(NO_ACCOUNT_FOUND, HttpStatus.OK);
+            } else {
+                transactionService.updateAccountBalance(account, depositInput.getAmount(), ACTION.DEPOSIT);
+                return new ResponseEntity<>(SUCCESS, HttpStatus.OK);
+            }
+        } else {
+            return new ResponseEntity<>(INVALID_SEARCH_CRITERIA, HttpStatus.BAD_REQUEST);
+        }
+    }
+
     @ResponseStatus(HttpStatus.BAD_REQUEST)
     @ExceptionHandler(MethodArgumentNotValidException.class)
     public Map<String, String> handleValidationExceptions(