BQuest

Setup

Install docker and docker-compose.
run git submodule init && git submodule update in root (for websockets)
run make build && make run in the root directory (this one)
In another window, run make init_db to set up some default values for everything
(opt) Run make run_command "cmd=python src/manage.py populate_tables" to load values into Major, Minor, Course tables

Project Organization

Simplified tree diagram

.  # Contains docker setup and Makefile
├── docker-compose.yml  # defines setup of PostgreSQL and Django
├── Dockerfile  # defines pickmybruin/backend Docker image
├── initialize.sh  # sets up Django container (runs migrations and then boots server)
├── Makefile  # contains very useful helper commands
└── src  # Contains all Django code
    ├── pickmybruin  # Contains code relating to the entire website
    │   ├── keys.py  # put confidential info in here
    │   ├── settings.py  # global settings (please keep confidential info out of here)
    │   ├── urls.py  # global URLs (usually imports app URLs too)
    └── users  # One app for just users
        ├── admin.py  # sets up /admin pages
        ├── models.py  # contains class declarations and methods
        ├── serializers.py  # contains serializers for classes 
        ├── tests.py  # necessary (pls)
        ├── urls.py  # sets up app specific URLs
        └── views.py  # sets up responses to URLs

Makefile commands

make build creates the pickmybruin/backend image
make run starts up the PostgreSQL and Django containers
make restart restarts the Django container (useful when you edit code)
make ssh starts a bash session in the latest Django container
make run_command runs a command inside the latest Django container
- make run_command cmd="echo hi" will run echo hi inside the latest Django container
make shell starts a manage.py shell_plus inside the latest Django container
- If you don't know what this means, that's fine
make test runs test.py use args=--keepdb to use previous test database

How to add a new app

Run make run_command cmd="src/manage.py startapp $APPNAME
- This creates a new skeleton folder for your new app
YOU MUST ADD THIS APP TO src/pickmybruin/settings.py INSTALLED_APPS FOR THE APP TO BE DISCOVEREDR
- 'users', adds the users app to the Django project. Big surprise.
Add your code
Add tests to tests.py
Add your models to admin.py
Import your urls.py in src/pickmybruin/urls.py
Run the tests
Submit a PR

How to do authorized requests

Login

Only the username and password fields in the input should ever change
Only the access_token field in the output really matters

Use the access_token to do requests

MUST BE Authorization: Bearer <ACCESS_TOKEN>
Django will automatically identify the user with the token

API

Create new user

POST /users/

    {
        "email": "<EMAIL>",
        "password": "<PASSWORD>"
    }

returns

    {
        "id": <PROFILE_ID>,
        "user": {
          "id" : <USER_ID>,
          "first_name" : "<FIRST_NAME>",
          "last_name" : "<LAST_NAME>",
          "email" : "<EMAIL>"
        },
        "verfied" : <VERIFIED>
    }

sends a verification email with a link: "https://bquest.ucladevx.com/verify?code=<VERIFICATION_CODE>" or "http://localhost:8000/users/verify?code=<VERIFICATION_CODE> in development

Verify user

POST /verify/

    {
        "verification_code": "<VERIFICATION_CODE>"
    }

returns

    {
        "profile_id": <PROFILE_ID>
    }

GET /verify_link/ re-sends verification link returns

    {
        "profile_id": <PROFILE_ID>
    }

Login

POST /o/token/ (login)

    grant_type:password
    username:<USER_EMAIL>
    password:<USER_PASSWORD>
    client_id:web
    client_secret:<CLIENT_SECRET> // Note: the CLIENT_SECRET is a hardcoded field you need to get from your backend

returns

    {
        "access_token": "<ACCESS_TOKEN>",
        "expires_in": 36000,
        "token_type": "Bearer",
        "scope": "read write groups",
        "refresh_token": "<REFRESH_TOKEN>"
    }

Authorization

Authorization done over headers
Authorization: "Bearer <ACCESS_TOKEN>"

