daevin 1.0.0

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

@@ -0,0 +1,45 @@
+<?php
+
+namespace App\Containers\AppSection\User\UI\API\Requests;
+
+use App\Ship\Parents\Requests\Request as ParentRequest;
+
+class FindUserByIdRequest extends ParentRequest
+{
+    /**
+     * Define which Roles and/or Permissions has access to this request.
+     */
+    protected array $access = [
+        'permissions' => 'search-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',
+        ]);
+    }
+}

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

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

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

@@ -0,0 +1,56 @@
+<?php
+
+namespace App\Containers\AppSection\User\UI\API\Requests;
+
+use App\Containers\AppSection\Authorization\Traits\IsResourceOwnerTrait;
+use App\Containers\AppSection\User\Models\User;
+use App\Ship\Parents\Requests\Request as ParentRequest;
+use Illuminate\Validation\Rule;
+
+class UpdateUserPasswordRequest extends ParentRequest
+{
+    use IsResourceOwnerTrait;
+
+    /**
+     * Define which Roles and/or Permissions has access to this request.
+     */
+    protected array $access = [
+        'permissions' => '',
+        '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 [
+            'current_password' => [Rule::requiredIf(
+                fn (): bool => !is_null($this->user()->password)
+            ), 'current_password:api'],
+            'new_password' => [
+                'required',
+                User::getPasswordValidationRules(),
+            ],
+        ];
+    }
+
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess|isResourceOwner',
+        ]);
+    }
+}

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

@@ -0,0 +1,50 @@
+<?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 UpdateUserRequest extends ParentRequest
+{
+    use IsResourceOwnerTrait;
+
+    /**
+     * Define which Roles and/or Permissions has access to this request.
+     */
+    protected array $access = [
+        'permissions' => 'update-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 [
+            'name' => 'min:2|max:50',
+            'gender' => 'in:male,female,unspecified',
+            'birth' => 'date',
+        ];
+    }
+
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess|isResourceOwner',
+        ]);
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/UI/API/Routes/DeleteUser.v1.private.php

@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * @apiGroup           User
+ * @apiName            DeleteUser
+ * @api                {delete} /v1/users/:id Delete User
+ * @apiDescription     Delete users of any type (Admin, Client...)
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      Authenticated ['permissions' => 'delete-users', 'roles' => ''] | Resource Owner
+ *
+ * @apiHeader          {String} accept=application/json
+ * @apiHeader          {String} authorization=Bearer
+ *
+ * @apiParam           {String} id user id
+ *
+ * @apiSuccessExample  {json}       Success-Response:
+ * HTTP/1.1 204 No Content
+ * {}
+ */
+
+use App\Containers\AppSection\User\UI\API\Controllers\DeleteUserController;
+use Illuminate\Support\Facades\Route;
+
+Route::delete('users/{id}', [DeleteUserController::class, 'deleteUser'])
+    ->middleware(['auth:api']);

package/Daevin_test/app/Containers/AppSection/User/UI/API/Routes/FindUserById.v1.private.php

@@ -0,0 +1,24 @@
+<?php
+
+/**
+ * @apiGroup           User
+ * @apiName            FindUserById
+ * @api                {get} /v1/users/:id Find User
+ * @apiDescription     Find a user by its ID
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      Authenticated ['permissions' => 'search-users', 'roles' => '']
+ *
+ * @apiHeader          {String} accept=application/json
+ * @apiHeader          {String} authorization=Bearer
+ *
+ * @apiParam           {String} id user id
+ *
+ * @apiUse             UserSuccessSingleResponse
+ */
+
+use App\Containers\AppSection\User\UI\API\Controllers\FindUserByIdController;
+use Illuminate\Support\Facades\Route;
+
+Route::get('users/{id}', [FindUserByIdController::class, 'findUserById'])
+    ->middleware(['auth:api']);

package/Daevin_test/app/Containers/AppSection/User/UI/API/Routes/GetAllUsers.v1.private.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * @apiGroup           User
+ * @apiName            GetAllUsers
+ * @api                {get} /v1/users Get All Users
+ * @apiDescription     Get All Application Users (clients and admins). For all registered users "Clients" only you
+ *                     can use `/clients`. And for all "Admins" only you can use `/admins`.
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      Authenticated ['permissions' => 'list-users', 'roles' => ''] | Resource Owner
+ *
+ * @apiHeader          {String} accept=application/json
+ * @apiHeader          {String} authorization=Bearer
+ *
+ * @apiUse             GeneralSuccessMultipleResponse
+ */
+
+use App\Containers\AppSection\User\UI\API\Controllers\GetAllUsersController;
+use Illuminate\Support\Facades\Route;
+
+Route::get('users', [GetAllUsersController::class, 'getAllUsers'])
+    ->middleware(['auth:api']);

