feat(Response): add method to extract guzzle promise

Author: jenschude

src/Core/Client.php

@@ -10,6 +10,7 @@
 use Commercetools\Core\Client\Adapter\TokenProviderAware;
 use Commercetools\Core\Helper\CorrelationIdProvider;
 use Commercetools\Core\Client\Adapter\AdapterOptionInterface;
+use Commercetools\Core\Response\ApiPromiseGetInterface;
 use Commercetools\Core\Response\ErrorResponse;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -285,7 +286,7 @@ public function execute(ClientRequestInterface $request, array $headers = null,
      * Executes an API request asynchronously
      * @param ClientRequestInterface $request
      * @param array $clientOptions
-     * @return ApiResponseInterface
+     * @return ApiResponseInterface|ApiPromiseGetInterface
      */
     public function executeAsync(ClientRequestInterface $request, array $headers = null, array $clientOptions = [])
     {

src/Core/Client/Adapter/Guzzle5Promise.php

@@ -11,7 +11,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\StreamInterface;
 
-class Guzzle5Promise implements AdapterPromiseInterface
+class Guzzle5Promise implements AdapterPromiseInterface, PromiseGetInterface
 {
     /**
      * @var FutureResponse
@@ -36,6 +36,14 @@ public function then(callable $onFulfilled = null, callable $onRejected = null)
         return $this;
     }
 
+    /**
+     * @return FutureInterface
+     */
+    public function getPromise()
+    {
+        return $this->promise;
+    }
+
     /**
      * @return ResponseInterface
      */

src/Core/Client/Adapter/Guzzle6Promise.php

@@ -9,7 +9,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\StreamInterface;
 
-class Guzzle6Promise implements AdapterPromiseInterface
+class Guzzle6Promise implements AdapterPromiseInterface, PromiseGetInterface
 {
     protected $response;
     protected $promise;
@@ -20,6 +20,14 @@ public function __construct(PromiseInterface $promise)
         $this->promise = $promise;
     }
 
+    /**
+     * @return PromiseInterface
+     */
+    public function getPromise()
+    {
+        return $this->promise;
+    }
+
     public function then(callable $onFulfilled = null, callable $onRejected = null)
     {
         $this->promise = $this->promise->then($onFulfilled, $onRejected);

src/Core/Client/Adapter/PromiseGetInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Commercetools\Core\Client\Adapter;
+
+use GuzzleHttp\Promise\PromiseInterface;
+use GuzzleHttp\Ring\Future\FutureInterface;
+
+interface PromiseGetInterface
+{
+    /**
+     * @return PromiseInterface|FutureInterface Promise
+     */
+    public function getPromise();
+}

src/Core/Response/AbstractApiResponse.php

@@ -6,7 +6,11 @@
 
 namespace Commercetools\Core\Response;
 
+use Commercetools\Core\Client\Adapter\PromiseGetInterface;
 use Commercetools\Core\Error\ErrorContainer;
+use Commercetools\Core\Error\InvalidArgumentException;
+use GuzzleHttp\Ring\Future\FutureInterface;
+use Prophecy\Promise\PromiseInterface;
 use Psr\Http\Message\ResponseInterface;
 use Commercetools\Core\Client\Adapter\AdapterPromiseInterface;
 use Commercetools\Core\Error\Message;
@@ -18,7 +22,7 @@
 /**
  * @package Commercetools\Core\Response
  */
-abstract class AbstractApiResponse implements ApiResponseInterface, ContextAwareInterface
+abstract class AbstractApiResponse implements ApiResponseInterface, ContextAwareInterface, ApiPromiseGetInterface
 {
     const X_CORRELATION_ID = 'X-Correlation-ID';
     use ContextTrait;
@@ -210,4 +214,16 @@ public function then(callable $onFulfilled = null, callable $onRejected = null)
 
         return $this;
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function getPromise()
+    {
+        $adapterResponse = $this->getResponse();
+        if ($adapterResponse instanceof PromiseGetInterface) {
+            return $adapterResponse->getPromise();
+        }
+        throw new \BadMethodCallException(Message::FUTURE_BAD_METHOD_CALL);
+    }
 }

src/Core/Response/ApiPromiseGetInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Commercetools\Core\Response;
+
+use Prophecy\Promise\PromiseInterface;
+use GuzzleHttp\Ring\Future\FutureInterface;
+
+interface ApiPromiseGetInterface
+{
+    /**
+     * @return PromiseInterface|FutureInterface Promise
+     */
+    public function getPromise();
+}

tests/unit/ClientTest.php

@@ -6,7 +6,6 @@
 
 namespace Commercetools\Core;
 
-use Commercetools\Core\Client\Adapter\AdapterFactory;
 use Commercetools\Core\Client\Adapter\AdapterOptionInterface;
 use Commercetools\Core\Client\Adapter\ConfigAware;
 use Commercetools\Core\Client\OAuth\Manager;
@@ -29,6 +28,8 @@
 use GuzzleHttp\Handler\MockHandler;
 use GuzzleHttp\HandlerStack;
 use GuzzleHttp\Middleware;
+use GuzzleHttp\Promise\PromiseInterface;
+use GuzzleHttp\Ring\Future\FutureInterface;
 use GuzzleHttp\Psr7\BufferStream;
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;
@@ -745,11 +746,9 @@ public function testUserAgent()
             $this->assertSame('commercetools-php-sdk/' . AbstractHttpClient::VERSION, $userAgent[$n++]);
             $this->assertSame('GuzzleHttp/' . HttpClient::VERSION, trim($userAgent[$n++], '();'));
             if (extension_loaded('curl') && function_exists('curl_version')) {
-                $this->assertSame('curl/' . \curl_version()['version'],trim($userAgent[$n++], '();'));
+                $this->assertSame('curl/' . \curl_version()['version'], trim($userAgent[$n++], '();'));
             }
             $this->assertSame('PHP/' . PHP_VERSION, $userAgent[$n++]);
-
-
         }
     }
 
@@ -805,7 +804,6 @@ public function testHtmlBody()
         $this->assertInstanceOf(ErrorContainer::class, $response->getErrors());
         $this->assertEmpty($response->getErrors());
         $this->assertSame('Length Required', $response->getMessage());
-
     }
 
     public function testSetClientOptions()
@@ -827,4 +825,24 @@ public function testSetClientOptions()
         $this->assertInstanceOf(ConfigAware::class, $client->getHttpClient());
         $this->assertFalse($client->getHttpClient()->getConfig('verify'));
     }
+
+    public function testGetPromise()
+    {
+        $client = $this->getMockClient($this->getConfig(), $this->getSingleOpResult(), 200);
+
+        $endpoint = new JsonEndpoint('test');
+        $request = $this->getMockForAbstractClass(
+            AbstractByIdGetRequest::class,
+            [$endpoint, 'id']
+        );
+        $response = $client->executeAsync($request);
+
+        $this->assertFalse($response->isError());
+
+        if (version_compare(HttpClient::VERSION, '6.0.0', '>=')) {
+            $this->assertInstanceOf(PromiseInterface::class, $response->getPromise());
+        } else {
+            $this->assertInstanceOf(FutureInterface::class, $response->getPromise());
+        }
+    }
 }