Password

POST /password_link (get password reset link)

    {
        "username" : <USERNAME>
    }

returns

    HTTPResponse 200

sends a verification email with a link: "https://bquest.ucladevx.com/password?code=<PASSWORD_RESET_CODE>&userid=" or "http://localhost:8000/users/password?code=<PASSWORD_RESET_CODE>&userid=" in development

POST /password (reset password)

    {
        "userid" : <USERID>
        "code" : <PASSWORD_RESET_CODE>
        "password" : <NEW_PASSWORD>
    }

returns

    HTTPResponse 200

Get own user

GET /users/me/
returns

    {
        "id": "<PROFILE_ID>",
        "first_name": "<USER_FIRST_NAME>",
        "last_name": "<USER_LAST_NAME>",
        "email": "<USER_EMAIL>",
        "year": "<YEAR>",
        "verified": "<VERIFIED>",
        "picture": <PICTURE>,
        "notifications_enabled": "<NOTIFICATION_BOOL>
        "phone_number": "<PHONE_NUMBER>"
        "date_created": "<DATE_CREATED_ISO8601>"
    }

Get specific user (Not Implemented)

GET /users/<PROFILE_ID>/
return is same as /users/me/

Update own user

PATCH /users/me/
schema is same as /users/me/, but will update subfields (don't change the id please)
return is same as /users/me/

Get own mentor

GET /mentors/me/
returns

    {
        "id": "<MENTOR_ID>",
        "profile": <PROFILE>,
        "active": "<MENTOR_STATE>",
        "major": [
            <MAJOR> ...
        ],
        "minor": [
            <MINOR> ...
        ],
        "gpa": "<GPA",
        "bio": <BIO>,
        "clubs": "<CLUBS>"
        "courses": [
            <COURSES> ...
        ],
        "pros": "<PROS>",
        "cons": "<CONS>",
        "date_created": "<DATE_CREATED_ISO8601>"
    }

Activate own mentor

POST /mentors/me/ - create mentor it doesn't exist - activate mentor if it does exist - will always set active to true - takes no params returns same as /mentors/me/

Update own mentor

PATCH /mentors/me/
schema is same as /mentors/me/, but will update subfields (don't change the id please) Note: Use this when setting mentor to inactive Note: Format to update major, minor, and courses is as follows: (Majors are limited to Max 2 and Minors are limited to Max 3)

  {
    "major": [
      { "name" : "<MAJOR>" },
      { "name" : "<MAJOR2>" }
    ]
  }
  {
    "minor": [
      { "name" : "<MINOR>" },
      { "name" : "<MINOR2>" }
    ]
  }
  {
    "courses": [
      { "name" : "<COURSE>" },
      { "name" : "<COURSE2>" }
    ]
  }

return is same as /mentors/me/

Get possible majors (Not Implemented)

GET /majors/
returns

    {
        "majors": [
            <MAJORS>...
        ]
    }

Search for mentors

GET /mentors/?query=<SPACE_SEPERATED_QUERY_STRINGS>&random=&name=&major=&bio=

if no query is given or no filters are checked, it defaults to return all (all params are optional)
checks user's name, major, and bio for Trigram Simularity (deprecated minor, courses, and year), and returns a sorted query based on similarity
random returns number of applicable mentors in a random order
case insentitive
only returns active mentors, excluding self
search term aliases, i.e ('cs' becomes 'computer science' and vice versa)

searching for multiple items allows more specific searches

ex) cs Han returns mentors majoring in computer science with name of Han

returns

    {
        "count": <NUMBER OF RESULTS>,
        "next": null,
        "previous": null,
        "results": [
            <MENTOR_PROFILE> ... // same as /mentor/me/ format
        ]
    }

sample GET request: GET /mentors/?query=computer science&major=True

Report User

POST /report_user/

sends email to '[email protected]'

  {
    "reported_id": <REPORTED_USER_ID>,
    "reason": <MESSAGE>
  }

returns

    HTTPResponse 200

Get specific mentor

GET /mentors/<MENTOR_ID>/
return is same as /mentors/me/

Send mentor a request

POST /requests/<MENTOR_ID>/

    {
        "phone": "<OPTIONAL_PHONE>"
        "preferred_mentee_email": "<REPLY_EMAIL>"
        "message": "<EMAIL_BODY>"
    }

returns a Request object (seen below)

Get all requests for user

GET /requests/list/me/
returns

    {
        "count": <NUMBER_OF_REQUESTS>
        "next": null
        "prev": null
        "results": <LIST_OF_REQUESTS> [
          {
            "mentee": <MENTEE_INFO>
            "mentor": <MENTOR_INFO>
            "email_body": "<MESSAGE_FROM_MENTEE>"
            "preferred_mentee_email": "<REPLY_EMAIL>"
            "phone": "<OPTIONAL_MENTEE_PHONE>"
            "date_created": "<DATE_OF_REQUEST>"
          }
          ...
        ]
    }

Get all threads for a user

GET /messaging/me/ GET /messaging/

returns

    {
        "count": <NUMBER_OF_THREADS>
        "next": null
        "prev": null
        "results": <LIST_OF_THREADS> [
        {
          'other_profile': <DATA_OF_OTHER_PROFILE>
          'recent_message': <MOST_RECENT_MESSAGE_DATA>
          }]
    }

Send a message

POST /messaging/<PROFILE_ID>/

    {
        "body": "<MESSAGE_BODY>"
    }

returns a Message object

Get all messages between user and someone else

GET /messaging/<PROFILE_ID>/

returns

    {
        "count": <NUMBER_OF_MESSAGES>
        "next": null
        "prev": null
        "results": <LIST_OF_MESSAGES> [
        {
          'id':'<MESSAGE_ID>'
          'sender':<PROFILE_OF_SENDER>
          'body':'<MESSAGE_BODY>'
          'timestamp':'TIME_SENT'
          'unread': <BOOLEAN>
          }]
    }

Mark a thread as read

PATCH /messaging/read/<THREAD_ID>/

    {
        <DOESN'T MATTER>
    }

returns the specified Thread object

Check if a thread exists between two users

GET /messaging/check/<PROFILE_ID>

returns

    {
        'exists': <True/False>
    }

Create Blog Post

POST /blogs/<USER_NAME>/ - Make sure to include the proper username after blog ([email protected])

    {
        "title": <TITLE>,
        "body": <BODY>,
        "anonymous":<BOOLEAN>
        "publish":<BOOLEAN>
        <FILENAME>:<FILE>,
        <FILE...
        .
        .
    }

returns

{
  "id": BLOG.ID,
  "author": "FIRST_NAME + LAST_NAME,
  "user": USER.ID,
  "body": BODY,
  "title": TITLE,
  "images": [
      {
          "id": IMAGE.ID,
          "filename": FILENAME,
          "blog": BLOG.ID,
          "picture": FILEURL,
      },
      .
      .
      .
  ],
  "published": time.current,
  "created": time.current,
  "updated": time.current, 
  "anonymous": BOOLEAN,
  "publish": BOOLEAN,
  "comments" : NUM_COMMENTS

}

Retrieve blogpost by id

GET /blogs/id/<BLOG_ID>/

returns

{
  "id": BLOG.ID,
  "author": "FIRST_NAME + LAST_NAME,
  "user": USER.ID,
  "body": BODY,
  "title": TITLE,
  "images": [
      {
          "id": IMAGE.ID,
          "filename": FILENAME,
          "blog": BLOG.ID,
          "picture": FILEURL,
      },
      .
      .
      .
  ],
  "published": time.current,
  "created": time.current,
  "updated": time.current, 
  "anonymous": BOOLEAN,
  "publish": BOOLEAN,
  "comments" : NUM_COMMENTS

}

Delete blogpost by id

DELETE /blogs/id/<BLOG_ID>/

returns HTTP_RESPONSE_200_OK

Patch blogpost by id

PATCH /blogs/id/<BLOG_ID>/

  {
      "title": <UPDATED_TITLE>,
      "body": <UPDATED_BODY>,
      "images": [IMAGE1.ID, IMAGE2.ID,...]
      "anonymous" : BOOLEAN,
      "publish" : BOOLEAN,
      <FILENAME>:<NEW_FILE>,
      <FILE...
      .
      .
  }

returns

  {
    "id": BLOG.ID,
    "author": "FIRST_NAME + LAST_NAME,
    "user": USER.ID,
    "body": UPDATED_BODY,
    "title": UPDATED_TITLE,
    "images": [
        {
            "id": IMAGE.ID,
            "filename": FILENAME,
            "blog": BLOG.ID,
            "picture": FILEURL,
        },
        .
        .
        .
    ],
    "published": time.publish,
    "created": time.created,
    "updated": time.current, 
    "anonymous": BOOLEAN,
    "publish": BOOLEAN,
    "comments" : NUM_COMMENTS
}

Search for Blog Posts

GET /blogs/?query=&num=

if no query is given, it defaults to return all (all params are optional)
checks title and body for Trigram Simularity

case insentitive

returns

    {
        "count": <NUMBER OF RESULTS>,
        "next": null,
        "previous": null,
        "results": [
            <BLOG_POST> ... // blogs/<blog_id>/ format
        ]
    }

Create Comment

POST /blogs/comment/

Enter blog or comment id to associate created comment with blog or comment. Enter type either 'blog' or 'post' Comments are connected like a single-directional tree with a blog root node.

    {
        "id": <BLOG_ID OR COMMENT_ID>,
        "body": <BODY>,
        "type":<'blog' OR 'comment'>
        .
        .
    }

returns

{
  "id": COMMENT.ID,
  "author": "FIRST_NAME + LAST_NAME,
  "user": USER.ID,
  "body": BODY,
  "blog": BLOG_ID,
  "published" : TIME.CURRENT(),
  "likes" : NUM_LIKES,
  "comments" : NUM_COMMENTS,
      .
      .
      .
  ],
}

