Merge branch 'master' into feature/webpack-asset-modules

app/Http/Controllers/RankingController.php

@@ -12,6 +12,7 @@
 use App\Models\User;
 use App\Models\UserStatistics;
 use App\Transformers\SelectOptionTransformer;
+use App\Transformers\UserCompactTransformer;
 use DB;
 use Illuminate\Pagination\LengthAwarePaginator;
 
@@ -221,6 +222,21 @@ public function index($mode, $type)
         return ext_view("rankings.{$type}", array_merge($this->defaultViewVars, compact('scores')));
     }
 
+    /**
+     * Get Kudosu Ranking
+     *
+     * Gets the kudosu ranking.
+     *
+     * ---
+     *
+     * ### Response format
+     *
+     * Field   | Type            | Description
+     * ------- | --------------- | -----------
+     * ranking | [User](#user)[] | Includes `kudosu`.
+     *
+     * @queryParam page Ranking page. Example: 1
+     */
     public function kudosu()
     {
         static $maxResults = 1000;
@@ -229,10 +245,19 @@ public function kudosu()
         $page = min(get_int(request('page')) ?? 1, $maxPage);
 
         $scores = User::default()
-            ->with('country')
             ->orderBy('osu_kudostotal', 'desc')
             ->paginate(static::PAGE_SIZE, ['*'], 'page', $page, $maxResults);
 
+        if (is_json_request()) {
+            return ['ranking' => json_collection(
+                $scores,
+                new UserCompactTransformer(),
+                'kudosu',
+            )];
+        }
+
+        $scores->loadMissing('country');
+
         return ext_view('rankings.kudosu', compact('scores'));
     }
 

app/Transformers/UserCompactTransformer.php

@@ -69,6 +69,7 @@ class UserCompactTransformer extends TransformerAbstract
         'is_nat',
         'is_restricted',
         'is_silenced',
+        'kudosu',
         'loved_beatmapset_count',
         'mapping_follower_count',
         'monthly_playcounts',
@@ -285,6 +286,14 @@ public function includeIsSilenced(User $user)
         return $this->primitive($user->isSilenced());
     }
 
+    public function includeKudosu(User $user): ResourceInterface
+    {
+        return $this->primitive([
+            'available' => $user->osu_kudosavailable,
+            'total' => $user->osu_kudostotal,
+        ]);
+    }
+
     public function includeLovedBeatmapsetCount(User $user)
     {
         return $this->primitive($user->profileBeatmapsetCountByGroupedStatus('loved'));

app/Transformers/UserTransformer.php

@@ -21,6 +21,7 @@ class UserTransformer extends UserCompactTransformer
         'is_nat',
         'is_restricted',
         'is_silenced',
+        'kudosu',
     ];
 
     public function transform(User $user)
@@ -35,10 +36,6 @@ public function transform(User $user)
             'has_supported' => $user->hasSupported(),
             'interests' => $user->user_interests,
             'join_date' => json_time($user->user_regdate),
-            'kudosu' => [
-                'total' => $user->osu_kudostotal,
-                'available' => $user->osu_kudosavailable,
-            ],
             'location' => $user->user_from,
             'max_blocks' => $user->maxBlocks(),
             'max_friends' => $user->maxFriends(),

resources/views/docs/_structures/user.md

@@ -55,6 +55,7 @@ graveyard_beatmapset_count | number
 groups                     | [UserGroup](#usergroup)[]
 guest_beatmapset_count     | number
 is_restricted              | boolean?
+kudosu                     | [User.Kudosu](#user-kudosu)
 loved_beatmapset_count     | number
 mapping_follower_count     | number
 monthly_playcounts         | [UserMonthlyPlaycount](#usermonthlyplaycount)[]
@@ -75,6 +76,15 @@ unread_pm_count            | |
 user_achievements          | |
 user_preferences           | |
 
+<div id="user-kudosu" data-unique="user-kudosu"></div>
+
+### Kudosu
+
+Field     | Type
+----------|-----
+available | number
+total     | number
+
 <div id="user-profilebanner" data-unique="user-profilebanner"></div>
 
 ### ProfileBanner

resources/views/docs/_structures/user_extended.md

@@ -171,8 +171,6 @@ discord          | string?                            | |
 has_supported    | boolean                            | whether or not ever being a supporter in the past
 interests        | string?                            | |
 join_date        | Timestamp                          | |
-kudosu.available | number                             | |
-kudosu.total     | number                             | |
 location         | string?                            | |
 max_blocks       | number                             | maximum number of users allowed to be blocked
 max_friends      | number                             | maximum number of friends allowed to be added
@@ -191,3 +189,4 @@ In addition, the following [optional attributes on User](#user-optionalattribute
 - country
 - cover
 - is_restricted (present only if this is the currently authenticated user)
+- kudosu

routes/web.php

@@ -514,6 +514,7 @@
         //  POST /api/v2/notifications/mark-read
         Route::post('notifications/mark-read', 'NotificationsController@markRead')->name('notifications.mark-read');
 
+        Route::get('rankings/kudosu', 'RankingController@kudosu');
         //  GET /api/v2/rankings/:mode/:type
         Route::get('rankings/{mode}/{type}', 'RankingController@index');
         Route::resource('spotlights', 'SpotlightsController', ['only' => ['index']]);

tests/api_routes.json

@@ -1081,6 +1081,22 @@
         ],
         "scopes": []
     },
+    {
+        "uri": "api/v2/rankings/kudosu",
+        "methods": [
+            "GET",
+            "HEAD"
+        ],
+        "controller": "App\\Http\\Controllers\\RankingController@kudosu",
+        "middlewares": [
+            "App\\Http\\Middleware\\ThrottleRequests:1200,1,api:",
+            "App\\Http\\Middleware\\RequireScopes",
+            "App\\Http\\Middleware\\RequireScopes:public"
+        ],
+        "scopes": [
+            "public"
+        ]
+    },
     {
         "uri": "api/v2/rankings/{mode}/{type}",
         "methods": [