Implement Update Employer Bank Account Details Endpoint

[PramithaMJ]

Pull Request: Implement Update Employer Bank Account Details Endpoint

Title

Implement Update Employer Bank Account Details Endpoint

Description

This pull request adds functionality to update the bank account details of an employer via a new endpoint /employers/updateEmployerBankAccountDetailsWithId/{employerId}. It includes unit tests to ensure the correctness of the implementation and handles scenarios where the employer exists, doesn't exist, and when the bank details are missing.

Changes Made

New Endpoint Implementation:

• Added a new endpoint in EmployerController to update employer bank account details based on the provided employer ID.
• Implemented the corresponding service method updateEmployerBankAccountDetails in EmployerService to handle the update operation.

Unit Tests:

• Added unit tests for the new endpoint to cover various scenarios:
  • When the employer exists, and bank details exist.
  • When the employer exists, but bank details do not exist.
  • When the employer does not exist.

Example Endpoint Usage:

Request:

POST /lifepill/v1/employers/updateEmployerBankAccountDetailsWithId/299
Content-Type: application/json

{
    "bankName": "new test",
    "bankBranchName": "Example Branch",
    "bankAccountNumber": "1234567890",
    "employerDescription": "Example Employer Description",
    "monthlyPayment": 1000.00,
    "employerId": 299,
    "monthlyPaymentStatus": true
}

Response:

{
    "code": 201,
    "message": "SUCCESS",
    "data": {
        "employerId": 299,
        "branchId": 3,
        "employerNicName": "ch",
        "employerFirstName": "John",
        "employerLastName": "Doe",
        "employerEmail": "emal@dasd.com",
        "employerPhone": "+1234567890",
        "employerAddress": "123 Main Street",
        "employerSalary": 50000.0,
        "employerNic": "ABCD1234",
        "gender": "MALE",
        "dateOfBirth": "1989-12-31T18:30:00.000+00:00",
        "role": "OWNER",
        "pin": 1234,
        "profileImage": null,
        "employerBankDetails": {
            "employerBankDetailsId": 174,
            "bankName": "new test",
            "bankBranchName": "Example Branch",
            "bankAccountNumber": "1234567890",
            "employerDescription": "Example Employer Description",
            "monthlyPayment": 1000.0,
            "monthlyPaymentStatus": true,
            "employerId": 299,
            "employers": null
        },
        "activeStatus": true
    }
}

Impact Analysis

• New Endpoint: Enables clients to update employer bank account details efficiently.
• Enhanced Testing: Ensures the correctness and robustness of the implemented functionality through comprehensive unit tests.

Affected Files

• EmployerController.java (Added new endpoint)
• EmployerService.java (Implemented new method)
• EmployerControllerTest.java (Added unit tests)

Test Plan

• Unit Tests:

  • Validate the functionality of the new endpoint under various scenarios.
  • Ensure correct handling of edge cases such as employer existence, bank details existence, and non-existence.

• Integration Tests:

  • Verify the integration of the new endpoint with the existing application flow.
  • Test the endpoint's behavior in conjunction with other components.

• Manual Testing:

  • Manually test the endpoint using tools like Postman to validate its behavior in real-world scenarios.

Related Issues

• Addresses the need for updating employer bank account details efficiently.

Checklist

• [x] Implemented new endpoint to update employer bank account details.
• [x] Added corresponding service method and repository interactions.
• [x] Ensured comprehensive unit test coverage for the new functionality.
• [x] Verified the correctness of the implementation through manual and automated testing.

Conclusion

This pull request introduces a new endpoint to update employer bank account details, enhancing the functionality of the system. The implementation has been thoroughly tested to ensure reliability and correctness. Please review the changes and provide any feedback for further refinement.

Best regards,
Pramitha Jayasooriya, Backend Developer at LifePill, https://pramithamj.me