Retrieve comment by id

GET /blogs/comment/id/<COMMENT_ID>/?depth=

Depth is a parameter that sets the depth of the traversal if there are more nodes. Default is 0. For traversal, will give array of comments. At end of root will give num comments.

returns

{
  "id": COMMENT.ID,
  "author": "FIRST_NAME + LAST_NAME,
  "user": USER.ID,
  "body": BODY,
  "published": time.current,
  "likes" : NUM_LIKES,
  "comments" : NUM_COMMENTS or
  [
        {
          "id": COMMENT.ID,
          "author": "FIRST_NAME + LAST_NAME,
          "user": USER.ID,
          "body": BODY,
          "published": time.current,
          "likes" : NUM_LIKES,
          "comments" : NUM_COMMENTS or
          [
              ... 
          ]
         },
         {
              ...
         }
  ]
}

Delete comment by id

DELETE /blogs/comment/id/<COMMENT_ID>/

returns HTTP_RESPONSE_200_OK

Patch comment by id

PATCH /blogs/comment/id/<COMMENT_ID>/

  {
      "id": COMMENT_ID,
      "user": USER_ID,
      "author": FIRST_NAME + LAST_NAME,
      "blog": BLOG_ID or null,
      "published": TIMEZONE.NOW()
      "body": "New updated blog",
      "likes": NUM_LIKES,
      "comments": NUM_COMMENTS 
  }

