feat: create GET/mentorship_relations API #168

khushishikhu · 2020-10-03T20:52:27Z

Description

added GET/mentorship_relations API endpoints

Fixes #162

Type of Change:

Code
User Interface
Documentation

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
Any dependent changes have been merged

anitab-org#162

mtreacy002

@khushishikhu , it's best to create a new file for this task (you can call it mentorship_relations.py) instead of using the users.py. Also, please check my comment below.

mtreacy002 · 2020-10-05T02:54:08Z

app/api/resources/users.py

+        per_page = request.args.get("per_page", default=DEFAULT_USERS_PER_PAGE, type=int)
+
+
+        return http_response_checker(get_request("/users/verified", token))


why is this retuning verified users and not mentorship rrelations the login user?

khushishikhu · 2020-10-08T07:02:43Z

@mtreacy002 i think we need to add the file mentorship_relation.py in the folder dao , resources and models

khushishikhu · 2020-10-08T16:46:25Z

@mtreacy002 i just need a help, i don't know why i can't see the "mentorship relation" endpoint on the page. Through the changes i have made

mtreacy002 · 2020-10-14T03:26:08Z

@khushishikhu , you also need to add the new mentorship_relation to the namespace so you can use it as @mentorship_relations_ns in the route, just like we did to users_ns and organization_ns.

mtreacy002 · 2020-10-18T09:51:40Z

@khushishikhu , can you please give me an update on this issue?

khushishikhu · 2020-10-18T11:04:55Z

@mtreacy002 sorry for not updating you, i am still working on the issue , will update you in 2-3 days

mtreacy002 · 2020-10-18T11:34:16Z

@mtreacy002 sorry for not updating you, i am still working on the issue , will update you in 2-3 days

No worries, @khushishikhu. Let me know if you need any help 😉.

khushishikhu · 2020-10-20T16:21:05Z

@mtreacy002 i have done the changes please review it now. and help me to know what else is needed. thank you.

mtreacy002 · 2020-10-23T21:43:49Z

Thanks, @khushishikhu . I'll review this PR today

mtreacy002

@khushishikhu. There are a couple of things need to be modified on this PR. Also, just want to make sure you understand the task involve in this PR.

BIT is using existing mentorship_relation of MS System when creating a relation between program and mentor/mentee. Along with this, BIT also create an instance of mentorship_relations_extension which holds that specific information related to BIT that MS doen't have in its mentorship_relation table. When getting information on mentorship relation, the GET /mentorship_relations request will be sent to MS backend, and the response will be matched to the list of objects on mentorship_relations_extension so that an array of objects that contains info on both tables can be returned to user.
At the moment, the code you provided here are duplication of MS backend for mentorship relation.
the focus of this PR is on GET mentorship_relations endpoint, not creating the mentorship relation itself. Since the issue Feat: create POST /organizations /{organization_id} /programs/{program_id} /send_request #161 is still in progress (meaning you won't be able to show HTTPStatus.OK on the GET request) you can still work on error responses first like Not Found, Internal Server Error or Unauthorized responses.

Let me know if you need any help.

mtreacy002 · 2020-10-27T02:29:50Z

app/api/resources/mentorship_relation.py

