Desafio Backend Jayson Santos

Instruções

1. Dowload Repository

git clone https://github.com/jaysongyn/desafio-picpay.git

2. Criar os containers

docker-compose up --build

3. Instalar dependências do composer

docker exec -it users-api-php composer install

4. Criar o .env

cp .env.example .env

5. Rodar os testes

docker exec -it users-api-php vendor/bin/phpunit --testdox

Resultado dos Testes:

Foi adicionado CI utilizando o Google Cloud Plataform para rodar os tests toda vez que fizer um push

Para rodar as migrations

docker-compose exec users-api-php php artisan migrate

Problema

O PicPay é uma empresa de pagamentos que visa revolucionar a forma com que lidamos com dinheiro em nosso dia-a-dia. Um dos passos necessários para completarmos essa missão é implementar a criação de diferentes tipos de contas para utilização do nosso aplicativo.
É importante lembrar que o seu sistema será integrado aos nossos painéis internos e ao aplicativo.

Todo o processo começa com a criação de um Usuário. Um usuário pode ter mais de um tipo de conta vinculada a ele.
De um Usuário (User), queremos saber seu Nome Completo, CPF, Número de Telefone, e-mail e Senha.
CPFs e e-mails devem ser únicos no sistema. Sendo assim, seu sistema deve permitir apenas um cadastro com o mesmo CPF ou endereço de e-mail.

Os tipos de conta que existem no PicPay são Consumidor (Consumer) e Lojista (Seller). Todo Consumidor ou Lojista deve estar vinculado a um usuário existente.
De um Lojista queremos saber a Razão Social, o Nome Fantasia, o CNPJ e seu Username, além do id de Usuário que será dono dessa conta.
De um Consumidor, queremos saber apenas seu Username, além do id de Usuário que será dono dessa conta.
Os usernames devem ser únicos dentro do sistema, mesmo entre contas de tipos diferentes.
Devido a algumas limitações do sistema, cada Usuário pode ter apenas uma conta de cada tipo.

Seu sistema deve ser capaz de listar todos os usuários, além de conseguir trazer informações detalhadas de um usuário específico.
Durante a listagem, deve ser possível filtar os resultados por Nome ou Username.
Para fins didáticos, sua busca deve considerar apenas resultados que comecem com a string especificada na busca. Como exemplo,
GET /users?q=joao deve retornar apenas Usuários cujos Nomes ou Usernames comecem com a string joao.
Não há a necessidade de lidar com acentos.

Outra funcionalidade do sistema deve ser a possiblidade de contas poderem realizar pagamentos entre si, chamados Transações (Transactions).
Para a realização de pagamentos, seu sistema deve consumir um serviço externo (mock criado por você) para autorização das movimentações entre as contas.
Todas as transações cujo valor seja maior ou igual a R$ 100.00 devem ser recusadas. Transações de valor inferior a R$ 100.00 devem ser autorizadas.
Transações recusadas devem retornar código HTTP 401, não autorizadas. A lógica de autorização ou recusa de transações deve estar contida no serviço externo.

Sua tarefa é desenvolver uma API capaz de cumprir com todos os requisitos especificados.

A especificação da API está disponível no nosso site. O arquivo disponibilizado está no formato Swagger 2.0, e pode ser visualizado
utilizando o Swagger. Siga as aqui as instruções de como visualizar a especificação.

Instruções

Para ajudar no desenvolvimento e evitar perda de tempo com código boilerplate, decidimos prover uma estrutura básica para o desenvolvimento da sua solução utilizando a plataforma PHP (Lumen 5.6 + MySQL/MongoDB com Eloquent).
A estrutura deve ser utilizada no desenvolvimento da sua solução.
É possível fazer download do template inicial aqui.

O primeiro passo para o início do desenvolvimento é escolher qual tecnologia de banco de dados será utilizada no seu projeto. Dependendo da escolha, existem algumas alterações que devem ser feitas no seu projeto base.

• Alterar, no arquivo .env, o valor da variável DB_CONNECTION=mysql|mongodb.

Para verificar se a sua solução está funcionando, utilize o comando docker-compose up --build a partir do diretório raiz do projeto.
A sua API estará mapeada para a porta 8000do seu host local. Uma requisição GET localhost:8000/ vai retornar a versão do Lumen em execução.

IMPORTANTE: após a execução do docker-compose up --build, na pasta do projeto, execute o comando docker exec -it users-api-php composer install.
Quando o volume atual é mapeado para dentro do container, ele sobrescreve a pasta com as dependências instaladas pelo composer, por isso o comando é necessário.

Avaliação

A avaliação da sua solução será constituída de duas etapas principais: Correção objetiva e Correção qualitativa.

Caso você não se sinta à vontade com a arquitetura proposta, você pode apresentar sua solução utilizando frameworks diferentes.
Porém, nesse caso, uma entrevista de Code Review será necessária para a avaliação da sua solução.

A correção objetiva será realizada através da utilização de um script de correção automatizada. A correção qualitativa levará em conta os seguintes critérios:

• Modelagem de Dados
• Domínio da Linguagem
• Legibilidade do Código
• Estrutura do Código
• Organização do Código
• Design Patterns
• Manutenibilidade do Código
• Diferenciais: Testes Unitários e Cobertura de Testes

Como submeter

Ao finalizar envie um email para [email protected] com seu Nome, Telefone para contato e a solução do desafio.
Caso já esteja em processo de avaliação, é interessante também informar o(a) seu(sua) recrutador(a) sobre a conclusão desta etapa.

Lembre-se de não enviar arquivos compilados e configurações de IDE ao submeter a sua solução.