feat: send challeng with documentation

challenge/.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[docker-compose.yml]
+indent_size = 4

challenge/.env.example

@@ -0,0 +1,58 @@
+APP_NAME=Laravel
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=true
+APP_URL=http://localhost
+
+LOG_CHANNEL=stack
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
+
+DB_CONNECTION=mysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_DATABASE=example_app
+DB_USERNAME=root
+DB_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
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_MAILER=smtp
+MAIL_HOST=mailhog
+MAIL_PORT=1025
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS="[email protected]"
+MAIL_FROM_NAME="${APP_NAME}"
+
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=us-east-1
+AWS_BUCKET=
+AWS_USE_PATH_STYLE_ENDPOINT=false
+
+PUSHER_APP_ID=
+PUSHER_APP_KEY=
+PUSHER_APP_SECRET=
+PUSHER_HOST=
+PUSHER_PORT=443
+PUSHER_SCHEME=https
+PUSHER_APP_CLUSTER=mt1
+
+VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
+VITE_PUSHER_HOST="${PUSHER_HOST}"
+VITE_PUSHER_PORT="${PUSHER_PORT}"
+VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
+VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

challenge/.gitattributes

@@ -0,0 +1,11 @@
+* text=auto
+
+*.blade.php diff=html
+*.css diff=css
+*.html diff=html
+*.md diff=markdown
+*.php diff=php
+
+/.github export-ignore
+CHANGELOG.md export-ignore
+.styleci.yml export-ignore

challenge/.gitignore

@@ -0,0 +1,16 @@
+/node_modules
+/public/build
+/public/hot
+/public/storage
+/storage/*.key
+/vendor
+.env
+.env.backup
+.phpunit.result.cache
+Homestead.json
+Homestead.yaml
+auth.json
+npm-debug.log
+yarn-error.log
+/.idea
+/.vscode

challenge/README.md

@@ -0,0 +1,15 @@
+## Sobre api
+- O teste lógico está documentado com a tag `Challeng logical`
+- A parte de integração com a API qualifica está com a tag `User`
+
+## Instruções de instalação
+- Copiar as váriaveis de ambiente `cp .env.example .env`
+- Rodar `composer install` no terminal para instalar as dependências do Laravel.
+- Para rodar o projeto usar o [laravel sail](https://laravel.com/docs/9.x/sail) `./vendor/bin/sail up`
+- Caso APP_KEY no .env não esteja cadastrada rodar `./vendor/bin/sail artisan key:generate`
+- Rodar as migration `./vendor/bin/sail artisan migrate`
+- Gerar a documentação da api e fazer testes com [swagger](https://swagger.io/) `./vendor/bin/sail artisan l5-swagger:generate`
+
+## Acessos
+- PhpMyAdmin: http://localhost:8002/ | Username: `sail` Password: `password`
+- Documentação swagger: http://0.0.0.0/api/documentation#/

challenge/app/Console/Kernel.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Console;
+
+use Illuminate\Console\Scheduling\Schedule;
+use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
+
+class Kernel extends ConsoleKernel
+{
+    /**
+     * Define the application's command schedule.
+     *
+     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
+     * @return void
+     */
+    protected function schedule(Schedule $schedule)
+    {
+        // $schedule->command('inspire')->hourly();
+    }
+
+    /**
+     * Register the commands for the application.
+     *
+     * @return void
+     */
+    protected function commands()
+    {
+        $this->load(__DIR__.'/Commands');
+
+        require base_path('routes/console.php');
+    }
+}

challenge/app/Contract/DowngradeUserAPIInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Contract;
+
+use App\DTO\DowngradeUserDTO;
+
+interface DowngradeUserAPIInterface
+{
+
+	public function handle(DowngradeUserDTO $dataDTO);  
+}

challenge/app/Contract/FindByExternalIdInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Contract;
+
+use App\DTO\FindByExternalIdUserDTO;
+
+interface FindByExternalIdInterface
+{
+
+	public function handle(FindByExternalIdUserDTO $dataDTO);  
+}

