Add stats in User resource API

[rcomunica]

Hello Nabel!

I'm here again, I think create a project that maybe can help for all community and I expect more later tell you about this.
But firts I need make some modifications in the API's

Preview

Endpoint: /api/user

{
       ...
        "flights": 125,
        "flight_time": 12463,
        "transfer_time": 0,
        "total_time": 12463,
        "timezone": "GMT",
        "state": 1,
        "stats": {
            "balance": 9999.99,
            "avgScore": "100",
            "avgLanding": "-100",
            "avgFuel": "4,648 kg"
        },
        ...
}

Remember that only you can user Average Score and Average Landing if your pirep was submitted with Acars

I hope in the future add more stats how Average burn fuel and other field

[nabeelio]

Hi @rcomunica!

Thanks for this. It looks good, however, I think you need to put the stats under its own controller and endpoint. Something like:

GET /api/user/<id>/stats
app/Http/Controllers/Api/StatsController.php

This way we can expand on them. The DB calls in the Resource aren't the right place. Balance should be returned already, and the naming of the return fields should be in snake_case

[rcomunica]

Okay @nabeelio I'll make a commit you again when the features are ready

[rcomunica]

Hello @nabeelio,

I think it's ready!... and sorry for the delay, I didn't have internet.

[arthurpar06]

Hey,
Here are some thoughts to make your code more readable and more aligned with the repository structure.

The StatsController.php file should be in the App\Http\Controllers\Api directory rather than App\Http\Resources since this is a controller and this controller should be used by the api.

It also looks like you forgot to register the route, which means that even though the code is present, no one will be able to access it. You need to add a route to the RouteServiceProvider like this. Once added, you'll be able to test it and see if it works correctly.

https://github.com/nabeelio/phpvms/blob/dev/app/Providers/RouteServiceProvider.php#L662

Route::get('user/stats', 'StatsController@index');

[rcomunica]

Hey, Here are some thoughts to make your code more readable and more aligned with the repository structure.

The StatsController.php file should be in the App\Http\Controllers\Api directory rather than App\Http\Resources since this is a controller and this controller should be used by the api.

It also looks like you forgot to register the route, which means that even though the code is present, no one will be able to access it. You need to add a route to the RouteServiceProvider like this. Once added, you'll be able to test it and see if it works correctly.

https://github.com/nabeelio/phpvms/blob/dev/app/Providers/RouteServiceProvider.php#L662

Route::get('user/stats', 'StatsController@index');

Yea man!, thank you. Really I forgot create the folders and other files in github, also upload the file RouteServiceProvider, but thanks!

[FatihKoz]

I do not think that this is correct. It should be casted as Fuel and then we can get both lbs and kg results.

Forcing something to kg is not logical 😉

[FatihKoz]

Something like below should work

use App\Support\Units\Fuel

'average_fuel' => Fuel::make($this->average_fuel_used, config('phpvms.internal_units.fuel'))->getResponseUnits();

[FatihKoz]

If you don't want to create extra queries, you should eager load the journal relationship here.

Also no need to call the Auth facade twice, you can get the user once with relationships and use wherever needed 😉