+    @mentorship_relation_ns.marshal_list_with(mentorship_request_response_body)
+    def get(cls):
+        """
+        Lists all mentorship relations of current user.


can you please give a more informative description on what the endpoint is about. You can use similar style on User's GET /users endpont below.

Points to show:

the need of valid token

the type of input

what's being returned and what information are given.

Thankyou for letting me i was just confused for what needs to show

mtreacy002 · 2020-10-27T02:45:55Z

app/api/dao/mentorship_relation.py

+    MAXIMUM_MENTORSHIP_DURATION = timedelta(weeks=24)  # 6 months = approximately 6*4
+    MINIMUM_MENTORSHIP_DURATION = timedelta(weeks=4)
+
+    def create_mentorship_relation(self, user_id: int, data: Dict[str, str]):


There is no need to duplicate the DAO functionality already existed in Mentorship System Backend for creating mentorship_relation instance. You only need to send GET request to the MS Backend for this. On the BIT side you need to create the dao functionality related to Mentorship Relation Extension table that belongs to bitschema (hence, the name of the file also will reflect the content, mentorship_relation_extension.py - under the dao folder only). Although, the function you need to focus on this PR is only the get functionality (not create) since the create function will be dealt with in other issue (#161).

khushishikhu · 2020-11-04T04:46:52Z

@mtreacy002 sorry i just got busy in some other work. i will give you an update on this at the EOD.

khushishikhu · 2020-11-04T06:07:58Z

@mtreacy002 i have made the error responses like Internal Server Error or Unauthorized whereas right now i am not able to show HTTPStatus.OK (as that will depend on the completion of issue #161)

mtreacy002 · 2020-11-22T11:30:41Z

Sorry for the late reply, @khushishikhu. Sure, I'll check it out. If need to, I will create a separate PR for status OK which will be made available when issue #161 is finalised and will just review this PR based on the specific error responses you've created here. Will let you know.

feat: create GET/mentorship_relations API

2ddb2c2

anitab-org#162

mtreacy002 requested changes Oct 5, 2020

View reviewed changes

khushishikhu added 4 commits October 8, 2020 16:29

Update users.py

799e1b2

Create mentorship_relation.py

a934b48

Create mentorship_relation.py

381500e

Create mentorship_relation.py

16391b3

mtreacy002 added Category: Coding Changes to code base or refactored code that doesn't fix a bug. hacktoberfest-accepted Issue that is accepted to the Hactoberfest Type: Enhancement New feature or request. labels Oct 14, 2020

khushishikhu added 3 commits October 20, 2020 21:42

Update mentorship_relation.py

da90862

Update bit_extension.py

0c643a9

Update mentorship_relation.py

2ef70b4

khushishikhu requested a review from mtreacy002 October 20, 2020 16:18

mtreacy002 requested changes Oct 27, 2020

View reviewed changes

mtreacy002 mentioned this pull request Jan 26, 2021

Feat: create GET /mentorship_relations API endpoint #162

Open

4 tasks

mtreacy002 added the Status: On Hold Issue or PR needs more info, a discussion, a review or approval from a Maintainer/Code Owner. label Jan 26, 2021

mtreacy002 added this to In Progress in BIT Roadmap Apr 5, 2021

mtreacy002 moved this from In Progress to Code Review in BIT Roadmap Apr 5, 2021

mtreacy002 removed this from Code Review in BIT Roadmap Apr 5, 2021

mtreacy002 added this to In Progress in BIT Roadmap via automation Apr 5, 2021

mtreacy002 moved this from In Progress to Code Review in BIT Roadmap Apr 5, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: create GET/mentorship_relations API #168

feat: create GET/mentorship_relations API #168

khushishikhu commented Oct 3, 2020 •

edited

Loading

mtreacy002 left a comment

mtreacy002 Oct 5, 2020

khushishikhu commented Oct 8, 2020

khushishikhu commented Oct 8, 2020 •

edited

Loading

mtreacy002 commented Oct 14, 2020

mtreacy002 commented Oct 18, 2020

khushishikhu commented Oct 18, 2020

mtreacy002 commented Oct 18, 2020

khushishikhu commented Oct 20, 2020

mtreacy002 commented Oct 23, 2020

mtreacy002 left a comment

mtreacy002 Oct 27, 2020

khushishikhu Nov 4, 2020

mtreacy002 Oct 27, 2020 •

edited

Loading

khushishikhu commented Nov 4, 2020

khushishikhu commented Nov 4, 2020

mtreacy002 commented Nov 22, 2020

		per_page = request.args.get("per_page", default=DEFAULT_USERS_PER_PAGE, type=int)


		return http_response_checker(get_request("/users/verified", token))

feat: create GET/mentorship_relations API #168

Are you sure you want to change the base?

feat: create GET/mentorship_relations API #168

Conversation

khushishikhu commented Oct 3, 2020 • edited Loading

Description

Type of Change:

Checklist:

mtreacy002 left a comment

Choose a reason for hiding this comment

mtreacy002 Oct 5, 2020

Choose a reason for hiding this comment

khushishikhu commented Oct 8, 2020

khushishikhu commented Oct 8, 2020 • edited Loading

mtreacy002 commented Oct 14, 2020

mtreacy002 commented Oct 18, 2020

khushishikhu commented Oct 18, 2020

mtreacy002 commented Oct 18, 2020

khushishikhu commented Oct 20, 2020

mtreacy002 commented Oct 23, 2020

mtreacy002 left a comment

Choose a reason for hiding this comment

mtreacy002 Oct 27, 2020

Choose a reason for hiding this comment

khushishikhu Nov 4, 2020

Choose a reason for hiding this comment

mtreacy002 Oct 27, 2020 • edited Loading

Choose a reason for hiding this comment

khushishikhu commented Nov 4, 2020

khushishikhu commented Nov 4, 2020

mtreacy002 commented Nov 22, 2020

khushishikhu commented Oct 3, 2020 •

edited

Loading

khushishikhu commented Oct 8, 2020 •

edited

Loading

mtreacy002 Oct 27, 2020 •

edited

Loading