Entrega do Projeto

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+## Porque?
+
+
+## Como?
+
+
+## Checklist
+- [] Escopo do PR é isolado
+- [] PR tem no máximo 10 arquivos | 300 linhas
+- [] PR foi marcado com label correspondente
+
+[Tarefa no Quadro](https://trello.com/b/ZkolCsrm/slytherin-pay)

.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: PHP Composer
 
 on:
   push:
-    branches: [ main ]
+    branches: [ main , develop]
   pull_request:
     branches: [ main ]
 

.gitignore

@@ -2,4 +2,6 @@
 vendor/
 .phpunit*
 .idea*
-./tests/reports/*
+tests/reports/*
+coverage*
+secrets-token-access-git

Dockerfile

@@ -0,0 +1,13 @@
+FROM webdevops/php-nginx:7.4
+
+ENV WEB_DOCUMENT_ROOT /app/public
+ENV WEB_DOCUMENT_INDEX index.php
+ENV COMPOSER_VERSION 2
+ENV PHP_DATE_TIMEZONE America/Sao_Paulo
+
+RUN pecl install -f xdebug-2.9.8 && \
+    docker-php-ext-enable xdebug 
+
+COPY ./xdebug.ini  /usr/local/etc/php/conf.d/xdebug.ini
+
+WORKDIR /app

Makefile

@@ -0,0 +1,16 @@
+setup:
+	@docker-compose up -d --build
+	@docker-compose exec -T app composer install -n
+
+bash:
+	@docker-compose exec app bash
+
+test:
+	@docker-compose exec -T app php ./vendor/bin/phpunit --coverage-text
+
+test-coverage:
+	@docker-compose exec -T app php ./vendor/bin/phpunit --coverage-html coverage
+
+infection:
+	@docker-compose exec -T app composer run-script infection
+

README.md

@@ -1,55 +1,20 @@
-# Desafio Consertando o SonserinaPay
-_________
-## Apresentações 
-Olá, meu nome é Malfoy, Draco Malfoy, como todo bom desenvolvedor também sou um bruxo.
+# slytherin-pay
+Projeto SLYTHERIN-PAY: Validador de Transações
 
-Crabbe, Goyle e eu estavamos cansados da burocracia de pagamentos dos duendes e resolvemos criar nosso proprio app
-de pagamentos, o Sonserina Pay. Agora estamos expandindo nossas operações para o mundo dos trouxas, vamos concorrer 
-com um tal de PicPay (eles estão lascados). Para garantir que nosso sistema funcione corretamente e não só por mágica, 
-contratamos uma consultora externa de qualidade (Hermione Granger, aquela sabe tudo, trouxa de sangu* ***m). 
+### Instalação
 
-Durante os testes dela ela levantou alguns problemas no nosso software e você deverá corrigi-los,  afinal de contas eu
-sou um genio da programação das trevas muito importante pra isso, mas os créditos se ficar bom serão meus ok?
+1. Clonar o Projeto
+1. Esse projeto possui Makefile, para subir o container basta executar `make setup`
+1. Existe um arquivo `index.php` na pasta `public`, nele é possível simular a aplicação
+1. Para velo rodando localmente, basta acessar o endereço [localhost](http://localhost:8089/), rodando na porta `:8089`
 
-Tarefas:
+### Acessar o Container
 
-1 - Você deverá implementar uma classe para checagem anti fraude (App\Domain\Services\FraudChecker), eu já comecei a
-criar a classe, mas fiquei com preguiça. 
+1. Executar o comando `make bash` para testes de Unidade
 
-A Granger pediu para fazer o código de uma maneira que mais regras podem ser implementadas nesse fluxo. 
+### Testes
 
-As regras dessa classe são:
-- Essa classe deve ser chamado toda vez que uma transação for criada
-- A classe vai consultar 2 serviços diferentes de checagem, esses serviços são de terceiros e por isso só vamos nos 
-  preocupar em se comunicar com eles através de seus clients (SDK ou API)
-- Nossa classe de checagem de deverá chamar o primeiro cliente e caso ele diga que está "Autorizado" nós processaremos a
-transação sem consultar o segundo
-- Caso o primeiro cliente retorne que "Não está autorizado" ou falhe, iremos chamar o segundo cliente.
-- Se o segundo cliente retornar que está "Autorizado" nós processaremos a transação.
-- Se o segundo cliente retorne que "Não está autorizado" ou falhe. Iremos retornar uma excessão e não salvaremos a
-transação
-- Se possível ordem de execução dos clientes devem ser alteradas sem necessáriamente alterar a classe
-
-2 - A classe principal do nosso serviço é o TransactionHandler (App\Domain\Services\TransactionHandler) e segundo a Granger,
-nosso código não tá bom e apresenta muito erros. Precisamos que você melhore o código para nós.
-
-Problemas que reportados:
-
-- Tem usuários conseguindo sacar dinheiro dos lojistas
-- Não estamos salvando corretamente os valores. Parece que não estão salvando a taxa do SonserinaPay, o valor total das 
-taxas e o valor total correto das transações
-- Notificações não estão funcionando
-- Quando as notificações estavam enviando as vezes enviava mesmo quando uma transação falhava na hora de salvar.
-- Precisamos colocar essa aplicação em um container (Docker) para que ela não dependa de um ambiente local
-- Ela também falou que não estamos cobrindo bem a nossa aplicação com testes, eu até comecei a fazer alguns testes,
-  mas achei facil demais, se você quiser pode usar ele como exemplo. Ela disse que o ideal é cobrirmos 100% dos testes. 
-  Para executar os testes é só rodar `./vendor/bin/phpunit --coverage-text`.
-- A Granger falou que nosso código não tá bom! Quem é essa sang#& ru$% pra falar do meu código. Disse para aplicarmos
-  melhor SOLID, Object Calisthenics e conceitos do livro Clean Code (Código Limpo) do Uncle Bob. Acredito que não tem
-  como melhorar esse código afinal de contas, fui eu quem fiz. Mas tenta ai só pra que eu tenha certeza que sou perfeito.
-- A Granger criou uma tal de pipeline com o Github Actions, ela pediu para tentar fazer ela passar sem nenhum erro.
-
-Observação:
-
-_Não precisa se preocupar com fazer um endpoint ou cli para a execução do seu código ou com a implementação real das
-chamadas para os clientes, ou persistencia em banco de dados. Faremos isso com mágica._
+1. Executar o comando `make test` para testes de Unidade
+1. Executar o comando `make test-coverage` para testes de Unidade com geração de HTML coma cobertura dos testes [`slytherin-pay/coverage/index.html`]
+1. Executar o comando `make infection` para testes de Mutação via infection
+1. Executar testes dentro do container `./vendor/bin/phpunit --coverage-html coverage`

composer.json

@@ -17,6 +17,6 @@
   },
   "scripts": {
     "test": "vendor/bin/phpunit --coverage-text",
-    "infection": "vendor/bin/infection --min-msi=100 --min-covered-msi=100"
+    "infection": "vendor/bin/infection --min-msi=69.53 --min-covered-msi=69.53"
   }
 }

docker-compose.yml

@@ -0,0 +1,11 @@
+version: "3"
+services:
+  app:
+    build:
+      context: ./
+    container_name: slytherin-pay
+    ports:
+      - 8089:80
+    restart: always
+    volumes:
+      - ./:/app

public/index.php

@@ -0,0 +1,21 @@
+<?php
+
+require __DIR__.'/../vendor/autoload.php';
+
+use \App\Domain\Services\Transactions\TransactionExecutator;
+
+$simulateAuthorized = [
+    0 => ['connect' => true, 'authorized' => true],
+    1 => ['connect' => true, 'authorized' => true],
+    3 => ['connect' => true, 'authorized' => true],
+];
+$orderReverse = true;
+
+$executator = new TransactionExecutator();
+$executator->setEmailBuyer('[email protected]');
+$executator->setEmailSeller('[email protected]');
+$executator->setTransaction(2, 20);
+
+$executator->instantiatesClasses();
+
+$executator->transactionHandlerExecute($orderReverse, $simulateAuthorized);

src/App/Domain/Client/NotifierClient.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Domain\Client;
+
+use App\Domain\Contracts\NotifierClientInterface;
+use App\Domain\Entities\Notification;
+
+class NotifierClient implements NotifierClientInterface
+{
+    public function notify(Notification $notifier): void
+    {
+        echo nl2br("email= ".$notifier->getEmail()." message= ".$notifier->getMessage().PHP_EOL);
+    }
+}

src/App/Domain/Client/TaxManagerClient.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Domain\Client;
+
+use App\Domain\Contracts\TaxManagerClientInterface;
+
+class TaxManagerClient implements TaxManagerClientInterface
+{
+    private const DEFAULT_INCREMENT_VALUE = 3.14;
+
+    /**
+     * @param float $tax
+     * @return float
+     */
+    public function getIncrementValue(float $tax): float
+    {
+        return self::DEFAULT_INCREMENT_VALUE;
+    }
+}

