Feature/refactoring changes

.env.testing

@@ -0,0 +1,36 @@
+APP_NAME=Laravel
+APP_ENV=local
+APP_KEY=base64:vXZ/jB8d03n3McCvEFY3Po4Y9jqQDbXMapstnqHW6no=
+APP_DEBUG=true
+APP_URL=http://localhost:8080
+
+LOG_CHANNEL=stack
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
+
+DB_CONNECTION=mysql
+DB_HOST=mysql
+DB_PORT=3306
+DB_DATABASE=testing
+DB_USERNAME=sail
+DB_PASSWORD=password
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=file
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=sync
+SESSION_DRIVER=file
+SESSION_LIFETIME=120
+
+MEMCACHED_HOST=127.0.0.1
+
+MAIL_MAILER=smtp
+MAIL_HOST=mailpit
+MAIL_PORT=1025
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS="[email protected]"
+MAIL_FROM_NAME="${APP_NAME}"
+
+L5_SWAGGER_CONST_HOST=${APP_URL}/api

ANSWER.md

@@ -0,0 +1,50 @@
+# DECISOES QUE TOMEI NO PROCESSO DE REFATORAÇÃO
+
+- API de usuários usei o padrão Repository com contrato, junto com um serviço para a lógica de negócio e controladores limpos, resulta em um código mais organizado, fácil de manter.
+
+- A separação das responsabilidades torna o código mais modular e fácil de manter. Alterações em uma camada (por exemplo, a lógica de negócio) não afetam diretamente outras camadas (por exemplo, o controlador).
+
+## Separação de Responsabilidades
+
+- InterfaceRepository: Define os métodos essenciais (all, find, create, update, delete) que qualquer repositório deve implementar.
+
+- AbstractRepository: Implementa a interface InterfaceRepository e fornece a lógica básica para manipulação de modelos.
+
+- UserRepository: Extende AbstractRepository e especifica que o modelo é User.
+
+## UserService Service para Lógica de Negócio:
+
+- UserService: Contém a lógica de negócio para manipulação dos usuários (busca, criação, atualização e deleção). O serviço interage com o repositório para realizar essas operações e formata a resposta.
+
+## UserController Limpo
+
+- UserController: Recebe as requisições, delega a lógica de negócio para o UserService e retorna as respostas formatadas.
+
+## ValidateUserRequest Validação Centralizada
+
+- ValidateUserRequest: Classe responsável pela validação dos dados de entrada para criação e atualização de usuários. Contém as regras e mensagens de validação.
+
+## UserControllerTest Testes Automatizados
+
+- Testes para garantir que os métodos do UserController funcionem conforme esperado. Isso inclui testar as operações de indexação, exibição, criação, atualização e deleção de usuários.
+
+## Legibilidade e Clareza:
+
+- A estrutura modular facilita a adição de novas funcionalidades ou a modificação das existentes sem causar grandes impactos na aplicação como um todo.
+
+## Mudança no makefile
+
+- A estrutura que estava como padrão não funcionava na minha maquina então adicionei uma condicional `||` para que funcione em outras versões inclusive a minha ex: 
+`docker-compose down || docker compose down`
+
+## Mudança no Readme.md 
+
+- a porta da aplicaçaõ estava em `http://localhost:8000`. Fiz a mudança para `http://localhost:8080`. O mesmo para a documentação `http://localhost:8000/api/documentation`. Fiz a mudança para `http://localhost:8080/api/documentation`.
+
+
+## Meio de Contato 
+
+- whats: (98) 984242805
+- email: [email protected]
+
+` Espero seu retorno ...`

README.md

@@ -42,11 +42,11 @@ Ensure that docker is running on your local machine.
    make up
    ```
 
-The application will be accessible at `http://localhost:8000`.
+The application will be accessible at `http://localhost:8080`.
 
 ### Documentation
 
-The API is documented using Swagger. Ensure that your refactoring maintains or improves the clarity of the API documentation. The Swagger documentation can be accessed at `http://localhost:8000/api/documentation`.
+The API is documented using Swagger. Ensure that your refactoring maintains or improves the clarity of the API documentation. The Swagger documentation can be accessed at `http://localhost:8080/api/documentation`.
 
 ### Useful Makefile Targets
 

app/Exceptions/Handler.php

@@ -2,8 +2,9 @@
 
 namespace App\Exceptions;
 
-use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
 use Throwable;
+use Illuminate\Validation\ValidationException;
+use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
 
 class Handler extends ExceptionHandler
 {
@@ -27,4 +28,23 @@ public function register(): void
             //
         });
     }
+
+    /**
+     * Render an exception into an HTTP response.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Throwable  $exception
+     * @return \Illuminate\Http\Response
+     */
+    public function render($request, Throwable $exception)
+    {
+        if ($exception instanceof ValidationException) {
+            return response()->json([
+                'status' => false,
+                'errors' => $exception->errors()
+            ], 422);
+        }
+
+        return parent::render($request, $exception);
+    }
 }

app/Http/Controllers/UserController.php → app/Http/Controllers/Api/UserController.php

@@ -1,17 +1,21 @@
 <?php
 
-namespace App\Http\Controllers;
+namespace App\Http\Controllers\Api;
 
 use App\Models\User;
