daevin 1.0.0

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Requests/GetAuthenticatedUserRequest.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace App\Containers\AppSection\Authentication\UI\API\Requests;
+
+use App\Ship\Parents\Requests\Request as ParentRequest;
+
+class GetAuthenticatedUserRequest extends ParentRequest
+{
+    /**
+     * 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 (e.g, `/user/{id}`) allows applying
+     * validation rules on them and allows accessing them like request data.
+     */
+    protected array $urlParameters = [
+        //'id',
+    ];
+
+    public function rules(): array
+    {
+        return [
+            // 'name' => 'required|max:255'
+        ];
+    }
+
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess',
+        ]);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Requests/LoginProxyPasswordGrantRequest.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace App\Containers\AppSection\Authentication\UI\API\Requests;
+
+use App\Containers\AppSection\Authentication\Classes\LoginCustomAttribute;
+use App\Ship\Parents\Requests\Request as ParentRequest;
+
+class LoginProxyPasswordGrantRequest extends ParentRequest
+{
+    /**
+     * 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 = [
+
+    ];
+
+    /**
+     * Defining the URL parameters (`/stores/999/items`) allows applying
+     * validation rules on them and allows accessing them like request data.
+     */
+    protected array $urlParameters = [
+
+    ];
+
+    /**
+     * Get the validation rules that apply to the request.
+     */
+    public function rules(): array
+    {
+        $rules = [
+            // we don't need to require email here. The proper login attribute (with proper validations)
+            // will be added automatically by "mergeValidationRules" method below
+            // 'email' => 'required',
+            'password' => 'required',
+        ];
+
+        return LoginCustomAttribute::mergeValidationRules($rules);
+    }
+
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess',
+        ]);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Requests/LogoutRequest.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace App\Containers\AppSection\Authentication\UI\API\Requests;
+
+use App\Ship\Parents\Requests\Request as ParentRequest;
+
+class LogoutRequest extends ParentRequest
+{
+    /**
+     * 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 = [
+
+    ];
+
+    /**
+     * Defining the URL parameters (`/stores/999/items`) allows applying
+     * validation rules on them and allows accessing them like request data.
+     */
+    protected array $urlParameters = [
+
+    ];
+
+    /**
+     * Get the validation rules that apply to the request.
+     */
+    public function rules(): array
+    {
+        return [
+
+        ];
+    }
+
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess',
+        ]);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Requests/RefreshProxyRequest.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace App\Containers\AppSection\Authentication\UI\API\Requests;
+
+use App\Ship\Parents\Requests\Request as ParentRequest;
+
+class RefreshProxyRequest extends ParentRequest
+{
+    /**
+     * 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 = [
+
+    ];
+
+    /**
+     * Defining the URL parameters (`/stores/999/items`) allows applying
+     * validation rules on them and allows accessing them like request data.
+     */
+    protected array $urlParameters = [
+
+    ];
+
+    /**
+     * Get the validation rules that apply to the request.
+     */
+    public function rules(): array
+    {
+        return [
+            'refresh_token' => 'string',
+        ];
+    }
+
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess',
+        ]);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Requests/RegisterUserRequest.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace App\Containers\AppSection\Authentication\UI\API\Requests;
+
+use App\Containers\AppSection\User\Models\User;
+use App\Ship\Parents\Requests\Request as ParentRequest;
+use Illuminate\Validation\Rule;
+
+class RegisterUserRequest extends ParentRequest
+{
+    /**
+     * 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 = [
+
+    ];
+
+    /**
+     * 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 [
+            'email' => 'required|email|unique:users,email',
+            'password' => [
+                'required',
+                User::getPasswordValidationRules(),
+            ],
+            'name' => 'min:2|max:50',
+            'gender' => 'in:male,female,unspecified',
+            'birth' => 'date',
+            'verification_url' => [
+                'url',
+                Rule::requiredIf(function () {
+                    return config('appSection-authentication.require_email_verification');
+                }),
+                Rule::in(config('appSection-authentication.allowed-verify-email-urls')),
+            ],
+        ];
+    }
+
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess',
+        ]);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Requests/ResetPasswordRequest.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace App\Containers\AppSection\Authentication\UI\API\Requests;
+
+use App\Ship\Parents\Requests\Request as ParentRequest;
+use Illuminate\Validation\Rules\Password;
+
+class ResetPasswordRequest extends ParentRequest
+{
+    /**
+     * 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 (e.g, `/user/{id}`) allows applying
+     * validation rules on them and allows accessing them like request data.
+     */
+    protected array $urlParameters = [
+        // 'id',
+    ];
+
+    public function rules(): array
+    {
+        return [
+            'token' => 'required',
+            'email' => 'required|email',
+            'password' => [
+                'required',
+                Password::min(8)
+                    ->letters()
+                    ->mixedCase()
+                    ->numbers()
+                    ->symbols(),
+            ],
+        ];
+    }
+
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess',
+        ]);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Requests/SendVerificationEmailRequest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace App\Containers\AppSection\Authentication\UI\API\Requests;
+
+use App\Ship\Parents\Requests\Request as ParentRequest;
+use Illuminate\Validation\Rule;
+
+class SendVerificationEmailRequest extends ParentRequest
+{
+    /**
+     * 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 (e.g, `/user/{id}`) allows applying
+     * validation rules on them and allows accessing them like request data.
+     */
+    protected array $urlParameters = [
+        // 'id',
+    ];
+
+    /**
+     * Get the validation rules that apply to the request.
+     */
+    public function rules(): array
+    {
+        return [
+            'verification_url' => [
+                'required',
+                'url',
+                Rule::in(config('appSection-authentication.allowed-verify-email-urls')),
+            ],
+        ];
+    }
+
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess',
+        ]);
+    }
+}

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Requests/VerifyEmailRequest.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace App\Containers\AppSection\Authentication\UI\API\Requests;
+
+use App\Ship\Parents\Requests\Request as ParentRequest;
+
+class VerifyEmailRequest extends ParentRequest
+{
+    /**
+     * 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 (e.g, `/user/{id}`) allows applying
+     * validation rules on them and allows accessing them like request data.
+     */
+    protected array $urlParameters = [
+        'id',
+    ];
+
+    /**
+     * Get the validation rules that apply to the request.
+     */
+    public function rules(): array
+    {
+        return [
+            // 'id' => 'required',
+        ];
+    }
+
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess',
+        ]);
+    }
+}

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

