add ResolveVanityURL request

README.md

@@ -33,6 +33,7 @@ $steam->getPlayerSummaries($steamid);
 | ✅   | **GET**  | `ISteamUser/GetFriendList/v1`                                  | `$steam->getFriendList()`                         |
 | ✅   | **GET**  | `ISteamUser/GetPlayerBans/v1`                                  | `$steam->getPlayerBans()`                         |
 | ✅   | **GET**  | `ISteamUser/GetPlayerSummaries/v2`                             | `$steam->getPlayerSummaries()`                    |
+| ✅   | **GET**  | `ISteamUser/ResolveVanityURL/v1`                               | `$steam->resolveVanityUrl()`                      |
 | ✅   | **GET**  | `ISteamUserStats/GetGlobalAchievementPercentagesForApp/v2`     | `$steam->getGlobalAchievementPercentagesForApp()` |
 | ✅   | **GET**  | `ISteamWebAPIUtil/GetSupportedAPIList/v1`                      | `$steam->getSupportedApiList()`                   |
 | ✅   | **GET**  | `actions/QueryLocations`                                       | `$steam->queryLocations()`                        |
@@ -47,7 +48,6 @@ $steam->getPlayerSummaries($steamid);
 | 🗒️ | **GET**  | `IPlayerService/GetSteamLevel/v1`                              |                                                   |
 | 🗒️ | **GET**  | `IPlayerService/IsPlayingSharedGame/v1`                        |                                                   |
 | 🗒️ | **GET**  | `ISteamUser/GetUserGroupList/v1`                               |                                                   |
-| 🗒️ | **GET**  | `ISteamUser/ResolveVanityURL/v1`                               |                                                   |
 | 🗒️ | **GET**  | `ISteamUserStats/GetGlobalStatsForGame/v1`                     |                                                   |
 | 🗒️ | **GET**  | `ISteamUserStats/GetNumberOfCurrentPlayers/v1`                 |                                                   |
 | 🗒️ | **GET**  | `ISteamUserStats/GetPlayerAchievements/v1`                     |                                                   |

src/Enums/VanityType.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Astrotomic\SteamSdk\Enums;
+
+enum VanityType: int
+{
+    case Individual = 1;
+    case Group = 2;
+    case GameGroup = 3;
+}

src/Requests/GetSupportedAPIListRequest.php → src/Requests/GetSupportedApiListRequest.php

@@ -7,7 +7,7 @@
 use Sammyjo20\Saloon\Http\SaloonResponse;
 use Sammyjo20\Saloon\Traits\Plugins\CastsToDto;
 
-class GetSupportedAPIListRequest extends SaloonRequest
+class GetSupportedApiListRequest extends SaloonRequest
 {
     use CastsToDto;
 

src/Requests/ResolveVanityUrlRequest.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Astrotomic\SteamSdk\Requests;
+
+use Astrotomic\SteamSdk\Enums\VanityType;
+use Sammyjo20\Saloon\Http\SaloonRequest;
+
+class ResolveVanityUrlRequest extends SaloonRequest
+{
+    protected ?string $method = 'GET';
+
+    public function __construct(
+        public readonly string $vanityurl,
+        public readonly VanityType $url_type,
+    ) {
+    }
+
+    public function defineEndpoint(): string
+    {
+        return '/ISteamUser/ResolveVanityURL/v1';
+    }
+
+    public function defaultQuery(): array
+    {
+        return [
+            'vanityurl' => $this->vanityurl,
+            'url_type' => $this->url_type->value,
+        ];
+    }
+}

src/SteamConnector.php

@@ -13,19 +13,23 @@
 use Astrotomic\SteamSdk\Collections\PlayerBanCollection;
 use Astrotomic\SteamSdk\Collections\PlayerSummaryCollection;
 use Astrotomic\SteamSdk\Enums\Relationship;
+use Astrotomic\SteamSdk\Enums\VanityType;
 use Astrotomic\SteamSdk\Requests\GetAppListRequest;
 use Astrotomic\SteamSdk\Requests\GetFriendListRequest;
 use Astrotomic\SteamSdk\Requests\GetGlobalAchievementPercentagesForAppRequest;
 use Astrotomic\SteamSdk\Requests\GetNewsForAppRequest;
 use Astrotomic\SteamSdk\Requests\GetPlayerBansRequest;
 use Astrotomic\SteamSdk\Requests\GetPlayerSummariesRequest;
-use Astrotomic\SteamSdk\Requests\GetSupportedAPIListRequest;
+use Astrotomic\SteamSdk\Requests\GetSupportedApiListRequest;
 use Astrotomic\SteamSdk\Requests\QueryLocationsRequest;
+use Astrotomic\SteamSdk\Requests\ResolveVanityUrlRequest;
 use Astrotomic\SteamSdk\Responses\SteamResponse;
 use Carbon\CarbonInterface;
+use InvalidArgumentException;
 use Sammyjo20\Saloon\Http\SaloonConnector;
 use Sammyjo20\Saloon\Traits\Plugins\AcceptsJson;
 use Sammyjo20\Saloon\Traits\Plugins\AlwaysThrowsOnErrors;
+use SteamID;
 
 class SteamConnector extends SaloonConnector
 {
@@ -55,7 +59,7 @@ public function defaultQuery(): array
     public function getSupportedApiList(): ApiInterfaceCollection
     {
         return $this->send(
-            new GetSupportedAPIListRequest()
+            new GetSupportedApiListRequest()
         )->dto();
     }
 
@@ -115,4 +119,17 @@ public function getAppList(): AppCollection
             new GetAppListRequest()
         )->dto();
     }
