daevin 1.0.0

package/Daevin_test/app/Containers/AppSection/Users/UI/API/Requests/UpdateUsersRequest.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace App\Containers\AppSection\Users\UI\API\Requests;
+
+use App\Ship\Parents\Requests\Request;
+
+class UpdateUsersRequest extends Request
+{
+    /**
+     * 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',
+            'email' => 'nullable|unique|string|max:40',
+			'is_active' => 'nullable|notNull',
+			'password' => 'nullable|notNull|min:8|max:20|string|hidden',
+			'name' => 'nullable|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/Users/UI/API/Routes/CreateUsersRoute.v1.private.php

@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * @apiGroup           Users
+ * @apiName            CreateUsers
+ *
+ * @api                {POST} /v1/users Create Users
+ * @apiDescription     Create a new Users
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      Authenticated ['permissions' => '', 'roles' => '']
+ *
+ * @apiHeader          {String} accept=application/json
+ * @apiHeader          {String} authorization=Bearer
+ *
+ * @apiBody           {string} email (Optional)
+* @apiBody           {boolean} is_active (Optional)
+* @apiBody           {string} password (Optional)
+* @apiBody           {string} name (Optional)
+
+ *
+ * @apiSuccessExample  {json} Success-Response:
+ * HTTP/1.1 200 OK
+ * {
+ *     {
+ *       "data": {
+ *               "object": "Users",
+ *               "id": "NxOpZowo9GmjKqdR",
+ *               "deleted_at": null,
+ *               "deleted_by": null,
+ *               "updated_by": null,
+ *               "created_at": "2021-12-24T11:57:37.000000Z",
+ *               "updated_at": "2022-05-03T07:03:00.000000Z",
+ *               "readable_created_at": "1 year ago",
+ *               "readable_updated_at": "9 months ago",
+ *               "real_id": 1
+ *           },    
+ *       "meta": {
+ *           "include": [],
+ *           "custom": [],
+ *       }
+ *   }
+ * }
+ */
+
+use App\Containers\AppSection\Users\UI\API\Controllers\Controller;
+use Illuminate\Support\Facades\Route;
+
+Route::post('users', [Controller::class, 'createUsers'])
+    ->middleware(['auth:api']);
+
+
+        

package/Daevin_test/app/Containers/AppSection/Users/UI/API/Routes/DeleteUsersRoute.v1.private.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * @apiGroup           Users
+ * @apiName            DeleteUsers
+ *
+ * @api                {DELETE} /v1/users/:id Delete Users
+ * @apiDescription     Delete a Users by its id
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      Authenticated ['permissions' => '', 'roles' => '']
+ *
+ * @apiHeader          {String} accept=application/json
+ * @apiHeader          {String} authorization=Bearer
+ *
+ *
+ * @apiSuccessExample  {json} Success-Response:
+ * HTTP/1.1 200 OK
+ * {
+ *    
+ * }
+ */
+
+use App\Containers\AppSection\Users\UI\API\Controllers\Controller;
+use Illuminate\Support\Facades\Route;
+
+Route::delete('users/{id}', [Controller::class, 'deleteUsers'])
+    ->middleware(['auth:api']);
+
+
+        

package/Daevin_test/app/Containers/AppSection/Users/UI/API/Routes/FindUsersByIdRoute.v1.private.php

@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * @apiGroup           Users
+ * @apiName            FindUsersByid
+ *
+ * @api                {GET} /v1/users/:id Find Users
+ * @apiDescription     Find a Users by its id
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      Authenticated ['permissions' => '', 'roles' => '']
+ *
+ * @apiHeader          {String} accept=application/json
+ * @apiHeader          {String} authorization=Bearer
+ *
+ * @apiParam           {string} email (Optional)
+* @apiParam           {boolean} is_active (Optional)
+* @apiParam           {string} password (Optional)
+* @apiParam           {string} name (Optional)
+
+ *
+ * @apiSuccessExample  {json} Success-Response:
+ * HTTP/1.1 200 OK
+ * {
+ *     {
+ *       "data": {
+ *               "object": "Users",
+ *               "id": "NxOpZowo9GmjKqdR",
+ *               "deleted_at": null,
+ *               "deleted_by": null,
+ *               "updated_by": null,
+ *               "created_at": "2021-12-24T11:57:37.000000Z",
+ *               "updated_at": "2022-05-03T07:03:00.000000Z",
+ *               "readable_created_at": "1 year ago",
+ *               "readable_updated_at": "9 months ago",
+ *               "real_id": 1
+ *           },    
+ *       "meta": {
+ *           "include": [],
+ *           "custom": [],
+ *       }
+ *   }
+ * }
+ */
+
+use App\Containers\AppSection\Users\UI\API\Controllers\Controller;
+use Illuminate\Support\Facades\Route;
+
+Route::get('users/{id}', [Controller::class, 'findUsersById'])
+    ->middleware(['auth:api']);
+
+
+        

package/Daevin_test/app/Containers/AppSection/Users/UI/API/Routes/GetAllUsersRoute.v1.private.php

@@ -0,0 +1,75 @@
+<?php
+
+/**
+ * @apiGroup           Users
+ * @apiName            CreateUsers
+ *
+ * @api                {GET} /v1/users Get Users
+ * @apiDescription     Get all  Users
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      Authenticated ['permissions' => '', 'roles' => '']
+ *
+ * @apiHeader          {String} accept=application/json
+ * @apiHeader          {String} authorization=Bearer
+ *
+ * @apiParam           {string} email (Optional)
+* @apiParam           {boolean} is_active (Optional)
+* @apiParam           {string} password (Optional)
+* @apiParam           {string} name (Optional)
+
+ *
+ * @apiSuccessExample  {json} Success-Response:
+ * HTTP/1.1 200 OK
+ * {
+ *     {
+ *       "data": [
+ *            {
+ *               "object": "Users",
+ *               "id": "NxOpZowo9GmjKqdR",
+ *               "deleted_at": null,
+ *               "deleted_by": null,
+ *               "updated_by": null,
+ *               "created_at": "2021-12-24T11:57:37.000000Z",
+ *               "updated_at": "2022-05-03T07:03:00.000000Z",
+ *               "readable_created_at": "1 year ago",
+ *               "readable_updated_at": "9 months ago",
+ *               "real_id": 1
+ *           },
+ *            {
+ *               "object": "Users",
+ *               "id": "NxOpZowo9GmjKqdR",
+ *               "deleted_at": null,
+ *               "deleted_by": null,
+ *               "updated_by": null,
+ *               "created_at": "2021-12-24T11:57:37.000000Z",
+ *               "updated_at": "2022-05-03T07:03:00.000000Z",
+ *               "readable_created_at": "1 year ago",
+ *               "readable_updated_at": "9 months ago",
+ *               "real_id": 1
+ *           },
+ *          ],    
+ *       "meta": {
+ *           "include": [],
+ *           "custom": [],
+ *           "pagination": {
+ *               "total": 2,
+ *               "count": 2,
+ *               "per_page": 10,
+ *               "current_page": 1,
+ *               "total_pages": 1,
+ *               "links": {}
+ *           }
+ *       }
+ *   }
+ * }
+ */
+
+use App\Containers\AppSection\Users\UI\API\Controllers\Controller;
+use Illuminate\Support\Facades\Route;
+
+Route::get('users', [Controller::class, 'getAllUsers'])
+    ->middleware(['auth:api']);
+
+
+        

package/Daevin_test/app/Containers/AppSection/Users/UI/API/Routes/UpdateUsersRoute.v1.private.php

@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * @apiGroup           Users
+ * @apiName            UpdateUsers
+ *
+ * @api                {PATCH} /v1/users/:id Update Users
+ * @apiDescription     Update a Users by its id
+ *
+ * @apiVersion         1.0.0
+ * @apiPermission      Authenticated ['permissions' => '', 'roles' => '']
+ *
+ * @apiHeader          {String} accept=application/json
+ * @apiHeader          {String} authorization=Bearer
+ *
+ * @apiBody           {string} email (Optional)
+* @apiBody           {boolean} is_active (Optional)
+* @apiBody           {string} password (Optional)
+* @apiBody           {string} name (Optional)
+
+ *
+ * @apiSuccessExample  {json} Success-Response:
+ * HTTP/1.1 200 OK
+ * {
+ *     {
+ *       "data": {
+ *               "object": "Users",
+ *               "id": "NxOpZowo9GmjKqdR",
+ *               "deleted_at": null,
+ *               "deleted_by": null,
+ *               "updated_by": null,
+ *               "created_at": "2021-12-24T11:57:37.000000Z",
+ *               "updated_at": "2022-05-03T07:03:00.000000Z",
+ *               "readable_created_at": "1 year ago",
+ *               "readable_updated_at": "9 months ago",
+ *               "real_id": 1
+ *           },    
+ *       "meta": {
+ *           "include": [],
+ *           "custom": [],
+ *       }
+ *   }
+ * }
+ */
+
+use App\Containers\AppSection\Users\UI\API\Controllers\Controller;
+use Illuminate\Support\Facades\Route;
+
+Route::patch('users/{id}', [Controller::class, 'updateUsers'])
+    ->middleware(['auth:api']);
+
+
+        

package/Daevin_test/app/Containers/AppSection/Users/UI/API/Transformers/UsersTransformer.php

@@ -0,0 +1,49 @@
+<?php 
+
+namespace App\Containers\AppSection\Users\UI\API\Transformers;
+
+use App\Containers\AppSection\Users\Models\Users;
+use App\Ship\Parents\Transformers\Transformer as ParentTransformer;
+
+class UsersTransformer extends ParentTransformer
+{
+    protected array $defaultIncludes = [
+
+    ];
+
+    protected array $availableIncludes = [
+            'post',
+    
+    ];
+
+    public function transform(Users $users): array
+    {
+        $response = [
+            'object' => $users->getResourceKey(),
+            'id' => $users->getHashedKey(),
+            'created_at' => $users->created_at,
+            'updated_at' => $users->updated_at,
+        ];
+
+        return $this->ifAdmin([
+            'real_id' => $users->id,
+            'created_at' => $users->created_at,
+            'updated_at' => $users->updated_at,
+            'readable_created_at' => $users->created_at->diffForHumans(),
+            'readable_updated_at' => $users->updated_at->diffForHumans(),
+            'deleted_at' => $users->deleted_at,
+        ], $response);
+    }
+    
+    public function includePost(Users $users)
+    {
+        if (is_null($users->post)) 
+            return $this->null();
+        return $this->collection($users->post, new PostTransformer());
+    }
+
+
+    
+}
+
+        

package/Daevin_test/app/Containers/AppSection/Users/Users.json

@@ -0,0 +1,7 @@
+{
+    "name": "apiato/users",
+    "description": "Users Container for apiato.",
+    "require": {
+    }
+}
+

package/Daevin_test/app/Containers/AppSection/Users/composer.json

@@ -0,0 +1,7 @@
+{
+    "name": "apiato/users",
+    "description": "Users Container for apiato.",
+    "require": {
+    }
+}
+

package/Daevin_test/app/Ship/Broadcasts/channels.php

@@ -0,0 +1,16 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| Broadcast Channels
+|--------------------------------------------------------------------------
+|
+| Here you may register all of the event broadcasting channels that your
+| application supports. The given channel authorization callbacks are
+| used to check if an authenticated user can listen to the channel.
+|
+*/
+
+//Broadcast::channel('App.Models.User.{id}', function ($user, $id) {
+//    return (int) $user->id === (int) $id;
+//});

package/Daevin_test/app/Ship/Commands/HelloWorldCommand.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Ship\Commands;
+
+use App\Ship\Parents\Commands\ConsoleCommand;
+
+class HelloWorldCommand extends ConsoleCommand
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'hello:world';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Hello World!';
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        echo "Hello World :)\n";
+    }
+}