@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * @apiGroup           Authentication
+ * @apiName            ForgotPassword
+ *
+ * @api                {POST} /v1/password/forgot Forgot password
+ * @apiDescription     Forgot password endpoint.
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      none
+ *
+ * @apiHeader          {String} accept=application/json
+ *
+ * @apiBody           {String}  email
+ * @apiBody           {String="reset-password"}  reseturl the reset password url
+ *
+ * @apiSuccessExample  {json}  Success-Response:
+ * HTTP/1.1 204 No Content
+ * {}
+ */
+
+use App\Containers\AppSection\Authentication\UI\API\Controllers\ForgotPasswordController;
+use Illuminate\Support\Facades\Route;
+
+Route::post('password/forgot', [ForgotPasswordController::class, 'forgotPassword']);

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Routes/GetAuthenticatedUser.v1.private.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * @apiGroup           Authentication
+ * @apiName            GetAuthenticatedUser
+ *
+ * @api                {GET} /v1/profile Get Profile
+ * @apiDescription     Find the user details of the logged-in user from its Token. (without specifying his ID)
+ *
+ * @apiHeader          {String} accept=application/json
+ * @apiHeader          {String} authorization=Bearer
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      Authenticated ['permissions' => '', 'roles' => '']
+ *
+ * @apiUse             UserSuccessSingleResponse
+ */
+
+use App\Containers\AppSection\Authentication\UI\API\Controllers\GetAuthenticatedUserController;
+use Illuminate\Support\Facades\Route;
+
+Route::get('profile', [GetAuthenticatedUserController::class, 'getAuthenticatedUser'])
+    ->middleware(['auth:api']);

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

@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * @apiGroup           OAuth2
+ * @apiName            LoginProxyForWebClient
+ * @api                {post} /v1/clients/web/login Login (Password Grant with proxy)
+ * @apiDescription     Login Users using their email and password, without client_id and client_secret.
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      none
+ *
+ * @apiHeader          {String} accept=application/json
+ *
+ * @apiBody           {String} email
+ * @apiBody           {String} password
+ *
+ * @apiSuccessExample  {json}       Success-Response:
+ * HTTP/1.1 200 OK
+ * {
+ * "token_type": "Bearer",
+ * "expires_in": 315360000,
+ * "access_token": "eyJ0eXAiOiJKV1QiLCJhbG...",
+ * "refresh_token": "ZFDPA1S7H8Wydjkjl+xt+hPGWTagX..."
+ * }
+ */
+
+use App\Containers\AppSection\Authentication\UI\API\Controllers\LoginProxyForWebClientController;
+use Illuminate\Support\Facades\Route;
+
+Route::post('clients/web/login', [LoginProxyForWebClientController::class, 'loginProxyForWebClient']);

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

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * @apiGroup           OAuth2
+ * @apiName            LoginCredentialsGrant
+ * @api                {post} /v1/oauth/token Login (Client Credentials Grant)
+ * @apiDescription     Login Users using their username and passwords. (For Third-Party Clients).
+ *                     You must have client ID and secret first. You can generate them by creating new Client in our Web App.
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      none
+ *
+ * @apiHeader          {String} accept=application/json
+ *
+ * @apiBody           {String}  client_id
+ * @apiBody           {String}  client_secret
+ * @apiBody           {String}  grant_type must be `client_credentials`
+ * @apiBody           {String}  [scope] you can leave it empty
+ *
+ * @apiSuccessExample  {json}       Success-Response:
+ * HTTP/1.1 200 OK
+ * {
+ * "token_type": "Bearer",
+ * "expires_in": 315360000,
+ * "access_token": "eyJ0eXAiOiJKV1QiLCJhbG...",
+ * }
+ */
+
+// Implementation in the Laravel Passport package

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Routes/LoginUsingPasswordGrant.v1.private.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * @apiGroup           OAuth2
+ * @apiName            LoginPasswordGrant
+ * @api                {post} /v1/oauth/token Login (Password Grant)
+ * @apiDescription     Login Users using their username and passwords. (For First-Party Clients)
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      none
+ *
+ * @apiHeader          {String} accept=application/json
+ *
+ * @apiBody           {String}  username user email
+ * @apiBody           {String}  password user password
+ * @apiBody           {String}  client_id
+ * @apiBody           {String}  client_secret
+ * @apiBody           {String}  grant_type must be `password`
+ * @apiBody           {String}  [scope] you can leave it empty
+ *
+ * @apiSuccessExample  {json}       Success-Response:
+ * HTTP/1.1 200 OK
+ * {
+ * "token_type": "Bearer",
+ * "expires_in": 315360000,
+ * "access_token": "eyJ0eXAiOiJKV1QiLCJhbG...",
+ * "refresh_token": "Oukd61zgKzt8TBwRjnasd..."
+ * }
+ */
+
+// Implementation in the Laravel Passport package

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

