Merge pull request #10 from AdamGaskins/arrayable

Add support for JsonResources (and any other Arrayables/JsonSerializables)

Author: Robert Allport

README.md

@@ -46,12 +46,11 @@ Optionally, the trait could be imported within a base controller.
 
 ## Available methods
 
-
 #### `respondNotFound(string|Exception $message, ?string $key = 'error')`
 
 Returns a `404` HTTP status code, an excpetion object can optionally be passed.
 
-#### `respondWithSuccess(?array $contents = [])`
+#### `respondWithSuccess(array|Arrayable|JsonSerializable|null $contents = [])`
 
 Returns a `200` HTTP status code
 
@@ -71,11 +70,11 @@ Returns a `403` HTTP status code
 
 Returns a `400` HTTP status code
 
-#### `respondCreated(?array $data = [])`
+#### `respondCreated(array|Arrayable|JsonSerializable|null $data = [])`
 
 Returns a `201` HTTP status code, with response optional data
 
-#### `respondNoContent(?array $data = [])`
+#### `respondNoContent(array|Arrayable|JsonSerializable|null $data = [])`
 
 Returns a `204` HTTP status code, with optional response data. Strictly speaking, the response body should be empty. However, functionality to optionally return data was added to handle legacy projects. Within your own projects, you can simply call the method, omitting parameters, to generate a correct `204` response i.e. `return $this->respondNoContent()` 
 
@@ -93,7 +92,11 @@ I wanted to add a simple trait that kept this consistent, in this case:
 
 `$this->respondError('Ouch')`
 
-This package is intended to be used **alongside** Laravel's  [API resources](https://laravel.com/docs/8.x/eloquent-resources) and in no way replaces them.
+This package is intended to be used **alongside** Laravel's  [API resources](https://laravel.com/docs/8.x/eloquent-resources) and in no way replaces them:
+
+```php
+$this->respondCreated(PostResource::make($post));
+```
 
 ## Contribution
 

composer.json

@@ -18,7 +18,8 @@
   ],
   "require": {
     "php": "^7.4 | ^8.0",
-    "illuminate/support": "^6.0|^7.0|^8.0"
+    "illuminate/support": "^6.0|^7.0|^8.0",
+    "ext-json": "*"
   },
   "require-dev": {
     "orchestra/testbench": "^4.0|^5.0|^6.0",

src/ApiResponseHelpers.php

@@ -5,7 +5,9 @@
 namespace F9Web;
 
 use Exception;
+use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Http\JsonResponse;
+use JsonSerializable;
 use Symfony\Component\HttpFoundation\Response;
 
 use function response;
@@ -32,8 +34,13 @@ public function respondNotFound(
         );
     }
 
-    public function respondWithSuccess(?array $contents = []): JsonResponse
+    /**
+     * @param array|Arrayable|JsonSerializable|null $contents
+     */
+    public function respondWithSuccess($contents = []): JsonResponse
     {
+        $contents = $this->morphToArray($contents);
+
         $data = [] === $contents
             ? ['success' => true]
             : $contents;
@@ -70,8 +77,13 @@ public function respondError(?string $message = null): JsonResponse
         );
     }
 
-    public function respondCreated(?array $data = []): JsonResponse
+    /**
+     * @param array|Arrayable|JsonSerializable|null $data
+     */
+    public function respondCreated($data = []): JsonResponse
     {
+        $data = $this->morphToArray($data);
+
         return $this->apiResponse($data, Response::HTTP_CREATED);
     }
 
@@ -102,14 +114,36 @@ public function respondTeapot(): JsonResponse
           Response::HTTP_I_AM_A_TEAPOT
         );
     }
-    
-    public function respondNoContent(?array $data = []): JsonResponse
+
+    /**
+     * @param array|Arrayable|JsonSerializable|null $data
+     */
+    public function respondNoContent($data = []): JsonResponse
     {
+        $data = $this->morphToArray($data);
+
         return $this->apiResponse($data, Response::HTTP_NO_CONTENT);
     }
 
     private function apiResponse(array $data, int $code = 200): JsonResponse
     {
         return response()->json($data, $code);
     }
+
+    /**
+     * @param array|Arrayable|JsonSerializable|null $data
+     * @return array|null
+     */
+    private function morphToArray($data)
+    {
+        if ($data instanceof Arrayable) {
+            return $data->toArray();
+        }
+
+        if ($data instanceof JsonSerializable) {
+            return $data->jsonSerialize();
+        }
+
+        return $data;
+    }
 }

tests/ResponseTest.php

@@ -7,6 +7,7 @@
 use DomainException;
 use F9Web\ApiResponseHelpers;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Collection;
 use Symfony\Component\HttpFoundation\Response;
 
 class ResponseTest extends TestCase
@@ -50,6 +51,10 @@ public function testRespondWithSuccess(): void
         $response = $this->service->respondWithSuccess(['super' => 'response', 'yes' => 123]);
         self::assertJsonStringEqualsJsonString('{"super":"response","yes":123}', $response->getContent());
         self::assertEquals(['super' => 'response', 'yes' => 123], $response->getData(true));
+
+        $response = $this->service->respondWithSuccess(new Collection(['super' => 'response', 'yes' => 123]));
+        self::assertJsonStringEqualsJsonString('{"super":"response","yes":123}', $response->getContent());
+        self::assertEquals(['super' => 'response', 'yes' => 123], $response->getData(true));
     }
 
     public function testRespondOk(): void
@@ -112,6 +117,15 @@ public function testRespondCreated(): void
         self::assertEquals(Response::HTTP_CREATED, $response->getStatusCode());
         self::assertJsonStringEqualsJsonString('[]', $response->getContent());
         self::assertEquals([], $response->getData(true));
+
+        $response = $this->service->respondCreated([ 'id' => 123, 'title' => 'ABC' ]);
+        self::assertJsonStringEqualsJsonString('{"id":123,"title":"ABC"}', $response->getContent());
+        self::assertEquals([ 'id' => 123, 'title' => 'ABC' ], $response->getData(true));
+
+        $response = $this->service->respondCreated(new Collection([ 'id' => 123, 'title' => 'ABC' ]));
+        self::assertJsonStringEqualsJsonString('{"id":123,"title":"ABC"}', $response->getContent());
+        self::assertEquals([ 'id' => 123, 'title' => 'ABC' ], $response->getData(true));
+        self::assertEquals(Response::HTTP_CREATED, $response->getStatusCode());
     }
 
     public function testRespondFailedValidation(): void