Check for member types before hydration

woohoolabs · Feb 14, 2017 · 4957da5 · 4957da5
1 parent 08388a7
commit 4957da5
Show file tree

Hide file tree

Showing 12 changed files with 149 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,10 +4,14 @@ ADDED:
 
 CHANGED:
 
+- Renamed some methods of `ExceptionFactoryInterface` which didn't end with `Exception` (e.g. `createRelationshipNotExists()` to `createRelationshipNotExistsException()`)
+
 REMOVED:
 
 FIXED:
 
+- [#59](https://github.com/woohoolabs/yin/issues/59): Resource schema validating
+
 ## 2.0.0-beta1 - 2017-02-09
 
 ADDED:

diff --git a/src/JsonApi/Exception/DefaultExceptionFactory.php b/src/JsonApi/Exception/DefaultExceptionFactory.php
@@ -75,7 +75,7 @@ public function createQueryParamUnrecognizedException(
         return new QueryParamUnrecognized($queryParamName);
     }
 
-    public function createRelationshipNotExists(string $relationship): RelationshipNotExists
+    public function createRelationshipNotExistsException(string $relationship): RelationshipNotExists
     {
         return new RelationshipNotExists($relationship);
     }
@@ -113,17 +113,27 @@ public function createRequestBodyInvalidJsonApiException(
         return new RequestBodyInvalidJsonApi($request, $validationErrors, $includeOriginalBody);
     }
 
-    public function createResourceIdentifierIdMissing(array $resourceIdentifier): ResourceIdentifierIdMissing
+    public function createResourceIdentifierIdInvalidException($id): ResourceIdentifierIdInvalid
+    {
+        return new ResourceIdentifierIdInvalid($id);
+    }
+
+    public function createResourceIdentifierIdMissingException(array $resourceIdentifier): ResourceIdentifierIdMissing
     {
         return new ResourceIdentifierIdMissing($resourceIdentifier);
     }
 
-    public function createResourceIdentifierTypeMissing(array $resourceIdentifier): ResourceIdentifierTypeMissing
+    public function createResourceIdentifierTypeInvalidException($type): ResourceIdentifierTypeInvalid
+    {
+        return new ResourceIdentifierTypeInvalid($type);
+    }
+
+    public function createResourceIdentifierTypeMissingException(array $resourceIdentifier): ResourceIdentifierTypeMissing
     {
         return new ResourceIdentifierTypeMissing($resourceIdentifier);
     }
 
-    public function createResourceIdInvalidException(string $id): ResourceIdInvalid
+    public function createResourceIdInvalidException($id): ResourceIdInvalid
     {
         return new ResourceIdInvalid($id);
     }
@@ -144,7 +154,7 @@ public function createResourceNotFoundException(RequestInterface $request): Reso
     }
 
     public function createResourceTypeUnacceptableException(
-        string $currentType,
+        $currentType,
         array $acceptedTypes
     ): ResourceTypeUnacceptable {
         return new ResourceTypeUnacceptable($currentType, $acceptedTypes);

diff --git a/src/JsonApi/Exception/ExceptionFactoryInterface.php b/src/JsonApi/Exception/ExceptionFactoryInterface.php
@@ -67,7 +67,7 @@ public function createQueryParamUnrecognizedException(RequestInterface $request,
     /**
      * @return JsonApiExceptionInterface|Exception
      */
-    public function createRelationshipNotExists(string $relationship);
+    public function createRelationshipNotExistsException(string $relationship);
 
     /**
      * @return JsonApiExceptionInterface|Exception
@@ -102,19 +102,31 @@ public function createRequestBodyInvalidJsonApiException(
     );
 
     /**
+     * @param mixed $id
      * @return JsonApiExceptionInterface|Exception
      */
-    public function createResourceIdentifierIdMissing(array $resourceIdentifier);
+    public function createResourceIdentifierIdInvalidException($id);
 
     /**
      * @return JsonApiExceptionInterface|Exception
      */
-    public function createResourceIdentifierTypeMissing(array $resourceIdentifier);
+    public function createResourceIdentifierIdMissingException(array $resourceIdentifier);
 
     /**
+     * @param mixed $type
      * @return JsonApiExceptionInterface|Exception
      */
-    public function createResourceIdInvalidException(string $id);
+    public function createResourceIdentifierTypeInvalidException($type);
+
+    /**
+     * @return JsonApiExceptionInterface|Exception
+     */
+    public function createResourceIdentifierTypeMissingException(array $resourceIdentifier);
+
+    /**
+     * @return JsonApiExceptionInterface|Exception
+     */
+    public function createResourceIdInvalidException($id);
 
     /**
      * @return JsonApiExceptionInterface|Exception
@@ -134,7 +146,7 @@ public function createResourceTypeMissingException();
     /**
      * @return JsonApiExceptionInterface|Exception
      */
-    public function createResourceTypeUnacceptableException(string $currentType, array $acceptedTypes);
+    public function createResourceTypeUnacceptableException($currentType, array $acceptedTypes);
 
     /**
      * @return JsonApiExceptionInterface|Exception

diff --git a/src/JsonApi/Exception/ResourceIdInvalid.php b/src/JsonApi/Exception/ResourceIdInvalid.php
@@ -9,13 +9,13 @@
 class ResourceIdInvalid extends JsonApiException
 {
     /**
-     * @var string
+     * @var mixed
      */
     protected $id;
 
     public function __construct(string $id)
     {
-        parent::__construct("The resource ID '$id' is invalid!");
+        parent::__construct("The resource ID '$id' must be a string!");
         $this->id = $id;
     }
 
@@ -31,7 +31,10 @@ protected function getErrors(): array
         ];
     }
 