@@ -0,0 +1,26 @@
+<?php
+/**
+ * @apiGroup           OAuth2
+ * @apiName            Logout
+ * @api                {DELETE} /v1/logout Logout
+ * @apiDescription     User Logout. (Revoking Access Token)
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      Authenticated ['permissions' => '', 'roles' => '']
+ *
+ * @apiHeader          {String} accept=application/json
+ * @apiHeader          {String} authorization=Bearer
+ *
+ * @apiSuccessExample  {json}       Success-Response:
+ * HTTP/1.1 202 Accepted
+ * {
+ * "message": "Token revoked successfully."
+ * }
+ */
+
+use App\Containers\AppSection\Authentication\UI\API\Controllers\LogoutController;
+use Illuminate\Support\Facades\Route;
+
+Route::delete('logout', [LogoutController::class, 'logout'])
+    ->middleware(['auth:api']);
+

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

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * @apiGroup           OAuth2
+ * @apiName            RefreshProxyForWebClient
+ * @api                {post} /v1/clients/web/refresh Refresh
+ * @apiDescription     Get new tokens given a valid refresh token is provided.
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      none
+ *
+ * @apiHeader          {String} accept=application/json
+ *
+ * @apiBody           {String}  [refresh_token] The refresh Token
+ *
+ * @apiSuccessExample  {json}       Success-Response:
+ * HTTP/1.1 200 OK
+ * {
+ * "token_type": "Bearer",
+ * "expires_in": 315360000,
+ * "access_token": "eyJ0eXAiOiJKV1QiLCJhbG...",
+ * "refresh_token": "ZFDPA1S7H8Wydjkjl+xt+hPGWTagX..."
+ * }
+ */
+
+use App\Containers\AppSection\Authentication\UI\API\Controllers\RefreshProxyForWebClientController;
+use Illuminate\Support\Facades\Route;
+
+Route::post('clients/web/refresh', [RefreshProxyForWebClientController::class, 'refreshProxyForWebClient']);

package/Daevin_test/app/Containers/AppSection/Authentication/UI/API/Routes/RegisterUser.v1.private.php

@@ -0,0 +1,38 @@
+<?php
+
+/**
+ * @apiGroup           Authentication
+ * @apiName            RegisterUser
+ * @api                {post} /v1/register Register User (create client)
+ * @apiDescription     Register users as (client).
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      none
+ *
+ * @apiHeader          {String} accept=application/json
+ *
+ * @apiBody           {String} email
+ * @apiBody           {String} password min: 8
+ *
+ * at least one character of the following:
+ *
+ * upper case letter
+ *
+ * lower case letter
+ *
+ * number
+ *
+ * special character
+ *
+ * @apiParam           {String} [name] min:2|max:50
+ * @apiParam           {String="male","female","unspecified"} [gender]
+ * @apiParam           {Date} [birth] format: Y-m-d / e.g. 2015-10-15
+ * @apiParam           {String} [verification_url] requireIf:email_verification_required|url|in:allowed-verify-email-urls
+ *
+ * @apiUse             UserSuccessSingleResponse
+ */
+
+use App\Containers\AppSection\Authentication\UI\API\Controllers\RegisterUserController;
+use Illuminate\Support\Facades\Route;
+
+Route::post('/register', [RegisterUserController::class, 'registerUser']);