- Document new functionality to pass additional object types
- Extract code to fetch message from an exception to method

Author: ultrono

README.md

@@ -21,7 +21,7 @@ A simple package allowing for consistent API responses throughout your Laravel a
 `composer require f9webltd/laravel-api-response-helpers`
 
 
-Simply reference the required trait in your controller:
+Simply reference the required trait within your controller:
 
 ```php
 <?php
@@ -48,7 +48,7 @@ Optionally, the trait could be imported within a base controller.
 
 #### `respondNotFound(string|Exception $message, ?string $key = 'error')`
 
-Returns a `404` HTTP status code, an excpetion object can optionally be passed.
+Returns a `404` HTTP status code, an exception object can optionally be passed.
 
 #### `respondWithSuccess(array|Arrayable|JsonSerializable|null $contents = [])`
 
@@ -78,6 +78,22 @@ Returns a `201` HTTP status code, with response optional 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()` 
 
+## Additional Data Types
+
+In addition to a plain PHP `array`, the following data types can be passed to relevant methods:
+
+- Objects implementing the Laravel `Illuminate\Contracts\Support\Arrayable` contract
+- Objects implementing the native PHP `JsonSerializable` contract
+
+This allows a variety of object types to be passed and converted automatically.
+
+Some example objects that can be passed (there are a lot more):
+
+- `Illuminate\Support\Collection` (i.e. [Collections](https://laravel.com/docs/8.x/collections))
+- `Illuminate\Database\Eloquent`  (i.e. [Eloquent collections](https://laravel.com/docs/8.x/eloquent-collections))
+- `Illuminate\Http\Resources\Json\JsonResource` (i.e. [Laravel API resources](https://laravel.com/docs/8.x/eloquent-resources))
+- `Illuminate\Foundation\Http\FormRequest`
+
 ## Motivation
 
 Ensure consistent JSON API responses throughout an application. The motivation was primarily based on a very old inherited Laravel project. The project contained a plethora of methods/structures used to return an error:

src/ApiResponseHelpers.php

@@ -24,12 +24,8 @@ public function respondNotFound(
         $message,
         ?string $key = 'error'
     ): JsonResponse {
-        $message = $message instanceof Exception
-            ? $message->getMessage()
-            : $message;
-
         return $this->apiResponse(
-            [$key => $message],
+            [$key => $this->morphMessage($message)],
             Response::HTTP_NOT_FOUND
         );
     }
@@ -82,9 +78,10 @@ public function respondError(?string $message = null): JsonResponse
      */
     public function respondCreated($data = []): JsonResponse
     {
-        $data = $this->morphToArray($data);
-
-        return $this->apiResponse($data, Response::HTTP_CREATED);
+        return $this->apiResponse(
+          $this->morphToArray($data),
+          Response::HTTP_CREATED
+        );
     }
 
     /**
@@ -97,12 +94,8 @@ public function respondFailedValidation(
         $message,
         ?string $key = 'message'
     ): JsonResponse {
-        $message = $message instanceof Exception
-            ? $message->getMessage()
-            : $message;
-
         return $this->apiResponse(
-            [$key => $message ?? 'Validation errors'],
+            [$key => $this->morphMessage($message)],
             Response::HTTP_UNPROCESSABLE_ENTITY
         );
     }
@@ -146,4 +139,15 @@ private function morphToArray($data)
 
         return $data;
     }
+
+    /**
+     * @param string|\Exception $message
+     * @return string
+     */
+    private function morphMessage($message): string
+    {
+        return $message instanceof Exception
+          ? $message->getMessage()
+          : $message;
+    }
 }

tests/ResponseTest.php

@@ -137,6 +137,11 @@ public function testRespondFailedValidation(): void
         self::assertJsonStringEqualsJsonString('{"message":"Password is required"}', $response->getContent());
         self::assertEquals(['message' => 'Password is required'], $response->getData(true));
 
+        /** @var \Illuminate\Http\JsonResponse $response */
+        $response = $this->service->respondFailedValidation(new DomainException('Bad things happening ...'));
+        self::assertJsonStringEqualsJsonString('{"message":"Bad things happening ..."}', $response->getContent());
+        self::assertEquals(['message' => 'Bad things happening ...'], $response->getData(true));
+
         /** @var \Illuminate\Http\JsonResponse $response */
         $response = $this->service->respondFailedValidation('Password is required', 'erm');
         self::assertJsonStringEqualsJsonString('{"erm":"Password is required"}', $response->getContent());