lucasdutraf / debts-api

This repository stores code from Zapay's Python Backend Developer coding challenge

Debts API

This repository stores code from Zapay's Python Backend Developer coding challenge.

Baixando o conteúdo do repositório

1. É necessário possuir git instalado em sua máquina;
2. Clone o projeto; $ git clone https://github.com/lucasdutraf/debts-api
3. Acesse o diretório criado. $ cd debts-api

Como rodar o projeto

1. O ideal é possuir um virtualenv para instalar as bibliotecas extras;
2. Instale as bibliotecas adicionais utilizadas pip3 install -r requirements.txt
3. O projeto aceita 2 ou 3 argumentos para realizar a busca de débitos do carro.
   1. Resgatando todos os débitos disponíveis; $ python3 main.py ABC1234 11111111111
   2. Resgatando débitos de um tipo em específico; $ python3 main.py ipva ABC1234 11111111111
4. Rode os testes. pytest tests.py

Evoluções requiridas

1. Adicionar funcionalidade de resgatar todos os débitos. A funcionalidade foi adicionada através de mudanças nos 3 principais arquivos. Sendo elas contempladas nos três commits "Create mount debt data method", "Update main according to all debts return functionality", "Create parsing function to return all debts".
2. Implementar um novo tipo de débito. A funcionalidade foi adicionada através de mudanças nos 3 principais arquivos. Sendo elas contempladas nos três commits "Create licensing debt option fetch logic", "Add licensing debt option to parser", "Update main logic to support licensing".
3. Implementar uma solução que aceite placas de modelo novo como input. A funcionalidade foi adicionada através de mudanças no arquivo main.py. Sendo ela contemplata em apenas um commits "Add function for handling with new license plate pattern".
4. Adicionar testes na aplicação. Essa evolução foi atendida e foi utilizada a técnica de testes parametrizados, com o apoio da biblioteca pytest. Todos os testes implementados constam no arquivo tests.py.

Autor: Lucas Dutra Ferreira do Nascimento