Add BatchResult

spec/BatchResultSpec.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace spec\Http\Client;
+
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use PhpSpec\ObjectBehavior;
+
+class BatchResultSpec extends ObjectBehavior
+{
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('Http\Client\BatchResult');
+    }
+
+    function it_is_immutable(RequestInterface $request, ResponseInterface $response)
+    {
+        $new = $this->addResponse($request, $response);
+
+        $this->getResponses()->shouldReturn([]);
+        $new->shouldHaveType('Http\Client\BatchResult');
+        $new->getResponses()->shouldReturn([$response]);
+    }
+
+    function it_has_a_responses(RequestInterface $request, ResponseInterface $response)
+    {
+        $new = $this->addResponse($request, $response);
+
+        $this->hasResponses()->shouldReturn(false);
+        $this->getResponses()->shouldReturn([]);
+        $new->hasResponses()->shouldReturn(true);
+        $new->getResponses()->shouldReturn([$response]);
+    }
+
+    function it_has_a_response_for_a_request(RequestInterface $request, ResponseInterface $response)
+    {
+        $new = $this->addResponse($request, $response);
+
+        $this->shouldThrow('Http\Client\Exception\UnexpectedValueException')->duringGetResponseFor($request);
+        $this->hasResponseFor($request)->shouldReturn(false);
+        $new->getResponseFor($request)->shouldReturn($response);
+        $new->hasResponseFor($request)->shouldReturn(true);
+    }
+}

spec/Exception/BatchExceptionSpec.php

@@ -2,40 +2,64 @@
 
 namespace spec\Http\Client\Exception;
 
-use Http\Client\Exception\TransferException;
-use Psr\Http\Message\ResponseInterface;
+use Http\Client\BatchResult;
+use Http\Client\Exception;
+use Psr\Http\Message\RequestInterface;
 use PhpSpec\ObjectBehavior;
 
 class BatchExceptionSpec extends ObjectBehavior
 {
-    function let(TransferException $e, ResponseInterface $response)
+    function it_is_initializable()
     {
-        $this->beConstructedWith([$e], [$response]);
+        $this->shouldHaveType('Http\Client\Exception\BatchException');
     }
 
-    function it_is_initializable()
+    function it_is_an_exception()
     {
-        $this->shouldHaveType('Http\Client\Exception\BatchException');
+        $this->shouldImplement('Http\Client\Exception');
+        $this->shouldHaveType('Exception');
+    }
+
+    function it_has_a_result()
+    {
+        $this->setResult($result = new BatchResult());
+        $this->getResult()->shouldReturn($result);
+    }
+
+    function it_throws_an_exception_if_the_result_is_already_set()
+    {
+        $this->getResult()->shouldHaveType('Http\Client\BatchResult');
+        $this->shouldThrow('Http\Client\Exception\InvalidArgumentException')->duringSetResult(new BatchResult());
     }
 
-    function it_is_a_transfer_exception()
+    function it_has_an_exception_for_a_request(RequestInterface $request, Exception $exception)
     {
-        $this->shouldHaveType('Http\Client\Exception\TransferException');
+        $this->shouldThrow('Http\Client\Exception\UnexpectedValueException')->duringGetExceptionFor($request);
+        $this->hasExceptionFor($request)->shouldReturn(false);
+
+        $this->addException($request, $exception);
+
+        $this->getExceptionFor($request)->shouldReturn($exception);
+        $this->hasExceptionFor($request)->shouldReturn(true);
     }
 
-    function it_has_exceptions(TransferException $e, TransferException $e2)
+    function it_has_exceptions(RequestInterface $request, Exception $exception)
     {
-        $this->getExceptions()->shouldReturn([$e]);
-        $this->hasException($e)->shouldReturn(true);
-        $this->hasException($e2)->shouldReturn(false);
-        $this->hasExceptions()->shouldReturn(true);
+        $this->getExceptions()->shouldReturn([]);
+
+        $this->addException($request, $exception);
+
+        $this->getExceptions()->shouldReturn([$exception]);
     }
 
-    function it_has_responses(ResponseInterface $response, ResponseInterface $response2)
+    function it_checks_if_a_request_failed(RequestInterface $request, Exception $exception)
     {
-        $this->getResponses()->shouldReturn([$response]);
-        $this->hasResponse($response)->shouldReturn(true);
-        $this->hasResponse($response2)->shouldReturn(false);
-        $this->hasResponses()->shouldReturn(true);
+        $this->isSuccessful($request)->shouldReturn(false);
+        $this->isFailed($request)->shouldReturn(false);
+
+        $this->addException($request, $exception);
+
+        $this->isSuccessful($request)->shouldReturn(false);
+        $this->isFailed($request)->shouldReturn(true);
     }
 }

spec/Exception/UnexpectedValueExceptionSpec.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace spec\Http\Client\Exception;
+
+use PhpSpec\ObjectBehavior;
+
+class UnexpectedValueExceptionSpec extends ObjectBehavior
+{
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('Http\Client\Exception\UnexpectedValueException');
+    }
+
+    function it_is_invalid_argument_exception()
+    {
+        $this->shouldHaveType('UnexpectedValueException');
+    }
+
+    function it_is_exception()
+    {
+        $this->shouldImplement('Http\Client\Exception');
+    }
+}

src/BatchResult.php

@@ -0,0 +1,104 @@
+<?php
+
+namespace Http\Client;
+
+use Http\Client\Exception\UnexpectedValueException;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * Successful responses returned from parallel request execution
+ *
+ * @author Márk Sági-Kazár <[email protected]>
+ */
+final class BatchResult
+{
+    /**
+     * @var \SplObjectStorage
+     */
+    private $responses;
+
+    public function __construct()
+    {
+        $this->responses = new \SplObjectStorage();
+    }
+
+    /**
+     * Returns all successful responses
+     *
+     * @return ResponseInterface[]
+     */
+    public function getResponses()
+    {
+        $responses = [];
+
+        foreach ($this->responses as $request) {
+            $responses[] = $this->responses[$request];
+        }
+
+        return $responses;
+    }
+
+    /**
+     * Returns a response of a request
+     *
+     * @param RequestInterface $request
+     *
+     * @return ResponseInterface
+     *
+     * @throws UnexpectedValueException
+     */
+    public function getResponseFor(RequestInterface $request)
+    {
+        try {
+            return $this->responses[$request];
+        } catch (\UnexpectedValueException $e) {
+            throw new UnexpectedValueException('Request not found', $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * Checks if there are any successful responses at all
+     *
+     * @return boolean
+     */
+    public function hasResponses()
+    {
+        return $this->responses->count() > 0;
+    }
+
+    /**
+     * Checks if there is a response of a request
+     *
+     * @param RequestInterface $request
+     *
+     * @return ResponseInterface
+     */
+    public function hasResponseFor(RequestInterface $request)
+    {
+        return $this->responses->contains($request);
+    }
+
+    /**
+     * Adds a response in an immutable way
+     *
+     * @param RequestInterface  $request
+     * @param ResponseInterface $response
+     *
+     * @return BatchResult
+     *
+     * @internal
+     */
+    public function addResponse(RequestInterface $request, ResponseInterface $response)
+    {
+        $new = clone $this;
+        $new->responses->attach($request, $response);
+
+        return $new;
+    }
+
+    public function __clone()
+    {
+        $this->responses = clone $this->responses;
+    }
+}