-    public function getId(): string
+    /**
+     * @return mixed
+     */
+    public function getId()
     {
         return $this->id;
     }

diff --git a/src/JsonApi/Exception/ResourceIdentifierIdInvalid.php b/src/JsonApi/Exception/ResourceIdentifierIdInvalid.php
@@ -0,0 +1,37 @@
+<?php
+declare(strict_types=1);
+
+namespace WoohooLabs\Yin\JsonApi\Exception;
+
+use WoohooLabs\Yin\JsonApi\Schema\Error;
+use WoohooLabs\Yin\JsonApi\Schema\ErrorSource;
+
+class ResourceIdentifierIdInvalid extends JsonApiException
+{
+    /**
+     * @var mixed
+     */
+    protected $id;
+
+    public function __construct($id)
+    {
+        parent::__construct("The resource ID '$id' must be a string!");
+        $this->id = $id;
+    }
+
+    protected function getErrors(): array
+    {
+        return [
+            Error::create()
+                ->setStatus("400")
+                ->setCode("RESOURCE_IDENTIFIER_ID_INVALID")
+                ->setTitle("Resource identifier ID is invalid")
+                ->setDetail("The resource ID '$this->id' must be a string!")
+        ];
+    }
+
+    public function getId(): string
+    {
+        return $this->id;
+    }
+}
diff --git a/src/JsonApi/Exception/ResourceIdentifierTypeInvalid.php b/src/JsonApi/Exception/ResourceIdentifierTypeInvalid.php
@@ -0,0 +1,37 @@
+<?php
+declare(strict_types=1);
+
+namespace WoohooLabs\Yin\JsonApi\Exception;
+
+use WoohooLabs\Yin\JsonApi\Schema\Error;
+use WoohooLabs\Yin\JsonApi\Schema\ErrorSource;
+
+class ResourceIdentifierTypeInvalid extends JsonApiException
+{
+    /**
+     * @var mixed
+     */
+    protected $type;
+
+    public function __construct($type)
+    {
+        parent::__construct("The resource type '$type' must be a string!");
+        $this->type = $type;
+    }
+
+    protected function getErrors(): array
+    {
+        return [
+            Error::create()
+                ->setStatus("400")
+                ->setCode("RESOURCE_IDENTIFIER_TYPE_INVALID")
+                ->setTitle("Resource identifier type is invalid")
+                ->setDetail("The resource type '$this->type' must be a string!")
+        ];
+    }
+
+    public function getType(): string
+    {
+        return $this->type;
+    }
+}
diff --git a/src/JsonApi/Exception/ResourceTypeUnacceptable.php b/src/JsonApi/Exception/ResourceTypeUnacceptable.php
@@ -9,7 +9,7 @@
 class ResourceTypeUnacceptable extends JsonApiException
 {
     /**
-     * @var string
+     * @var mixed
      */
     protected $currentType;
 
@@ -18,9 +18,9 @@ class ResourceTypeUnacceptable extends JsonApiException
      */
     protected $acceptedTypes;
 
-    public function __construct(string $currentType, array $acceptedTypes)
+    public function __construct($currentType, array $acceptedTypes)
     {
-        parent::__construct("Resource type '$currentType' can't be accepted by the Hydrator!");
+        parent::__construct("Resource type '$currentType' is not a string or can't be accepted by the Hydrator!");
         $this->currentType = $currentType;
         $this->acceptedTypes = $acceptedTypes;
     }
@@ -37,7 +37,10 @@ public function getErrors(): array
         ];
     }
 
-    public function getCurrentType(): string
+    /**
+     * @return mixed
+     */
+    public function getCurrentType()
     {
         return $this->currentType;
     }

