Feat: Issue#82 POST and GET /user/personal_background api endpoints

[mtreacy002]

Description

Give user the ability to create and get their personal background information.

Fixes #82

Type of Change:

• Code

Code/Quality Assurance Only

• New feature (non-breaking change which adds functionality pre-approved by mentors)

How Has This Been Tested?

• Tested manually by sending POST /user/personal_background (to create personal background of existing user).

• on successful output - personal background information successfully created:
  

• when user already has existing personal background information in the database:
  

• tested manually by sending GET /user/personal_background (to get their personal background information):

• on successful output:
  

• on error response - user has no personal background information in the database:
  

Checklist:

• My PR follows the style guidelines of this project
• I have performed a self-review of my own code or materials
• I have commented my code or provided relevant documentation, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation

Code/Quality Assurance Only

• My changes generate no new warnings
• New and existing unit tests pass locally with my changes
• Any dependent changes have been published in downstream modules

Additional note

• Test cases will be done on a separate PR.
• Personal Background enum input must be taken from the Background enum VALUE from within app/utils/bitschema_utils.py file.

[mtreacy002]

Update @ramitsawhney27 and @anitab-org/bridgeintech-maintainers . Here's PR for POST and GET /user/personal_background api endpoints. The test cases will be submitted separately. Look forward to hear your feedback.

[ramitsawhney27]

This PR (+the tests) look coherent. Good work!

[mtreacy002]

This PR (+the tests) look coherent. Good work!

Thanks, @ramitsawhney27

[mtreacy002]

Update @anitab-org/bridgeintech-maintainers . I've modified background enum logic as per our discussion on BIT weekly meeting. Please re-rerview. Thanks

[mtreacy002]

Update @anitab-org/bridgeintech-maintainers . I've just force pushed changes to add other fields for physical and mental ability as well as socio-economic status.

[mtreacy002]

Update @anitab-org/bridgeintech-maintainers . I've solved merge conflict, fix bug as mentioned on zulip post, and temporarily fix bug as reported on issue #94 (similar approach also applied on PR #80).
Can you please re-review when you have time? Thanks

[foongminwong]

PR81 for issue80 was reviewed and tested. @mtreacy002
review the following conflicting files when you have time 👍

[mtreacy002]

@ramitsawhney27 and @foongminwong, I've resolved the merged conflicts. I think you both need to re-approve it again as your previous approvals were removed by the force pushed.

[foongminwong]

@mtreacy002
When I tried to test POST /user/personal_background using the following input:

{
  "gender": "MALE",
  "age": "DECLINED",
  "ethnicity": "DECLINED",
  "sexual_orientation": "DECLINED",
  "religion": "DECLINED",
  "physical_ability": "DECLINED",
  "mental_ability": "DECLINED",
  "socio_economic": "DECLINED",
  "highest_education": "DECLINED",
  "years_of_experience": "DECLINED",
  "gender_other": "DECLINED",
  "ethnicity_other": "NOT_APPLICABLE",
  "sexual_orientation_other": "DECLINED",
  "religion_other": "DECLINED",
  "physical_ability_other": "DECLINED",
  "mental_ability_other": "DECLINED",
  "socio_economic_other": "DECLINED",
  "highest_education_other": "DECLINED",
  "is_public": true
}

I got the following response:

Do you know which personal background fields input provided is/are not within the given list.?

[mtreacy002]

@foongminwong . As per our last week discussion on the enum logic all pushed to backend, the input fields now only take background VALUE instead of their Keys. So, your input instead of DECLINED should be Prefer not to say. (Note: It's the same as POST. or PUT /user/additional_info where you give Timezone input in its enum value)
Note @anitab-org/bridgeintech-maintainers. I'll add this info in the API endpoint details so collaborator awaree of this.

[mtreacy002]

Update @anitab-org/bridgeintech-maintainers . I've just force pushed with the change on POST /user/personal_background doc string that Background enum input needs the enum VALUE. @ramitsawhney27 and @foongminwong , can you please re-approve? Thanks

[foongminwong]

The changes made in this PR were tested locally. Following are the results:

1. Code review - Done

2. All possible responses were tested as below:

   • POST /user/personal_background
     Screenshot/gif/url:

     

     Description: Above gif output shows users who added their personal background and viewed after that.
     Expected Result: As a user, I should be able to create my personal background.
     Actual Result: Same as expected
     Json:

{
  "gender": "Prefer not to say",
  "age": "Prefer not to say",
  "ethnicity": "Prefer not to say",
  "sexual_orientation": "Prefer not to say",
  "religion": "Prefer not to say",
  "physical_ability": "Prefer not to say",
  "mental_ability": "Prefer not to say",
  "socio_economic": "Prefer not to say",
  "highest_education": "Prefer not to say",
  "years_of_experience": "Prefer not to say",
  "gender_other": "Prefer not to say",
  "ethnicity_other": "Prefer not to say",
  "sexual_orientation_other": "Prefer not to say",
  "religion_other": "Not Applicable",
  "physical_ability_other": "Not Applicable",
  "mental_ability_other": "Not Applicable",
  "socio_economic_other": "Not Applicable",
  "highest_education_other": "Not Applicable",
  "is_public": true
}

• GET /user/personal_background
  Screenshot/gif/url:

  

  Description: Above gif output shows a person who does not have any personal background.
  Expected Result: As a user, I should be able to retrieve my personal background.
  Actual Result: Same as expected

3. OS Version: Windows 10