Merge pull request #1 from php-http/tools

Add client decorators and emulators

Author: sagikazarmark

composer.json

@@ -13,7 +13,8 @@
     "require": {
         "php": ">=5.4",
         "php-http/httplug": "1.0.0-beta",
-        "php-http/message-factory": "^1.0"
+        "php-http/message-factory": "^1.0",
+        "php-http/promise": "^0.1.1"
     },
     "require-dev": {
         "phpspec/phpspec": "^2.4",

spec/BatchClientSpec.php

@@ -3,9 +3,9 @@
 namespace spec\Http\Client\Common;
 
 use Http\Client\HttpClient;
-use PhpSpec\ObjectBehavior;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
+use PhpSpec\ObjectBehavior;
 
 class BatchClientSpec extends ObjectBehavior
 {

spec/HttpAsyncClientDecoratorSpec.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace spec\Http\Client\Common;
+
+use Http\Client\HttpAsyncClient;
+use Http\Client\Common\HttpAsyncClientDecorator;
+use Http\Promise\Promise;
+use Psr\Http\Message\RequestInterface;
+use PhpSpec\ObjectBehavior;
+
+class HttpAsyncClientDecoratorSpec extends ObjectBehavior
+{
+    function let(HttpAsyncClient $httpAsyncClient)
+    {
+        $this->beAnInstanceOf('spec\Http\Client\Common\HttpAsyncClientDecoratorStub', [$httpAsyncClient]);
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('spec\Http\Client\Common\HttpAsyncClientDecoratorStub');
+    }
+
+    function it_is_an_http_async_client()
+    {
+        $this->shouldImplement('Http\Client\HttpAsyncClient');
+    }
+
+    function it_decorates_the_underlying_client(HttpAsyncClient $httpAsyncClient, RequestInterface $request, Promise $promise)
+    {
+        $httpAsyncClient->sendAsyncRequest($request)->willReturn($promise);
+
+        $this->sendAsyncRequest($request)->shouldReturn($promise);
+    }
+}
+
+class HttpAsyncClientDecoratorStub implements HttpAsyncClient
+{
+    use HttpAsyncClientDecorator;
+
+    /**
+     * @param HttpAsyncClient $httpAsyncClient
+     */
+    public function __construct(HttpAsyncClient $httpAsyncClient)
+    {
+        $this->httpAsyncClient = $httpAsyncClient;
+    }
+}

spec/HttpAsyncClientEmulatorSpec.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace spec\Http\Client\Common;
+
+use Http\Client\HttpAsyncClient;
+use Http\Client\HttpClient;
+use Http\Client\Common\HttpAsyncClientEmulator;
+use Http\Client\Common\HttpClientDecorator;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use PhpSpec\ObjectBehavior;
+
+class HttpAsyncClientEmulatorSpec extends ObjectBehavior
+{
+    function let(HttpClient $httpClient)
+    {
+        $this->beAnInstanceOf('spec\Http\Client\Common\HttpAsyncClientEmulatorStub', [$httpClient]);
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('spec\Http\Client\Common\HttpAsyncClientEmulatorStub');
+    }
+
+    function it_emulates_a_successful_request(HttpClient $httpClient, RequestInterface $request, ResponseInterface $response)
+    {
+        $httpClient->sendRequest($request)->willReturn($response);
+
+        $this->sendAsyncRequest($request)->shouldReturnAnInstanceOf('Http\Promise\FulfilledPromise');
+    }
+
+    function it_emulates_a_failed_request(HttpClient $httpClient, RequestInterface $request)
+    {
+        $httpClient->sendRequest($request)->willThrow('Http\Client\Exception\TransferException');
+
+        $this->sendAsyncRequest($request)->shouldReturnAnInstanceOf('Http\Promise\RejectedPromise');
+    }
+}
+
+class HttpAsyncClientEmulatorStub implements HttpClient, HttpAsyncClient
+{
+    use HttpClientDecorator;
+    use HttpAsyncClientEmulator;
+
+    /**
+     * @param HttpClient $httpClient
+     */
+    public function __construct(HttpClient $httpClient)
+    {
+        $this->httpClient = $httpClient;
+    }
+}

spec/HttpClientDecoratorSpec.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace spec\Http\Client\Common;
+
+use Http\Client\HttpClient;
+use Http\Client\Common\HttpClientDecorator;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use PhpSpec\ObjectBehavior;
+
+class HttpClientDecoratorSpec extends ObjectBehavior
+{
+    function let(HttpClient $httpClient)
+    {
+        $this->beAnInstanceOf('spec\Http\Client\Common\HttpClientDecoratorStub', [$httpClient]);
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('spec\Http\Client\Common\HttpClientDecoratorStub');
+    }
+
+    function it_is_an_http_client()
+    {
+        $this->shouldImplement('Http\Client\HttpClient');
+    }
+
+    function it_decorates_the_underlying_client(HttpClient $httpClient, RequestInterface $request, ResponseInterface $response)
+    {
+        $httpClient->sendRequest($request)->willReturn($response);
+
+        $this->sendRequest($request)->shouldReturn($response);
+    }
+}
+
+class HttpClientDecoratorStub implements HttpClient
+{
+    use HttpClientDecorator;
+
+    /**
+     * @param HttpClient $httpClient
+     */
+    public function __construct(HttpClient $httpClient)
+    {
+        $this->httpClient = $httpClient;
+    }
+}

spec/HttpClientEmulatorSpec.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace spec\Http\Client\Common;
+
+use Http\Client\Exception\TransferException;
+use Http\Client\HttpClient;
+use Http\Client\HttpAsyncClient;
+use Http\Client\Common\HttpClientEmulator;
+use Http\Client\Common\HttpAsyncClientDecorator;
+use Http\Promise\Promise;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use PhpSpec\ObjectBehavior;
+
+class HttpClientEmulatorSpec extends ObjectBehavior
+{
+    function let(HttpAsyncClient $httpAsyncClient)
+    {
+        $this->beAnInstanceOf('spec\Http\Client\Common\HttpClientEmulatorStub', [$httpAsyncClient]);
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('spec\Http\Client\Common\HttpClientEmulatorStub');
+    }
+
+    function it_emulates_a_successful_request(HttpAsyncClient $httpAsyncClient, RequestInterface $request, Promise $promise, ResponseInterface $response)
+    {
+        $promise->wait()->shouldBeCalled();
+        $promise->getState()->willReturn(Promise::FULFILLED);
+        $promise->wait()->willReturn($response);
+
+        $httpAsyncClient->sendAsyncRequest($request)->willReturn($promise);
+
+        $this->sendRequest($request)->shouldReturn($response);
+    }
+
+    function it_emulates_a_failed_request(HttpAsyncClient $httpAsyncClient, RequestInterface $request, Promise $promise)
+    {
+        $promise->wait()->shouldBeCalled();
+        $promise->getState()->willReturn(Promise::REJECTED);
+        $promise->wait()->willThrow(new TransferException());
+
+        $httpAsyncClient->sendAsyncRequest($request)->willReturn($promise);
+
+        $this->shouldThrow('Http\Client\Exception')->duringSendRequest($request);
+    }
+}
+
+class HttpClientEmulatorStub implements HttpAsyncClient, HttpClient
+{
+    use HttpAsyncClientDecorator;
+    use HttpClientEmulator;
+
+    /**
+     * @param HttpAsyncClient $httpAsyncClient
+     */
+    public function __construct(HttpAsyncClient $httpAsyncClient)
+    {
+        $this->httpAsyncClient = $httpAsyncClient;
+    }
+}

spec/HttpMethodsClientSpec.php

@@ -6,9 +6,9 @@
 use Http\Client\HttpClient;
 use Http\Client\Common\HttpMethodsClient;
 use Http\Message\MessageFactory;
-use PhpSpec\ObjectBehavior;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
+use PhpSpec\ObjectBehavior;
 
 class HttpMethodsClientSpec extends ObjectBehavior
 {

src/HttpAsyncClientDecorator.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Http\Client\Common;
+
+use Http\Client\HttpAsyncClient;
+use Psr\Http\Message\RequestInterface;
+
+/**
+ * Decorates an HTTP Async Client.
+ *
+ * @author Márk Sági-Kazár <mark.sagikazar@gmail.com>
+ */
+trait HttpAsyncClientDecorator
+{
+    /**
+     * @var HttpAsyncClient
+     */
+    protected $httpAsyncClient;
+
+    /**
+     * {@inheritdoc}
+     *
+     * @see HttpAsyncClient::sendAsyncRequest
+     */
+    public function sendAsyncRequest(RequestInterface $request)
+    {
+        return $this->httpAsyncClient->sendAsyncRequest($request);
+    }
+}

src/HttpAsyncClientEmulator.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Http\Client\Common;
+
+use Http\Client\Exception;
+use Http\Promise;
+use Psr\Http\Message\RequestInterface;
+
+/**
+ * Emulates an HTTP Async Client in an HTTP Client.
+ *
+ * @author Márk Sági-Kazár <mark.sagikazar@gmail.com>
+ */
+trait HttpAsyncClientEmulator
+{
+    /**
+     * {@inheritdoc}
+     *
+     * @see HttpClient::sendRequest
+     */
+    abstract public function sendRequest(RequestInterface $request);
+
+    /**
+     * {@inheritdoc}
+     *
+     * @see HttpAsyncClient::sendAsyncRequest
+     */
+    public function sendAsyncRequest(RequestInterface $request)
+    {
+        try {
+            return new Promise\FulfilledPromise($this->sendRequest($request));
+        } catch (Exception $e) {
+            return new Promise\RejectedPromise($e);
+        }
+    }
+}

src/HttpClientDecorator.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Http\Client\Common;
+
+use Http\Client\HttpClient;
+use Psr\Http\Message\RequestInterface;
+
+/**
+ * Decorates an HTTP Client.
+ *
+ * @author Márk Sági-Kazár <mark.sagikazar@gmail.com>
+ */
+trait HttpClientDecorator
+{
+    /**
+     * @var HttpClient
+     */
+    protected $httpClient;
+
+    /**
+     * {@inheritdoc}
+     *
+     * @see HttpClient::sendRequest
+     */
+    public function sendRequest(RequestInterface $request)
+    {
+        return $this->httpClient->sendRequest($request);
+    }
+}

src/HttpClientEmulator.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Http\Client\Common;
+
+use Psr\Http\Message\RequestInterface;
+
+/**
+ * Emulates an HTTP Client in an HTTP Async Client.
+ *
+ * @author Márk Sági-Kazár <mark.sagikazar@gmail.com>
+ */
+trait HttpClientEmulator
+{
+    /**
+     * {@inheritdoc}
+     *
+     * @see HttpClient::sendRequest
+     */
+    public function sendRequest(RequestInterface $request)
+    {
+        $promise = $this->sendAsyncRequest($request);
+
+        return $promise->wait();
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @see HttpAsyncClient::sendAsyncRequest
+     */
+    abstract public function sendAsyncRequest(RequestInterface $request);
+}