add X api

Author: eugenefvdm

README.md

@@ -13,6 +13,7 @@ A set of Laravel API service providers.
 - Slack
 - Telegram
 - WHM
+- X (Twitter)
 - ZADomains
 
 ## Installation
@@ -59,6 +60,10 @@ return [
         'server' => env('WHM_SERVER', 'https://server.example.com:2087'),
     ],
 
+    'x' => [
+        'bearer_token' => env('X_BEARER_TOKEN'),
+    ],
+
     'za_domains' => [
         'username' => env('ZA_DOMAINS_USERNAME'),
         'password' => env('ZA_DOMAINS_PASSWORD'),
@@ -69,26 +74,31 @@ return [
 ## Usage
 
 ```php
-use Eugenefvdm\Api\Facades\BulkSMS;
-$bulkSMS = BulkSMS::sendSMS("Hello SMS!", ["27600000000"]);
+use Eugenefvdm\Api\Facades\Bulksms;
+$bulkSMS = Bulksms::sendSMS("Hello SMS!", ["27600000000"]);
 
 use Eugenefvdm\Api\Facades\Discord;
 $discord = Discord::getUser("123456789012345678");
 
-use Eugenefvdm\Api\Facades\HelloPeter;
-$helloPeter = HelloPeter::getUnrepliedReviews();
+use Eugenefvdm\Api\Facades\Hellopeter;
+$hellopeterUnrepliedReviews = Hellopeter::getUnrepliedReviews();
 
 use Eugenefvdm\Api\Facades\Slack;
-$slack = Slack::sendText("Hello Slack!");
+$textSendResult = Slack::sendText("Hello Slack!");
 
 use Eugenefvdm\Api\Facades\Telegram;
-$telegram = Telegram::sendMessage("Hi Telegram!");
+$messageSendResult = Telegram::sendMessage("Hi Telegram!");
+
+use Eugenefvdm\Api\Facades\Whm;
+$whmBandwidth = Whm::bandwidth();
 
-use Eugenefvdm\Api\Facades\WHM;
-$bandwidth = WHM::bandwidth();
+use Eugenefvdm\Api\Facades\X;
+$userId = X::userId("eugenefvdm");
+$tweets = X::tweets($userId['data']['id'], 5);
+$userWithLimits = X::userWithRateLimits("eugenefvdm");
 
-use Eugenefvdm\Api\Facades\ZADomains;
-$zadomainsRegistrant = ZADomains::registrant("example.co.za");
+use Eugenefvdm\Api\Facades\Zadomains;
+$zadomainsRegistrant = Zadomains::registrant("example.co.za");
 ```
 
 ## Testing

composer.json

@@ -25,7 +25,8 @@
     "homepage": "https://github.com/eugenefvdm/api",
     "require": {
         "php": "^8.1",
-        "illuminate/support": "^8.12|^9.0|^10.0|^11.0|^12.0"
+        "illuminate/support": "^8.12|^9.0|^10.0|^11.0|^12.0",
+        "spatie/laravel-ray": "^1.40"
     },
     "require-dev": {
         "guzzlehttp/guzzle": "^7.9",

config/api.php

@@ -1,17 +1,17 @@
 <?php
 
 return [
-    'bulk_sms' => [
-        'username' => env('BULK_SMS_USERNAME'),
-        'password' => env('BULK_SMS_PASSWORD'),
+    'bulksms' => [
+        'username' => env('BULKSMS_USERNAME'),
+        'password' => env('BULKSMS_PASSWORD'),
     ],
 
     'discord' => [
         'bot_token' => env('DISCORD_BOT_TOKEN'),
     ],
 
-    'hello_peter' => [
-        'api_key' => env('HELLO_PETER_API_KEY'),
+    'hellopeter' => [
+        'api_key' => env('HELLOPETER_API_KEY'),
     ],
 
     'slack' => [
@@ -29,8 +29,12 @@
         'server' => env('WHM_SERVER'),
     ],
 
-    'za_domains' => [
-        'username' => env('ZA_DOMAINS_USERNAME'),
-        'password' => env('ZA_DOMAINS_PASSWORD'),
+    'x' => [
+        'bearer_token' => env('X_BEARER_TOKEN'),
     ],
+
+    'zadomains' => [
+        'username' => env('ZADOMAINS_USERNAME'),
+        'password' => env('ZADOMAINS_PASSWORD'),
+    ],    
 ];

src/ApiManager.php

@@ -48,6 +48,11 @@ public function whm()
         return $this->app->make('whm');
     }
 
+    public function x()
+    {
+        return $this->app->make('x');
+    }
+
     /**
      * Magic method to dynamically access services
      */

src/ApiServiceProvider.php

@@ -39,7 +39,7 @@ public function register()
         // Register HelloPeter
         $this->app->singleton(Hellopeter::class, function ($app) {
             return new Hellopeter(
-                Config::get('api.hello_peter.api_key')
+                Config::get('api.hellopeter.api_key')
             );
         });
         $this->app->alias(Hellopeter::class, 'hellopeter');
@@ -79,6 +79,14 @@ public function register()
             );
         });
         $this->app->alias(Whm::class, 'whm');
+
+        // Register X
+        $this->app->singleton(X::class, function ($app) {
+            return new X(
+                Config::get('api.x.bearer_token')
+            );
+        });
+        $this->app->alias(X::class, 'x');
     }
 
     public function boot()

src/Facades/X.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Eugenefvdm\Api\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+/**
+ * @method static array userId(string $username)
+ * @method static array tweets(string $userId, int $maxResults = 5)
+ * @method static array userWithRateLimits(string $username)
+ *
+ * @see \Eugenefvdm\Api\X
+ */
+class X extends Facade
+{
+    /**
+     * Get the registered name of the component.
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor()
+    {
+        return 'x';
+    }
+} 

src/X.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace Eugenefvdm\Api;
+
+use Illuminate\Http\Client\PendingRequest;
+use Illuminate\Support\Facades\Http;
+
+class X
+{
+    private string $bearerToken;
+    private string $baseUrl = 'https://api.twitter.com/2';
+    private ?PendingRequest $client = null;
+
+    public function __construct(string $bearerToken)
+    {
+        $this->bearerToken = $bearerToken;
+    }
+
+    /**
+     * Get the HTTP client instance
+     */
+    private function client(): PendingRequest
+    {
+        if (! $this->client) {
+            $this->client = Http::baseUrl($this->baseUrl)
+                ->withHeaders([
+                    'Authorization' => "Bearer {$this->bearerToken}",
+                    'Content-Type' => 'application/json',
+                ]);
+        }
+
+        return $this->client;
+    }
+
+    /**
+     * Set a custom HTTP client (used for testing)
+     */
+    public function setClient(PendingRequest $client): void
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * Get user ID by username
+     *
+     * @param  string  $username  The username to lookup
+     * @return array User data including id, name, and username
+     */
+    public function userId(string $username): array
+    {
+        $response = $this->client()->get("/users/by/username/{$username}");
+        return $response->json();
+    }
+
+    /**
+     * Get tweets for a user
+     *
+     * @param  string  $userId  The user ID to get tweets for
+     * @param  int  $maxResults  Maximum number of tweets to retrieve (default: 5)
+     * @return array Tweets data including tweets and metadata
+     */
+    public function tweets(string $userId, int $maxResults = 5): array
+    {
+        $response = $this->client()->get("/users/{$userId}/tweets", [
+            'max_results' => $maxResults,
+        ]);
+        return $response->json();
+    }
+
+    /**
+     * Get user data and rate limits
+     *
+     * @param  string  $username  The username to lookup
+     * @return array User data and rate limit information
+     */
+    public function userWithRateLimits(string $username): array
+    {
+        $response = $this->client()->withHeaders([
+            'Accept' => 'application/json',
+        ])->get("/users/by/username/{$username}");
+
+        return [
+            'data' => $response->json(),
+            'rate_limits' => [
+                'limit' => $response->header('x-rate-limit-limit'),
+                'remaining' => $response->header('x-rate-limit-remaining'),
+                'reset' => $response->header('x-rate-limit-reset'),
+            ],
+        ];
+    }
+} 

src/ZADomains.php

@@ -57,6 +57,8 @@ public function registrant(string $domainName): string
         $result = $this->getDomainSelect($domainName);
         $data = json_decode($result->Domain_SelectResult, true);
 
+        ray($data);
+
         if (! isset($data['Response_Value'])) {
             throw new \RuntimeException('Unable to fetch registrant information');
         }

tests/Feature/X/RateLimitTest.php

@@ -0,0 +1,23 @@
+<?php
+
+use Eugenefvdm\Api\X;
+use Illuminate\Support\Facades\Http;
+
+test('tweets returns rate limit error when limit is hit', function () {
+    $stub = json_decode(file_get_contents(__DIR__.'/../../stubs/x/rate_limit.json'), true);
+
+    Http::fake([
+        'api.twitter.com/2/users/74251818/tweets*' => Http::response($stub, 429),
+    ]);
+
+    $x = new X('test_bearer_token');
+
+    $result = $x->tweets('74251818');
+
+    expect($result)
+        ->toBe($stub)
+        ->and($result['title'])->toBe('Too Many Requests')
+        ->and($result['detail'])->toBe('Too Many Requests')
+        ->and($result['type'])->toBe('about:blank')
+        ->and($result['status'])->toBe(429);
+}); 

tests/Feature/X/RateLimitsTest.php

@@ -0,0 +1,28 @@
+<?php
+
+use Eugenefvdm\Api\X;
+use Illuminate\Support\Facades\Http;
+
+test('userWithRateLimits returns user data and rate limits', function () {
+    $stub = json_decode(file_get_contents(__DIR__.'/../../stubs/x/user_id.json'), true);
+
+    Http::fake([
+        'api.twitter.com/2/users/by/username/eugenefvdm' => Http::response($stub, 200, [
+            'x-rate-limit-limit' => '1200000',
+            'x-rate-limit-remaining' => '1199998',
+            'x-rate-limit-reset' => '1738820163',
+        ]),
+    ]);
+
+    $x = new X('test_bearer_token');
+
+    $result = $x->userWithRateLimits('eugenefvdm');
+
+    expect($result)
+        ->toHaveKeys(['data', 'rate_limits'])
+        ->and($result['data'])->toBe($stub)
+        ->and($result['rate_limits'])->toHaveKeys(['limit', 'remaining', 'reset'])
+        ->and($result['rate_limits']['limit'])->toBe('1200000')
+        ->and($result['rate_limits']['remaining'])->toBe('1199998')
+        ->and($result['rate_limits']['reset'])->toBe('1738820163');
+});