Implement New Endpoints and Fix Issues

[PramithaMJ]

Pull Request: Implement New Endpoints and Fix Issues

Title

Implement New Endpoints and Resolve Issues Related to Employer Management

Description

This pull request addresses multiple issues and implements new endpoints related to employer management within the system. The changes include adding functionalities to retrieve branch managers, update branch manager details, and retrieve employers by branch ID and role. Additionally, it fixes issues related to branch manager retrieval and employer updates.

Changes Made

1. New Endpoints

• Branch Managers Retrieve: Implemented an endpoint to retrieve branch managers by branch ID.
• Change Manager Update: Added functionality to update branch managers, including handling changes in the backend and reflecting updates in the database.
• Update Existing Branch Manager Details: Implemented an endpoint to update existing branch manager details.
• Branch Employer Retrieve by Branch ID and Role: Added an endpoint to retrieve branch employers by branch ID and role.
• Get Employers By Branch ID: Implemented an endpoint to retrieve all employers associated with a specific branch.

2. Issue Fixes

• Resolved issues related to branch manager retrieval and employer updates, ensuring smooth functionality and error handling.

Updated Endpoints

• Branch Managers Retrieve: GET /lifepill/v1/branch-manager/managers/by-branch/{branchId}
• Change Manager Update: POST /lifepill/v1/branch-manager/change-manager
• Update Existing Branch Manager Details: PUT /lifepill/v1/branch-manager/managers/by-branch/{branchId}
• Branch Employer Retrieve by Branch ID and Role: GET /lifepill/v1/branch-manager/employer/by-branch/role/{branchId}?role={role}
• Get Employers By Branch ID: GET /lifepill/v1/employers/get-employers-by-branch/{branchId}

Acceptance Criteria

• All new endpoints should retrieve data accurately and handle errors gracefully.
• Endpoints should return appropriate responses, including success messages and error codes, as per the acceptance criteria defined for each issue.

Test Plan

• Unit tests for each new endpoint to verify functionality.
• Integration testing to ensure proper interaction with the database and other components.
• Manual testing in a local environment to validate endpoint responses and error handling.

Endpoints

1. Branch Managers Retrieve

• URL: GET /lifepill/v1/branch-manager/managers/by-branch/{branchId}
• Request: No request body required. Replace {branchId} in the URL with the actual branch ID.
• Response:

  {
  "code": 200,
  "message": "Branch Manager retrieve successfully",
  "data": [
      {
          "employerId": 425,
          "branchId": 1,
          "employerNicName": "new",
          "employerFirstName": "aaaa",
          "employerLastName": "ja",
          "employerEmail": "aaaq@gmail.com",
          "employerPhone": null,
          "employerAddress": "123 Main Street, City",
          "employerSalary": 50000.0,
          "employerNic": "123456789V",
          "gender": "MALE",
          "dateOfBirth": "1989-12-31T18:30:00.000+00:00",
          "role": "MANAGER",
          "pin": 0,
          "profileImage": null,
          "activeStatus": false
      }
  ]
  }

2. Change Manager Update

• URL: POST /lifepill/v1/branch-manager/change-manager
• Request:

  {
  "formerManagerId": 2,
  "branchId": 1,
  "newManagerId": 425,
  "currentManagerNewRole": "OTHER",
  "newManagerRole": "MANAGER"
  }

• Response:

  {
  "code": 200,
  "message": "Branch Manager changed successfully",
  "data": {
      "branchId": 1,
      "newManager": {
          "branchId": 1,
          "employerFirstName": "aaaa",
          "employerLastName": "ja",
          "employerEmail": "aaaq@gmail.com",
          "employerPassword": "$2a$10$eKBT.15D5xmuaqBsjynSAOeeWKkGktAIuR/bhjD5p8Lvc.aT8XlHG",
          "role": "MANAGER",
          "pin": 0
      },
      "formerManager": {
          "branchId": 1,
          "employerFirstName": "John",
          "employerLastName": "Doe",
          "employerEmail": "12345gh@example.com",
          "employerPassword": "password2",
          "role": "OTHER",
          "pin": 1234
      }
  }
  }

3. Update Existing Branch Manager Details

• URL: PUT /lifepill/v1/branch-manager/managers/by-branch/{branchId}
• Request:

  {
  "branchId": 2,
  "employerFirstName": "John",
  "employerLastName": "Doe",
  "employerEmail": "12345gh@example.com",
  "employerPassword": "password123",
  "role": "MANAGER",
  "pin": 1234
  }

• Response:

  {
  "code": 200,
  "message": "Update Branch Manager",
  "data": {
      "employerId": 2,
      "branchId": 2,
      "employerNicName": "NicName2",
      "employerFirstName": "John",
      "employerLastName": "Doe",
      "employerPassword": "password2",
      "employerEmail": "12345gh@example.com",
      "employerPhone": "234-567-8901",
      "employerAddress": "456 Elm St",
      "employerSalary": 2800.0,
      "employerNic": "234567890123",
      "gender": "FEMALE",
      "dateOfBirth": "1991-02-01T18:30:00.000+00:00",
      "role": "MANAGER",
      "pin": 1234,
      "profileImage": null,
      "activeStatus": true
  }
  }

4. Branch Employer Retrieve by Branch ID and Role

• URL: GET /lifepill/v1/branch-manager/employer/by-branch/role/{branchId}?role={role}
• Request: No request body required. Replace {branchId} in the URL with the actual branch ID and {role} with the desired role.
• Response:

  {
  "code": 200,
  "message": "Get Manager by branch Id",
  "data": [
      {
          "employerId": 2,
          "branchId": 2,
          "employerNicName": "NicName2",
          "employerFirstName": "Jane",
          "employerLastName": "Smith",
          "employerPassword": "password2",
          "employerEmail": "jane@example.com",
          "employerPhone": "234-567-8901",
          "employerAddress": "456 Elm St",
          "employerSalary": 2800.0,
          "employerNic": "234567890123",
          "gender": "FEMALE",
          "dateOfBirth": "1991-02-01T18:30:00.000+00:00",
          "role": "MANAGER",
          "pin": 2345,
          "profileImage": null,
          "activeStatus": true
      }
  ]
  }

5. Get Employers By Branch ID

• URL: GET /lifepill/v1/employers/get-employers-by-branch/{branchId}
• Request: No request body required. Replace {branchId} in the URL with the actual branch ID.
• Response:

  {
  "code": 200,
  "message": "SUCCESS",
  "data": [
      {
          "employerId": 1,
          "employerFirstName": "John",
          "employerLastName": "Doe"
      },
      ...
  ]
  }

Related Issues

• [Issue #122]: Implement Endpoint to Retrieve Employer Name and ID
• [Issue #121]: Implement Endpoint to Retrieve Branch Manager
• [Issue #120]: Add Functionality to Update Branch Manager

Checklist

• [x] Implemented new endpoints as per the provided specifications.
• [x] Fixed issues related to branch manager retrieval and employer updates.
• [x] Verified functionality through unit tests, integration tests, and manual testing.
• [x] Ensured proper error handling and response messages for all endpoints.

ScreenShot

Conclusion

This pull request enhances employer management functionalities within the system by adding new endpoints and resolving issues related to branch manager retrieval and updates. Reviewers are encouraged to test the new functionalities thoroughly and provide feedback.

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

[sonarcloud[bot]]

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud