Add async concurrency support.

Author: vekien

cli

@@ -8,16 +8,20 @@ $arg1   = isset($argv[2]) ? trim($argv[2]) : false;
 
 // setup xivapi
 $api = new \XIVAPI\XIVAPI();
+$api->environment->key('');
 
-// set env key
-$api->environment->key('my_api_key');
+// using concurrent
+use GuzzleHttp\Promise;
 
-$items = $api->search
-    ->indexes(['item'])
-    ->filter('ItemSearchCategory.ID', 10, \XIVAPI\Api\SearchFilters::EQUAL_TO)
-    ->limit(500)
-    ->sort('LevelItem', 'desc')
-    ->columns(['ID','Name'])
-    ->results();
+$promises = [
+    'item1' => $api->async()->content->Item()->one(1675),
+    'item2' => $api->async()->content->Item()->one(5),
+    'item3' => $api->async()->content->Item()->one(2546),
+];
 
-print_r($items);
+$results = Promise\settle($promises)->wait();
+$items = $api->unwrap($results);
+
+print_r( $items->item1->Name . PHP_EOL);
+print_r( $items->item2->Name . PHP_EOL);
+print_r( $items->item3->Name . PHP_EOL);

src/XIVAPI/Api/Content.php

@@ -469,7 +469,7 @@ public function servers(): array
         return Guzzle::get('/servers');
     }
 
-    public function serversByDataCenter(): array
+    public function serversByDataCenter(): \stdClass
     {
         return Guzzle::get('/servers/dc');
     }

src/XIVAPI/Guzzle/Guzzle.php

@@ -12,31 +12,58 @@ class Guzzle
     const ENDPOINT_DEV  = 'https://xivapi.local';
     const TIMEOUT = 10.0;
     const VERIFY = false;
-
+    
+    /** @var Client */
+    private static $client = null;
+    /** @var bool */
+    private static $async = false;
+    /** @var array */
     private static $options = [];
+    
+    /**
+     * Set the Guzzle client
+     */
+    private static function setClient()
+    {
+        if (self::$client === null) {
+            self::$client = new Client([
+                'base_uri'  => self::ENDPOINT_PROD,
+                'timeout'   => self::TIMEOUT,
+                'verify'    => self::VERIFY,
+            ]);
+        }
+    }
 
     public static function query($method, $apiEndpoint, $options = [])
     {
+        self::setClient();
+        
+        // set XIVAPI key
         if ($key = getenv(Environment::XIVAPI_KEY)) {
             $options[RequestOptions::QUERY]['key'] = $key;
         }
 
+        // set request queries
         foreach (self::$options as $query => $value) {
             $value = is_array($value) ? implode(',', $value) : $value;
             $options[RequestOptions::QUERY][$query] = $value;
         }
-
-        $client = new Client([
-            'base_uri'  => self::ENDPOINT_PROD,
-            'timeout'   => self::TIMEOUT,
-            'verify'    => self::VERIFY,
-        ]);
+        
+        // allow async
+        if (self::$async) {
+            return self::$client->requestAsync($method, $apiEndpoint, $options);
+        }
 
         return \GuzzleHttp\json_decode(
-            $client->request($method, $apiEndpoint, $options)->getBody()
+            self::$client->request($method, $apiEndpoint, $options)->getBody()
         );
     }
 
+    public static function setAsync()
+    {
+        self::$async = true;
+    }
+    
     public static function resetQuery()
     {
         self::$options = [];

src/XIVAPI/XIVAPI.php

@@ -2,6 +2,7 @@
 
 namespace XIVAPI;
 
+use GuzzleHttp\Psr7\Response;
 use XIVAPI\Api\Character;
 use XIVAPI\Api\FreeCompany;
 use XIVAPI\Api\Linkshell;
@@ -50,6 +51,35 @@ public function __construct()
         $this->market       = new Market();
         $this->patchlist    = new PatchList();
     }
+    
+    public function reset(): XIVAPI
+    {
+        Guzzle::resetQuery();
+        return $this;
+    }
+    
+    public function async(): XIVAPI
+    {
+        Guzzle::setAsync();
+        return $this;
+    }
+    
+    public function unwrap($results): \stdClass
+    {
+        $unwrapped = (Object)[];
+        foreach ($results as $key => $response) {
+            /** @var Response $response */
+            $response = $response['value'] ?? false;
+            
+            if ($response) {
+                $response = \GuzzleHttp\json_decode($response->getBody());
+            }
+            
+            $unwrapped->{$key} = $response;
+        }
+        
+        return $unwrapped;
+    }
 
     public function queries($queries): XIVAPI
     {