Add BatchResult

spec/BatchResultSpec.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace spec\Http\Client;
+
+use Http\Client\Exception;
+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, Exception $exception)
+    {
+        $new = $this->addResponse($request, $response);
+        $new2 = $new->addException($request, $exception);
+
+        $this->getResponses()->shouldReturn([]);
+        $this->getExceptions()->shouldReturn([]);
+        $new->shouldHaveType('Http\Client\BatchResult');
+        $new->getResponses()->shouldReturn([$response]);
+        $new->getExceptions()->shouldReturn([]);
+        $new2->shouldHaveType('Http\Client\BatchResult');
+        $new2->getResponses()->shouldReturn([$response]);
+        $new2->getExceptions()->shouldReturn([$exception]);
+    }
+
+    function it_has_a_response_for_a_request(RequestInterface $request, ResponseInterface $response)
+    {
+        $new = $this->addResponse($request, $response);
+
+        $this->getResponseFor($request)->shouldReturn(null);
+        $this->hasResponses()->shouldReturn(false);
+        $this->hasResponseFor($request)->shouldReturn(false);
+        $this->getResponses()->shouldReturn([]);
+        $this->isSuccessful($request)->shouldReturn(false);
+        $this->isFailed($request)->shouldReturn(false);
+        $new->getResponseFor($request)->shouldReturn($response);
+        $new->hasResponses()->shouldReturn(true);
+        $new->hasResponseFor($request)->shouldReturn(true);
+        $new->getResponses()->shouldReturn([$response]);
+        $new->isSuccessful($request)->shouldReturn(true);
+        $new->isFailed($request)->shouldReturn(false);
+    }
+
+    function it_has_an_exception_for_a_request(RequestInterface $request, Exception $exception)
+    {
+        $new = $this->addException($request, $exception);
+
+        $this->getExceptionFor($request)->shouldReturn(null);
+        $this->hasExceptions()->shouldReturn(false);
+        $this->hasExceptionFor($request)->shouldReturn(false);
+        $this->getExceptions()->shouldReturn([]);
+        $this->isSuccessful($request)->shouldReturn(false);
+        $this->isFailed($request)->shouldReturn(false);
+        $new->getExceptionFor($request)->shouldReturn($exception);
+        $new->hasExceptions()->shouldReturn(true);
+        $new->hasExceptionFor($request)->shouldReturn(true);
+        $new->getExceptions()->shouldReturn([$exception]);
+        $new->isSuccessful($request)->shouldReturn(false);
+        $new->isFailed($request)->shouldReturn(true);
+    }
+}

spec/Exception/BatchExceptionSpec.php

@@ -2,40 +2,31 @@
 
 namespace spec\Http\Client\Exception;
 
-use Http\Client\Exception\TransferException;
-use Psr\Http\Message\ResponseInterface;
+use Http\Client\BatchResult;
 use PhpSpec\ObjectBehavior;
 
 class BatchExceptionSpec extends ObjectBehavior
 {
-    function let(TransferException $e, ResponseInterface $response)
+    private $result;
+
+    function let()
     {
-        $this->beConstructedWith([$e], [$response]);
+        $this->beConstructedWith($this->result = new BatchResult());
     }
 
     function it_is_initializable()
     {
         $this->shouldHaveType('Http\Client\Exception\BatchException');
     }
 
-    function it_is_a_transfer_exception()
-    {
-        $this->shouldHaveType('Http\Client\Exception\TransferException');
-    }
-
-    function it_has_exceptions(TransferException $e, TransferException $e2)
+    function it_is_an_exception()
     {
-        $this->getExceptions()->shouldReturn([$e]);
-        $this->hasException($e)->shouldReturn(true);
-        $this->hasException($e2)->shouldReturn(false);
-        $this->hasExceptions()->shouldReturn(true);
+        $this->shouldImplement('Http\Client\Exception');
+        $this->shouldHaveType('Exception');
     }
 
-    function it_has_responses(ResponseInterface $response, ResponseInterface $response2)
+    function it_has_a_result()
     {
-        $this->getResponses()->shouldReturn([$response]);
-        $this->hasResponse($response)->shouldReturn(true);
-        $this->hasResponse($response2)->shouldReturn(false);
-        $this->hasResponses()->shouldReturn(true);
+        $this->getResult()->shouldReturn($this->result);
     }
 }

src/BatchResult.php

