daevin 1.0.0

package/Daevin_test/app/Containers/AppSection/User/Tasks/DeleteUserTask.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Containers\AppSection\User\Tasks;
+
+use App\Containers\AppSection\User\Data\Repositories\UserRepository;
+use App\Ship\Exceptions\DeleteResourceFailedException;
+use App\Ship\Exceptions\NotFoundException;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+use Exception;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+
+class DeleteUserTask extends ParentTask
+{
+    public function __construct(
+        protected UserRepository $repository
+    ) {
+    }
+
+    /**
+     * @param $id
+     * @return int
+     * @throws DeleteResourceFailedException
+     * @throws NotFoundException
+     */
+    public function run($id): int
+    {
+        try {
+            return $this->repository->delete($id);
+        } catch (ModelNotFoundException) {
+            throw new NotFoundException();
+        } catch (Exception) {
+            throw new DeleteResourceFailedException();
+        }
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/Tasks/FindUserByEmailTask.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Containers\AppSection\User\Tasks;
+
+use App\Containers\AppSection\User\Data\Repositories\UserRepository;
+use App\Containers\AppSection\User\Models\User;
+use App\Ship\Exceptions\NotFoundException;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+
+class FindUserByEmailTask extends ParentTask
+{
+    public function __construct(
+        protected UserRepository $repository
+    ) {
+    }
+
+    /**
+     * @param string $email
+     * @return User
+     * @throws NotFoundException
+     */
+    public function run(string $email): User
+    {
+        $user = $this->repository->findByField('email', $email)->first();
+
+        return $user ?? throw new NotFoundException();
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/Tasks/FindUserByIdTask.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace App\Containers\AppSection\User\Tasks;
+
+use App\Containers\AppSection\User\Data\Repositories\UserRepository;
+use App\Containers\AppSection\User\Models\User;
+use App\Ship\Exceptions\NotFoundException;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+use Exception;
+
+class FindUserByIdTask extends ParentTask
+{
+    public function __construct(
+        protected UserRepository $repository
+    ) {
+    }
+
+    /**
+     * @param $userId
+     * @return User
+     * @throws NotFoundException
+     */
+    public function run($userId): User
+    {
+        try {
+            return $this->repository->find($userId);
+        } catch (Exception) {
+            throw new NotFoundException();
+        }
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/Tasks/GetAllUsersTask.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Containers\AppSection\User\Tasks;
+
+use Apiato\Core\Exceptions\CoreInternalErrorException;
+use App\Containers\AppSection\User\Data\Repositories\UserRepository;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+use Prettus\Repository\Exceptions\RepositoryException;
+
+class GetAllUsersTask extends ParentTask
+{
+    public function __construct(
+        protected UserRepository $repository
+    ) {
+    }
+
+    /**
+     * @return mixed
+     * @throws CoreInternalErrorException
+     * @throws RepositoryException
+     */
+    public function run(): mixed
+    {
+        return $this->addRequestCriteria()->repository->paginate();
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/Tasks/UpdateUserTask.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace App\Containers\AppSection\User\Tasks;
+
+use App\Containers\AppSection\User\Data\Repositories\UserRepository;
+use App\Containers\AppSection\User\Models\User;
+use App\Ship\Exceptions\NotFoundException;
+use App\Ship\Exceptions\UpdateResourceFailedException;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+use Exception;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Support\Facades\Hash;
+
+class UpdateUserTask extends ParentTask
+{
+    public function __construct(
+        protected UserRepository $repository
+    ) {
+    }
+
+    /**
+     * @param array $userData
+     * @param $userId
+     * @return User
+     * @throws NotFoundException
+     * @throws UpdateResourceFailedException
+     */
+    public function run(array $userData, $userId): User
+    {
+        try {
+            if (array_key_exists('password', $userData)) {
+                $userData['password'] = Hash::make($userData['password']);
+            }
+
+            return $this->repository->update($userData, $userId);
+        } catch (ModelNotFoundException) {
+            throw new NotFoundException();
+        } catch (Exception) {
+            throw new UpdateResourceFailedException();
+        }
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/Tests/TestCase.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Containers\AppSection\User\Tests;
+
+use App\Ship\Parents\Tests\PhpUnit\TestCase as ParentTestCase;
+
+/**
+ * Class TestCase
+ *
+ * This is the container TestCase class. Use this class to add your container specific helper functions. This testcase
+ * is usually used only for unit tests.
+ *
+ * NOTE: API, WEB & CLI specific TestCase classes are located inside their own respective folders e.g. UI/API/Tests/ApiTestCase.php
+ */
+class TestCase extends ParentTestCase
+{
+    // ..
+}

package/Daevin_test/app/Containers/AppSection/User/Tests/Unit/CreateAdminActionTest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace App\Containers\AppSection\User\Tests\Unit;
+
+use App\Containers\AppSection\User\Actions\CreateAdminAction;
+use App\Containers\AppSection\User\Tests\TestCase;
+use Exception;
+
+/**
+ * Class CreateAdminActionTest.
+ *
+ * @group user
+ * @group unit
+ */
+class CreateAdminActionTest extends TestCase
+{
+    public function testCreateAdmin(): void
+    {
+        $data = [
+            'email' => 'some@one.test',
+            'password' => 'admin',
+            'name' => 'Super Admin',
+        ];
+
+        $admin = app(CreateAdminAction::class)->run($data);
+
+        $this->assertEquals($data['email'], $admin->email);
+        $this->assertTrue($admin->hasRole(config('appSection-authorization.admin_role')));
+        $this->assertNotNull($admin->email_verified_at);
+    }
+
+    public function testGivenInvalidData_ThrowExceptionAndRollbackAllCommits(): void
+    {
+        $this->expectException(Exception::class);
+
+        // update Admin role name to a not existing role (different from what is seeded for admin role),
+        // so we can get an error
+        config(['appSection-authorization.admin_role' => 'not_existing_role']);
+
+        $data = [
+            'email' => 'a@new.email',
+            'password' => 'admin',
+            'name' => 'Super Admin',
+        ];
+
+        $admin = app(CreateAdminAction::class)->run($data);
+
+        $this->assertModelMissing($admin);
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/Tests/Unit/DeleteUserTaskTest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Containers\AppSection\User\Tests\Unit;
+
+use App\Containers\AppSection\User\Models\User;
+use App\Containers\AppSection\User\Tasks\DeleteUserTask;
+use App\Containers\AppSection\User\Tests\TestCase;
+use App\Ship\Exceptions\NotFoundException;
+
+/**
+ * Class DeleteUserTaskTest.
+ *
+ * @group user
+ * @group unit
+ */
+class DeleteUserTaskTest extends TestCase
+{
+    public function testDeleteUser(): void
+    {
+        $user = User::factory()->create();
+
+        $result = app(DeleteUserTask::class)->run($user->id);
+
+        $this->assertEquals(1, $result);
+    }
+
+    public function testDeleteUserWithInvalidId(): void
+    {
+        $this->expectException(NotFoundException::class);
+
+        $noneExistingId = 777777;
+
+        app(DeleteUserTask::class)->run($noneExistingId);
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/Tests/Unit/FindUserByIdTaskTest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Containers\AppSection\User\Tests\Unit;
+
+use App\Containers\AppSection\User\Models\User;
+use App\Containers\AppSection\User\Tasks\FindUserByIdTask;
+use App\Containers\AppSection\User\Tests\TestCase;
+use App\Ship\Exceptions\NotFoundException;
+
+/**
+ * Class FindUserByIdTaskTest.
+ *
+ * @group user
+ * @group unit
+ */
+class FindUserByIdTaskTest extends TestCase
+{
+    public function testFindUserById(): void
+    {
+        $user = User::factory()->create();
+
+        $foundUser = app(FindUserByIdTask::class)->run($user->id);
+
+        $this->assertEquals($user->id, $foundUser->id);
+    }
+
+    public function testFindUserWithInvalidId(): void
+    {
+        $this->expectException(NotFoundException::class);
+
+        $noneExistingId = 777777;
+
+        app(FindUserByIdTask::class)->run($noneExistingId);
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/Tests/Unit/PasswordResetsMigrationTest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Containers\AppSection\User\Tests\Unit;
+
+use App\Containers\AppSection\User\Tests\TestCase;
+use Illuminate\Support\Facades\Schema;
+
+/**
+ * Class PasswordResetsMigrationTest.
+ *
+ * @group user
+ * @group unit
+ */
+class PasswordResetsMigrationTest extends TestCase
+{
+    public function test_password_resets_table_has_expected_columns(): void
+    {
+        $columns = [
+            'email',
+            'token',
+            'created_at',
+        ];
+
+        foreach ($columns as $column) {
+            $this->assertTrue(Schema::hasColumn('password_resets', $column));
+        }
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/Tests/Unit/UpdateUserTaskTest.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace App\Containers\AppSection\User\Tests\Unit;
+
+use App\Containers\AppSection\User\Models\User;
+use App\Containers\AppSection\User\Tasks\UpdateUserTask;
+use App\Containers\AppSection\User\Tests\TestCase;
+use App\Ship\Exceptions\NotFoundException;
+use Illuminate\Support\Facades\Hash;
+
+/**
+ * Class UpdateUserTaskTest.
+ *
+ * @group user
+ * @group unit
+ */
+class UpdateUserTaskTest extends TestCase
+{
+    public function testUpdateUser(): void
+    {
+        $user = User::factory()->create();
+        $data = [
+            'name' => 'new name',
+        ];
+
+        $updatedUser = app(UpdateUserTask::class)->run($data, $user->id);
+
+        $this->assertEquals($user->id, $updatedUser->id);
+        $this->assertEquals($data['name'], $updatedUser->name);
+    }
+
+    public function testUpdateUserWithInvalidID(): void
+    {
+        $this->expectException(NotFoundException::class);
+
+        $noneExistingId = 777777;
+
+        app(UpdateUserTask::class)->run([], $noneExistingId);
+    }
+
+    public function testUpdatedPasswordShouldBeHashed(): void
+    {
+        $user = User::factory()->create();
+        $data = [
+            'password' => 'secret',
+        ];
+
+        $result = app(UpdateUserTask::class)->run($data, $user->id);
+
+        $this->assertTrue(Hash::check($data['password'], $result->password));
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/Tests/Unit/UserFactoryTest.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace App\Containers\AppSection\User\Tests\Unit;
+
+use App\Containers\AppSection\User\Models\User;
+use App\Containers\AppSection\User\Tests\TestCase;
+
+/**
+ * Class UserFactoryTest.
+ *
+ * @group user
+ * @group unit
+ */
+class UserFactoryTest extends TestCase
+{
+    public function testCreateUser(): void
+    {
+        $user = User::factory()->create();
+
+        $this->assertInstanceOf(User::class, $user);
+    }
+
+    public function testCreateAdminUser(): void
+    {
+        $user = User::factory()->admin()->create();
+
+        $this->assertTrue($user->hasRole(config('appSection-authorization.admin_role')));
+    }
+
+    public function testCreateUnverifiedUser(): void
+    {
+        $user = User::factory()->unverified()->create();
+
+        $this->assertNull($user->email_verified_at);
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/Tests/Unit/UsersMigrationTest.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Containers\AppSection\User\Tests\Unit;
+
+use App\Containers\AppSection\User\Tests\TestCase;
+use Illuminate\Support\Facades\Schema;
+
+/**
+ * Class UsersMigrationTest.
+ *
+ * @group user
+ * @group unit
+ */
+class UsersMigrationTest extends TestCase
+{
+    public function test_users_table_has_expected_columns(): void
+    {
+        $columns = [
+            'id',
+            'name',
+            'email',
+            'password',
+            'email_verified_at',
+            'gender',
+            'remember_token',
+            'created_at',
+            'updated_at',
+        ];
+
+        foreach ($columns as $column) {
+            $this->assertTrue(Schema::hasColumn('users', $column));
+        }
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/UI/API/Controllers/DeleteUserController.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Containers\AppSection\User\UI\API\Controllers;
+
+use App\Containers\AppSection\User\Actions\DeleteUserAction;
+use App\Containers\AppSection\User\UI\API\Requests\DeleteUserRequest;
+use App\Ship\Exceptions\DeleteResourceFailedException;
+use App\Ship\Exceptions\NotFoundException;
+use App\Ship\Parents\Controllers\ApiController;
+use Illuminate\Http\JsonResponse;
+
+class DeleteUserController extends ApiController
+{
+    /**
+     * @param DeleteUserRequest $request
+     * @return JsonResponse
+     * @throws DeleteResourceFailedException
+     * @throws NotFoundException
+     */
+    public function deleteUser(DeleteUserRequest $request): JsonResponse
+    {
+        app(DeleteUserAction::class)->run($request);
+
+        return $this->noContent();
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/UI/API/Controllers/FindUserByIdController.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Containers\AppSection\User\UI\API\Controllers;
+
+use Apiato\Core\Exceptions\InvalidTransformerException;
+use App\Containers\AppSection\User\Actions\FindUserByIdAction;
+use App\Containers\AppSection\User\UI\API\Requests\FindUserByIdRequest;
+use App\Containers\AppSection\User\UI\API\Transformers\UserTransformer;
+use App\Ship\Exceptions\NotFoundException;
+use App\Ship\Parents\Controllers\ApiController;
+
+class FindUserByIdController extends ApiController
+{
+    /**
+     * @param FindUserByIdRequest $request
+     * @return array
+     * @throws InvalidTransformerException
+     * @throws NotFoundException
+     */
+    public function findUserById(FindUserByIdRequest $request): array
+    {
+        $user = app(FindUserByIdAction::class)->run($request);
+
+        return $this->transform($user, UserTransformer::class);
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/UI/API/Controllers/GetAllUsersController.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Containers\AppSection\User\UI\API\Controllers;
+
+use Apiato\Core\Exceptions\CoreInternalErrorException;
+use Apiato\Core\Exceptions\InvalidTransformerException;
+use App\Containers\AppSection\User\Actions\GetAllUsersAction;
+use App\Containers\AppSection\User\UI\API\Requests\GetAllUsersRequest;
+use App\Containers\AppSection\User\UI\API\Transformers\UserTransformer;
+use App\Ship\Parents\Controllers\ApiController;
+use Prettus\Repository\Exceptions\RepositoryException;
+
+class GetAllUsersController extends ApiController
+{
+    /**
+     * @param GetAllUsersRequest $request
+     * @return array
+     * @throws CoreInternalErrorException
+     * @throws InvalidTransformerException
+     * @throws RepositoryException
+     */
+    public function getAllUsers(GetAllUsersRequest $request): array
+    {
+        $users = app(GetAllUsersAction::class)->run();
+
+        return $this->transform($users, UserTransformer::class);
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/UI/API/Controllers/UpdateUserController.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Containers\AppSection\User\UI\API\Controllers;
+
+use Apiato\Core\Exceptions\IncorrectIdException;
+use Apiato\Core\Exceptions\InvalidTransformerException;
+use App\Containers\AppSection\User\Actions\UpdateUserAction;
+use App\Containers\AppSection\User\UI\API\Requests\UpdateUserRequest;
+use App\Containers\AppSection\User\UI\API\Transformers\UserTransformer;
+use App\Ship\Exceptions\NotFoundException;
+use App\Ship\Exceptions\UpdateResourceFailedException;
+use App\Ship\Parents\Controllers\ApiController;
+
+class UpdateUserController extends ApiController
+{
+    /**
+     * @param UpdateUserRequest $request
+     * @return array
+     * @throws InvalidTransformerException
+     * @throws NotFoundException
+     * @throws UpdateResourceFailedException
+     * @throws IncorrectIdException
+     */
+    public function updateUser(UpdateUserRequest $request): array
+    {
+        $user = app(UpdateUserAction::class)->run($request);
+
+        return $this->transform($user, UserTransformer::class);
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/UI/API/Controllers/UpdateUserPasswordController.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Containers\AppSection\User\UI\API\Controllers;
+
+use Apiato\Core\Exceptions\IncorrectIdException;
+use Apiato\Core\Exceptions\InvalidTransformerException;
+use App\Containers\AppSection\User\Actions\UpdateUserPasswordAction;
+use App\Containers\AppSection\User\UI\API\Requests\UpdateUserPasswordRequest;
+use App\Containers\AppSection\User\UI\API\Transformers\UserTransformer;
+use App\Ship\Exceptions\NotFoundException;
+use App\Ship\Exceptions\UpdateResourceFailedException;
+use App\Ship\Parents\Controllers\ApiController;
+
+class UpdateUserPasswordController extends ApiController
+{
+    /**
+     * @param UpdateUserPasswordRequest $request
+     * @return array
+     * @throws IncorrectIdException
+     * @throws InvalidTransformerException
+     * @throws NotFoundException
+     * @throws UpdateResourceFailedException
+     */
+    public function updateUserPassword(UpdateUserPasswordRequest $request): array
+    {
+        $user = app(UpdateUserPasswordAction::class)->run($request);
+
+        return $this->transform($user, UserTransformer::class);
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/UI/API/Requests/DeleteUserRequest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace App\Containers\AppSection\User\UI\API\Requests;
+
+use App\Containers\AppSection\Authorization\Traits\IsResourceOwnerTrait;
+use App\Ship\Parents\Requests\Request as ParentRequest;
+
+class DeleteUserRequest extends ParentRequest
+{
+    use IsResourceOwnerTrait;
+
+    /**
+     * Define which Roles and/or Permissions has access to this request.
+     */
+    protected array $access = [
+        'permissions' => 'delete-users',
+        'roles' => '',
+    ];
+
+    /**
+     * Id's that needs decoding before applying the validation rules.
+     */
+    protected array $decode = [
+        'id',
+    ];
+
+    /**
+     * Defining the URL parameters (`/stores/999/items`) allows applying
+     * validation rules on them and allows accessing them like request data.
+     */
+    protected array $urlParameters = [
+        'id',
+    ];
+
+    public function rules(): array
+    {
+        return [
+            // 'id' => 'required',
+        ];
+    }
+
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess|isResourceOwner',
+        ]);
+    }
+}