3.x (#10)

* updated readme
* optional dto params

Author: ilzrv

README.md

@@ -1,7 +1,8 @@
 # Steam Auth for Laravel
 [![Latest Stable Version](https://img.shields.io/packagist/v/ilzrv/laravel-steam-auth.svg)](https://packagist.org/packages/ilzrv/laravel-steam-auth)
-[![Codecov](https://img.shields.io/codecov/c/github/ilzrv/laravel-steam-auth?token=MIEA87EZGP)](https://app.codecov.io/github/ilzrv/laravel-steam-auth)
 [![Total Downloads](https://img.shields.io/packagist/dt/ilzrv/laravel-steam-auth.svg)](https://packagist.org/packages/ilzrv/laravel-steam-auth)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ilzrv/laravel-steam-auth/tests.yml)](https://github.com/ilzrv/laravel-steam-auth/actions/workflows/tests.yml)
+[![Codecov](https://img.shields.io/codecov/c/github/ilzrv/laravel-steam-auth?token=MIEA87EZGP)](https://app.codecov.io/github/ilzrv/laravel-steam-auth)
 [![License](https://img.shields.io/github/license/ilzrv/laravel-steam-auth.svg)](https://packagist.org/packages/ilzrv/laravel-steam-auth)
 
 Package allows you to implement Steam authentication in your Laravel project.
@@ -113,6 +114,7 @@ use Illuminate\Auth\AuthManager;
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Http\Request;
 use Illuminate\Routing\Redirector;
+use Ilzrv\LaravelSteamAuth\Exceptions\Authentication\SteamResponseNotValidAuthenticationException;
 use Ilzrv\LaravelSteamAuth\Exceptions\Validation\ValidationException;
 use Ilzrv\LaravelSteamAuth\SteamAuthenticator;
 use Ilzrv\LaravelSteamAuth\SteamUserDto;
@@ -134,7 +136,7 @@ final class SteamAuthController
 
         try {
             $steamAuthenticator->auth();
-        } catch (ValidationException) {
+        } catch (ValidationException|SteamResponseNotValidAuthenticationException) {
             return $redirector->to(
                 $steamAuthenticator->buildAuthUrl()
             );

src/SteamAuthenticator.php

@@ -51,7 +51,9 @@ public function auth(): void
         $contents = $response->getBody()->getContents();
 
         if (preg_match("#is_valid\s*:\s*true#i", $contents) !== 1) {
-            throw new SteamResponseNotValidAuthenticationException();
+            throw new SteamResponseNotValidAuthenticationException(
+                sprintf('Steam response contains invalid content: "%s"', $contents)
+            );
         }
 
         $query = $this->parseUriQueryString();

src/SteamUserDto.php

@@ -8,21 +8,21 @@ final class SteamUserDto
 {
     private function __construct(
         private readonly string $steamId,
-        private readonly int $communityVisibilityState,
-        private readonly int $profileState,
-        private readonly string $personaName,
-        private readonly int $commentPermission,
-        private readonly string $profileUrl,
-        private readonly string $avatar,
-        private readonly string $avatarMedium,
-        private readonly string $avatarFull,
-        private readonly string $avatarHash,
-        private readonly int $lastLogoff,
-        private readonly int $personaState,
-        private readonly string $primaryClanId,
-        private readonly int $timeCreated,
-        private readonly int $personaStateFlags,
-        private readonly string $locCountryCode,
+        private readonly ?int $communityVisibilityState,
+        private readonly ?int $profileState,
+        private readonly ?string $personaName,
+        private readonly ?int $commentPermission,
+        private readonly ?string $profileUrl,
+        private readonly ?string $avatar,
+        private readonly ?string $avatarMedium,
+        private readonly ?string $avatarFull,
+        private readonly ?string $avatarHash,
+        private readonly ?int $lastLogoff,
+        private readonly ?int $personaState,
+        private readonly ?string $primaryClanId,
+        private readonly ?int $timeCreated,
+        private readonly ?int $personaStateFlags,
+        private readonly ?string $locCountryCode,
         private readonly ?int $playerLevel,
     ) {
     }
@@ -31,21 +31,21 @@ public static function create(array $data): self
     {
         return new self(
             steamId: $data['steamid'],
-            communityVisibilityState: $data['communityvisibilitystate'],
-            profileState: $data['profilestate'],
-            personaName: $data['personaname'],
-            commentPermission: $data['commentpermission'],
-            profileUrl: $data['profileurl'],
-            avatar: $data['avatar'],
-            avatarMedium: $data['avatarmedium'],
-            avatarFull: $data['avatarfull'],
-            avatarHash: $data['avatarhash'],
-            lastLogoff: $data['lastlogoff'],
-            personaState: $data['personastate'],
-            primaryClanId: $data['primaryclanid'],
-            timeCreated: $data['timecreated'],
-            personaStateFlags: $data['personastateflags'],
-            locCountryCode: $data['loccountrycode'],
+            communityVisibilityState: $data['communityvisibilitystate'] ?? null,
+            profileState: $data['profilestate'] ?? null,
+            personaName: $data['personaname'] ?? null,
+            commentPermission: $data['commentpermission'] ?? null,
+            profileUrl: $data['profileurl'] ?? null,
+            avatar: $data['avatar'] ?? null,
+            avatarMedium: $data['avatarmedium'] ?? null,
+            avatarFull: $data['avatarfull'] ?? null,
+            avatarHash: $data['avatarhash'] ?? null,
+            lastLogoff: $data['lastlogoff'] ?? null,
+            personaState: $data['personastate'] ?? null,
+            primaryClanId: $data['primaryclanid'] ?? null,
+            timeCreated: $data['timecreated'] ?? null,
+            personaStateFlags: $data['personastateflags'] ?? null,
+            locCountryCode: $data['loccountrycode'] ?? null,
             playerLevel: $data['player_level'] ?? null,
         );
     }
@@ -55,77 +55,77 @@ public function getSteamId(): string
         return $this->steamId;
     }
 
-    public function getCommunityVisibilityState(): int
+    public function getCommunityVisibilityState(): ?int
     {
         return $this->communityVisibilityState;
     }
 
-    public function getProfileState(): int
+    public function getProfileState(): ?int
     {
         return $this->profileState;
     }
 
-    public function getPersonaName(): string
+    public function getPersonaName(): ?string
     {
         return $this->personaName;
     }
 
-    public function getCommentPermission(): int
+    public function getCommentPermission(): ?int
     {
         return $this->commentPermission;
     }
 
-    public function getProfileUrl(): string
+    public function getProfileUrl(): ?string
     {
         return $this->profileUrl;
     }
 
-    public function getAvatar(): string
+    public function getAvatar(): ?string
     {
         return $this->avatar;
     }
 
-    public function getAvatarMedium(): string
+    public function getAvatarMedium(): ?string
     {
         return $this->avatarMedium;
     }
 
-    public function getAvatarFull(): string
+    public function getAvatarFull(): ?string
     {
         return $this->avatarFull;
     }
 
-    public function getAvatarHash(): string
+    public function getAvatarHash(): ?string
     {
         return $this->avatarHash;
     }
 
-    public function getLastLogoff(): int
+    public function getLastLogoff(): ?int
     {
         return $this->lastLogoff;
     }
 
-    public function getPersonaState(): int
+    public function getPersonaState(): ?int
     {
         return $this->personaState;
     }
 
-    public function getPrimaryClanId(): string
+    public function getPrimaryClanId(): ?string
     {
         return $this->primaryClanId;
     }
 
-    public function getTimeCreated(): int
+    public function getTimeCreated(): ?int
     {
         return $this->timeCreated;
     }
 
-    public function getPersonaStateFlags(): int
+    public function getPersonaStateFlags(): ?int
     {
         return $this->personaStateFlags;
     }
 
-    public function getLocCountryCode(): string
+    public function getLocCountryCode(): ?string
     {
         return $this->locCountryCode;
     }