src/App/Domain/Contracts/FraudCheckerClientAuthorizedInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Domain\Contracts;
+
+use App\Domain\Contracts\FraudCheckerClientInterface;
+use App\Domain\Entities\Transaction;
+
+interface FraudCheckerClientAuthorizedInterface extends FraudCheckerClientInterface
+{
+    public function isAuthorized(Transaction $transaction, array $simulateAuthorized): bool;
+}

src/App/Domain/Contracts/FraudCheckerClientInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Domain\Contracts;
+
+interface FraudCheckerClientInterface
+{
+    public function connect(bool $return): bool;
+}

src/App/Domain/Clients/NotifierClientInterface.php → src/App/Domain/Contracts/NotifierClientInterface.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace App\Domain\Clients;
+namespace App\Domain\Contracts;
 
 use App\Domain\Entities\Notification;
 

src/App/Domain/Clients/TaxManagerClientInterface.php → src/App/Domain/Contracts/TaxManagerClientInterface.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace App\Domain\Clients;
+namespace App\Domain\Contracts;
 
 /**
  * Interface TaxManagerClientInterface
- * @package App\Domain\Clients
+ * @package App\Domain\Contracts
  */
 interface TaxManagerClientInterface
 {

src/App/Domain/Repositories/TransactionRepositoryInterface.php → src/App/Domain/Contracts/TransactionRepositoryInterface.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace App\Domain\Repositories;
+namespace App\Domain\Contracts;
 
 use App\Domain\Entities\Transaction;
 

src/App/Domain/Entities/Buyer.php

@@ -4,8 +4,12 @@
 
 namespace App\Domain\Entities;
 
+use App\Domain\Traits\EmailTrait;
+
 class Buyer
 {
+    use EmailTrait;
+
     /**
      * @var string
      */

src/App/Domain/Entities/Notification.php

@@ -15,4 +15,36 @@ class Notification
      * @var string
      */
     private string $message;
+
+    /**
+     * @param string $email
+     */
+    public function setEmail(string $email): void
+    {
+        $this->email = $email;
+    }
+
+    /**
+     * @return string
+     */
+    public function getEmail(): string
+    {
+        return $this->email;
+    }
+
+    /**
+     * @param  string  $message
+     */
+    public function setMessage(string $message)
+    {
+        $this->message = $message;
+    }
+
+    /**
+     * @return  string
+     */
+    public function getMessage()
+    {
+        return $this->message;
+    }
 }

src/App/Domain/Entities/Seller.php

@@ -4,8 +4,12 @@
 
 namespace App\Domain\Entities;
 
+use App\Domain\Traits\EmailTrait;
+
 class Seller
 {
+    use EmailTrait;
+
     /**
      * @var string
      */

src/App/Domain/Entities/Transaction.php

@@ -53,6 +53,11 @@ class Transaction
      */
     private Buyer $buyer;
 
+    /**
+     * @var bool
+     */
+    private bool $status;
+
     /**
      * @return string
      */
@@ -196,4 +201,20 @@ public function setBuyer(Buyer $buyer): void
     {
         $this->buyer = $buyer;
     }
+
+    /**
+     * @return bool $status
+     */
+    public function getStatus(): bool
+    {
+        return $this->status;
+    }
+
+    /**
+     * @param bool $status
+     */
+    public function setStatus(bool $status): void
+    {
+        $this->status = $status;
+    }
 }