elhanarinc/socialnetwork-challenge

Challenge written with Django Framework

PythonGPL-3.0

Django Challenge

Coding challenge written with Django Framework.

This project assumes you had already installed these tools:

Third party packages, tools, etc:

bcrypt for encryption of passwords.
clearbit for getting additional data on emails.
psycopg2 for interacting with postgresql.
pyhunter for check email validity.
PyJWT for authentication.

API Usage

In order to use the API, you need a living postgresql instance on your local machine with these properties:

name_of_database: socialnetwork
user: dummy
password: 123456

In order to use django with postgresql, you need to follow this link.

First we need to create a virtualenv by using below commands:

virtualenv venv -p [python3 location like /usr/local/bin/python3]
source venv/bin/activate
Go to the project directory like cd /home/challenge-directory/
pip install -r requirements.txt

Below are the commands that is need for populating the empty postgresql table, then running the API:

python manage.py makemigrations socialnetwork
python manage.py migrate
python manage.py runserver

There are different endpoints for this API:

/signup
- This endpoint accepts POST request.
- If user data is not on db it hashes the password, inserts the user data into db and returns a token.
- Body Params:
```
{
    "name": "dummy",
    "email": "dummy@gmail.com",
    "password": "123456"
}
```
/login
- This endpoint accepts POST request.
- If user data is on db, it returns a token.
- Body Params:
```
{
    "email": "dummy@gmail.com",
    "password": "123456"
}
```
/create
- This endpoint accepts POST request.
- x-access-token should be on header.
- Body Params:
```
{
    "content": "Lorem ipsum dolor sit amet"
}
```
/like
- This endpoint accepts POST request.
- x-access-token should be on header.
- Body Params:
```
{
    "post_id": 5
}
```
/unlike
- This endpoint accepts POST request.
- x-access-token should be on header.
- Body Params:
```
{
    "post_id": 5
}
```

Additional Information:

There are also 7 different endpoints other than the endpoints above and used for helper endpoints of automated bot and debugging.
You could find a sample POSTMAN json file in the directory.

AUTOMATED BOT

For this part, again you need to activate virtualenv and install requirements.

Bot Configuration File:

{
  "number_of_users": 4,
  "max_posts_per_user": 4,
  "max_likes_per_user": 4,
  "api_url": "http://localhost:8000"
}

Sample bot start command (You should give the bot config location as --file parameter):

python automated_bot.py --file config.json

Tools used for deploying and serving endpoints: