Write phpunit tests for handlePost

phramework · Oct 8, 2016 · ae4cb8e · ae4cb8e
1 parent 748aff3
commit ae4cb8e
Show file tree

Hide file tree

Showing 8 changed files with 594 additions and 21 deletions.
diff --git a/src/Controller/Controller.php b/src/Controller/Controller.php
@@ -217,7 +217,6 @@ function ($d) {
                 $model
             );
 
-
             if ($parsed !== null) {
                 //overwrite
                 if ($overwrite
@@ -238,6 +237,12 @@ function ($d) {
         return $directives;
     }
 
+    /**
+     * @param              $object
+     * @param ISource|null $source
+     * @param string[]    ...$properties
+     * @throws MissingParametersException
+     */
     public static function requireProperties(
         $object,
         ISource $source = null,

diff --git a/src/Controller/Helper/RequestBodyQueue.php b/src/Controller/Helper/RequestBodyQueue.php
@@ -37,7 +37,6 @@
 trait RequestBodyQueue
 {
     /**
-     * What is resource ?
      * @todo
      * @param \stdClass $resource Primary data resource
      */
@@ -47,8 +46,7 @@ public static function handleResource(
         ResourceModel $model,
         ValidationModel $validationModel,
         array $validationCallbacks = []
-    )
-    {
+    ) {
         //Fetch request attributes
         $requestAttributes = $resource->attributes    ?? new \stdClass();
         $requestRelationships = $resource->relationships ?? new \stdClass();
@@ -164,7 +162,7 @@ function (\stdClass $p) {
 
             //Convert to array
             $tempIds = (
-            is_array($rValue)
+                is_array($rValue)
                 ? $rValue
                 : [$rValue]
             );
@@ -204,7 +202,8 @@ function (\stdClass $p) {
             $callback(
                 $resource,
                 $parsedAttributes, //parsed
-                $parsedRelationships //parsed
+                $parsedRelationships, //parsed
+                $source
             );
         }
 
@@ -214,4 +213,3 @@ function (\stdClass $p) {
         );
     }
 }
-
diff --git a/src/Controller/Post.php b/src/Controller/Post.php
@@ -19,6 +19,7 @@
 
 use Phramework\Exceptions\ForbiddenException;
 use Phramework\Exceptions\IncorrectParameterException;
+use Phramework\Exceptions\MissingParametersException;
 use Phramework\Exceptions\RequestException;
 use Phramework\Exceptions\ServerException;
 use Phramework\Exceptions\Source\Pointer;
@@ -43,19 +44,29 @@ trait Post
 {
     use RequestBodyQueue;
 
-    //prototype
     /**
      * Handle HTTP POST request method to create new resources
      * @param ServerRequestInterface $request
      * @param ResponseInterface      $response
      * @param ResourceModel          $model
-     * @param array                  $validationCallbacks
-     * @param callable|null          $viewCallback
+     * @param array                  $validationCallbacks function of
+     * - \stdClass $resource
+     * - \stdClass $parsedAttributes
+     * - \stdClass $parsedRelationships
+     * - ISource $source
+     * returning void
+     * @param callable|null          $viewCallback function of
+     * - ServerRequestInterface $request,
+     * - ResponseInterface $response,
+     * - string[] $ids
+     * - returning ResponseInterface
      * @param int|null               $bulkLimit
      * @param array                  $directives
      * @return ResponseInterface
      * @throws ForbiddenException
      * @throws RequestException
+     * @throws MissingParametersException
+     * @throws ServerException
      */
     public static function handlePost(
         ServerRequestInterface $request,
@@ -67,10 +78,12 @@ public static function handlePost(
         array $directives = []
     ) : ResponseInterface {
         //todo figure out a permanent solution to have body as object instead of array, for every framework
-        $body = json_decode(json_encode($request->getParsedBody()));
+        $body = json_decode(json_encode($request->getParsedBody())) ?? new \stdClass();
+
+        Controller::requireProperties($body, new Pointer('/'), 'data');
 
         //Access request body primary data
-        $data = $body->data ?? [new \stdClass()];
+        $data = $body->data;
 
         /**
          * @var bool
@@ -88,7 +101,7 @@ public static function handlePost(
         //check bulk limit
         if ($bulkLimit !== null && count($data) > $bulkLimit) {
             throw new RequestException(sprintf(
-                'Number of batch requests is exceeding the maximum of %s',
+                'Number of bulk requests is exceeding the maximum of %s',
                 $bulkLimit
             ));
         }
@@ -143,6 +156,7 @@ public static function handlePost(
             $item = static::handleResource(
                 $resource,
                 $source,
+                $model,
                 $validationModel,
                 $validationCallbacks
             );
@@ -233,13 +247,25 @@ public static function handlePost(
             );
         }
 
-        /*if (count($ids) === 1) {
+        return Post::defaultViewCallback(
+            $request,
+            $response,
+            $ids
+        );
+    }
+
+    public static function defaultViewCallback(
+        ServerRequestInterface $request,
+        ResponseInterface $response,
+        array $ids
+    ) : ResponseInterface {
+        if (count($ids) === 1) {
             //Prepare response with 201 Created status code
-            return Response::created(
+            $response = Response::created(
                 $response,
-                'link' . $ids[0] // location
+                'link/' . $ids[0] // location //todo
             );
-        }*/ //see https://stackoverflow.com/questions/11309444/can-the-location-header-be-used-for-multiple-resource-locations-in-a-201-created
+        } //see https://stackoverflow.com/questions/11309444/can-the-location-header-be-used-for-multiple-resource-locations-in-a-201-created
 
         //Return 204 No Content
         return Response::noContent($response);

diff --git a/src/Directive/FilterAttribute.php b/src/Directive/FilterAttribute.php
@@ -118,7 +118,7 @@ public static function parse($filterKey, $filterValue)
             }
 
             //@todo is this required?
-            $singleFilterValue = urldecode($singleFilterValue);
+            $singleFilterValue = urldecode((string) $singleFilterValue);
 
             list($operator, $operand) = Operator::parse($singleFilterValue);
 

diff --git a/tests/APP/DataSource/MemoryDataSource.php b/tests/APP/DataSource/MemoryDataSource.php
@@ -159,7 +159,7 @@ public function post(
 
         if (!property_exists($attributes, $idAttribute)) {
             //generate an id
-            $attributes->{$idAttribute} = md5(mt_rand());
+            $attributes->{$idAttribute} = md5((string) mt_rand());
         }
 
         $table = $this->resourceModel->getVariable('table');

diff --git a/tests/APP/Models/Tag.php b/tests/APP/Models/Tag.php
@@ -22,6 +22,9 @@
 use Phramework\JSONAPI\ResourceModel;
 use Phramework\JSONAPI\Model;
 use Phramework\JSONAPI\ModelTrait;
+use Phramework\JSONAPI\ValidationModel;
+use Phramework\Validate\ObjectValidator;
+use Phramework\Validate\StringValidator;
 
 /**
  * @since 3.0.0
@@ -38,7 +41,19 @@ class Tag extends Model
     protected static function defineModel() : ResourceModel
     {
         $model = (new ResourceModel('tag', new MemoryDataSource()))
-            ->addVariable('table', 'tag');
+            ->addVariable('table', 'tag')
+            ->setValidationModel(
+                new ValidationModel(
+                    new ObjectValidator(
+                        (object) [
+                            'name' => new StringValidator(2, 10)
+                        ],
+                        ['name'],
+                        false
+                    )
+                ),
+                'POST'
+            );
 
         return $model;
     }