@@ -0,0 +1,196 @@
+<?php
+
+namespace Http\Client;
+
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * Successful responses and exceptions returned from parallel request execution
+ *
+ * @author Márk Sági-Kazár <[email protected]>
+ */
+final class BatchResult
+{
+    /**
+     * @var \SplObjectStorage
+     */
+    private $responses;
+
+    /**
+     * @var \SplObjectStorage
+     */
+    private $exceptions;
+
+    public function __construct()
+    {
+        $this->responses = new \SplObjectStorage();
+        $this->exceptions = new \SplObjectStorage();
+    }
+
+    /**
+     * Checks if a request is successful
+     *
+     * @param RequestInterface $request
+     *
+     * @return boolean
+     */
+    public function isSuccessful(RequestInterface $request)
+    {
+        return $this->responses->contains($request);
+    }
+
+    /**
+     * Checks if a request is failed
+     *
+     * @param RequestInterface $request
+     *
+     * @return boolean
+     */
+    public function isFailed(RequestInterface $request)
+    {
+        return $this->exceptions->contains($request);
+    }
+
+    /**
+     * 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 or null if not found
+     *
+     * @param RequestInterface $request
+     *
+     * @return ResponseInterface|null
+     */
+    public function getResponseFor(RequestInterface $request)
+    {
+        if ($this->responses->contains($request)) {
+            return $this->responses[$request];
+        }
+    }
+
+    /**
+     * 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
+     */
+    public function addResponse(RequestInterface $request, ResponseInterface $response)
+    {
+        $new = clone $this;
+        $new->responses->attach($request, $response);
+
+        return $new;
+    }
+
+    /**
+     * Returns all exceptions
+     *
+     * @return Exception[]
+     */
+    public function getExceptions()
+    {
+        $exceptions = [];
+
+        foreach ($this->exceptions as $request) {
+            $exceptions[] = $this->exceptions[$request];
+        }
+
+        return $exceptions;
+    }
+
+    /**
+     * Returns an exception for a request or null if not found
+     *
+     * @param RequestInterface $request
+     *
+     * @return Exception|null
+     */
+    public function getExceptionFor(RequestInterface $request)
+    {
+        if ($this->exceptions->contains($request)) {
+            return $this->exceptions[$request];
+        }
+    }
+
+    /**
+     * Checks if there are any exceptions at all
+     *
+     * @return boolean
+     */
+    public function hasExceptions()
+    {
+        return $this->exceptions->count() > 0;
+    }
+
+    /**
+     * Checks if there is an exception for a request
+     *
+     * @param RequestInterface $request
+     *
+     * @return Exception
+     */
+    public function hasExceptionFor(RequestInterface $request)
+    {
+        return $this->exceptions->contains($request);
+    }
+
+    /**
+     * Adds an exception in an immutable way
+     *
+     * @param RequestInterface  $request
+     * @param Exception         $exception
+     *
+     * @return BatchResult
+     */
+    public function addException(RequestInterface $request, Exception $exception)
+    {
+        $new = clone $this;
+        $new->exceptions->attach($request, $exception);
+
+        return $new;
+    }
+
+    public function __clone()
+    {
+        $this->responses = clone $this->responses;
+        $this->exceptions = clone $this->exceptions;
+    }
+}

src/Exception/BatchException.php

@@ -2,61 +2,49 @@
 
 namespace Http\Client\Exception;
 
+use Http\Client\BatchResult;
+
 /**
  * @author Márk Sági-Kazár <[email protected]>
  */
-final class BatchException extends TransferException
+final class BatchException extends RuntimeException
 {
     /**
-     * @var TransferException[]
+     * @var BatchResult
      */
-    private $exceptions;
+    private $result;
 
     /**
-     * @param TransferException[] $exceptions
+     * @param BatchResult $result
      */
-    public function __construct(array $exceptions = [])
+    public function __construct(BatchResult $result)
     {
-        parent::__construct('An error occurred when sending multiple requests.');
-
-        foreach ($exceptions as $e) {
-            if (!$e instanceof TransferException) {
-                throw new InvalidArgumentException('Exception is not an instanceof Http\Client\Exception\TransferException');
-            }
-        }
-
-        $this->exceptions = $exceptions;
+        $this->result = $result;
     }
 
     /**
-     * Returns all exceptions
+     * Returns successful responses or null
      *
-     * @return TransferException[]
+     * @return BatchResult
      */
-    public function getExceptions()
+    public function getResult()
     {
-        return $this->exceptions;
+        return $this->result;
     }
 
     /**
-     * Checks if a specific exception exists
+     * Decides whether the result has any failures
      *
-     * @param TransferException $exception
+     * @param BatchResult $result
      *
-     * @return boolean TRUE if there is the exception else FALSE.
+     * @return BatchResult|BatchException
      */
-    public function hasException(TransferException $exception)
+    public static function decideReturnValue(BatchResult $result)
     {
-        return array_search($exception, $this->exceptions, true) !== false;
-    }
+        if ($result->hasExceptions()) {
+            return new self($result);
+        }
 
-    /**
-     * Checks if any exception exists
-     *
-     * @return boolean
-     */
-    public function hasExceptions()
-    {
-        return !empty($this->exceptions);
+        return $result;
     }
 }