package/Daevin_test/app/Ship/Commands/closures.php

@@ -0,0 +1,19 @@
+<?php
+
+use Illuminate\Foundation\Inspiring;
+use Illuminate\Support\Facades\Artisan;
+
+/*
+|--------------------------------------------------------------------------
+| Console Routes
+|--------------------------------------------------------------------------
+|
+| This file is where you may define all of your Closure based console
+| commands. Each Closure is bound to a command instance allowing a
+| simple approach to interacting with each command's IO methods.
+|
+*/
+
+Artisan::command('inspire', function () {
+    $this->comment(Inspiring::quote());
+})->purpose('Display an inspiring quote');

package/Daevin_test/app/Ship/Configs/apiato.php

@@ -0,0 +1,185 @@
+<?php
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | Enable / Disable Hashed ID
+    |--------------------------------------------------------------------------
+    */
+    'hash-id' => env('HASH_ID', true),
+
+    'api' => [
+        /*
+        |--------------------------------------------------------------------------
+        | API URL
+        |--------------------------------------------------------------------------
+        */
+        'url' => env('API_URL', 'http://localhost'),
+
+        /*
+        |--------------------------------------------------------------------------
+        | API Prefix
+        |--------------------------------------------------------------------------
+        */
+        'prefix' => env('API_PREFIX', '/'),
+
+        /*
+        |--------------------------------------------------------------------------
+        | API Prefix
+        |--------------------------------------------------------------------------
+        */
+        'enable_version_prefix' => true,
+
+
+        /*
+        |--------------------------------------------------------------------------
+        | Access Token Expiration
+        |--------------------------------------------------------------------------
+        |
+        | In Minutes. Default to 1,440 minutes = 1 day
+        |
+        */
+        'expires-in' => env('API_TOKEN_EXPIRES', 1440),
+
+        /*
+        |--------------------------------------------------------------------------
+        | Refresh Token Expiration
+        |--------------------------------------------------------------------------
+        |
+        | In Minutes. Default to 43,200 minutes = 30 days
+        |
+        */
+        'refresh-expires-in' => env('API_REFRESH_TOKEN_EXPIRES', 43200),
+
+        /*
+        |--------------------------------------------------------------------------
+        | Enable Disable API Debugging
+        |--------------------------------------------------------------------------
+        |
+        | If enabled, the Error Exception trace will be injected in the JSON
+        | response, and it will be logged in the default Log file.
+        |
+        */
+        'debug' => env('API_DEBUG', true),
+
+        /*
+        |--------------------------------------------------------------------------
+        | Enable/Disable Implicit Grant
+        |--------------------------------------------------------------------------
+        */
+        'enabled-implicit-grant' => env('API_ENABLE_IMPLICIT_GRANT', true),
+
+        /*
+        |--------------------------------------------------------------------------
+        | Rate Limit (throttle)
+        |--------------------------------------------------------------------------
+        |
+        | Attempts per minutes.
+        | `attempts` is the number of attempts per `expires` in minutes.
+        |
+        */
+        'throttle' => [
+            'enabled' => env('GLOBAL_API_RATE_LIMIT_ENABLED', true),
+            'attempts' => env('GLOBAL_API_RATE_LIMIT_ATTEMPTS_PER_MIN', '30'),
+            'expires' => env('GLOBAL_API_RATE_LIMIT_EXPIRES_IN_MIN', '1'),
+        ],
+
+    ],
+
+    'requests' => [
+        /*
+        |--------------------------------------------------------------------------
+        | Allow Roles to access all Routes
+        |--------------------------------------------------------------------------
+        |
+        | Define a list of roles that do not need to go through the "hasAccess"
+        | check in Requests. These roles automatically pass this check. This is
+        | useful, if you want to make all routes accessible for admin users.
+        |
+        | Usage: ['admin', 'editor']
+        | Default: []
+        |
+        */
+        'allow-roles-to-access-all-routes' => [
+            env('ADMIN_ROLE', 'admin'),
+        ],
+
+        /*
+        |--------------------------------------------------------------------------
+        | Force Request Header to Contain header
+        |--------------------------------------------------------------------------
+        |
+        | By default, users can send request without defining the accept header and
+        | setting it to [ accept = application/json ].
+        | To force the users to define that header, set this to true.
+        | When set to true, a PHP exception will be thrown preventing users from access
+        | When set to false, the header will contain a warning message.
+        |
+        */
+        'force-accept-header' => false,
+
+        /*
+        |--------------------------------------------------------------------------
+        | Force Valid Request Include Parameters
+        |--------------------------------------------------------------------------
+        |
+        | By default, users can request to include additional resources into the
+        | response by using the ?include=... query parameter. The requested top-level
+        | resource also responds with all available includes. However, the user may
+        | still request an invalid (i.e., not available) include parameter. This flag
+        | determines, how to proceed in such a case:
+        | When set to true, a PHP Exception will be thrown (default)
+        | When set to false, this invalid include will be skipped
+        |
+        */
+        'force-valid-includes' => true,
+
+        /*
+        |--------------------------------------------------------------------------
+        | Use ETags
+        |--------------------------------------------------------------------------
+        |
+        | This option appends an "ETag" HTTP Header to the Response. This ETag is a
+        | calculated hash of the content to be delivered.
+        | Clients can add an "If-None-Match" HTTP Header to the Request and submit
+        | an (old) ETag. These ETags are validated. If they match (are the same),
+        | an empty BODY with HTTP STATUS 304 (not modified) is returned!
+        |
+        */
+        'use-etag' => false,
+    ],
+
+    'seeders' => [
+        /*
+        |--------------------------------------------------------------------------
+        | Special seeders for apiato:seed-deploy & apiato:seed-test commands
+        |--------------------------------------------------------------------------
+        |
+        */
+        'deployment' => App\Ship\Seeders\SeedDeploymentData::class,
+        'testing' => App\Ship\Seeders\SeedTestingData::class,
+    ],
+
+    'tests' => [
+        /*
+        |--------------------------------------------------------------------------
+        | In order to be able to create testing user in your tests using test helpers, tests needs to know
+        | the name of the user model.This is working by default but if you are using another
+        | user model you should update this config.
+        | This user model MUST have a factory defined.
+        |--------------------------------------------------------------------------
+        |
+        */
+        'user-class' => App\Containers\AppSection\User\Models\User::class,
+
+        /*
+        |--------------------------------------------------------------------------
+        | In order to be able to create admin testing user in your tests using test helpers, tests needs to know
+        | the name of the admin state in user factory. This is working by default but if you are using another
+        | user model or you have changed the default admin state name you should update this config.
+        |--------------------------------------------------------------------------
+        |
+        */
+        'user-admin-state' => 'admin',
+    ],
+];