Created API endpoint for GET request (list view) for USERS with proper JWT authentication #77

Esterello2 · 2023-10-30T18:10:00Z

Modified views.py, urls.py, and serialization.py to establish endpoint for GET User (List View) with JWT authentication. This included adding the simpleJWT module from rest framework, along with JWT token built-in API views to allow the for the generation and refresh of tokens.
A POST User request API endpoint was also created here, which was also originally meant to deal with JWT authentication, however, team decided to make it an open endpoint.

Specifies how user data should be serialized

added UserCreateView to allow for the POST of users

added a view to deal with creating a new User

Added a check for authenticated users only to be able to send GET, POST, and PATCH requests for User info.

Esterello2 · 2023-11-13T07:04:18Z

Updated the PR by deleting the old files from the "users" directory, and adding the serializers, views, urls, and permissions files in a directory called API.

…s/post-users

Esterello2 · 2023-11-27T17:43:34Z

Made a big update here, I added simple JWT authentication by importing the simpleJWT module from the rest_framework app. I incorporated three new views that deal with generating, refreshing, and verifying JWT tokens to properly authenticate API requests for POST and GET for User info.

cuyakonwu · 2023-11-28T19:14:58Z

src/chigame/api/permissions.py

Any reason you check for unauthentication as opposed to authentication?

Thanks for pointing this out, it was originally done like this because the only POST requests for Users I had in mind were when new users were creating accounts. I will remove this and update with the new implementation we agreed on that only admin users can create new users through API request.

cuyakonwu

Looks good generally! Please try to get back to the comments I made on the code though.

cuyakonwu · 2023-11-28T19:16:30Z

src/chigame/api/serializers.py

Glad you condensed the user serializers! Any reason for the notification serializer in this PR specifically?

Thank you for pointing this out, I was actually testing this out by making a serializer for the Notification model, but I will actually look to remove this now to keep the PR organized.

cuyakonwu · 2023-11-28T19:17:34Z

src/chigame/api/urls.py

Please leave the comments in, it helps with organization.

Esterello2 · 2023-12-01T21:19:02Z

Added proper JWT authentication to a POST User API endpoint that allows a successful POST only if a valid JWT token is provided. Also, incorporated in the User List View all to ensure only Authenticated entities can see all users info. Deleted the extraneous code Conrad mentioned.

…s/post-users

Esterello2 · 2023-12-03T22:55:21Z

Made a final edit after consulting team to take off JWT Authentication method for POST new users, and only kept it for ListView of Users.

Esterello2 · 2023-12-06T00:52:40Z

A quick overview of using Postman to test JWT authentication on the GET User listview API endpoint:

To generate a token, you have to go to the api/token/ url endpoint in the DRF GUI endpoint.
Enter superuser credentials (email: esteban@test.com pass: Estetheyan)
It will return two token strings, one that says refresh and other that says accept
Copy the "accept" one, and then this is the part that so far can only be done on Postman interface
Postman lets you send a GET request to a protected endpoint with the token you copied.
Enter the appropriate URL (~/api/users/)
In the Auth tab in the Postman interface, select the dropdown under type that says "Bearer Token", and paste token string into the "Token" field on the right.
Ensuring "GET" is selected as Request type, select Send.

jwt-postman.snip.mp4

majorsylvie

I can successfully NOT access /api/users when I don't use JWT authentication.