challenge/app/Contract/ListAllUsersInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Contract;
+
+use App\DTO\StoreUserAPIDTO;
+
+interface ListAllUsersInterface
+{
+
+	public function handle();  
+}

challenge/app/Contract/StoreUserAPIInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Contract;
+
+use App\DTO\StoreUserAPIDTO;
+
+interface StoreUserAPIInterface
+{
+
+	public function handle(StoreUserAPIDTO $dataDTO);  
+}

challenge/app/Contract/StoreUserInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Contract;
+
+use App\DTO\StoreUserDTO;
+
+interface StoreUserInterface
+{
+
+	public function handle(StoreUserDTO $dataDTO);  
+}

challenge/app/Contract/UpdateUserInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Contract;
+
+use App\DTO\UpdateUserDTO;
+
+interface UpdateUserInterface
+{
+
+	public function handle(UpdateUserDTO $dataDTO);  
+}

challenge/app/Contract/UpgradeUserAPIInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace App\Contract;
+
+use App\DTO\StoreUserAPIDTO;
+use App\DTO\UpgradeUserDTO;
+
+interface UpgradeUserAPIInterface
+{
+
+	public function handle(UpgradeUserDTO $dataDTO);  
+}

challenge/app/DTO/DowngradeUserDTO.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace App\DTO;
+
+use Spatie\DataTransferObject\Attributes\MapFrom;
+use Spatie\DataTransferObject\DataTransferObject;
+
+class DowngradeUserDTO extends DataTransferObject
+{
+
+    /**
+     *
+     * @var string
+     */
+    public string $id;
+
+
+
+}

challenge/app/DTO/FindByExternalIdUserDTO.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\DTO;
+
+use App\Models\User;
+use Spatie\DataTransferObject\Attributes\MapFrom;
+use Spatie\DataTransferObject\DataTransferObject;
+
+class FindByExternalIdUserDTO extends DataTransferObject
+{
+
+    /**
+     *
+     * @var string
+     */
+    public string $id;
+
+
+
+}

challenge/app/DTO/StoreUserAPIDTO.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\DTO;
+
+use Spatie\DataTransferObject\Attributes\MapFrom;
+use Spatie\DataTransferObject\DataTransferObject;
+
+class StoreUserAPIDTO extends DataTransferObject
+{
+
+    /**
+     *
+     * @var string
+     */
+    public string $msisdn;
+
+    /**
+     *
+     * @var string
+     */
+    public string $name;
+
+    /**
+     *
+     * @var string
+     */
+    public string $access_level;
+
+    /**
+     *
+     * @var string|null
+     */
+    public ?string $password = null;
+
+    /**
+     *
+     * @var integer
+     */
+    public int $external_id;
+}

challenge/app/DTO/StoreUserDTO.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace App\DTO;
+
+use Spatie\DataTransferObject\Attributes\MapFrom;
+use Spatie\DataTransferObject\DataTransferObject;
+
+class StoreUserDTO extends DataTransferObject
+{
+
+    /**
+     *
+     * @var string
+     */
+    public string $msisdn;
+
+    /**
+     *
+     * @var string
+     */
+    public string $name;
+
+    /**
+     *
+     * @var string
+     */
+    public string $access_level;
+
+    /**
+     *
+     * @var string|null
+     */
+    public ?string $password = null;
+
+
+}

challenge/app/DTO/UpdateUserDTO.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\DTO;
+
+use App\Models\User;
+use Spatie\DataTransferObject\Attributes\MapFrom;
+use Spatie\DataTransferObject\DataTransferObject;
+
+class UpdateUserDTO extends DataTransferObject
+{
+
+    /**
+     *
+     * @var User
+     */
+    public User $user;
+
+    /**
+     *
+     * @var array
+     */
+    public array $data;
+
+
+
+}