returns

    {
        "id": COMMENT.ID,
        "author": "FIRST_NAME + LAST_NAME,
        "user": USER.ID,
        "body": UPDATED_BODY,
        "blog": BLOG_ID or null,
        "published": TIMEZONE.NOW()
        "likes": NUM_LIKES,
        "comments": NUM_COMMENTS 
    }

Get comments from blog

GET /blogs/id/<BLOG_ID>/comments/?num=&depth=

If depth is not given, defaults to 0, surface level query
If num not given, default to return all

Typically set num from GET blog endpoint, user comment integer to set num

returns

    {
        "count": <NUMBER OF RESULTS>,
        "next": null,
        "previous": null,
        "results": [
            <COMMENTS> ... // /blogs/comment/id/<COMMENT_ID>/ format
        ]
    }

Like comment

PATCH /blogs/comment/id/<COMMENT_ID>/likes/

Will increment or decrement like counter by 1

returns

{
  "id": COMMENT.ID,
  "author": "FIRST_NAME + LAST_NAME,
  "user": USER.ID,
  "body": BODY,
  "published": time.current,
  "likes" : NUM_LIKES +- 1,
  "comments" : NUM_COMMENTS 
}

AWS Cronjobs

Update year field

(not implemented)

Current Database Schema (Will probably be outdated soon)

