Add decoders, exceptions and some contracts.

Author: lindyhopchris

src/Contracts/Error/ErrorCollectionInterface.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace CloudCreativity\JsonApi\Contracts\Error;
+use Neomerx\JsonApi\Contracts\Document\ErrorInterface;
+
+interface ErrorCollectionInterface extends \Traversable, \Countable
+{
+
+    /**
+     * @param ErrorInterface $error
+     * @return $this
+     */
+    public function add(ErrorInterface $error);
+
+    /**
+     * @param ErrorInterface[] $errors
+     * @return $this
+     */
+    public function addMany(array $errors);
+
+    /**
+     * @return ErrorInterface[]
+     */
+    public function getAll();
+
+    /**
+     * @return string
+     */
+    public function getStatus();
+
+    /**
+     * @param string|\Closure $pointer
+     * @return $this
+     */
+    public function setSourcePointer($pointer);
+
+    /**
+     * @return bool
+     */
+    public function isEmpty();
+
+    /**
+     * @return $this
+     */
+    public function clear();
+
+    /**
+     * @param ErrorCollectionInterface $errors
+     * @return $this
+     */
+    public function merge(ErrorCollectionInterface $errors);
+
+}

src/Contracts/Error/ErrorsAwareInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace CloudCreativity\JsonApi\Contracts\Error;
+
+interface ErrorsAwareInterface
+{
+
+    /**
+     * @return ErrorCollectionInterface
+     */
+    public function getErrors();
+}

src/Contracts/Validator/ValidatorInterface.php

@@ -2,19 +2,14 @@
 
 namespace CloudCreativity\JsonApi\Contracts\Validator;
 
-use CloudCreativity\JsonApi\Error\ErrorCollection;
+use CloudCreativity\JsonApi\Contracts\Error\ErrorsAwareInterface;
 
-interface ValidatorInterface
+interface ValidatorInterface extends ErrorsAwareInterface
 {
 
     /**
      * @param mixed $value
      * @return bool
      */
     public function isValid($value);
-
-    /**
-     * @return ErrorCollection
-     */
-    public function getErrors();
 }

src/Decoders/AbstractDecoder.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace CloudCreativity\JsonApi\Decoders;
+
+use CloudCreativity\JsonApi\Error\ErrorException;
+use CloudCreativity\JsonApi\Error\ErrorObject;
+use Neomerx\JsonApi\Contracts\Decoder\DecoderInterface;
+
+abstract class AbstractDecoder implements DecoderInterface
+{
+
+    const ERROR_INVALID_JSON = 'invalid-json';
+
+    /**
+     * @param $content
+     * @param bool|false $assoc
+     * @param int $depth
+     * @param int $options
+     * @return mixed
+     */
+    public function parseJson($content, $assoc = false, $depth = 512, $options = 0)
+    {
+        $parsed = json_decode($content, $assoc, $depth, $options);
+
+        if (JSON_ERROR_NONE !== json_last_error()) {
+            $error = new ErrorObject([
+                ErrorObject::TITLE => 'Invalid JSON',
+                ErrorObject::DETAIL => 'Request body content could not be parsed as JSON: ' . json_last_error_msg(),
+                ErrorObject::CODE => static::ERROR_INVALID_JSON,
+                ErrorObject::STATUS => 400,
+            ]);
+
+            throw new ErrorException($error);
+        }
+
+        return $parsed;
+    }
+}

src/Decoders/RelationshipDecoder.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace CloudCreativity\JsonApi\Decoders;
+
+use CloudCreativity\JsonApi\Error\MultiErrorException;
+use CloudCreativity\JsonApi\Object\Relationships\Relationship;
+use CloudCreativity\JsonApi\Validator\ValidatorAwareTrait;
+
+class RelationshipDecoder extends AbstractDecoder
+{
+
+    use ValidatorAwareTrait;
+
+    /**
+     * @param string $content
+     * @return Relationship
+     * @throws MultiErrorException
+     */
+    public function decode($content)
+    {
+        $content = $this->parseJson($content);
+        $validator = $this->getValidator();
+
+        if (!$validator->isValid($content)) {
+            throw new MultiErrorException($validator->getErrors(), 'Invalid request body content.');
+        }
+
+        return new Relationship($content);
+    }
+}

