Feat: POST/GET/PUT program and list of programs #114

mtreacy002 · 2020-08-19T10:59:58Z

Description

Added create, gt and update programs using the following endpoints:

POST /organizations/{organization_id}/programs/program
- to create program on the ogranization where the logged-in user is the representative. If they are not the representative, this action is not permitted.
GET /organizations/{organization_id}/programs
- to get list of programs under the organization specified in the parameter organization_id.
  The purpose of this endpoint is so on the frontend, when user go to Organizations > 'Organization-Portfolo`, they can see the list of programs that organization have. Any user can retrieve this list.
GET /organizations/{organization_id}/programs/{program_id}

to get the detail of a specific program that a specific organization has.
The purpose of this endpoint is so that logged-in user can view the details on a specific program after selecting it from the list of programs from API endpoint number 2 above.

PUT /organizations/{organization_id}/programs/{program_id}
- to update the detail of a specific program that matches the parameters organization_id and program_id.

Fixes #113

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?

Note: The screenshots below are selected from random data

logged in as a user who represents an organization
test create PUT /organizations/{organization_id}/programs/{program_id} using POST /organizations/{organization_id}/programs/program endpoint. Upon succesful process, see code 201 and message below

test GET /organizations/{organization_id}/programs. on successful response see below:

test update by sending the PUT /organizations/{organization_id}/programs/{program_id} with the correct organization_id and program_id . Upon successful update, get message

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

Code/Quality Assurance Only

My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes

mtreacy002 · 2020-08-19T11:15:12Z

Update @anitab-org/bridgeintech-maintainers . I've completed the POST/GET/PUT program functionalities. Note that atm I only GET endpoint for Programs list using organizations/{organization_id}/programs path as at frontend this is one of my target feature (viewing Programs list under specific organization) (at least for the remaining of GSoC). The next one i need to do is Send Application functionality for user to apply to a program.
Later, perhaps post gsoc, we can work on another route to view list of programs, such as:

GET /users/{user_id}/programs - for list of programs where user whose ID is passed as parameters is involved in (either as mentor or mentee)

NOTE I will write the test cases for these PR endpoints on a separate PR as this PR already pretty big.

Please review when you have time. Thanks

ramitsawhney27 · 2020-08-19T19:11:26Z

app/api/dao/program.py

+            return user.message, user.status_code
+
+        programs = ProgramModel.get_all_programs_by_organization(organization_id)
+        list_of_programs = []


Why not declare list of programs after “if not programs:”
Also, lines 69-70 can just be a list comprehension

Got it. Changed now

ramitsawhney27 · 2020-08-19T19:12:40Z

app/api/dao/program.py

+
+def update(program, data, success_message, status_code):
+    target_candidate_data = {}
+    try:


I think some info should be given if it is a bad request, such as which field(s) is malformed

@ramitsawhney27 , I do it this way coz for the fields that required specific format, the validation already done specific to each fields in the preceding code (inside app/api/resources/organizations.py) line 105

as for the TypeError e done here, will specify which fields other than those catch in the above that is malformed. Let me know if you have another alternative. Thanks

ramitsawhney27 · 2020-08-19T19:14:00Z

app/api/validations/organization.py

+        if not is_phone_valid(mobile):
+            return messages.PHONE_OR_MOBILE_IS_NOT_IN_NUMBER_FORMAT
+    except ValueError as e:
+        return e


Why is e being returned? Can you add a comment to the code to explain this to future readers?

Done. Refactored email, phone and mobile to LBYL instead of EAFP as the LBYL makes more sense in this situation and use less lines of codes

mtreacy002 · 2020-08-19T23:45:21Z

Update @anitab-org/bridgeintech-maintainers, I've pushed the changes requested by @ramitsawhney27 . Can you please check again? Thanks

ramitsawhney27 · 2020-08-20T01:37:55Z

app/api/dao/program.py

+        programs = ProgramModel.get_all_programs_by_organization(organization_id)
+        if not programs:
+            return messages.NO_PROGRAM_FOUND, HTTPStatus.NOT_FOUND
+        list_of_programs = []


Lines 68-70 (even 71) can be condensed into 1 line using list comprehension. Could you please do that?

Done, @ramitsawhney27 . It surely looks better now. Thanks heaps for the tips. 😉

Refactor validations refactor list_of_programs to use list comprehension Remove is_organization_rep being returned upon login

mtreacy002 · 2020-08-23T04:21:26Z

Update @ramitsawhney27 and @anitab-org/bridgeintech-maintainers . I've removed the is_organization_rep from being returned when the user login as per @meenakshi-dhanani advice here. Can you please re-review this PR? Thanks

meenakshi-dhanani · 2020-08-23T07:56:45Z

Paired with @mtreacy002 to test this! LGTM!

foongminwong

For future reference,
This is a test case for PUT /organization:

{
  "representative_department": "momo",
  "name": "moasdea",
  "email": "maomo@test.com",
  "about": "moamo",
  "address": "123 test street",
  "website": "string",
  "timezone": "America/New_York",
  "phone": "123-445-232",
  "status": "Publish"
}

