daevin 1.0.0

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Routes/ResetPassword.v1.public.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * @apiGroup           Authentication
+ * @apiName            ResetPassword
+ *
+ * @api                {GET/POST} /v1/password/reset Reset Password
+ * @apiDescription     Resets password of a user.
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      none
+ *
+ * @apiHeader          {String} accept=application/json
+ *
+ * @apiBody           {String} email
+ * @apiBody           {String} token from the forgot password email
+ * @apiBody           {String} password min: 8
+ *
+ * at least one character of the following:
+ *
+ * upper case letter
+ *
+ * lower case letter
+ *
+ * number
+ *
+ * special character
+ *
+ * @apiSuccessExample  {json}  Success-Response:
+ * HTTP/1.1 204 No Content
+ * {}
+ */
+
+use App\Containers\AppSection\Authentication\UI\API\Controllers\ResetPasswordController;
+use Illuminate\Support\Facades\Route;
+
+Route::any('password/reset', [ResetPasswordController::class, 'resetPassword']);

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Routes/SendVerificationEmail.v1.public.php

@@ -0,0 +1,32 @@
+<?php
+
+/**
+ * @apiGroup           Authentication
+ * @apiName            SendVerificationEmail
+ *
+ * @api                {POST} /v1/email/verification-notification Send Verification Email
+ * @apiDescription     Send verification email to the currently authenticated user
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      Authenticated ['permissions' => '', 'roles' => '']
+ *
+ * @apiHeader          {String} accept=application/json
+ * @apiHeader          {String} authorization=Bearer
+ *
+ * @apiPermission      Authenticated ['permissions' => '', 'roles' => '']
+ *
+ * @apiBody           {String} verification_url required|url
+ *
+ * @apiSuccessExample  {json} Success-Response:
+ * HTTP/1.1 202 Accepted
+ * {}
+ */
+
+use App\Containers\AppSection\Authentication\UI\API\Controllers\SendVerificationEmailController;
+use Illuminate\Support\Facades\Route;
+
+if (config('appSection-authentication.require_email_verification')) {
+    Route::post('/email/verification-notification', [SendVerificationEmailController::class, 'sendVerificationEmail'])
+        ->middleware(['auth:api']);
+}
+

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Routes/VerifyEmail.v1.public.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * @apiGroup           Authentication
+ * @apiName            VerifyEmail
+ *
+ * @api                {POST} /v1/email/verify/:id/:hash Verify Email
+ * @apiDescription     Verify user email
+ *
+ * Example of a verification email link sent to the user which is used to verify the user `http://apiato.test/email/verify?url=http://api.apiato.test/v1/email/verify/XbPW7awNkzl83LD6/eaabd911e2e07ede6456d3bd5725c6d4a5c2dc0b?expires=1646913047&signature=232702865b8353c445b39c50397e66db33c74df80e3db5a7c0d46ef94c8ab6a9`
+ *
+ * Value of `url` query string in the verification link above (sent to the user by email) can be directly used to call the api to verify the user.
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      none
+ *
+ * @apiHeader          {String} accept=application/json
+ *
+ * @apiParam           {String} id user id
+ * @apiParam           {String} hash a hashed value sent to the user email
+ *
+ * @apiQuery           {string} expires expiration time of the `verify email` link
+ * @apiQuery           {string} signature a signature to check the validity of the `verify email` link
+ *
+ * @apiSuccessExample  {json} Success-Response:
+ * HTTP/1.1 200 OK
+ * {}
+ */
+
+use App\Containers\AppSection\Authentication\UI\API\Controllers\VerifyEmailController;
+use Illuminate\Support\Facades\Route;
+
+Route::post('email/verify/{id}/{hash}', [VerifyEmailController::class, 'verifyEmail'])
+    ->name('verification.verify')
+    ->middleware('signed');

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

