Send_IT_APIs

Set of API endpoints to be consumed by a courier service application

Features

The API offers the following set of endpoints:

Getting started

These instructions will get you a copy of the program on your local machine for development and testing purposes. The instructions are tailored for uses of LINUX OS particularly UBUNTU

Prerequisites

What things you will need to run the application

Python3
    version: 3.6

Pip for python3
    $ sudo apt-get install python3-pip

Flask to build the application
    version: 1.0.2
    $ pip install flask

Virtualenv to create a virtual environment
    version: 16.0.0

Pytest to perform tests
    version: 3.9.1
    $ pip install pytest -U

Alternatively, run pip install -r requirements.txt to install all the necessary tools

Built With

1. Flask - microframework for Python
2. Flask-JWT-Extended
3. PostgreSQL
4. Passlib

Installing

To have a copy of the project on your machine, run the command below in your preferred directory:

git clone https://github.com/dxania/Send_IT_APIs.git

After cloning, you will have a folder named Send_IT_APIs

How to use

1. Navigate to Send_IT_APIs
2. Create a virtual environment by running:
   python3 -m venv <name of virtualenvironment>
3. Activate the virtual environment
   source <name of virtualenvironment>/bin/activate
   You should see the name of the virtual environment placed right before your current path/directory in brackets()
4. Connect to the postgres db
   Once Postgres is installed and you can connect, youll need to export the DATABASE_URL environment variable for to connect to it when running locally
   Run the command below to connect

DATABASE_URL=$(heroku config:get DATABASE_URL -a send-it-api-app)

5. Run the application
   export FLASK_APP=app.py then
   flask run

Testing

1. Run pytest or pytest tests/<test_file_name> in the directory of the project to run unit tests
2. Test with Postman by pasting the url https://send-it-api-app.herokuapp.com/api/v1/auth/signup (For the POST requests, enter the data as raw application/json)

Sample Requests and Responses for a non admin user

Sign up

Endpoint /api/v1/auth/signup

Input

    {
        "user_name":"Dee",
        "email": "[email protected]",
        "password":"warmups"
    }

Output

{"message":"User Dee successfully created"}

Login

Endpoint /api/v1/auth/login

Input

    {
        "user_name":"Dee",
        "password":"warmups"
    }

Output

    {
        "access_token" : some access token,
        "message":"You have sucessfully been logged in as Dee"
    }

Create parcel

Endpoint /api/v1/parcels

Input

    {
        "recipient_name":"leonne",
        "recipient_mobile": 1234567890,
        "pickup_location":"Entebbe",
        "destination":"Mombasa",
        "weight": 900
    }

Output

    {"message":"Parcel successfully created"}

Get the parcel

Endpoint /api/v1/parcels/1

Output

    {
    "parcel": {
        "created_by": "Dee",
        "destination": "Mombasa",
        "parcel_id": 1,
        "pickup_location": "Entebbe",
        "present_location": "Entebbe",
        "recipient_mobile": "1234567890",
        "recipient_name": "leonne",
        "status": "pending",
        "total_price": 100000,
        "weight": 900
    }
}

Update the destination

Endpoint /api/v1/parcels/1/destination

Input

    {"destination":"Nairobi"}    

Output

    {"message":"Destination of parcel 1 changed to Nairobi"}

Deployment

Deployed on heroku

Author

Daizy Obura