UserData/UserApi tests and helpers method

Author: roberto-butti

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
-## 0.0.5 - 2025-02-25
+## 0.0.6 - 2025-02-07
+
+- Adding helper methods to UserData
+- UserData / UserApi tests
+
+## 0.0.5 - 2025-02-05
 
 - Re-structuring bulk operations and pagination with `StoryBulkApi` class
 - Refactoring creating new Api instance from Api classes

src/Data/UserData.php

@@ -27,11 +27,31 @@ public function orgName(): string
         return $this->getString('org.name');
     }
 
+    public function username(): string
+    {
+        return $this->getString('username');
+    }
+
+    public function firstname(): string
+    {
+        return $this->getString('firstname');
+    }
+
+    public function lastname(): string
+    {
+        return $this->getString('lastname');
+    }
+
     public function id(): string
     {
         return $this->getString('id');
     }
 
+    public function orgRole(): string
+    {
+        return $this->getString('org_role');
+    }
+
     public function userId(): string
     {
         return $this->getString('userid');
@@ -42,6 +62,14 @@ public function email(): string
         return $this->getString('email');
     }
 
+    public function createdAt(string $format = 'Y-m-d H:i:s'): string|null
+    {
+        return $this->getFormattedDateTime(
+            'created_at',
+            format: $format,
+        );
+    }
+
 
 
     public function hasOrganization(): bool
@@ -54,14 +82,28 @@ public function hasPartner(): bool
         return $this->getBoolean('has_partner');
     }
 
-    public function lastSignInAt(): null|string
+    public function partnerStatus(): string
     {
-        return $this->getFormattedDateTime('last_sign_in_at', "", format: "Y-m-d");
+        return $this->getString('partner_status');
     }
 
-    public function createdAt(): null|string
+    public function timezone(): string
     {
-        return $this->getFormattedDateTime('created_at', "", format: "Y-m-d");
+        return $this->getString('timezone');
     }
 
+    public function avatarUrl(?int $size = 72): string
+    {
+        $sizeString = "";
+        if (null !== $size) {
+            $sizeString = $size . 'x' . $size . "/";
+        }
+
+        return "https://img2.storyblok.com/" . $sizeString . $this->getString('avatar');
+    }
+
+
+
+
+
 }

tests/Feature/Data/empty-user.json

@@ -0,0 +1 @@
+["This record could not be found"]

tests/Feature/Data/one-user.json

@@ -0,0 +1,52 @@
+{
+    "user": {
+        "userid": "myuserid",
+        "email": "[email protected]",
+        "organization": null,
+        "username": "myusername",
+        "use_username": true,
+        "alt_email": null,
+        "firstname": "John",
+        "lastname": "Doe",
+        "phone": null,
+        "id": 123456,
+        "login_strategy": "otp_email",
+        "created_at": "2022-06-01T16:54:34.759Z",
+        "org_role": "admin",
+        "has_org": true,
+        "has_partner": true,
+        "partner_status": "approved",
+        "org": {
+            "name": "Storyblok",
+            "settings": []
+        },
+        "timezone": "Europe\/Rome",
+        "avatar": "avatars\/118830\/01290bd7fa\/myimage.JPG",
+        "friendly_name": "John Doe",
+        "notified": [],
+        "lang": "en",
+        "partner_role": "partner_member",
+        "favourite_spaces": [
+            123456,
+            123457
+        ],
+        "favourite_ideas": [],
+        "role": null,
+        "beta_user": true,
+        "track_statistics": true,
+        "ui_theme": {
+            "theme": "default"
+        },
+        "is_editor": false,
+        "sso": false,
+        "job_role": "developer",
+        "totp_factor_verified": false,
+        "configured_2fa_options": [
+            "otp_email"
+        ],
+        "disclaimer_ids": [
+            1,
+            2
+        ]
+    }
+}

tests/Feature/UserTest.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+
+use Storyblok\ManagementApi\Endpoints\UserApi;
+use Storyblok\ManagementApi\ManagementApiClient;
+use Symfony\Component\HttpClient\MockHttpClient;
+
+test('Testing current user', function (): void {
+    $responses = [
+        \mockResponse("one-user", 200),
+        \mockResponse("empty-user", 404),
+        //\mockResponse("empty-asset", 404),
+    ];
+
+    $client = new MockHttpClient($responses);
+    $mapiClient = ManagementApiClient::initTest($client);
+    $userApi = new UserApi($mapiClient);
+
+    $storyblokResponse = $userApi->me();
+    $string = $storyblokResponse->getLastCalledUrl();
+    expect($string)->toMatch('/.*users.*/');
+    /* @var \Storyblok\ManagementApi\Data\UserData $userData */
+    $userData = $storyblokResponse->data();
+    expect($userData->firstname())->toBe("John");
+    expect($userData->lastname())->toBe("Doe");
+    expect($userData->id())->toBe("123456");
+    expect($userData->orgName())->toBe("Storyblok");
+    expect($userData->username())->toBe("myusername");
+    expect($userData->orgRole())->toBe("admin");
+    expect($userData->userId())->toBe("myuserid");
+    expect($userData->email())->toBe("[email protected]");
+    expect($userData->email())->toBe("[email protected]");
+    expect($userData->createdAt())->toBe("2022-06-01 16:54:34");
+    expect($userData->createdAt("Y-m-d"))->toBe("2022-06-01");
+    expect($userData->hasOrganization())->toBe(true);
+    expect($userData->hasPartner())->toBe(true);
+    expect($userData->partnerStatus())->toBe("approved");
+    expect($userData->timezone())->toBe("Europe/Rome");
+    expect($userData->avatarUrl())->toBe("https://img2.storyblok.com/72x72/avatars/118830/01290bd7fa/myimage.JPG");
+    expect($userData->avatarUrl(null))->toBe("https://img2.storyblok.com/avatars/118830/01290bd7fa/myimage.JPG");
+
+    $userData = \Storyblok\ManagementApi\Data\UserData::make([]);
+    expect($userData)->toBeInstanceOf(\Storyblok\ManagementApi\Data\UserData::class);
+
+    $userApi = $mapiClient->userApi();
+    expect($userApi)->toBeInstanceOf(UserApi::class);
+
+
+
+});