@@ -0,0 +1,74 @@
+<?php
+
+namespace App\Containers\AppSection\Authentication\UI\API\Tests;
+
+use App\Ship\Parents\Tests\PhpUnit\TestCase as ParentTestCase;
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\DB;
+
+/**
+ * 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
+{
+    private bool $testingFilesCreated = false;
+    private string $publicFilePath;
+    private string $privateFilePath;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $clientId = '100';
+        $clientSecret = 'XXp8x4QK7d3J9R7OVRXWrhc19XPRroHTTKIbY8XX';
+
+        // create password grand client
+        DB::table('oauth_clients')->insert([
+            [
+                'id' => $clientId,
+                'secret' => $clientSecret,
+                'name' => 'Testing',
+                'redirect' => 'http://localhost',
+                'password_client' => '1',
+                'personal_access_client' => '0',
+                'revoked' => '0',
+            ],
+        ]);
+
+        // make the clients credentials available as env variables
+        Config::set('appSection-authentication.clients.web.id', $clientId);
+        Config::set('appSection-authentication.clients.web.secret', $clientSecret);
+
+        // create testing oauth keys files
+        $this->publicFilePath = $this->createTestingKey('oauth-public.key');
+        $this->privateFilePath = $this->createTestingKey('oauth-private.key');
+    }
+
+    private function createTestingKey($fileName): string
+    {
+        $filePath = storage_path($fileName);
+
+        if (!file_exists($filePath)) {
+            $keysStubDirectory = __DIR__ . '/Functional/Stubs/';
+
+            copy($keysStubDirectory . $fileName, $filePath);
+
+            $this->testingFilesCreated = true;
+        }
+
+        return $filePath;
+    }
+
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        // delete testing keys files if they were created for this test
+        if ($this->testingFilesCreated) {
+            unlink($this->publicFilePath);
+            unlink($this->privateFilePath);
+        }
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Tests/Functional/ApiLoginProxyForWebClientTest.php

@@ -0,0 +1,129 @@
+<?php
+
+namespace App\Containers\AppSection\Authentication\UI\API\Tests\Functional;
+
+use App\Containers\AppSection\Authentication\UI\API\Tests\ApiTestCase;
+use Illuminate\Support\Facades\Config;
+
+/**
+ * Class ApiLoginProxyForWebClientTest
+ *
+ * @group authentication
+ * @group api
+ */
+class ApiLoginProxyForWebClientTest extends ApiTestCase
+{
+    protected string $endpoint = 'post@v1/clients/web/login';
+
+    public function testClientWebAdminProxyLogin(): void
+    {
+        $data = [
+            'email' => 'testing@mail.com',
+            'password' => 'testingpass',
+        ];
+        $this->getTestingUser($data);
+
+        $response = $this->makeCall($data);
+
+        $response->assertStatus(200);
+        $this->assertResponseContainKeyValue([
+            'token_type' => 'Bearer',
+        ]);
+        $this->assertResponseContainKeys(['expires_in', 'access_token']);
+    }
+
+    public function testClientWebAdminProxyLoginWithUppercaseEmail(): void
+    {
+        $data = [
+            'email' => 'Testing@Mail.Com',
+            'password' => 'testiness',
+        ];
+        $this->getTestingUser(['email' => 'testing@mail.com', 'password' => $data['password'],]);
+        Config::set('appSection-authentication.login.case_sensitive', false);
+
+        $response = $this->makeCall($data);
+
+        $response->assertStatus(200);
+        $this->assertResponseContainKeyValue([
+            'token_type' => 'Bearer',
+        ]);
+        $this->assertResponseContainKeys(['expires_in', 'access_token']);
+    }
+
+    public function testLoginWithNameAttribute(): void
+    {
+        $data = [
+            'email' => 'testing@mail.com',
+            'password' => 'testingpass',
+            'name' => 'username',
+        ];
+        $this->getTestingUser($data);
+        $this->setLoginAttributes([
+            'email' => [],
+            'name' => [],
+        ]);
+        $request = [
+            'password' => 'testingpass',
+            'name' => 'username',
+        ];
+
+        $response = $this->makeCall($request);
+
+        $response->assertStatus(200);
+        $this->assertResponseContainKeyValue([
+            'token_type' => 'Bearer',
+        ]);
+        $this->assertResponseContainKeys(['expires_in', 'access_token', 'refresh_token']);
+    }
+
+    private function setLoginAttributes(array $attributes): void
+    {
+        Config::set('appSection-authentication.login.attributes', $attributes);
+    }
+
+    public function testGivenOnlyOneLoginAttributeIsSetThenItShouldBeRequired(): void
+    {
+        $this->setLoginAttributes([
+            'email' => [],
+        ]);
+        $data = [
+            'password' => 'so-secret',
+        ];
+
+        $this->makeCall($data);
+
+        $this->assertValidationErrorContain([
+            'email' => 'The email field is required.',
+        ]);
+    }
+
+    public function testGivenMultipleLoginAttributeIsSetThenAtLeastOneShouldBeRequired(): void
+    {
+        $this->setLoginAttributes([
+            'email' => [],
+            'name' => [],
+        ]);
+        $data = [
+            'password' => 'so-secret',
+        ];
+
+        $this->makeCall($data);
+
+        $this->assertValidationErrorContain([
+            'email' => 'The email field is required when none of name are present.',
+            'name' => 'The name field is required when none of email are present.',
+        ]);
+    }
+
+    public function testGivenWrongCredential_Throw422(): void
+    {
+        $data = [
+            'email' => 'none@existing.mail',
+            'password' => 'some-unbelievable-password',
+        ];
+
+        $response = $this->makeCall($data);
+
+        $response->assertStatus(422);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Tests/Functional/ApiLogoutTest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Containers\AppSection\Authentication\UI\API\Tests\Functional;
+
+use App\Containers\AppSection\Authentication\UI\API\Tests\ApiTestCase;
+
+/**
+ * Class ApiLogoutTest
+ *
+ * @group authentication
+ * @group api
+ */
+class ApiLogoutTest extends ApiTestCase
+{
+    protected string $endpoint = 'delete@v1/logout';
+
+    public function testLogout(): void
+    {
+        $response = $this->makeCall([], [
+            'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImUxODk3NjU3YTVlZWQxMDkyMThlZjVmOThlMGMzMzg5OTQ3MzNkZDYyZWM0Nzk5Y2E0NWQ1NjUyYmQ0NjFiZWUzZWQ5YjU1ZjNmMGE2NTA3In0.eyJhdWQiOiIyIiwianRpIjoiZTE4OTc2NTdhNWVlZDEwOTIxOGVmNWY5OGUwYzMzODk5NDczM2RkNjJlYzQ3OTljYTQ1ZDU2NTJiZDQ2MWJlZTNlZDliNTVmM2YwYTY1MDciLCJpYXQiOjE1MTI4NzgzNjMsIm5iZiI6MTUxMjg3ODM2MywiZXhwIjoxODI4MjM4MzYyLCJzdWIiOiI0Iiwic2NvcGVzIjpbXX0.q1MXp5odmhlurbGa-Ft8m3U3DA6CetCCk23ap8aqY2z_pTpfugqh6vqCe-8iVE9cJPjoMifWAFQ4UeTy_Y0PRurRh7o8_jCqclQ-1IudPmggayyS0kBYoHRRHT-2wzdpIw7jDLg589HV2HClbBq5IwYvLw3yqRTGmEgTFEJ2jCnT58A2sAuRuJ95k3FjuyBZ33dvoFelotMOSG0wR-2H7JjWRi4SL0XEZikoIlT4aAFC8Xa8TVt8ZsfQxDjc9Uyg6HBGTQo5JZNZgSje_0K4DyrHzW3tbWJ2CxLQjTPpWyEcVGavZ55UEjGJXr4JmFAZMCEyIfq0xop1ZnIOiIrmI1ajopXwcTTo0K8ymDDCAgB8JbGQTcGGSZe2VHJCXXaQJvesIlvke6ZvsoKwUqphpe99Qi67e3TA0_uDK8_u-Bv4lew95lg3IXBMKvfXvi17rEDvO23uClDWnZUhHKgqtPhO8oG7A1hFR8arLN1lEKrP44zO5470cD6_Pw7Ngi1coJeG5jXmtRb9gCpksdYQBB5csURioYSZuHNZQBGVWZVzlURPWvgtSd_aL646KmMmy64L4MA1QXsqXzzuLULGbcSntB8N-2XcogdTFe0ZG6RL8UzcArZx0Xur8CCi01UuPkBCnv5R4hxIjsQDkmFIDmrCyo2VuoVyrlxWIgsTm04',
+        ]);
+
+        $response->assertStatus(202);
+        $this->assertResponseContainKeyValue([
+            'message' => 'Token revoked successfully.',
+        ]);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Tests/Functional/ApiRefreshProxyForWebClientTest.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace App\Containers\AppSection\Authentication\UI\API\Tests\Functional;
+
+use App\Containers\AppSection\Authentication\Exceptions\RefreshTokenMissingException;
+use App\Containers\AppSection\Authentication\UI\API\Tests\ApiTestCase;
+use Illuminate\Testing\Fluent\AssertableJson;
+
+/**
+ * Class ApiRefreshProxyForWebClientTest
+ *
+ * @group authentication
+ * @group api
+ */
+class ApiRefreshProxyForWebClientTest extends ApiTestCase
+{
+    protected string $endpoint = 'post@v1/clients/web/refresh';
+
+    private array $data;
+
+    public function testRequestingRefreshTokenWithoutPassingARefreshTokenShouldThrowAnException(): void
+    {
+        $data = [];
+
+        $response = $this->makeCall($data);
+
+        $response->assertStatus(400);
+        $message = (new RefreshTokenMissingException())->getMessage();
+        $response->assertJson(
+            fn (AssertableJson $json) => $json->has('message')
+                ->where('message', $message)
+                ->etc()
+        );
+    }
+
+    public function testGivenRefreshTokenPassedAsParameter_ItShouldBeString(): void
+    {
+        $data = [
+            'refresh_token' => '', // empty equals `not string`
+        ];
+
+        $response = $this->makeCall($data);
+
+        $response->assertStatus(422);
+        $response->assertJson(
+            fn (AssertableJson $json) => $json->hasAll(['message', 'errors' => 1])
+                ->has(
+                    'errors',
+                    fn (AssertableJson $json) => $json->where('refresh_token.0', 'The refresh token must be a string.')
+                )
+        );
+    }
+
+    public function testOnSuccessfulRefreshTokenRequestEnsureValuesAreSetProperly(): void
+    {
+        $loginResponse = $this->endpoint('post@v1/clients/web/login')->makeCall($this->data);
+        $refreshToken = json_decode($loginResponse->getContent(), true, 512, JSON_THROW_ON_ERROR)['refresh_token'];
+        $data = [
+            'refresh_token' => $refreshToken,
+        ];
+
+        $response = $this->endpoint($this->endpoint)->makeCall($data);
+
+        $response->assertStatus(200);
+        $this->assertResponseContainKeyValue([
+            'token_type' => 'Bearer',
+        ]);
+        $response->assertJson(
+            fn (AssertableJson $json) => $json->hasAll(['expires_in', 'access_token'])
+                ->etc()
+        );
+    }
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->data = [
+            'email' => 'testing@mail.com',
+            'password' => 'testing_pass',
+        ];
+
+        $this->getTestingUser($this->data);
+        $this->actingAs($this->testingUser, 'web');
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Tests/Functional/ForgotPasswordTest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace App\Containers\AppSection\Authentication\UI\API\Tests\Functional;
+
+use App\Containers\AppSection\Authentication\UI\API\Tests\ApiTestCase;
+use Illuminate\Testing\Fluent\AssertableJson;
+
+/**
+ * Class ForgotPasswordTest.
+ *
+ * @group authentication
+ * @group api
+ */
+class ForgotPasswordTest extends ApiTestCase
+{
+    protected string $endpoint = 'post@v1/password/forgot';
+
+    protected bool $auth = false;
+
+    protected array $access = [
+        'permissions' => '',
+        'roles' => '',
+    ];
+
+    public function testForgotPassword(): void
+    {
+        $reseturl = 'http://somereseturl.test/yea/something';
+        config(['appSection-authentication.allowed-reset-password-urls' => $reseturl]);
+        $data = [
+            'email' => 'admin@admin.com',
+            'reseturl' => $reseturl,
+        ];
+
+        $response = $this->makeCall($data);
+        $response->assertStatus(204);
+    }
+
+    public function testForgotPasswordWithNotAllowedVerificationUrl(): void
+    {
+        config(['appSection-authentication.allowed-reset-password-urls' => []]);
+
+        $data = [
+            'email' => 'test@test.test',
+            'password' => 'secret',
+            'reseturl' => 'http://notallowed.test/wrong',
+        ];
+
+        $response = $this->makeCall($data);
+
+        $response->assertStatus(422);
+        $response->assertJson(
+            fn (AssertableJson $json) => $json->hasAll(['message', 'errors' => 1])
+                ->where('errors.reseturl.0', 'The selected reseturl is invalid.')
+        );
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Tests/Functional/GetAuthenticatedUserTest.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace App\Containers\AppSection\Authentication\UI\API\Tests\Functional;
+
+use App\Containers\AppSection\Authentication\UI\API\Tests\ApiTestCase;
+use App\Containers\AppSection\User\Models\User;
+
+/**
+ * Class GetAuthenticatedUserTest.
+ *
+ * @group authentication
+ * @group api
+ */
+class GetAuthenticatedUserTest extends ApiTestCase
+{
+    protected string $endpoint = 'get@v1/profile';
+
+    protected array $access = [
+        'permissions' => '',
+        'roles' => '',
+    ];
+
+    public function testGetAuthenticatedUser(): void
+    {
+        $user = $this->getTestingUser();
+
+        $response = $this->makeCall();
+
+        $response->assertStatus(200);
+        $responseContent = $this->getResponseContentObject();
+        $this->assertResponseContainKeyValue([
+            'object' => 'User',
+            'id' => $user->getHashedKey(),
+            'email' => $user->email,
+            'email_verified_at' => $user->email_verified_at,
+            'name' => $user->name,
+            'gender' => $user->gender,
+            'birth' => $user->birth,
+        ]);
+        $this->assertEquals($user->name, $responseContent->data->name);
+    }
+
+    public function testGetAuthenticatedUserAsAdmin(): void
+    {
+        $user = $this->getTestingUser(createUserAsAdmin: true);
+
+        $response = $this->makeCall();
+
+        $response->assertStatus(200);
+        $responseContent = $this->getResponseContentObject();
+        $this->assertResponseContainKeyValue([
+            'object' => 'User',
+            'id' => $user->getHashedKey(),
+            'email' => $user->email,
+            'email_verified_at' => $user->email_verified_at,
+            'name' => $user->name,
+            'gender' => $user->gender,
+            'birth' => $user->birth,
+            'real_id' => $user->id,
+            'created_at' => $user->created_at,
+            'updated_at' => $user->updated_at,
+            'readable_created_at' => $user->created_at->diffForHumans(),
+            'readable_updated_at' => $user->updated_at->diffForHumans(),
+        ]);
+        $this->assertEquals($user->name, $responseContent->data->name);
+    }
+
+    public function testGetAuthenticatedUser_ByUnauthenticatedUser(): void
+    {
+        $this->testingUser = User::factory()->create();
+
+        $response = $this->auth(false)->makeCall();
+
+        $response->assertStatus(401);
+    }
+}