package/Daevin_test/app/Containers/AppSection/User/UI/API/Routes/UpdateUser.v1.private.php

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * @apiGroup           User
+ * @apiName            UpdateUser
+ * @api                {patch} /v1/users/:id Update User
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      Authenticated ['permissions' => 'update-users', 'roles' => ''] | Resource Owner
+ *
+ * @apiHeader          {String} accept=application/json
+ * @apiHeader          {String} authorization=Bearer
+ *
+ * @apiParam           {String} id user id
+ *
+ * @apiBody           {String} [name] min:2|max:50
+ * @apiBody           {String="male","female","unspecified"} [gender]
+ * @apiBody           {Date} [birth] format: Y-m-d / e.g. 2015-10-15
+ *
+ * @apiUse             UserSuccessSingleResponse
+ */
+
+use App\Containers\AppSection\User\UI\API\Controllers\UpdateUserController;
+use Illuminate\Support\Facades\Route;
+
+Route::patch('users/{id}', [UpdateUserController::class, 'updateUser'])
+    ->middleware(['auth:api']);

package/Daevin_test/app/Containers/AppSection/User/UI/API/Routes/UpdateUserPassword.v1.private.php

@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * @apiGroup           User
+ * @apiName            UpdateUserPassword
+ * @api                {patch} /v1/users/:id/password Update User's Password
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      Authenticated ['permissions' => '', 'roles' => ''] | Resource Owner
+ *
+ * @apiHeader          {String} accept=application/json
+ * @apiHeader          {String} authorization=Bearer
+ *
+ * @apiParam           {String} id user id
+ *
+ * @apiBody           {String} current_password
+ * @apiBody           {String} new_password min: 8
+ *
+ * at least one character of the following:
+ *
+ * upper case letter
+ *
+ * lower case letter
+ *
+ * number
+ *
+ * special character
+ *
+ * @apiUse             UserSuccessSingleResponse
+ */
+
+use App\Containers\AppSection\User\UI\API\Controllers\UpdateUserPasswordController;
+use Illuminate\Support\Facades\Route;
+
+Route::patch('users/{id}/password', [UpdateUserPasswordController::class, 'updateUserPassword'])
+    ->middleware(['auth:api']);

package/Daevin_test/app/Containers/AppSection/User/UI/API/Routes/_user.v1.public.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * @apiDefine UserSuccessSingleResponse
+ * @apiSuccessExample {json} Success-Response:
+HTTP/1.1 200 OK
+{
+    "data": {
+    "object": "User",
+    "id": "XbPW7awNkzl83LD6",
+    "name": "Mohammad Alavi",
+    "email": "mohammad.alavi1990@gmail.com",
+    "email_verified_at": "2021-04-07T07:59:47.000000Z",
+    "gender": "male",
+    "birth": "1990-01-06T00:00:00.000000Z"
+  },
+  "meta": {
+    "include": [
+        "roles"
+    ],
+    "custom": []
+  }
+}
+*/
+

package/Daevin_test/app/Containers/AppSection/User/UI/API/Tests/ApiTestCase.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace App\Containers\AppSection\User\UI\API\Tests;
+
+use App\Ship\Parents\Tests\PhpUnit\TestCase as ParentTestCase;
+
+/**
+ * Class ApiTestCase.
+ *
+ * This is the container API TestCase class. Use this class to add your container specific API related helper functions.
+ */
+class ApiTestCase extends ParentTestCase
+{
+    // ..
+}