+
+    public function resolveVanityUrl(string $vanityurl): ?SteamID
+    {
+        try {
+            return SteamID::SetFromURL($vanityurl, function (string $vanityurl, int $type): ?string {
+                return $this->send(
+                    new ResolveVanityUrlRequest($vanityurl, VanityType::from($type))
+                )->json('response.steamid');
+            });
+        } catch (InvalidArgumentException) {
+            return null;
+        }
+    }
 }

tests/Feature/Requests/ResolveVanityUrlRequestTest.php

@@ -0,0 +1,24 @@
+<?php
+
+use PHPUnit\Framework\Assert;
+
+it('returns resolved steamid', closure: function (string $vanityurl, string $expected): void {
+    $steamid = $this->steam->resolveVanityUrl(vanityurl: $vanityurl);
+
+    Assert::assertInstanceOf(SteamID::class, $steamid);
+    Assert::assertSame($expected, $steamid->ConvertToUInt64());
+})->with([
+    ['https://steamcommunity.com/profiles/76561198061912622', '76561198061912622'],
+    ['https://steamcommunity.com/profiles/[U:1:101646894]', '76561198061912622'],
+    ['https://steamcommunity.com/id/gummibeer/', '76561198061912622'],
+    ['https://s.team/p/jbw-bddv', '76561198061912622'],
+    ['https://steamcommunity.com/groups/archiasf', '103582791440160998'],
+]);
+
+it('returns null for invalid vanity', closure: function (string $vanityurl): void {
+    $steamid = $this->steam->resolveVanityUrl(vanityurl: $vanityurl);
+
+    Assert::assertNull($steamid);
+})->with([
+    'https://steamcommunity.com/profiles/[U:1:jbw-bddv]',
+]);

tests/Fixtures/Saloon/api.steampowered.com/GET/ISteamUser/ResolveVanityURL/v1/vanityurl=archiasf&url_type=2.json

@@ -0,0 +1 @@
+{"statusCode":200,"headers":{"Server":["nginx"],"Content-Type":["application\/json; charset=UTF-8"],"Expires":["Mon, 07 Nov 2022 20:53:39 GMT"],"Date":["Mon, 07 Nov 2022 20:53:39 GMT"],"Content-Length":["57"],"Connection":["keep-alive"]},"data":"{\"response\":{\"steamid\":\"103582791440160998\",\"success\":1}}"}

tests/Fixtures/Saloon/api.steampowered.com/GET/ISteamUser/ResolveVanityURL/v1/vanityurl=gummibeer&url_type=1.json

@@ -0,0 +1 @@
+{"statusCode":200,"headers":{"Server":["nginx"],"Content-Type":["application\/json; charset=UTF-8"],"Expires":["Mon, 07 Nov 2022 20:52:02 GMT"],"Date":["Mon, 07 Nov 2022 20:52:02 GMT"],"Content-Length":["56"],"Connection":["keep-alive"]},"data":"{\"response\":{\"steamid\":\"76561198061912622\",\"success\":1}}"}