Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dehsilvadeveloper/laravel10-pagamento-simplificado
Desafio cujo objetivo é disponibilizar uma API que permita realizar transferência de dinheiro entre 2 usuários seguindo as regras propostas.
https://github.com/dehsilvadeveloper/laravel10-pagamento-simplificado
api docker docker-compose eloquent laravel laravel10 mysql payments php php8 transfer
Last synced: 1 day ago
JSON representation
Desafio cujo objetivo é disponibilizar uma API que permita realizar transferência de dinheiro entre 2 usuários seguindo as regras propostas.
- Host: GitHub
- URL: https://github.com/dehsilvadeveloper/laravel10-pagamento-simplificado
- Owner: dehsilvadeveloper
- Created: 2024-06-11T19:59:54.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-17T20:23:33.000Z (10 days ago)
- Last Synced: 2024-09-21T14:05:57.306Z (6 days ago)
- Topics: api, docker, docker-compose, eloquent, laravel, laravel10, mysql, payments, php, php8, transfer
- Language: PHP
- Homepage:
- Size: 733 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Laravel][laravel-shield]][ref-laravel]
[![PHP][php-shield]][ref-php]
[![MySQL][mysql-shield]][ref-mysql]
[![JWT][jwt-shield]][ref-jwt]
[![Composer][composer-shield]][ref-composer]
[![Docker][docker-shield]][ref-docker]
[![Git][git-shield]][ref-git]
[![Redis][redis-shield]][ref-redis]
[![Markdown][markdown-shield]][ref-markdown]
[![Env][env-shield]][ref-env]
# Desafio Pagamento Simplificado (Versão Laravel 10)
EM CONSTRUÇÃO
## Descrição do desafio
O objetivo deste desafio é construir uma API RESTFul para efetuar pagamentos simples. Nela deve ser possível realizar transferências de dinheiro entre usuários. Temos 2 tipos de usuários: os *comuns* e os *lojistas*, sendo que ambos possuem carteira com dinheiro e realizam transferências entre eles.
### Requisitos
A API desenvolvida deve respeitar as regras de negócio a seguir:
- Este serviço deve ser RESTFul;
- Para ambos tipos de usuário, precisamos do `Nome Completo`, `CPF/CNPJ`, `E-mail` e `Senha`. CPF/CNPJ e e-mail devem ser únicos no sistema. Sendo assim, seu sistema deve permitir apenas um cadastro com o mesmo CPF/CNPJ ou endereço de e-mail;
- Usuários comuns podem enviar dinheiro (efetuar transferência) para lojistas e entre usuários comuns;
- Lojistas só recebem transferências, não enviam dinheiro para ninguém;
- Validar se o usuário tem saldo antes da transferência;
- Antes de finalizar a transferência, deve-se consultar um *serviço autorizador externo*. Use este **mock** [https://util.devi.tools/api/v2/authorize](https://util.devi.tools/api/v2/authorize) para simular o serviço utilizando o verbo `GET`. Ele retornará uma resposta no seguinte formato:
```json
{"status" : "success", "data" : { "authorization" : true }}
```
A resposta retornada pelo mock é randômica, então também vai acontecer de serem retornadas respostas negativas.
```json
{"status" : "fail", "data" : { "authorization" : false }}
```
Lembre-se considerar as possíveis respostas que podem ser recebidas do mock no desenvolvimento da API;
- A operação de transferência deve ser uma *transação* (ou seja, revertida em qualquer caso de inconsistência) e o dinheiro deve voltar para a carteira do usuário que envia (independente do tipo);
- No recebimento de pagamento, o usuário comum ou lojista precisa receber uma *notificação* (envio de email, sms, etc) enviada por um serviço de terceiro e eventualmente este serviço pode estar indisponível/instável. Use este **mock** [https://util.devi.tools/api/v1/notify](https://util.devi.tools/api/v1/notify) para simular o envio da notificação utilizando o verbo `POST`. Ele retornará uma resposta no seguinte formato:
```json
{"status" : "success", "data" : { "sent" : true }}
```
A resposta retornada pelo mock é randômica, então também vai acontecer de serem retornadas respostas negativas.
```json
{"status" : "fail", "data" : { "sent" : false }}
```
Lembre-se considerar as possíveis respostas que podem ser recebidas do mock no desenvolvimento da API.
### Endpoint de transferência
A implementação do endpoint de transferência deve seguir o contrato seguir:
```json
POST /transfer
Content-Type: application/json
{
"value": 100.0,
"payer": 4,
"payee": 15
}
```
### Avaliação
Você pode implementar o que achar conveniente para o funcionamento do sistema, porém a avaliação do resultado do desafio vai considerar apenas o fluxo de transferência entre 2 usuários. O fluxo de gerenciamento de usuários e autenticação da API não são requisitos para conclusão do desafio, mas são bem-vindos se implementados.
Lembre-se de respeitar as regras de negócio do desafio.
## Desenvolvido com
| Nome | Versão |
| ---------- | -------- |
| Laravel | v10.x + |
| PHP | v8.2.x + |
| Docker | v20.10.x + |
| Docker Compose | v3.8.x + |
| MySQL | v8.0.x |
| Redis | v6.2.x |
## Documentação
* [Resolvendo o desafio](./docs/answering_challenge.md)
* [Como começar](./docs/getting_started.md)
* [Utilizando a API](./docs/using_api.md)
* [Instruções para containers Docker](./docs/docker_containers_instructions.md)
* [Estrutura do banco de dados](./docs/database_structure.md)
[laravel-shield]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[php-shield]: https://img.shields.io/badge/PHP-777BB4?style=for-the-badge&logo=php&logoColor=white
[mysql-shield]: https://img.shields.io/badge/mysql-%2300f.svg?style=for-the-badge&logo=mysql&logoColor=white
[jwt-shield]: https://img.shields.io/badge/JWT-black?style=for-the-badge&logo=JSON%20web%20tokens
[composer-shield]: https://img.shields.io/badge/Composer-885630?style=for-the-badge&logo=composer&logoColor=white
[docker-shield]: https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white
[git-shield]: https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white
[redis-shield]: https://img.shields.io/badge/Redis-DC382D?style=for-the-badge&logo=redis&logoColor=white
[markdown-shield]: https://img.shields.io/badge/Markdown-000?style=for-the-badge&logo=markdown
[env-shield]: https://img.shields.io/badge/.ENV-ECD53F?logo=dotenv&logoColor=000&style=for-the-badge
[ref-laravel]: https://laravel.com/docs/10.x/readme
[ref-php]: https://www.php.net
[ref-mysql]: https://www.mysql.com
[ref-jwt]: https://jwt.io
[ref-composer]: https://getcomposer.org
[ref-docker]: https://www.docker.com
[ref-git]: https://git-scm.com
[ref-redis]: https://redis.io/docs/latest/develop/data-types/
[ref-markdown]: https://www.markdownguide.org/getting-started/
[ref-env]: https://medium.com/@sujathamudadla1213/what-is-the-use-of-env-8d6b3eb94843