src/Decoders/ResourceDecoder.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace CloudCreativity\JsonApi\Decoders;
+
+use CloudCreativity\JsonApi\Error\MultiErrorException;
+use CloudCreativity\JsonApi\Object\Resource\Resource;
+use CloudCreativity\JsonApi\Validator\ValidatorAwareTrait;
+
+class ResourceDecoder extends AbstractDecoder
+{
+
+    use ValidatorAwareTrait;
+
+    /**
+     * @param string $content
+     * @return Resource
+     * @throws MultiErrorException
+     */
+    public function decode($content)
+    {
+        $content = $this->parseJson($content);
+        $validator = $this->getValidator();
+
+        if (!$validator->isValid($content)) {
+            throw new MultiErrorException($validator->getErrors(), 'Invalid request body content.');
+        }
+
+        return new Resource($content);
+    }
+}

src/Error/ErrorCollection.php

@@ -2,9 +2,10 @@
 
 namespace CloudCreativity\JsonApi\Error;
 
+use CloudCreativity\JsonApi\Contracts\Error\ErrorCollectionInterface;
 use Neomerx\JsonApi\Contracts\Document\ErrorInterface;
 
-class ErrorCollection implements \IteratorAggregate, \Countable
+class ErrorCollection implements \IteratorAggregate, ErrorCollectionInterface
 {
 
     /**
@@ -84,14 +85,14 @@ public function error($error)
     }
 
     /**
-     * @param ErrorCollection $errors
+     * @param ErrorCollectionInterface $errors
      * @return $this
      */
-    public function merge(ErrorCollection $errors)
+    public function merge(ErrorCollectionInterface $errors)
     {
-        $clone = clone $errors;
-
-        $this->_stack = array_merge($this->_stack, $clone->_stack);
+        foreach ($errors as $error) {
+            $this->add(clone $error);
+        }
 
         return $this;
     }

src/Error/ErrorException.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace CloudCreativity\JsonApi\Error;
+
+use CloudCreativity\JsonApi\Contracts\Error\ErrorsAwareInterface;
+use Neomerx\JsonApi\Contracts\Document\ErrorInterface;
+
+class ErrorException extends \RuntimeException implements ErrorsAwareInterface
+{
+
+    /**
+     * @var ErrorInterface
+     */
+    protected $_error;
+
+    /**
+     * @param ErrorInterface $error
+     * @param \Exception|null $previous
+     */
+    public function __construct(ErrorInterface $error, \Exception $previous = null)
+    {
+        parent::__construct($error->getTitle(), $error->getCode(), $previous);
+
+        $this->_error = $error;
+    }
+
+    /**
+     * @return ErrorInterface
+     */
+    public function getError()
+    {
+        return $this->_error;
+    }
+
+    /**
+     * @return ErrorCollection
+     */
+    public function getErrors()
+    {
+        return new ErrorCollection([$this->getError()]);
+    }
+}

src/Error/ErrorsAwareTrait.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace CloudCreativity\JsonApi\Error;
+
+use CloudCreativity\JsonApi\Contracts\Error\ErrorCollectionInterface;
+
+trait ErrorsAwareTrait
+{
+
+    /**
+     * @var ErrorCollectionInterface|null
+     */
+    protected $_errors;
+
+    /**
+     * @param ErrorCollectionInterface $errors
+     * @return $this
+     */
+    public function setErrors(ErrorCollectionInterface $errors)
+    {
+        $this->_errors = $errors;
+
+        return $this;
+    }
+
+    /**
+     * @return ErrorCollectionInterface
+     */
+    public function getErrors()
+    {
+        if (!$this->_errors instanceof ErrorCollectionInterface) {
+            $this->_errors = new ErrorCollection();
+        }
+
+        return $this->_errors;
+    }
+}

src/Error/MultiErrorException.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace CloudCreativity\JsonApi\Error;
+
+use CloudCreativity\JsonApi\Contracts\Error\ErrorCollectionInterface;
+use CloudCreativity\JsonApi\Contracts\Error\ErrorsAwareInterface;
+
+class MultiErrorException extends \RuntimeException implements ErrorsAwareInterface
+{
+
+    /**
+     * @var ErrorCollectionInterface
+     */
+    protected $_errors;
+
+    /**
+     * @param ErrorCollectionInterface $errors
+     * @param $message
+     * @param \Exception|null $previous
+     */
+    public function __construct(ErrorCollectionInterface $errors, $message = null, \Exception $previous = null)
+    {
+        parent::__construct($message, null, $previous);
+
+        $this->_errors = $errors;
+    }
+
+    /**
+     * @return ErrorCollectionInterface
+     */
+    public function getErrors()
+    {
+        return $this->_errors;
+    }
+}