-use Illuminate\Http\Request;
+use App\Services\UserService;
+use Illuminate\Http\JsonResponse;
+use App\Http\Controllers\Controller;
+use App\Http\Requests\ValidateUserRequest;
+
 
 class UserController extends Controller
 {
-    private User $user;
+    protected $service;
 
-    function __construct(User $user)
+    function __construct(UserService $service)
     {
-        $this->user = $user;
+        $this->service = $service;
     }
 
     /**
@@ -48,9 +52,10 @@ function __construct(User $user)
      *      )
      * )
      */
-    public function index(Request $request)
+    public function index(): JsonResponse
     {
-        return $this->user->get();
+        $data = $this->service->getAllUser();
+        return $this->generateResponse($data);
     }
 
     /**
@@ -88,9 +93,10 @@ public function index(Request $request)
      *      )
      * )
      */
-    public function show(User $user)
+    public function show(int $id): JsonResponse
     {
-        return $user;
+        $data = $this->service->getUserById($id);
+        return $this->generateResponse($data);
     }
 
     /**
@@ -126,15 +132,10 @@ public function show(User $user)
      *      )
      * )
      */
-    public function store(Request $request)
+    public function store(ValidateUserRequest $request): JsonResponse
     {
-        $data = $request->only([
-            'name',
-            'email',
-            'password',
-        ]);
-
-        return $this->user->create($data);
+        $data = $this->service->createUser($request->all());
+        return $this->generateResponse($data);
     }
 
     /**
@@ -176,17 +177,10 @@ public function store(Request $request)
      *      )
      * )
      */
-    public function update(Request $request, User $user)
+    public function update(int $id, ValidateUserRequest $request): JsonResponse
     {
-        $data = $request->only([
-            'name',
-            'email',
-            'password',
-        ]);
-
-        $user->update($data);
-
-        return $user;
+        $data = $this->service->updateUser($id, $request->all());
+        return $this->generateResponse($data);
     }
 
     /**
@@ -224,11 +218,15 @@ public function update(Request $request, User $user)
      *      )
      * )
      */
-    public function destroy(User $user)
+    public function destroy(int $id): JsonResponse
     {
-        $user->delete();
+        $data = $this->service->deleteUser($id);
+        return $this->generateResponse($data);
+    }
 
-        return $user;
+    private function generateResponse(array $data): JsonResponse
+    {
+        return response()->json($data['data'], $data['status']);
     }
 }
 

app/Http/Requests/ValidateUserRequest.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace App\Http\Requests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class ValidateUserRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, \Illuminate\Contracts\Validation\ValidationRule|array<mixed>|string>
+     */
+    public function rules(): array
+    {
+        if ($this->isMethod('post')) {
+            return [
+                'name' => 'required|string|max:255|min:3',
+                'email' => 'required|email|unique:users,email',
+                'password' => 'required|string|min:8',
+            ];
+        } elseif ($this->isMethod('put') || $this->isMethod('patch')) {
+            return [
+                'name' => 'sometimes|string|max:255',
+                'email' => 'sometimes|email|unique:users,email,' . $this->route('id'),
+                'password' => 'sometimes|string|min:8',
+            ];
+        }
+
+        return [];
+    }
+
+    /**
+     * Get the custom validation messages.
+     *
+     * @return array<string, string>
+     */
+    public function messages(): array
+    {
+        return [
+            'name.min' => 'O nome deve ter pelo menos 3 caracteres.',
+            'name.required' => 'O nome é obrigatório.',
+            'name.string' => 'O nome deve ser uma string.',
+            'name.max' => 'O nome não pode ter mais de 255 caracteres.',
+            'email.required' => 'O email é obrigatório.',
+            'email.email' => 'O email deve ser um endereço de email válido.',
+            'email.unique' => 'O email já está em uso.',
+            'password.required' => 'A senha é obrigatória.',
+            'password.string' => 'A senha deve ser uma string.',
+            'password.min' => 'A senha deve ter pelo menos 8 caracteres.',
+        ];
+    }
+}

app/Repositories/Contract/AbstractRepository.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Repositories\Contract;
+
+abstract class AbstractRepository implements InterfaceRepository
+{
+    protected $model;
+
+    public function all(): object
+    {
+        return $this->model->all();
+    }
+
+    public function find(int $id): ?object
+    {
+        return $this->model->find($id);
+    }
+
+    public function create(array $data): object
+    {
+        return $this->model->create($data);
+    }
+
+    public function update($data, array $request): object
+    {
+        $data->update($request);
+        return $data;
+    }
+
+    public function delete(int $id): bool
+    {
+        return $this->model->find($id)->delete();
+    }
+}

app/Repositories/Contract/InterfaceRepository.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Repositories\Contract;
+
+interface InterfaceRepository
+{
+
+    public function all(): object;
+
+    public function find(int $id): ?object;
+
+    public function create(array $data): object;
+
+    public function update($data, array $request): object;
+
+    public function delete(int $id): bool;
+}

app/Repositories/UserRepository.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace App\Repositories;
+
+use App\Models\User;
+use App\Repositories\Contract\AbstractRepository;
+
+class UserRepository extends AbstractRepository
+{
+    public function __construct()
+    {
+        $this->model = new User();
+    }
+}