apisendIT

FEATURES

API has the following features:

1. GET /parcels
2. GET /parcels/
3. PUT /parcels//status
4. PUT /parcels//cancel
5. PUT /parcels//destination
6. PUT /parcels//presentLocation
7. GET /users//in-transit
8. GET /users//delivered
9. GET /users//parcels
10. POST /parcels
11. POST /auth/signup
12. POST /auth/login

INSTALLATION

pip install virtualenv

Clone the github repo:

1. Open new folder
2. Open Terminal on this folder
3. Type

    git clone https://github.com/mnswaleh/api_sendit.git .
   

create virtual evironment:

virtualenv venv
source venv/bin/activate

pip install -r requirements.txt

create Database:

on postreSQL database create

1. apisendit database
2. apitest database

TEST

install postman

on pytets

1. on terminal type

   pytest
   

2. all the tests should pass

on terminal: type export FLASK_APP=run.py flask run

On postman:

CREATE USER

1. Enter URL http://127.0.0.1:5000/api/v2/auth/signup
2. send post request with user details eg,

{
    "username": "tom",
    "first_name": "thomas",
    "second_name": "Kalume",
    "email": "mnswaleh@gmail.com",
    "gender": "male",
    "location": "kakamega",
    "type": "user",
    "password": "Ab243677"
}

3. should receive response with code 201 with success message with user details eg,

{
    "message": "Signup successul!",
    "user": {
        "email": "mnswaleh@gmail.com",
        "firstname": "thomas",
        "gender": "male",
        "location": "kakamega",
        "secondname": "Kalume",
        "type": "user",
        "user_id": 1,
        "username": "tom"
    }
}

SIGNIN USER

1. Enter URL http://127.0.0.1:5000/api/v2/auth/login
2. send post request with username and password eg,

{
    "username": "tom",
    "password": "Ab243677"
}

3. should receive response with code 201 with access token eg,

{
    "Message": "Login Successful!",
    "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NDg0NDE3NTYsIm5iZiI6MTU0ODQ0MTc1NiwianRpIjoiYjJhNWZlYjYtZjYzMC00NDBiLWIwM2MtOTA1ODcxMDQ2ZTRmIiwiZXhwIjoxNTQ4NDQyNjU2LCJpZGVudGl0eSI6WzMsInVzZXIiXSwiZnJlc2giOmZhbHNlLCJ0eXBlIjoiYWNjZXNzIn0.Uj_cZzP8fsH9ETbfg3sEk4-QAjO7NlxHwtqZkeL2i-M",
    "user": [
        3,
        "user"
    ]
}

CREATE ADMIN

1. Enter URL http://127.0.0.1:5000/api/v2/auth/signup
2. send post request with admin details eg,

{
    "username": "sali",
    "first_name": "sharon",
    "second_name": "mimo",
    "email": "mnswaleh@gmail.com",
    "gender": "female",
    "location": "karatina",
    "type": "admin",
    "password": "Wbc346789"
}

3. should receive response with code 201 with success message with user details eg,

{
    "message": "Signup successul!",
    "user": {
        "email": "mnswaleh@gmail.com",
        "firstname": "sharon",
        "gender": "female",
        "location": "karatina",
        "secondname": "mimo",
        "type": "admin",
        "user_id": 2,
        "username": "sali"
    }
}

SIGNIN ADMIN

1. Enter URL http://127.0.0.1:5000/api/v2/auth/login
2. send post request with username and password eg,

{
    "username": "tom",
    "password": "Ab243677"
}

3. should receive response with code 201 with access token eg,

{
    "Message": "Login Successful!",
    "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NDg0NDE3OTgsIm5iZiI6MTU0ODQ0MTc5OCwianRpIjoiMGQwYmE0MzAtNjlhZS00Y2U1LWEwNGYtMzZlMTc4NTU0OTgwIiwiZXhwIjoxNTQ4NDQyNjk4LCJpZGVudGl0eSI6WzIsImFkbWluIl0sImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyJ9.Mc_jfZSDq1qHZxhV_5BHtaaRc78oeDbJdGyAYa6KQTU",
    "user": [
        2,
        "admin"
    ]
}S6Q1LD0r6-5F0AFyKTS_bKgfo9SL8A8QZeyVDhCY4"
}

CREATE ORDER

1. Login as user
2. Copy the access token and paste it as Bearer Token on headers
3. Enter URL http://127.0.0.1:5000/api/v2/parcels
4. send post request with delivery order eg,

{
	"pick_up_location": "nyahururu",
	"delivery_location": "kitale",
	"weight": 2,
	"price": 200
}

5. should receive response with code 201 and order details eg,

{
    "current_location": "nyahururu",
    "delivery_location": "kitale",
    "pick_up_location": "nyahururu",
    "price": 200,
    "sender": 1,
    "status": "pending",
    "weight": 2
}

FETCH ALL ORDERS

1. Login as admin
2. Copy the access token and paste it as Bearer Token on headers
3. Enter URL http://127.0.0.1:5000/api/v2/parcels
4. send get request
5. should receive response with code 200 and all delivery orders created eg,

{
    "Delivery orders list": [
        {
            "created": "Tue, 20 Nov 2018 00:00:00 GMT",
            "current_location": "nyahururu",
            "destination": "kitale",
            "order_no": 1,
            "pickup": "nyahururu",
            "price": 200,
            "sender": 1,
            "status": "pending",
            "weight": 2
        }
    ],
    "Title": "Delivery orders"
}

FETCH ORDERS OF A PARTICULAR USER

1. Login as admin or user
2. Copy the access token and paste it as Bearer Token on headers
3. Enter URL http://127.0.0.1:5000/api/v2/users/1/parcels
4. send get request
5. should receive response with code 200 and all delivery orders created by user with user id 1 ie,

