Merge pull request #8 from CthulhuDen/async

Add asynchronous API

Author: iboldurev

README.md

@@ -69,6 +69,46 @@ try {
 }
 ```
 
+## Usage
+
+Using the low level asynchronous api:
+
+```php
+require_once __DIR__.'/vendor/autoload.php';
+
+use ApiAi\Client;
+use ApiAi\Model\Query;
+use ApiAi\Method\QueryApi;
+use GuzzleHttp\HandlerStack;
+use React\EventLoop\Factory;
+use WyriHaximus\React\GuzzlePsr7\HttpClientAdapter;
+
+$loop = Factory::create();
+$reactGuzzle = new \GuzzleHttp\Client([
+    'base_uri' => Client::API_BASE_URI . Client::DEFAULT_API_ENDPOINT,
+    'timeout' => Client::DEFAULT_TIMEOUT,
+    'connect_timeout' => Client::DEFAULT_TIMEOUT,
+    'handler' => HandlerStack::create(new HttpClientAdapter($loop))
+]);
+
+$client = new Client('bc0a6d712bba4b3c8063a9c7ff0fa4ea', new ApiAi\HttpClient\GuzzleHttpClient($reactGuzzle));
+$queryApi = new QueryApi($client);
+
+$queryApi->extractMeaningAsync('Hello', [
+    'sessionId' => '123456789',
+    'lang' => 'en'
+])->then(
+    function ($meaning) {
+        $response = new Query($meaning);
+    },
+    function ($error) {
+        echo $error;
+    }
+);
+
+$loop->run();
+```
+
 ## Dialog
 
 The `Dialog` class provides an easy way to use the `query` api and execute automatically the chaining steps :

src/Client.php

@@ -5,6 +5,8 @@
 use ApiAi\HttpClient\HttpClient;
 use ApiAi\HttpClient\GuzzleHttpClient;
 use ApiAi\Exception\BadResponseException;
+use GuzzleHttp\Promise\PromiseInterface;
+use function GuzzleHttp\Promise\rejection_for;
 use Psr\Http\Message\ResponseInterface;
 
 /**
@@ -145,6 +147,17 @@ public function get($uri, array $params = [])
         return $this->send('GET', $uri, null, $params);
     }
 
+    /**
+     * @param string $url
+     * @param array $params
+     *
+     * @return PromiseInterface
+     */
+    public function getAsync($url, array $params = [])
+    {
+        return $this->sendAsync('GET', $uri, null, $params);
+    }
+
     /**
      * @param string $uri
      * @param array $params
@@ -156,6 +169,17 @@ public function post($uri, array $params = [])
         return $this->send('POST', $uri, $params);
     }
 
+    /**
+     * @param string $uri
+     * @param array $params
+     *
+     * @return PromiseInterface
+     */
+    public function postAsync($uri, array $params = [])
+    {
+        return $this->sendAsync('POST', $uri, $params);
+    }
+
     /**
      * @param string $method
      * @param string $uri
@@ -180,6 +204,38 @@ public function send($method, $uri, $body = null, array $query = [], array $head
         return $this->lastResponse;
     }
 
+    /**
+     * @param string $method
+     * @param string $uri
+     * @param mixed $body
+     * @param array $query
+     * @param array $headers
+     * @param array $options
+     *
+     * @return PromiseInterface
+     */
+    public function sendAsync($method, $uri, $body = null, array $query = [], array $headers = [], array $options = [])
+    {
+        try {
+            $this->validateMethod($method);
+        } catch (\InvalidArgumentException $e) {
+            return rejection_for($e);
+        }
+
+        $query = array_merge($this->getDefaultQuery(), $query);
+        $headers = array_merge($this->getDefaultHeaders(), $headers);
+
+        return $this->client->sendAsync($method, $uri, $body, $query, $headers, $options)->then(
+            function (ResponseInterface $response) {
+                $this->lastResponse = $response;
+
+                $this->validateResponse($this->lastResponse);
+
+                return $this->lastResponse;
+            }
+        );
+    }
+
     /**
      * @param string $method
      * @throw \InvalidArgumentException

src/HttpClient/GuzzleHttpClient.php

@@ -37,6 +37,29 @@ public function __construct(ClientInterface $guzzleClient = null)
      * @inheritdoc
      */
     public function send($method, $uri, $body = null, array $query = [], array $headers = [], array $options = [])
+    {
+        $options = $this->prepareOptions($body, $query, $headers, $options);
+        return $this->guzzleClient->request($method, $uri, $options);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function sendAsync($method, $uri, $body = null, array $query = [], array $headers = [], array $options = [])
+    {
+        $options = $this->prepareOptions($body, $query, $headers, $options);
+        return $this->guzzleClient->requestAsync($method, $uri, $options);
+    }
+
+    /**
+     * @param mixed $body
+     * @param array $query
+     * @param array $headers
+     * @param array $options
+     *
+     * @return array
+     */
+    private function prepareOptions($body, array $query, array $headers, array $options)
     {
         $options = array_merge($options, [
             RequestOptions::QUERY => $query,
@@ -49,7 +72,6 @@ public function send($method, $uri, $body = null, array $query = [], array $head
             $options[RequestOptions::BODY] = $body;
         }
 
-        return $this->guzzleClient->request($method, $uri, $options);
+        return $options;
     }
-
 }

src/HttpClient/HttpClient.php

@@ -2,6 +2,7 @@
 
 namespace ApiAi\HttpClient;
 
+use GuzzleHttp\Promise\PromiseInterface;
 use Psr\Http\Message\ResponseInterface;
 
 /**
@@ -22,4 +23,16 @@ interface HttpClient
      * @return ResponseInterface
      */
     public function send($method, $uri, $body = null, array $query = [], array $headers = [], array $options = []);
+
+    /**
+     * @param string $method
+     * @param string $uri
+     * @param mixed $body
+     * @param array $query
+     * @param array $headers
+     * @param array $options
+     *
+     * @return PromiseInterface
+     */
+    public function sendAsync($method, $uri, $body = null, array $query = [], array $headers = [], array $options = []);
 }

src/Method/QueryApi.php

@@ -4,6 +4,8 @@
 
 use ApiAi\Client;
 use ApiAi\ResponseHandler;
+use GuzzleHttp\Promise\PromiseInterface;
+use Psr\Http\Message\ResponseInterface;
 
 /**
  * Class QueryApi
@@ -47,4 +49,19 @@ public function extractMeaning($query, $extraParams = [])
         return $this->decodeResponse($response);
     }
 
+    /**
+     * @param $query
+     * @param array $extraParams
+     *
+     * @return PromiseInterface
+     */
+    public function extractMeaningAsync($query, $extraParams = [])
+    {
+        $query = array_merge($extraParams, [
+            'lang' => $this->client->getApiLanguage(),
+            'query' => $query,
+        ]);
+
+        return $this->client->postAsync('query', $query)->then([$this, 'decodeResponse']);
+    }
 }