Yet I can still POST users (as you've said the team has decided to allow)

Then I can successfully view the api/users when GET requesting the endpoint with a proper JWT token, as generated from api/token (and verifiable as a successful token by visiting api/token/verify and POSTing the access token I got from api/token.

There are multiple comments about extraneous code. Please resolve then we can merge your actual functionality!

src/chigame/api/urls.py

majorsylvie · 2023-12-06T01:11:34Z

src/chigame/api/urls.py

-    # LOBBY API URLS
+    path("tournaments/create/", views.TournamentCreateView.as_view(), name="create-tournament"),
+    path("tournaments/", views.TournamentListView.as_view(), name="tournament-list"),
+    path("register/", views.UserRegistrationView.as_view(), name="user-registration"),


What is the point of this register endpoint?
Upon trying to access it it, it doesn't allow get.
You don't mention it in your JWT walkthrough, nor have any code comments explaining this.
Please either remove this URL, or explain and justify why this endpoint should be in this PR!

The register endpoint is the POST new user endpoint that does not have JWT, should I name it something more clear?

Yes please!

could also be api/usersregister`

src/chigame/api/views.py

majorsylvie

Seeing that you removed the tournament code from this PR, this is almost good to merge! Please add a code comment and make the register endpoint named more clearly.

Other than that, given the JWT GET users functionality is working as it's supposed to, this will be good to merge!

majorsylvie · 2023-12-07T20:24:58Z

src/chigame/api/urls.py

-    # LOBBY API URLS
+    path("tournaments/create/", views.TournamentCreateView.as_view(), name="create-tournament"),
+    path("tournaments/", views.TournamentListView.as_view(), name="tournament-list"),
+    path("register/", views.UserRegistrationView.as_view(), name="user-registration"),


Yes please!

majorsylvie · 2023-12-07T20:25:13Z

src/chigame/api/urls.py

-    # LOBBY API URLS
+    path("tournaments/create/", views.TournamentCreateView.as_view(), name="create-tournament"),
+    path("tournaments/", views.TournamentListView.as_view(), name="tournament-list"),
+    path("register/", views.UserRegistrationView.as_view(), name="user-registration"),


could also be api/usersregister`

Esterello2 added 3 commits October 30, 2023 11:52

Create serializers.py

90d71a7

Specifies how user data should be serialized

Update urls.py

d9792c7

added UserCreateView to allow for the POST of users

Update views.py

fd712df

added a view to deal with creating a new User

Esterello2 requested review from majorsylvie and cuyakonwu October 30, 2023 18:10

Esterello2 self-assigned this Oct 30, 2023

Esterello2 and others added 3 commits November 6, 2023 12:00

Update views.py

734d40d

Added a check for authenticated users only to be able to send GET, POST, and PATCH requests for User info.

Update

e48159f

Deleted some files

f3bc490

Esterello2 marked this pull request as draft November 13, 2023 06:42

Esterello2 changed the title ~~Apis/post users~~ Created API endpoint for POST requests for users with proper authentication method Nov 13, 2023

Esterello2 marked this pull request as ready for review November 13, 2023 07:03

majorsylvie added the x/api label Nov 14, 2023

majorsylvie modified the milestones: 2023/Sprint 1, 2023/Sprint 3 Nov 14, 2023

Merge branch 'dev' of https://github.com/uchicago-cs/chigame into api…

7ec1924

…s/post-users

majorsylvie changed the title ~~Created API endpoint for POST requests for users with proper authentication method~~ Created API endpoint for POST requests for users with proper JWT authentication Nov 27, 2023

cuyakonwu reviewed Nov 28, 2023

View reviewed changes

cuyakonwu approved these changes Nov 28, 2023

View reviewed changes

Esterello2 and others added 2 commits December 1, 2023 14:33

Fixed CI error

6525622

Merge branch 'dev' into apis/post-users

ed8943a

Esterello2 added 5 commits December 1, 2023 15:29

Fixing CI issues

d4d41c1

fixing CI issue in urls.py

23ae6ea

Fixing CI issues

b04b0fa

Fixing CI

6ee326c

Fix CI

8be6de9

Esterello2 changed the title ~~Created API endpoint for POST requests for users with proper JWT authentication~~ Created API endpoint for POST requests for users and GET list view for USERS with proper JWT authentication Dec 1, 2023

majorsylvie and others added 2 commits December 3, 2023 12:06

Merge branch 'dev' into apis/post-users

c2331b4

Merge branch 'dev' into apis/post-users

74a189d

cuyakonwu approved these changes Dec 3, 2023

View reviewed changes

Esterello2 added 3 commits December 3, 2023 16:29

CI update

d4d3b89

Merge branch 'dev' of https://github.com/uchicago-cs/chigame into api…

c0b0444

…s/post-users

update

fd0ed4b

Esterello2 and others added 8 commits December 4, 2023 20:18

update

3842b7e

ipdate

5375012

Merge branch 'dev' into apis/post-users

4999700

update

1012d69

updated

6d896f5

update

1b977ed

Merge branch 'dev' into apis/post-users

6b4988c

Merge branch 'dev' into apis/post-users

d47a503

Esterello2 changed the title ~~Created API endpoint for POST requests for users and GET list view for USERS with proper JWT authentication~~ Created API endpoint for GET request (list view) for USERS with proper JWT authentication Dec 6, 2023

Esterello2 and others added 2 commits December 5, 2023 18:54

Merge branch 'dev' into apis/post-users

db313f6

linter

3516339

majorsylvie requested changes Dec 6, 2023

View reviewed changes

majorsylvie mentioned this pull request Dec 6, 2023

Implementing test cases to GET and DELETE user models at the api/users endpoint #335

Open

majorsylvie and others added 4 commits December 5, 2023 19:45

Merge branch 'dev' into apis/post-users

074d813

Merge branch 'dev' into apis/post-users

c0bfd4c

linting

e6670af

update

31d910c

majorsylvie self-requested a review December 7, 2023 20:23

majorsylvie requested changes Dec 7, 2023

View reviewed changes

cuyakonwu and others added 2 commits December 7, 2023 15:27

Merge branch 'dev' into apis/post-users

d0726f7

Merge branch 'dev' into apis/post-users

15e23ee

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Created API endpoint for GET request (list view) for USERS with proper JWT authentication #77

Created API endpoint for GET request (list view) for USERS with proper JWT authentication #77

Esterello2 commented Oct 30, 2023 •

edited

Esterello2 commented Nov 13, 2023

Esterello2 commented Nov 27, 2023

cuyakonwu Nov 28, 2023

Esterello2 Dec 1, 2023 •

edited

cuyakonwu left a comment

cuyakonwu Nov 28, 2023

Esterello2 Dec 1, 2023

cuyakonwu Nov 28, 2023

Esterello2 commented Dec 1, 2023

Esterello2 commented Dec 3, 2023

Esterello2 commented Dec 6, 2023

majorsylvie left a comment

majorsylvie Dec 6, 2023

Esterello2 Dec 6, 2023

majorsylvie Dec 7, 2023

majorsylvie Dec 7, 2023

majorsylvie left a comment

majorsylvie Dec 7, 2023

majorsylvie Dec 7, 2023

Created API endpoint for GET request (list view) for USERS with proper JWT authentication #77

Are you sure you want to change the base?

Created API endpoint for GET request (list view) for USERS with proper JWT authentication #77

Conversation

Esterello2 commented Oct 30, 2023 • edited

Esterello2 commented Nov 13, 2023

Esterello2 commented Nov 27, 2023

Choose a reason for hiding this comment

Esterello2 Dec 1, 2023 • edited

Choose a reason for hiding this comment

cuyakonwu left a 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

Esterello2 commented Dec 1, 2023

Esterello2 commented Dec 3, 2023

Esterello2 commented Dec 6, 2023

majorsylvie left a 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

majorsylvie left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Esterello2 commented Oct 30, 2023 •

edited

Esterello2 Dec 1, 2023 •

edited