This is a test case for POST /organizations/{organization_id}/programs/program:

{
  "program_name": "Enhance soft skill program",
  "start_date": "2020-08-25 00:00",
  "end_date": "2020-09-22 11:11",
  "description": "come join us ",
  "target_skills": [
    "Public Speaking"
  ],
  "target_candidate_gender": "Not Applicable",
  "target_candidate_age": "Not Applicable",
  "target_candidate_ethnicity": "Not Applicable",
  "target_candidate_sexual_orientation": "Not Applicable",
  "target_candidate_religion": "Not Applicable",
  "target_candidate_physical_ability": "Not Applicable",
  "target_candidate_mental_ability": "Not Applicable",
  "target_candidate_socio_economic": "Not Applicable",
  "target_candidate_highest_education": "Not Applicable",
  "target_candidate_years_of_experience": "Not Applicable",
  "target_candidate_other": "",
  "payment_currency": "USD",
  "payment_amount": 0,
  "contact_type": "Face-to-face",
  "zone": "Global",
  "student_responsibility": [
    "string"
  ],
  "mentor_responsibility": [
    "string"
  ],
  "organization_responsibility": [
    "string"
  ],
  "student_requirements": [
    "string"
  ],
  "mentor_requirements": [
    "string"
  ],
  "resources_provided": [
    "string"
  ],
  "contact_name": "nicole",
  "contact_department": "momo department",
  "program_address": "123 test street",
  "contact_phone": "123-456-333",
  "contact_mobile": "123-333-333",
  "contact_email": "1sdas@df.com",
  "program_website": "https://123web.com",
  "irc_channel": "momo123",
  "tags": [
    "career"
  ],
  "status": "Open"
}

Bug: Refactor login to return is_organization_representative value

ea223ba

mtreacy002 requested review from ramitsawhney27 and a team August 19, 2020 11:16

mtreacy002 self-assigned this Aug 19, 2020

mtreacy002 added Category: Coding Changes to code base or refactored code that doesn't fix a bug. Program: GSOC Related to work completed during the Google Summer of Code Program. labels Aug 19, 2020

ramitsawhney27 suggested changes Aug 19, 2020

View reviewed changes

mtreacy002 force-pushed the feat-get-put-program-and-tests branch from e37ad31 to d10a27a Compare August 19, 2020 23:41

ramitsawhney27 reviewed Aug 20, 2020

View reviewed changes

mtreacy002 force-pushed the feat-get-put-program-and-tests branch from d10a27a to 661f41d Compare August 20, 2020 02:08

ramitsawhney27 previously approved these changes Aug 20, 2020

View reviewed changes

Feat: POST/GET/PUT Program ad GET list of programs

561b728

Refactor validations refactor list_of_programs to use list comprehension Remove is_organization_rep being returned upon login

mtreacy002 dismissed ramitsawhney27’s stale review via 561b728 August 23, 2020 04:17

mtreacy002 force-pushed the feat-get-put-program-and-tests branch from 661f41d to 561b728 Compare August 23, 2020 04:17

mtreacy002 requested review from ramitsawhney27 and a team August 23, 2020 04:21

ramitsawhney27 approved these changes Aug 23, 2020

View reviewed changes

mtreacy002 mentioned this pull request Aug 23, 2020

Dev refactor date fields to a human readable format #116

Merged

5 tasks

meenakshi-dhanani approved these changes Aug 23, 2020

View reviewed changes

meenakshi-dhanani merged commit 160bc61 into anitab-org:develop Aug 23, 2020

foongminwong reviewed Aug 25, 2020

View reviewed changes

mtreacy002 deleted the feat-get-put-program-and-tests branch August 30, 2020 11:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: POST/GET/PUT program and list of programs #114

Feat: POST/GET/PUT program and list of programs #114

mtreacy002 commented Aug 19, 2020

mtreacy002 commented Aug 19, 2020 •

edited

ramitsawhney27 Aug 19, 2020

mtreacy002 Aug 19, 2020

ramitsawhney27 Aug 19, 2020

mtreacy002 Aug 19, 2020

ramitsawhney27 Aug 19, 2020

mtreacy002 Aug 19, 2020

mtreacy002 commented Aug 19, 2020

ramitsawhney27 Aug 20, 2020

mtreacy002 Aug 20, 2020

mtreacy002 commented Aug 23, 2020

meenakshi-dhanani commented Aug 23, 2020

foongminwong left a comment •

edited

Feat: POST/GET/PUT program and list of programs #114

Feat: POST/GET/PUT program and list of programs #114

Conversation

mtreacy002 commented Aug 19, 2020

Description

Type of Change:

How Has This Been Tested?

Checklist:

mtreacy002 commented Aug 19, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mtreacy002 commented Aug 19, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mtreacy002 commented Aug 23, 2020

meenakshi-dhanani commented Aug 23, 2020

foongminwong left a comment • edited

Choose a reason for hiding this comment

mtreacy002 commented Aug 19, 2020 •

edited

foongminwong left a comment •

edited