{
    "Title": "Delivery orders by user 3",
    "orders": [
        {
            "created": "Fri, 25 Jan 2019 00:00:00 GMT",
            "current_location": "nyahururu",
            "destination": "kitale",
            "order_no": 26,
            "pickup": "nyahururu",
            "price": 200,
            "sender": 3,
            "status": "pending",
            "weight": 2
        },
        {
            "created": "Thu, 22 Nov 2018 00:00:00 GMT",
            "current_location": "nyahururu",
            "destination": "kitale",
            "order_no": 5,
            "pickup": "nyahururu",
            "price": 200,
            "sender": 3,
            "status": "pending",
            "weight": 1
        },
        {
            "created": "Thu, 22 Nov 2018 00:00:00 GMT",
            "current_location": "nyahururu",
            "destination": "kitale",
            "order_no": 6,
            "pickup": "nyahururu",
            "price": 200,
            "sender": 3,
            "status": "pending",
            "weight": 10
        }
    ]
}

FETCH PARTICULAR ORDER

1. Login as admin or user
2. Copy the access token and paste it as Bearer Token on headers
3. Enter URL http://127.0.0.1:5000/api/v2/parcels/1
4. send get request
5. should receive response with code 200 and details of order 367857 ie,

{
    "created": "Tue, 20 Nov 2018 00:00:00 GMT",
    "current_location": "nyahururu",
    "destination": "kitale",
    "order_no": 1,
    "pickup": "nyahururu",
    "price": 200,
    "sender": 1,
    "status": "pending",
    "weight": 2
}

CANCEL PARCEL DELIVERY ORDER

1. Login as user
2. Copy the access token and paste it as Bearer Token on headers
3. Enter URL http://127.0.0.1:5000/api/v2/parcels/1/cancel
4. send put request
5. should receive response with code 200 and details of order 1 with status as canceled ie,

{
    "created": "Tue, 20 Nov 2018 00:00:00 GMT",
    "current_location": "naivasha",
    "destination": "kisumu",
    "order_no": 1,
    "pickup": "nyahururu",
    "price": 200,
    "sender": 1,
    "status": "canceled",
    "weight": 2
}

CHANGE DELIVERY LOCATION

1. Login as user
2. Copy the access token and paste it as Bearer Token on headers
3. Enter URL http://127.0.0.1:5000/api/v2/parcels/1/destination
4. send put request with desired delivery location eg,

{
	"delivery_location": "kisumu"
}

4. should receive response with code 200 and details of order 1 with new delivery location eg,

{
    "created": "Tue, 20 Nov 2018 00:00:00 GMT",
    "current_location": "naivasha",
    "destination": "kisumu",
    "order_no": 1,
    "pickup": "nyahururu",
    "price": 200,
    "sender": 1,
    "status": "in transit",
    "weight": 2
}

CHANGE ORDER CURRENT LOCATION

1. Login as admin
2. Copy the access token and paste it as Bearer Token on headers
3. Enter URL http://127.0.0.1:5000/api/v2/parcels/1/presentLocation
4. send put request with current location eg,

{
	"current_location": "naivasha"
}

5. should receive response with code 200 and details of order 1 with new current location eg,

{
    "created": "Tue, 20 Nov 2018 00:00:00 GMT",
    "current_location": "naivasha",
    "destination": "kitale",
    "order_no": 1,
    "pickup": "nyahururu",
    "price": 200,
    "sender": 1,
    "status": "pending",
    "weight": 2
}

CHANGE ORDER STATUS

1. Login as admin
2. Copy the access token and paste it as Bearer Token on headers
3. Enter URL http://127.0.0.1:5000/api/v2/parcels/1/status
4. send put request with status eg,

{
	"status": "in transit"
}

5. should receive response with code 200 and details of order 1 with new status eg,

{
    "created": "Tue, 20 Nov 2018 00:00:00 GMT",
    "current_location": "naivasha",
    "destination": "kitale",
    "order_no": 1,
    "pickup": "nyahururu",
    "price": 200,
    "sender": 1,
    "status": "in transit",
    "weight": 2
}

GET ORDERS OF A PARTICULAR USER THAT ARE DELIVERED

1. Login as admin or user
2. Copy the access token and paste it as Bearer Token on headers
3. Enter URL http://127.0.0.1:5000/api/v2/users/1/delivered
4. send get request
5. should receive response with code 200 and the number of orders of user 1 that are delivered ie,

{
    "delivered": 0
}

GET ORDERS OF A PARTICULAR USER THAT ARE IN TRANSIT

1. Login as admin or user
2. Copy the access token and paste it as Bearer Token on headers
3. Enter URL http://127.0.0.1:5000/api/v2/users/1/in-transit
4. send get request
5. should receive response with code 200 and the number of orders of user 1 that are in transit ie,

{
    "in_transit": 0
}

VIEW USER PROFILE

1. Login as admin or user
2. Copy the access token and paste it as Bearer Token on headers
3. Enter URL http://127.0.0.1:5000/api/v2/user/3
4. send get request
5. should receive response with code 200 and details of user 3 ie,

{
    "email": "mnswaleh@gmail.com",
    "firstname": "thomas",
    "gender": "male",
    "location": "kakamega",
    "secondname": "Kalume",
    "type": "user",
    "user_id": 3,
    "username": "tom"
}

USER LOGIN

1. Login as admin or user
2. Copy the access token and paste it as Bearer Token on headers
3. Enter URL http://127.0.0.1:5000/api/v2/auth/logout
4. send put request
5. should receive response with code 200 and a success message ie,

{
    "message": "successful logout"
}

on heroku

reapet the postman tests above replacing server url http://127.0.0.1:5000 with https://api-sendit.herokuapp.com/