NOTE: you don't really need to understand this, but this is how Django will create tables for the models

User Table

id	email	first_name	last_name	(salted and hashed) password
1	[email protected]	Mark	Tai	verysecurepassword
2	[email protected]	John	Doe	corgisarecute

Profile Table

id	user_id	bio
1	1	Let me know if these examples suck
2	2	marktai.com/#corgis for all your corgi needs

Major Table

id	name
1	CS

Mentor Table

id	profile_id	major_id	bio
1	2	1	I will teach you the ways of corgis

Course Table

id	name
1	CS31

Code Profiling For Python

Why it's important

Identify bottlenecks
Unearth insight into performance
Future-proof code

Profile Hooks & cProfile!

cProfile is a built in profiler for python

$ python cProfile method.py

Using this, we can see the breakdown of function calls and dependencies across multiple files! Awesome!
What about functions that aren't inherently run? For example, a class method that is only run when it's called dynamically?
Profile hooks is the answer!

from profilehooks import profile

class ExampleClass():
@profile
def exampleFunc():
\\..
\\..

We're set! Now we have an easy and succinct way to test performance of new features!
Look for results in the docker terminal!

Name		Name	Last commit message	Last commit date
Latest commit History 90 Commits
.github		.github
.vscode		.vscode
src		src
websockets @ 1f5300d		websockets @ 1f5300d
.dockerignore		.dockerignore
.gitignore		.gitignore
.gitmodules		.gitmodules
Dockerfile		Dockerfile
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
docker-compose.yml		docker-compose.yml
init_db.sql		init_db.sql
initialize.sh		initialize.sh
package-lock.json		package-lock.json
requirements.txt		requirements.txt

License

ucladevx/BQuest-Backend

Folders and files

Latest commit

History

Repository files navigation

BQuest

Setup

Project Organization

Makefile commands

How to add a new app

How to do authorized requests

API

Create new user

Verify user

Login

Authorization

Password

Get own user

Get specific user (Not Implemented)

Update own user

Get own mentor

Activate own mentor

Update own mentor

Get possible majors (Not Implemented)

Search for mentors

Report User

Get specific mentor

Send mentor a request

Get all requests for user

Get all threads for a user

Send a message

Get all messages between user and someone else

Mark a thread as read

Check if a thread exists between two users

Create Blog Post

Retrieve blogpost by id

Delete blogpost by id

Patch blogpost by id

Search for Blog Posts

Create Comment

Retrieve comment by id

Delete comment by id

Patch comment by id

Get comments from blog

Like comment

AWS Cronjobs

Update year field

Current Database Schema (Will probably be outdated soon)

NOTE: you don't really need to understand this, but this is how Django will create tables for the models

User Table

Profile Table

Major Table

Mentor Table

Course Table

Code Profiling For Python

Why it's important

Profile Hooks & cProfile!

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Contributors 11

Languages

Packages