Merge pull request #9 from utxo-one/dev-Readme

📊 User Public Metrics Model

Author: utxo-one

src/Models/Like.php

@@ -67,4 +67,9 @@ public function getEntities(): ?array
     {
         return (isset($this->data['entities']) ? $this->data['entities'] : null);
     }
+
+    public function getPublicMetrics(): ?UserPublicMetrics
+    {
+        return (isset($this->data['public_metrics']) ? new UserPublicMetrics($this->data['public_metrics']) : null);
+    }
 }

src/Models/Timeline.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace UtxoOne\TwitterUltimatePhp\Models;
+
+class UserPublicMetrics
+{
+    public function __construct(private array $data)
+    {
+    }
+
+    public function getFollowersCount(): int
+    {
+        return $this->data['followers_count'];
+    }
+
+    public function getFollowingCount(): int
+    {
+        return $this->data['following_count'];
+    }
+
+    public function getTweetCount(): int
+    {
+        return $this->data['tweet_count'];
+    }
+
+    public function getListedCount(): int
+    {
+        return $this->data['listed_count'];
+    }
+}

src/Models/User.php

@@ -3,6 +3,7 @@
 use UtxoOne\TwitterUltimatePhp\Clients\UserClient;
 use UtxoOne\TwitterUltimatePhp\Models\Tweets;
 use UtxoOne\TwitterUltimatePhp\Models\User;
+use UtxoOne\TwitterUltimatePhp\Models\UserPublicMetrics;
 use UtxoOne\TwitterUltimatePhp\Models\Users;
 
 class UserClientTest extends BaseClientTest
@@ -172,4 +173,18 @@ public function testUnmute(): void
 
         $this->assertArrayHasKey('muting', $response->getData());
     }
+
+    /** @group getPublicMetrics */
+    public function testGetPublicMetrics(): void
+    {
+        $client = new UserClient(bearerToken: $_ENV['TWITTER_BEARER_TOKEN']);
+
+        $publicMetrics = $client->getUserById($_ENV['TWITTER_ADMIN_USER_ID'])->getPublicMetrics();
+
+        $this->assertInstanceOf(UserPublicMetrics::class, $publicMetrics);
+        $this->assertIsInt($publicMetrics->getFollowersCount());
+        $this->assertIsInt($publicMetrics->getFollowingCount());
+        $this->assertIsInt($publicMetrics->getTweetCount());
+        $this->assertIsInt($publicMetrics->getListedCount());
+    }
 }