PHONE RECHARGE

criação da estrutura inicial do projeto

• Create virtual environment

python3 -m venv .venv

• Active virtual environment

source .venv/bin/activate

• Install dependences manager

pip install pip-tools

• Create arquive of the development dependences

touch requirements.in requirements-dev.in
echo 'flask' > requirements.in
echo '-r requirements.in' > requirements-dev.in

• Include development dependences in requirements-dev.in

-r requirements.in
pytest
coverage
black
flake8
pytest-flask
pytest-cov
codecov

• Compile dependences, needed if not has the arquives requirements.txt and requirements-dev.txt

pip-compile requirements.in --generate-hashes
pip-compile requirements-dev.in --generate-hashes

• Install dependences

pip install -r requirements-dev.txt

Module for populate database tables Company, Product

module python for create registers Company and Product

from phonecharge.models import Company, Product

def create():
    company = Company(public_id='claro_11', name='claro')
    company.save()
    company = Company(public_id='tim_11', name='tim')
    company.save()

    product = Product(public_id='claro_10', value=10.0, company_id='claro_11')
    product.save()

    product = Product(public_id='claro_20', value=20.0, company_id='claro_11')
    product.save()

    product = Product(public_id='tim_20', value=20.0, company_id='tim_11')
    product.save()

    product = Product(public_id='tim_10', value=10.0, company_id='tim_11')
    product.save()



if __name__ == '__main__':
    create()

How to test Needed run docker-compose

docker-compose up

Find docker container

docker ps -a

Exemple

43cfc0fcb841   postgres         "docker-entrypoint.s…"   2 days ago     Up 52 minutes             0.0.0.0:5434->5432/tcp, :::5434->5432/tcp   rechargeDB

Enter container and create database

docker exec -it 43cfc0fcb841 bash 

root@43cfc0fcb841:/# psql postgres -U postgres

postgres=# CREATE DATABASE rechargedb;

create tables execute

python phonecharge/models.py 

Insert initials datas in to db for Company and Products, needed for test recharges

execute

python phonecharge/operations/create_company_and_product.py

API endpoints

Get all products

GET /CompanyProducts

Headers

headers ={ 'Authorization': 'Basic bWFyY29zcGF1bG8uc2lsdmF2aWFuYUBnbWFpbC5jb206bGF5bGFlYmVs' }

Response

[
    {
        "company_id": "claro_11",
        "products": [
            {
                "id": "claro_10",
                "value": 10.0
            },
            {
                "id": "claro_20",
                "value": 20.0
            }
        ]
    },
    {
        "company_id": "tim_11",
        "products": [
            {
                "id": "tim_10",
                "value": 10.0
            },
            {
                "id": "tim_20",
                "value": 20.0
            }
        ]
    }
]

Get all recharges

GET /PhoneRecharges

headers

headers ={ 'Authorization': 'Basic bWFyY29zcGF1bG8uc2lsdmF2aWFuYUBnbWFpbC5jb206bGF5bGFlYmVs' }

Response

[
    {
        "id": "107802416839818990217276955951447063658",
        "created_at": "2021-10-08T08:25:16.518757",
        "company_id": "claro_11",
        "product_id": "tim_10",
        "phone_number": "5511999999999",
        "value": 10.0
    },
    {
        "id": "112631079329131080778876532853319043477",
        "created_at": "2021-10-11T08:03:27.277829",
        "company_id": "claro_11",
        "product_id": "claro_20",
        "phone_number": "5511999556699",
        "value": 20.0
    }
]

Get recharges by phone number

GET /PhoneRecharges?phone_number=5511969999999

headers

headers ={ 'Authorization': 'Basic bWFyY29zcGF1bG8uc2lsdmF2aWFuYUBnbWFpbC5jb206bGF5bGFlYmVs' }

Response

{
    "id": "284206977373282501394198671064916751422",
    "created_at": "2021-10-08T08:25:16.518757",
    "company_id": "claro_11",
    "product_id": "claro_20",
    "phone_number": "5511969999999",
    "value": 20.0
}

Get recharges by id recharge

GET /PhoneRecharges?id=112631079329131080778876532853319043477

headers

headers ={ 'Authorization': 'Basic bWFyY29zcGF1bG8uc2lsdmF2aWFuYUBnbWFpbC5jb206bGF5bGFlYmVs' }

Response

{
    "id": "112631079329131080778876532853319043477",
    "created_at": "2021-10-11T08:03:27.277829",
    "company_id": "claro_11",
    "product_id": "claro_20",
    "phone_number": "5511999556699",
    "value": 20.0
}

Create a new recharge

POST /PhoneRecharges

Parameters headers

headers ={ 'Authorization': 'Basic bWFyY29zcGF1bG8uc2lsdmF2aWFuYUBnbWFpbC5jb206bGF5bGFlYmVs' }

{
"product_id": "claro_20",
"phone_number": "5511999556691",
"value": 20.0
}