NEAREST POINTS/CORDINATES

Assumptions

First point in list of tuples is x cordinate
Second point in the list of tuples is y cordinate
Uploaded points are grouped batchwise (each api request corresponds to a unique batch)
Shortest distance considers bidirrectional movement repetion of some points in different order

Features Implemented in the application

Application/api security (JWT token generation)
Data normalizations (Database functionlity)
Auditable data (Timestamps and user profile on any data manupilation done)
Application testability (Unit tests to achieve coverage of < 90%)
Application documentation (Feature and code documentation on readme file)
Code versioning (Git hub)
Deployment and delivery via Heroku
Depandencies management and documentation on requirements.txt
Logging and log management

Explicit Tasks

Create a Django application.
The application should have an API endpoint that accepts a string of comma separated points for example “(2,3), (1,1), (5, 4), ...” and calculates the closest points. It then stores them in a table with the following details:
The string of points submitted
The result of the computation: the closest points pair
Write unit tests to validate your expectations
Host the application on Heroku (or a different service of choice that will be publicly available)
Host your code on GitHub and share repository
Also share the API of the application and any credentials that might be needed alongside a [Shared on email]
summary of how your application works

Application setup

Get the application source code from github

git clone https://github.com/ryananyangu/tmpmfsrepo.git

Change directory into the application directory

cd tmpmfsrepo

Create virtual environment to host the application dependacies

python3 -m venv env

Activate the virtual environment

source ../env/bin/activate

Install application dependancies into your virtual directory

pip install -r requirements.txt

Add the following enviromental variables to be able to run the application smoothly

# Advisable never to use the default even though it exists esp in prod
export SECRET_KEY={insert your own !}
# Debug only accepts True or False values default is True
export DEBUG=True|False
# Database url if not set defaults to sqlite setup
export DATABASE_URL={insert your own postgresql url}

Making the model migrations and running the generated migrations For both default apps and cordinates app

python3 manage.py makemigrations
python3 manage.py makemigrations cordinates
python3 manage.py migrate

Create a supper user account to be able to access both the apis and admin portal

python3 manage.py createsuperuser
# Follow the prompt instructions recieved

Run the application

python3 manage.py runserver

Production setup is different as it uses

Whitenoise to server static files and
Gunicorn for serving the backend api

Following is the variation of production command for running the application Setup for whitenoise for deployment to heroku is already done in the settings.py file

# Collect all the static files to be served with application i.e. admin, rest_api browser etc.
python3 manage.py collectstatic --noinput

# Run the application on production
gunicorn --bind 0.0.0.0:$PORT mfs.wsgi:application --log-file -

Running test and getting the test coverage report.

coverage run --source='.' manage.py test cordinates
coverage report

Name                                    Stmts   Miss  Cover
-----------------------------------------------------------
cordinates/__init__.py                      0      0   100%
cordinates/admin.py                         3      0   100%
cordinates/apps.py                          4      0   100%
cordinates/migrations/0001_initial.py       7      0   100%
cordinates/migrations/__init__.py           0      0   100%
cordinates/models.py                       15      0   100%
cordinates/tests.py                        23      0   100%
cordinates/views.py                        72      1    99%
manage.py                                  12      2    83%
mfs/__init__.py                             0      0   100%
mfs/asgi.py                                 4      4     0%
mfs/settings.py                            36      1    97%
mfs/urls.py                                 8      0   100%
mfs/wsgi.py                                 4      4     0%
-----------------------------------------------------------
TOTAL                                     188     12    94%

APIs Implementation and Examples

Sample request via curl

curl -X POST \
  https://ashiruma-mfs.herokuapp.com/api-token-auth/ \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{
        "username": "rashiruma",
        "password": "XXXXXXXXX"
      }'

Sample response

{
  "token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

Verify Token API

token verification link

Sample request

curl -X POST \
  https://ashiruma-mfs.herokuapp.com/api-token-refresh/ \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{
        "token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
      }'

Sample response

{
  "token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

Refresh token API

token refresh link

Sample request

curl -X POST \
  https://ashiruma-mfs.herokuapp.com/api-token-refresh/ \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{
        "token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
      }'

Sample response with new token

{
  "token": "YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY"
}

Cordinates check API

points/ cordinates check link