package/Daevin_test/app/Containers/AppSection/User/UI/API/Tests/Functional/DeleteUserTest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace App\Containers\AppSection\User\UI\API\Tests\Functional;
+
+use App\Containers\AppSection\User\Models\User;
+use App\Containers\AppSection\User\UI\API\Tests\ApiTestCase;
+
+/**
+ * Class DeleteUserTest.
+ *
+ * @group user
+ * @group api
+ */
+class DeleteUserTest extends ApiTestCase
+{
+    protected string $endpoint = 'delete@v1/users/{id}';
+
+    protected array $access = [
+        'permissions' => 'delete-users',
+        'roles' => '',
+    ];
+
+    public function testDeleteExistingUser(): void
+    {
+        $user = $this->getTestingUser();
+
+        $response = $this->injectId($user->id)->makeCall();
+
+        $response->assertStatus(204);
+    }
+
+    public function testDeleteNonExistingUser(): void
+    {
+        $invalidId = 7777;
+
+        $response = $this->injectId($invalidId)->makeCall([]);
+
+        $response->assertStatus(404);
+    }
+
+    public function testGivenHaveNoAccess_CannotDeleteAnotherUser(): void
+    {
+        $this->getTestingUserWithoutAccess();
+        $anotherUser = User::factory()->create();
+
+        $response = $this->injectId($anotherUser->id)->makeCall();
+
+        $response->assertStatus(403);
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/UI/API/Tests/Functional/FindUserByIdTest.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace App\Containers\AppSection\User\UI\API\Tests\Functional;
+
+use App\Containers\AppSection\User\UI\API\Tests\ApiTestCase;
+use Hashids;
+use Illuminate\Testing\Fluent\AssertableJson;
+
+/**
+ * Class FindUserByIdTest.
+ *
+ * @group user
+ * @group api
+ */
+class FindUserByIdTest extends ApiTestCase
+{
+    protected string $endpoint = 'get@v1/users/{id}';
+
+    protected array $access = [
+        'permissions' => 'search-users',
+        'roles' => '',
+    ];
+
+    public function testFindUser(): void
+    {
+        $user = $this->getTestingUser();
+
+        $response = $this->injectId($user->id)->makeCall();
+
+        $response->assertStatus(200);
+        $response->assertJson(
+            fn (AssertableJson $json) =>
+                $json->has('data')
+                    ->where('data.id', Hashids::encode($user->id))
+                    ->etc()
+        );
+    }
+
+    public function testFindNonExistingUser(): void
+    {
+        $invalidId = 7777;
+
+        $response = $this->injectId($invalidId)->makeCall([]);
+
+        $response->assertStatus(404);
+    }
+
+    public function testFindFilteredUserResponse(): void
+    {
+        $user = $this->getTestingUser();
+
+        $response = $this->injectId($user->id)->endpoint($this->endpoint . '?filter=email;name')->makeCall();
+
+        $response->assertStatus(200);
+        $response->assertJson(
+            fn (AssertableJson $json) =>
+                $json->has('data')
+                    ->where('data.name', $user->name)
+                    ->where('data.email', $user->email)
+        );
+    }
+
+    public function testFindUserWithRelation(): void
+    {
+        $user = $this->getTestingUser();
+        $user->assignRole(config('appSection-authorization.admin_role'));
+
+        $response = $this->injectId($user->id)->endpoint($this->endpoint . '?include=roles')->makeCall();
+
+        $response->assertStatus(200);
+        $response->assertJson(
+            fn (AssertableJson $json) =>
+            $json->has('data')
+                ->where('data.email', $user->email)
+                ->count('data.roles.data', 1)
+                ->where('data.roles.data.0.name', config('appSection-authorization.admin_role'))
+                ->etc()
+        );
+    }
+}

package/Daevin_test/app/Containers/AppSection/User/UI/API/Tests/Functional/GetAllUsersTest.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace App\Containers\AppSection\User\UI\API\Tests\Functional;
+
+use App\Containers\AppSection\User\Models\User;
+use App\Containers\AppSection\User\UI\API\Tests\ApiTestCase;
+use Illuminate\Testing\Fluent\AssertableJson;
+
+/**
+ * Class GetAllUsersTest.
+ *
+ * @group user
+ * @group api
+ */
+class GetAllUsersTest extends ApiTestCase
+{
+    protected string $endpoint = 'get@v1/users';
+
+    protected array $access = [
+        'permissions' => 'list-users',
+        'roles' => '',
+    ];
+
+    public function testGetAllUsersByAdmin(): void
+    {
+        User::factory()->count(2)->create();
+        $this->getTestingUserWithoutAccess(createUserAsAdmin: true);
+
+        $response = $this->makeCall();
+
+        $response->assertStatus(200);
+        $response->assertJson(
+            fn (AssertableJson $json) =>
+                $json->has('data', 4)
+                    ->etc()
+        );
+    }
+
+    public function testGetAllUsersByNonAdmin(): void
+    {
+        $this->getTestingUserWithoutAccess();
+        User::factory()->count(2)->create();
+
+        $response = $this->makeCall();
+
+        $response->assertStatus(403);
+        $response->assertJson(
+            fn (AssertableJson $json) =>
+                $json->has('message')
+                    ->where('message', 'You are not authorized to request this resource.')
+                    ->etc()
+        );
+    }
+
+    public function testSearchUsersByName(): void
+    {
+        User::factory()->count(3)->create();
+        $user = $this->getTestingUser([
+            'name' => 'mahmoudzzz',
+        ]);
+
+        $response = $this->endpoint($this->endpoint . "?search=name:" . urlencode($user->name))->makeCall();
+
+        $response->assertStatus(200);
+        $response->assertJson(
+            fn (AssertableJson $json) =>
+                $json->has('data')
+                    ->where('data.0.name', $user->name)
+                    ->etc()
+        );
+    }
+
+    public function testSearchUsersByHashID(): void
+    {
+        User::factory()->count(3)->create();
+        $user = $this->getTestingUser();
+
+        $response = $this->endpoint($this->endpoint . '?search=id:' . $user->getHashedKey())->makeCall();
+
+        $response->assertStatus(200);
+        $response->assertJson(
+            fn (AssertableJson $json) =>
+                $json->has('data')
+                    ->where('data.0.id', $user->getHashedKey())
+                    ->etc()
+        );
+    }
+}