+Steam UserInfo

Author: codemasher

.config/.env_example

@@ -216,6 +216,7 @@ SPOTIFY_CALLBACK_URL=
 STEAMOPENID_KEY=
 STEAMOPENID_SECRET=
 STEAMOPENID_CALLBACK_URL=
+#STEAMOPENID_TESTUSER=
 
 # https://dashboard.stripe.com/account/apikeys
 STRIPE_KEY=

README.md

@@ -133,7 +133,7 @@ Note: replace `dev-main` with a [version constraint](https://getcomposer.org/doc
 | [Slack](https://api.slack.com) | [link](https://api.slack.com/apps) | [link](https://slack.com/apps/manage) | 2 | ✓ | ✓ |  |  |  |  |
 | [SoundCloud](https://developers.soundcloud.com/) | [link](https://soundcloud.com/you/apps) | [link](https://soundcloud.com/settings/connections) | 2 | ✓ |  |  | ✓ | ✓ |  |
 | [Spotify](https://developer.spotify.com/documentation/web-api/) | [link](https://developer.spotify.com/dashboard) | [link](https://www.spotify.com/account/apps/) | 2 | ✓ | ✓ |  | ✓ | ✓ |  |
-| [SteamOpenID](https://developer.valvesoftware.com/wiki/Steam_Web_API) | [link](https://steamcommunity.com/dev/apikey) |  | - |  |  |  |  |  |  |
+| [SteamOpenID](https://developer.valvesoftware.com/wiki/Steam_Web_API) | [link](https://steamcommunity.com/dev/apikey) |  | - | ✓ |  |  |  |  |  |
 | [Stripe](https://stripe.com/docs/api) | [link](https://dashboard.stripe.com/apikeys) | [link](https://dashboard.stripe.com/account/applications) | 2 | ✓ | ✓ |  |  | ✓ | ✓ |
 | [Tumblr](https://www.tumblr.com/docs/en/api/v2) | [link](https://www.tumblr.com/oauth/apps) | [link](https://www.tumblr.com/settings/apps) | 1 | ✓ |  |  |  |  |  |
 | [Tumblr2](https://www.tumblr.com/docs/en/api/v2) | [link](https://www.tumblr.com/oauth/apps) | [link](https://www.tumblr.com/settings/apps) | 2 | ✓ | ✓ |  | ✓ | ✓ |  |

docs/Basics/Overview.md

@@ -72,7 +72,7 @@ fully [PSR-7](https://www.php-fig.org/psr/psr-7/)/[PSR-17](https://www.php-fig.o
 | [Slack](https://api.slack.com) | [link](https://api.slack.com/apps) | [link](https://slack.com/apps/manage) | 2 | ✓ | ✓ |  |  |  |  |
 | [SoundCloud](https://developers.soundcloud.com/) | [link](https://soundcloud.com/you/apps) | [link](https://soundcloud.com/settings/connections) | 2 | ✓ |  |  | ✓ | ✓ |  |
 | [Spotify](https://developer.spotify.com/documentation/web-api/) | [link](https://developer.spotify.com/dashboard) | [link](https://www.spotify.com/account/apps/) | 2 | ✓ | ✓ |  | ✓ | ✓ |  |
-| [SteamOpenID](https://developer.valvesoftware.com/wiki/Steam_Web_API) | [link](https://steamcommunity.com/dev/apikey) |  | - |  |  |  |  |  |  |
+| [SteamOpenID](https://developer.valvesoftware.com/wiki/Steam_Web_API) | [link](https://steamcommunity.com/dev/apikey) |  | - | ✓ |  |  |  |  |  |
 | [Stripe](https://stripe.com/docs/api) | [link](https://dashboard.stripe.com/apikeys) | [link](https://dashboard.stripe.com/account/applications) | 2 | ✓ | ✓ |  |  | ✓ | ✓ |
 | [Tumblr](https://www.tumblr.com/docs/en/api/v2) | [link](https://www.tumblr.com/oauth/apps) | [link](https://www.tumblr.com/settings/apps) | 1 | ✓ |  |  |  |  |  |
 | [Tumblr2](https://www.tumblr.com/docs/en/api/v2) | [link](https://www.tumblr.com/oauth/apps) | [link](https://www.tumblr.com/settings/apps) | 2 | ✓ | ✓ |  | ✓ | ✓ |  |

src/Providers/SteamOpenID.php

@@ -12,7 +12,8 @@
 namespace chillerlan\OAuth\Providers;
 
 use chillerlan\HTTP\Utils\QueryUtil;
-use chillerlan\OAuth\Core\{AccessToken, OAuthProvider};
+use chillerlan\OAuth\Core\{AccessToken, AuthenticatedUser, OAuthProvider, UserInfo};
+use chillerlan\HTTP\Utils\UriUtil;
 use Psr\Http\Message\{RequestInterface, ResponseInterface, UriInterface};
 use function explode, intval, preg_replace;
 
@@ -23,7 +24,7 @@
  * @see https://partner.steamgames.com/doc/webapi_overview
  * @see https://steamwebapi.azurewebsites.net/
  */
-class SteamOpenID extends OAuthProvider{
+class SteamOpenID extends OAuthProvider implements UserInfo{
 
 	protected string      $authorizationURL = 'https://steamcommunity.com/openid/login';
 	protected string      $accessTokenURL   = 'https://steamcommunity.com/openid/login';
@@ -114,17 +115,34 @@ protected function parseTokenResponse(ResponseInterface $response):AccessToken{
 	 *
 	 */
 	public function getRequestAuthorization(RequestInterface $request, AccessToken|null $token = null):RequestInterface{
-		$token ??= $this->storage->getAccessToken($this->name);
+		$uri = UriUtil::withQueryValue($request->getUri(), 'key', $this->options->secret);
 
-		$uri    = (string)$request->getUri();
-		$params = ['key' => $this->options->secret];
+		return $request->withUri($uri);
+	}
+
+	/**
+	 * @inheritDoc
+	 * @codeCoverageIgnore
+	 */
+	public function me():AuthenticatedUser{
+		$token = $this->storage->getAccessToken($this->name);
+		$json  = $this->getMeResponseData('/ISteamUser/GetPlayerSummaries/v0002/', ['steamids' => $token->accessToken]);
 
-		// the steamid parameter does not necessarily specify the current user, so add it only when it's not already set
-		if(!str_contains($uri, 'steamid=')){
-			$params['steamid']= $token->accessToken;
+		if(!isset($json['response']['players'][0])){
+			throw new ProviderException('invalid response');
 		}
 
-		return $request->withUri($this->uriFactory->createUri(QueryUtil::merge($uri, $params)));
+		$data = $json['response']['players'][0];
+
+		$userdata = [
+			'data'        => $data,
+			'avatar'      => $data['avatarfull'],
+			'displayName' => $data['personaname'],
+			'id'          => $data['steamid'],
+			'url'         => $data['profileurl'],
+		];
+
+		return new AuthenticatedUser($userdata);
 	}
 
 }

tests/Providers/Live/SteamOpenIDAPITest.php

@@ -11,6 +11,7 @@
 
 namespace chillerlan\OAuthTest\Providers\Live;
 
+use chillerlan\OAuth\Core\AuthenticatedUser;
 use chillerlan\OAuth\Providers\SteamOpenID;
 use PHPUnit\Framework\Attributes\Group;
 
@@ -42,4 +43,9 @@ public function testUnauthorizedAccessException():void{
 		$this::markTestSkipped('N/A');
 	}
 
+	protected function assertMeResponse(AuthenticatedUser $user):void{
+		var_dump($user);
+		$this::assertSame((int)$this->TEST_USER, $user->id);
+	}
+
 }