daevin 1.0.0

package/Daevin_test/app/Containers/AppSection/Authorization/Models/Role.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Models;
+
+use Apiato\Core\Traits\FactoryLocatorTrait;
+use Apiato\Core\Traits\HashIdTrait;
+use Apiato\Core\Traits\HasResourceKeyTrait;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Spatie\Permission\Models\Role as SpatieRole;
+
+class Role extends SpatieRole
+{
+    use HashIdTrait;
+    use HasResourceKeyTrait;
+    use HasFactory, FactoryLocatorTrait {
+        FactoryLocatorTrait::newFactory insteadof HasFactory;
+    }
+
+    protected string $guard_name = 'api';
+
+    protected $fillable = [
+        'name',
+        'guard_name',
+        'display_name',
+        'description',
+    ];
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Providers/MainServiceProvider.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Providers;
+
+use App\Ship\Parents\Providers\MainServiceProvider as ParentMainServiceProvider;
+
+/**
+ * Class MainServiceProvider.
+ *
+ * The Main Service Provider of this container, it will be automatically registered in the framework.
+ */
+class MainServiceProvider extends ParentMainServiceProvider
+{
+    /**
+     * Container Service Providers.
+     */
+    public array $serviceProviders = [
+
+    ];
+
+    /**
+     * Container Aliases
+     */
+    public array $aliases = [
+
+    ];
+}

package/Daevin_test/app/Containers/AppSection/Authorization/README.md

@@ -0,0 +1 @@
+### Apiato Authorization Container

package/Daevin_test/app/Containers/AppSection/Authorization/Tasks/AssignRolesToUserTask.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tasks;
+
+use App\Containers\AppSection\Authorization\Models\Role;
+use App\Containers\AppSection\User\Models\User;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+use Illuminate\Contracts\Auth\Authenticatable;
+
+class AssignRolesToUserTask extends ParentTask
+{
+    /**
+     * @param User $user
+     * @param array|int|string|Role $roles
+     * @return Authenticatable
+     */
+    public function run(User $user, Role|array|int|string $roles): Authenticatable
+    {
+        return $user->assignRole($roles);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Tasks/CreatePermissionTask.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tasks;
+
+use App\Containers\AppSection\Authorization\Data\Repositories\PermissionRepository;
+use App\Containers\AppSection\Authorization\Models\Permission;
+use App\Ship\Exceptions\CreateResourceFailedException;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+use Exception;
+
+class CreatePermissionTask extends ParentTask
+{
+    public function __construct(
+        protected PermissionRepository $repository
+    ) {
+    }
+
+    /**
+     * @param string $name
+     * @param string|null $description
+     * @param string|null $displayName
+     * @param string $guardName
+     * @return Permission
+     * @throws CreateResourceFailedException
+     */
+    public function run(string $name, string $description = null, string $displayName = null, string $guardName = 'api'): Permission
+    {
+        try {
+            $permission = $this->repository->create([
+                'name' => strtolower($name),
+                'description' => $description,
+                'display_name' => $displayName,
+                'guard_name' => $guardName,
+            ]);
+        } catch (Exception $exception) {
+            throw new CreateResourceFailedException($exception->getMessage());
+        }
+
+        return $permission;
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Tasks/CreateRoleTask.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tasks;
+
+use App\Containers\AppSection\Authorization\Data\Repositories\RoleRepository;
+use App\Containers\AppSection\Authorization\Models\Role;
+use App\Ship\Exceptions\CreateResourceFailedException;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+use Exception;
+
+class CreateRoleTask extends ParentTask
+{
+    public function __construct(
+        protected RoleRepository $repository
+    ) {
+    }
+
+    /**
+     * @param string $name
+     * @param string|null $description
+     * @param string|null $displayName
+     * @param string $guardName
+     * @return Role
+     * @throws CreateResourceFailedException
+     */
+    public function run(string $name, string $description = null, string $displayName = null, string $guardName = 'api'): Role
+    {
+        try {
+            $role = $this->repository->create([
+                'name' => strtolower($name),
+                'description' => $description,
+                'display_name' => $displayName,
+                'guard_name' => $guardName,
+            ]);
+        } catch (Exception) {
+            throw new CreateResourceFailedException();
+        }
+
+        return $role;
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Tasks/DeleteRoleTask.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tasks;
+
+use App\Containers\AppSection\Authorization\Data\Repositories\RoleRepository;
+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 DeleteRoleTask extends ParentTask
+{
+    public function __construct(
+        protected RoleRepository $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/Authorization/Tasks/DetachPermissionsFromRoleTask.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tasks;
+
+use App\Containers\AppSection\Authorization\Models\Permission;
+use App\Containers\AppSection\Authorization\Models\Role;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+
+class DetachPermissionsFromRoleTask extends ParentTask
+{
+    /**
+     * @param Role $role
+     * @param Permission[] $permissions
+     * @return Role
+     */
+    public function run(Role $role, array $permissions): Role
+    {
+        array_map(static function ($permission) use ($role) {
+            $role->revokePermissionTo($permission);
+        }, $permissions);
+
+        return $role;
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Tasks/DetachPermissionsFromUserTask.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tasks;
+
+use App\Containers\AppSection\Authorization\Models\Permission;
+use App\Containers\AppSection\User\Models\User;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+
+class DetachPermissionsFromUserTask extends ParentTask
+{
+    /**
+     * @param User $user
+     * @param Permission[] $permissions
+     * @return User
+     */
+    public function run(User $user, array $permissions): User
+    {
+        array_map(static function ($permission) use ($user) {
+            $user->revokePermissionTo($permission);
+        }, $permissions);
+
+        return $user;
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Tasks/FindPermissionTask.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tasks;
+
+use App\Containers\AppSection\Authorization\Data\Repositories\PermissionRepository;
+use App\Containers\AppSection\Authorization\Models\Permission;
+use App\Ship\Exceptions\NotFoundException;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+use Illuminate\Support\Str;
+
+class FindPermissionTask extends ParentTask
+{
+    public function __construct(
+        protected PermissionRepository $repository
+    ) {
+    }
+
+    /**
+     * @param string|int $permissionNameOrId
+     * @param string $guardName
+     * @return Permission
+     * @throws NotFoundException
+     */
+    public function run(string|int $permissionNameOrId, string $guardName = 'api'): Permission
+    {
+        $query = [
+            'guard_name' => $guardName,
+        ];
+
+        if ($this->isID($permissionNameOrId)) {
+            $query['id'] = $permissionNameOrId;
+        } else {
+            $query['name'] = $permissionNameOrId;
+        }
+
+        $permission = $this->repository->findWhere($query)->first();
+
+        return $permission ?? throw new NotFoundException();
+    }
+
+    /**
+     * @param int|string $permissionNameOrId
+     * @return bool
+     */
+    private function isID(int|string $permissionNameOrId): bool
+    {
+        return (is_numeric($permissionNameOrId) || Str::isUuid($permissionNameOrId));
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Tasks/FindRoleTask.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tasks;
+
+use App\Containers\AppSection\Authorization\Data\Repositories\RoleRepository;
+use App\Containers\AppSection\Authorization\Models\Role;
+use App\Ship\Exceptions\NotFoundException;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+use Illuminate\Support\Str;
+
+class FindRoleTask extends ParentTask
+{
+    public function __construct(
+        protected RoleRepository $repository
+    ) {
+    }
+
+    /**
+     * @param string|int $roleNameOrId
+     * @param string $guardName
+     * @return Role
+     * @throws NotFoundException
+     */
+    public function run(string|int $roleNameOrId, string $guardName = 'api'): Role
+    {
+        $query = [
+            'guard_name' => $guardName,
+        ];
+
+        if ($this->isID($roleNameOrId)) {
+            $query['id'] = $roleNameOrId;
+        } else {
+            $query['name'] = $roleNameOrId;
+        }
+
+        $role = $this->repository->findWhere($query)->first();
+
+        return $role ?? throw new NotFoundException();
+    }
+
+    /**
+     * @param int|string $roleNameOrId
+     * @return bool
+     */
+    private function isID(int|string $roleNameOrId): bool
+    {
+        return (is_numeric($roleNameOrId) || Str::isUuid($roleNameOrId));
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Tasks/GetAllPermissionsTask.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tasks;
+
+use Apiato\Core\Exceptions\CoreInternalErrorException;
+use App\Containers\AppSection\Authorization\Data\Repositories\PermissionRepository;
+use App\Ship\Criterias\ThisLikeThatCriteria;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+use Prettus\Repository\Exceptions\RepositoryException;
+
+class GetAllPermissionsTask extends ParentTask
+{
+    public function __construct(
+        protected PermissionRepository $repository
+    ) {
+    }
+
+    /**
+     * @param bool $skipPagination
+     * @return mixed
+     * @throws CoreInternalErrorException
+     * @throws RepositoryException
+     */
+    public function run(bool $skipPagination = false): mixed
+    {
+        $repository = $this->addRequestCriteria()->repository;
+
+        return $skipPagination ? $repository->all() : $repository->paginate();
+    }
+
+    /**
+     * @throws RepositoryException
+     */
+    public function whereGuard(string $guardName): static
+    {
+        $this->repository->pushCriteria(new ThisLikeThatCriteria('guard_name', $guardName));
+
+        return $this;
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Tasks/GetAllRolesTask.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tasks;
+
+use Apiato\Core\Exceptions\CoreInternalErrorException;
+use App\Containers\AppSection\Authorization\Data\Repositories\RoleRepository;
+use App\Ship\Criterias\ThisLikeThatCriteria;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+use Prettus\Repository\Exceptions\RepositoryException;
+
+class GetAllRolesTask extends ParentTask
+{
+    public function __construct(
+        protected RoleRepository $repository
+    ) {
+    }
+
+    /**
+     * @param bool $skipPagination
+     * @return mixed
+     * @throws CoreInternalErrorException
+     * @throws RepositoryException
+     */
+    public function run(bool $skipPagination = false): mixed
+    {
+        $repository = $this->addRequestCriteria()->repository;
+
+        return $skipPagination ? $repository->all() : $repository->paginate();
+    }
+
+    /**
+     * @throws RepositoryException
+     */
+    public function whereGuard(string $guardName): static
+    {
+        $this->repository->pushCriteria(new ThisLikeThatCriteria('guard_name', $guardName));
+
+        return $this;
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Tasks/RevokeRoleFromUserTask.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tasks;
+
+use App\Containers\AppSection\Authorization\Models\Role;
+use App\Containers\AppSection\User\Models\User;
+use App\Ship\Parents\Tasks\Task as ParentTask;
+use Illuminate\Contracts\Auth\Authenticatable;
+
+class RevokeRoleFromUserTask extends ParentTask
+{
+    /**
+     * @param User $user
+     * @param string|int|Role $role
+     * @return Authenticatable
+     */
+    public function run(User $user, string|int|Role $role): Authenticatable
+    {
+        return $user->removeRole($role);
+    }
+}

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

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\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/Authorization/Tests/Unit/CreatePermissionTaskTest.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tests\Unit;
+
+use App\Containers\AppSection\Authorization\Tasks\CreatePermissionTask;
+use App\Containers\AppSection\Authorization\Tests\TestCase;
+
+/**
+ * Class CreatePermissionTaskTest.
+ *
+ * @group authorization
+ * @group unit
+ */
+class CreatePermissionTaskTest extends TestCase
+{
+    public function testCreatePermission(): void
+    {
+        $name = 'fuLl_coNtroL';
+        $description = 'Gives full control of everything!';
+        $display_name = 'Controller of All';
+
+        $permission = app(CreatePermissionTask::class)->run($name, $description, $display_name);
+
+        $this->assertEquals(strtolower($name), $permission->name);
+        $this->assertEquals($description, $permission->description);
+        $this->assertEquals($display_name, $permission->display_name);
+        $this->assertEquals('api', $permission->guard_name);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Tests/Unit/CreateRoleTaskTest.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tests\Unit;
+
+use App\Containers\AppSection\Authorization\Tasks\CreateRoleTask;
+use App\Containers\AppSection\Authorization\Tests\TestCase;
+
+/**
+ * Class CreateRoleTaskTest.
+ *
+ * @group authorization
+ * @group unit
+ */
+class CreateRoleTaskTest extends TestCase
+{
+    public function testCreateRole(): void
+    {
+        $name = 'MEga_AdmIn';
+        $description = 'The One above all';
+        $display_name = 'Mega Admin the Almighty';
+
+        $role = app(CreateRoleTask::class)->run($name, $description, $display_name);
+
+        $this->assertEquals(strtolower($name), $role->name);
+        $this->assertEquals($description, $role->description);
+        $this->assertEquals($display_name, $role->display_name);
+        $this->assertEquals('api', $role->guard_name);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Tests/Unit/DeleteRoleTaskTest.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tests\Unit;
+
+use App\Containers\AppSection\Authorization\Models\Role;
+use App\Containers\AppSection\Authorization\Tasks\DeleteRoleTask;
+use App\Containers\AppSection\Authorization\Tests\TestCase;
+use App\Ship\Exceptions\NotFoundException;
+
+/**
+ * Class DeleteRoleTaskTest.
+ *
+ * @group authorization
+ * @group unit
+ */
+class DeleteRoleTaskTest extends TestCase
+{
+    public function testSuccessfulDeleteRole_ShouldReturn1(): void
+    {
+        $role = Role::factory()->create(['name' => 'testRole']);
+
+        $result = app(DeleteRoleTask::class)->run($role->id);
+
+        $this->assertEquals(1, $result);
+        $this->assertDatabaseMissing(config('permission.table_names.roles'), $role->toArray());
+    }
+
+    public function testDeleteRoleWitInvalidId_Throws404(): void
+    {
+        $this->expectException(NotFoundException::class);
+
+        $invalidId = 7777;
+
+        app(DeleteRoleTask::class)->run($invalidId);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Tests/Unit/FindPermissionTaskTest.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tests\Unit;
+
+use App\Containers\AppSection\Authorization\Models\Permission;
+use App\Containers\AppSection\Authorization\Tasks\FindPermissionTask;
+use App\Containers\AppSection\Authorization\Tests\TestCase;
+use App\Ship\Exceptions\NotFoundException;
+
+/**
+ * Class FindPermissionTaskTest.
+ *
+ * @group authorization
+ * @group unit
+ */
+class FindPermissionTaskTest extends TestCase
+{
+    public function testFindPermissionById(): void
+    {
+        $permission = Permission::factory()->create();
+
+        $result = app(FindPermissionTask::class)->run($permission->id);
+
+        $this->assertEquals($permission->id, $result->id);
+    }
+
+    public function testFindPermissionByName(): void
+    {
+        $permission = Permission::factory()->create();
+
+        $result = app(FindPermissionTask::class)->run($permission->name);
+
+        $this->assertEquals($permission->id, $result->id);
+    }
+
+    public function testFindPermissionWithInvalidId_Throws404(): void
+    {
+        $this->expectException(NotFoundException::class);
+
+        $invalidId = 7777;
+
+        app(FindPermissionTask::class)->run($invalidId);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Tests/Unit/FindRoleTaskTest.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tests\Unit;
+
+use App\Containers\AppSection\Authorization\Models\Role;
+use App\Containers\AppSection\Authorization\Tasks\FindRoleTask;
+use App\Containers\AppSection\Authorization\Tests\TestCase;
+use App\Ship\Exceptions\NotFoundException;
+
+/**
+ * Class FindRoleTaskTest.
+ *
+ * @group authorization
+ * @group unit
+ */
+class FindRoleTaskTest extends TestCase
+{
+    public function testFindRoleById(): void
+    {
+        $role = Role::factory()->create();
+
+        $result = app(FindRoleTask::class)->run($role->id);
+
+        $this->assertEquals($role->id, $result->id);
+    }
+
+    public function testFindRoleByName(): void
+    {
+        $role = Role::factory()->create();
+
+        $result = app(FindRoleTask::class)->run($role->name);
+
+        $this->assertEquals($role->id, $result->id);
+    }
+
+    public function testFindRoleWithInvalidId_Throws404(): void
+    {
+        $this->expectException(NotFoundException::class);
+
+        $invalidId = 7777;
+
+        app(FindRoleTask::class)->run($invalidId);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authorization/Tests/Unit/PermissionFactoryTest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace App\Containers\AppSection\Authorization\Tests\Unit;
+
+use App\Containers\AppSection\Authorization\Models\Permission;
+use App\Containers\AppSection\Authorization\Tests\TestCase;
+
+/**
+ * Class PermissionFactoryTest.
+ *
+ * @group authorization
+ * @group unit
+ */
+class PermissionFactoryTest extends TestCase
+{
+    public function testCreatePermission(): void
+    {
+        $permission = Permission::factory()->create();
+
+        $this->assertInstanceOf(Permission::class, $permission);
+    }
+}