diff --git a/src/JsonApi/Hydrator/CreateHydratorTrait.php b/src/JsonApi/Hydrator/CreateHydratorTrait.php
@@ -111,7 +111,11 @@ protected function hydrateIdForCreate(
         RequestInterface $request,
         ExceptionFactoryInterface $exceptionFactory
     ) {
-        $id = isset($data["id"]) ? (string) $data["id"] : "";
+        if (empty($data["id"]) === false && is_string($data["id"]) === false) {
+            throw $exceptionFactory->createResourceIdInvalidException($data["id"]);
+        }
+
+        $id = empty($data["id"]) ? "" : $data["id"];
         $this->validateClientGeneratedId($id, $request, $exceptionFactory);
 
         if ($id === "") {

diff --git a/src/JsonApi/Hydrator/HydratorTrait.php b/src/JsonApi/Hydrator/HydratorTrait.php
@@ -71,11 +71,11 @@ protected function validateType(array $data, ExceptionFactoryInterface $exceptio
 
         $acceptedType = $this->getAcceptedType();
 
-        if (is_string($acceptedType) === true && $data["type"] !== $acceptedType) {
+        if (is_string($acceptedType) && $data["type"] !== $acceptedType) {
             throw $exceptionFactory->createResourceTypeUnacceptableException($data["type"], [$acceptedType]);
         }
 
-        if (is_array($acceptedType) && in_array($data["type"], $acceptedType) === false) {
+        if (is_array($acceptedType) && in_array($data["type"], $acceptedType, true) === false) {
             throw $exceptionFactory->createResourceTypeUnacceptableException($data["type"], $acceptedType);
         }
     }

diff --git a/src/JsonApi/Hydrator/UpdateHydratorTrait.php b/src/JsonApi/Hydrator/UpdateHydratorTrait.php
@@ -122,7 +122,7 @@ public function hydrateForRelationshipUpdate(
         $relationshipHydrators = $this->getRelationshipHydrator($domainObject);
 
         if (isset($relationshipHydrators[$relationship]) === false) {
-            throw $exceptionFactory->createRelationshipNotExists($relationship);
+            throw $exceptionFactory->createRelationshipNotExistsException($relationship);
         }
 
         $relationshipHydrator = $relationshipHydrators[$relationship];
@@ -148,7 +148,11 @@ protected function hydrateIdForUpdate($domainObject, array $data, ExceptionFacto
             throw $exceptionFactory->createResourceIdMissingException();
         }
 
-        $result = $this->setId($domainObject, (string) $data["id"]);
+        if (is_string($data["id"]) === false) {
+            throw $exceptionFactory->createResourceIdInvalidException($data["id"]);
+        }
+
+        $result = $this->setId($domainObject, $data["id"]);
         if ($result) {
             $domainObject = $result;
         }

diff --git a/src/JsonApi/Request/Request.php b/src/JsonApi/Request/Request.php
@@ -95,7 +95,7 @@ public function validateQueryParams()
     {
         foreach ($this->getQueryParams() as $queryParamName => $queryParamValue) {
             if (preg_match("/^([a-z]+)$/", $queryParamName) &&
-                in_array($queryParamName, ["fields", "include", "sort", "page", "filter"]) === false
+                in_array($queryParamName, ["fields", "include", "sort", "page", "filter"], true) === false
             ) {
                 throw $this->exceptionFactory->createQueryParamUnrecognizedException($this, $queryParamName);
             }

diff --git a/src/JsonApi/Schema/ResourceIdentifier.php b/src/JsonApi/Schema/ResourceIdentifier.php
@@ -25,12 +25,20 @@ class ResourceIdentifier
      */
     public static function fromArray(array $array, ExceptionFactoryInterface $exceptionFactory): ResourceIdentifier
     {
-        if (isset($array["type"]) === false) {
-            throw $exceptionFactory->createResourceIdentifierTypeMissing($array);
+        if (empty($array["type"])) {
+            throw $exceptionFactory->createResourceIdentifierTypeMissingException($array);
         }
 
-        if (isset($array["id"]) === false) {
-            throw $exceptionFactory->createResourceIdentifierIdMissing($array);
+        if (is_string($array["type"]) === false) {
+            throw $exceptionFactory->createResourceIdentifierTypeInvalidException($array["type"]);
+        }
+
+        if (empty($array["id"])) {
+            throw $exceptionFactory->createResourceIdentifierIdMissingException($array);
+        }
+
+        if (is_string($array["id"]) === false) {
+            throw $exceptionFactory->createResourceIdentifierIdInvalidException($array["id"]);
         }
 
         $resourceIdentifier = new self();