We're using API Resources to filter the model attributes that are transformed in JSON.

Do you plan to support UserResources in the ResponseBuilder in addition to Collections and Arrays?

Not sure this is 100% correct place, but I've seen people are really active so hoping this is ok?

This has been briefly mentioned in #109 but I must be missing something. Still not sure how to best get additional pagination information with the request. So far I have:

public function index(Request $request)
    {
        return ResponseBuilder::success(new GraphicDownloadCollection(GraphicDownload::byAccount($request->user()->account->id)->jsonPaginate()));
    }

NOTE The jsonPaginate comes from https://github.com/spatie/laravel-json-api-paginate, but even if I put standard Laravel paginate, I get same result.

Which returns:

{
    code: 0
    data: {
        items: {
            current_page: 1
            data: []
            first_page_url: "http://domain.test/api/v1/graphic-downloads?page%5Bnumber%5D=1"
            from: null
            last_page: 1
            last_page_url: "http://domain.test/api/v1/graphic-downloads?page%5Bnumber%5D=1"
            next_page_url: null
            path: "http://domain.test/api/v1/graphic-downloads"
            per_page: 10
            prev_page_url: null
            to: null
            total: 0
            locale: "en"
            message: "OK"
            success: true
        }
    }
}

Seems a better response would be:

{
    code: 0
    data: {
        current_page: 1
        items: []
        first_page_url: "http://domain.test/api/v1/graphic-downloads?page%5Bnumber%5D=1"
        from: null
        last_page: 1
        last_page_url: "http://domain.test/api/v1/graphic-downloads?page%5Bnumber%5D=1"
        next_page_url: null
        path: "http://domain.test/api/v1/graphic-downloads"
        per_page: 10
        prev_page_url: null
        to: null
        total: 0
        locale: "en"
        message: "OK"
        success: true
    }
}

This is my ResourceCollection class for that particular model:

<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\ResourceCollection;

class GraphicDownloadCollection extends ResourceCollection
{
    /**
     * Transform the resource collection into an array.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array
     */
    public function toArray($request = null)
    {
        return $this->resource;
    }
}

Any help would be greatly appreciated.

ExceptionHandlerHelper always returns HTTP 500 status code and API code 113 with default config file (no mappings).

{
    "success": false,
    "code": 113,
    "locale": "fr",
    "message": "Unauthenticated.",
    "data": null,
    "debug": {
        "trace": {
            "class": "Illuminate\\Auth\\AuthenticationException",
            "file": "/var/www/project/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php",
            "line": 81
        }
    }
}

{
    "success": false,
    "code": 113,
    "locale": "fr",
    "message": "No query results for model X",
    "data": null,
    "debug": {
        "trace": {
            "class": "Illuminate\\Database\\Eloquent\\ModelNotFoundException",
            "file": "/var/www/project/vendor/laravel/framework/src/Illuminate/Routing/ImplicitRouteBinding.php",
            "line": 38
        }
    }
}

Expected behavior Is this correct behavior ? I thought it would handle basic framework exceptions and return appropriate HTTP codes out of the box.

To reproduce In app/Exceptions/Handler.php

    public function render($request, Exception $exception)
    {
        return ExceptionHandlerHelper::render($request, $exception);
    }

Environemnt:

• PHP version 7.3
• Laravel version 6.6.0
• Laravel Response Builder 7.0.1

This is a wonderful package, but sometimes we don't want localization. If, for instance, localization is managed differently on some front-end, then we may not want to received a localized string when consuming an API.

With those changes, I propose to add an use_localization option in the configuration, which would simply make the response builder not translate the localization.

I did not add test coverage since the localization is too deeply implemented in the package. I think this feature would require more changes than what I made.

What do you think?

I've been using the package for 3 months now and i noticed that if the request is returning any status -except- 200 it fails to set the response status with the returning status, let's say if we're returning 404 the response builder will format the response json with code, etc ... but the response status it self is not as the returning code, it gives 200, so if this a misunderstanding from me of is this feature not supported?

What's wrong? Resource Builder is not working with the resource collection objects. In my case, it is Resources\UserCollection Object

Steps to reproduce the behavior:

1. Create resource and resource collection
2. use the Resource Builder and resource collection in the controller.

use App\Http\Resources\User as UserResource;
use App\Http\Resources\UserCollection;
use MarcinOrlowski\ResponseBuilder\ResponseBuilder;

class UserController extends Controller
{
    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index(Request $request)
    {
    	$users = User::all();
        $collection = new UserCollection($users);
        return ResponseBuilder::success($collection);
    }
}

3. Another version by using the collection method.

use App\Http\Resources\User as UserResource;
use App\Http\Resources\UserCollection;
use MarcinOrlowski\ResponseBuilder\ResponseBuilder;

class UserController extends Controller
{
    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index(Request $request)
    {
    	$users = User::all();
        $collection = NcfResource::collection($users);
        return ResponseBuilder::success($collection);
    }
}

You will get this error when you run the step 2 code:- Too few arguments to function App\Http\Resources\UserCollection::toArray(), 0 passed in vendor\marcin-orlowski\laravel-api-response-builder\src\Converters\ToArrayConverter.php on line 39 and exactly 1 expected

You will get this error when you run the step 3 code:- Too few arguments to function Illuminate\Http\Resources\Json\ResourceCollection::toArray(), 0 passed in vendor\marcin-orlowski\laravel-api-response-builder\src\Converters\ToArrayConverter.php on line 39 and exactly 1 expected

Expected behavior It should be working with the resource collection and Json\ResourceCollection.

Runtime environment

• Name and version of OS: Windows 10
• PHP version: PHP 7.3.7
• Laravel version: 7.30.4
• ResponseBuilder version used: 9.2

Notes Any additional information that may be helpful in diagnosing the problem.

Describe the bug When Laravel validation fails and HTTP code 422 is returned, I'm getting something like this:

    "success": false,
    "code": 115,
    "locale": "fa",
    "message": "The given data was invalid.",
    "data": ...

Expected behavior How can I translate the The given data was invalid.? I'm using v6.3.1 of this package

Environemnt:

• Name and version of OS: Windows 10
• PHP version 7.3
• Laravel version 6.5.0

• Added data_always_object config option that, when enabled enforces response data node to always be JSON object (for NULL it will return empty object {}).
• Improved code quality (fully pass on PHPStan's strict mode)
• Fixed floats being rejected as direct primitive payload.
• Fixed Converter unit tests for primitives-as-payload.
• Fixed ResponseBuilderProvider throwing incorrect Exception in case of invalid config file.
• Added Validator::assertIsObjectOrExistingClass() method.
• Validator::assertIsInt() throws now NotIntegerException as expected.
• Corrected Validator class tests to check agains specific exceptions thrown, not base class.
• Improved error handling in JsonSerializableConverter
• Switched Composer's autoload to follow psr-4 instead of plain classmap (thanks to Viktor Szépe).
• Added TestingHelpers::getResponseContent(), TestingHelpers::langGet() to satisfy static analyzers.
• Updated and corrected PHPDocs (incl. some type hints).
• Added missing type hint to success().
• Added strict type header to classes.
• Updated documentation.

Hey @MarcinOrlowski ! This is regarding the Laravel pagination response related to #127 and this comment

I'm on Laravel 8

'converter'         => [
   'classes' => [
       ...

       \Illuminate\Http\Resources\Json\ResourceCollection::class => [
          'handler' => App\Http\Converters\CustomJsonResourceCollectionConverter::class,
          'key' => null,  // <---- setting an empty key
          'pri' => 10,
       ],
   ],
]

The output as mentioned in the issue comment will be,

{
    "success": true,
    "code": 0,
    "locale": "en",
    "message": "OK",
    "data": {
        "items": [
            {
                "id": 137,
                "uuid": "b2f94a2f-42a8-4b9b-8e56-ea3ef54987f2",
            }
        ],
        "links": {
            "first": "https://example.com/api/public/v1/specs?page%5Bnumber%5D=1",
            "last": "https://example.com/api/public/v1/specs?page%5Bnumber%5D=11",
            "prev": null,
            "next": "https://example.com/api/public/v1/specs?page%5Bnumber%5D=2"
        },
        "meta": {
            "current_page": 1,
            "from": 1,
            "last_page": 11,
            "path": "https://example.com/api/public/v1/specs",
            "per_page": 30,
            "to": 30,
            "total": 316
        }
    }
}

Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

1. Add abort(403) in some API route
2. Make request to that route.

Expected behavior I expect to work like abort(401).

{
    "success": false,
    "code": 114,
    "locale": "en",
    "message": "Forbidden",
    "data": null
}

**Environemnt:Desktop (please complete the following information):

• Name and version of OS MacOS Catalina
• PHP version 7.3
• Laravel version 6.4.0

Additional context Now in this case it returns:

{
    "success": false,
    "code": 112,
    "locale": "en",
    "message": "HTTP exception Symfony\\Component\\HttpKernel\\Exception\\HttpException",
    "data": null
}

What's wrong? MarcinOrlowski\ResponseBuilder\Exceptions\IncompatibleTypeException Incompatible types. Cannot merge NULL into string (key 'key'). marcin-orlowski\laravel-api-response-builder\src\Util.php:46

Steps to reproduce the behavior:

1. Install new Laravel with "composer create-project laravel/laravel example-app"
2. Install this package with "composer require marcin-orlowski/laravel-api-response-builder"
3. Publish a configuration with "php artisan vendor:publish"
4. Edit a "collection converter" to use "key" as NULL
5. Create any sample API to return a convert with method "RB::success($items)"

Expected behavior Return a successful response without problem and without key

Runtime environment

• Name and version of OS: Windows 10
• PHP version: 7.4
• Laravel version: 8
• ResponseBuilder version used: 9.2.3

Notes The problem lines in MarcinOrlowski\ResponseBuilder\Util::mergeConfig(). The original configuration has a string type, where the actual environment wants NULL type. That is whey it will conflicts, the NULL for "key" configuration should be possible according to the document. I'm not personally sure how this should be handle but I am current do a quick work around by override a class myself without checking the type when merging.

• Big Surprise 💣
• convert tabs to spaces in source code
• move artworks to .github/
• add my default CI -> each check is a separate step
• introduce EditorConfig

Please hold on tight. Thank you.

diffs without whitespace changes: https://github.com/MarcinOrlowski/laravel-api-response-builder/pull/234/files?diff=unified&w=1

What is wrong?

Occassionally the exceptions are not fully rendered as the $handler = new $cfg[ RB::KEY_HANDLER ](); fails to work, as the array key "handler" is undefined?

This might be loosely linked to this existing issue: https://github.com/MarcinOrlowski/laravel-api-response-builder/issues/226

Steps to reproduce the behavior:

1. Follow the exception handler helper setup instructions
2. Occassionally for an unknown reason you will start to see receive: Undefined arrray key "handler"

Expected behavior

The exception should render.

Environment

• Name and version of OS: Happens locally (macOS) and other environments (Ubuntu)
• PHP version: 8.1
• Laravel version: 9
• ResponseBuilder version used: v9.1

Notes

Any additional information that may be helpful diagnosing the problem.

Would be great if you could also customize the key for the exceptions. For example we would want this:

{
    "success": false,
    "code": 115,
    "locale": "sv",
    "message": "The given data was invalid.",
    "data": {
        "messages": {
            "page": [
                "The page field is required."
            ]
        }
    },
}

to become like this below. But cant find any way to achieve this. Is this possible?

{
    "success": false,
    "code": 115,
    "locale": "sv",
    "message": "The given data was invalid.",
    "errors": {
        "messages": {
            "page": [
                "The page field is required."
            ]
        }
    },
}

I'm trying to create a validation error with this package. can you generate a new key for the error? I'm not comfortable entering validation error data into the key data.

{
    "success": false,
    "code": 422,
    "locale": "en",
    "message": "validation error, please check the input form",
    "data" : null,
    "errors": {
        "email": [
            "The email field is required."
        ],
        "password": [
            "The password field is required."
        ]
    }
}

LoginRequest.php
    protected function failedValidation(Validator $validator)
    {
        $response = RB::asError($apiCode)->withError($validator->errors()->toArray())->withMessage($msg)->build();
        throw new HttpResponseException($response);
    }

or more simply by adding a key parameter to replace the key data.
withData($errors, "errors")->build();

I have checked this

/** @var \Symfony\Component\HttpKernel\Exception\HttpException $ex */
$http_code = $ex->getStatusCode();

And $ex->getStatusCode() indeed returns 404, but at the same time, the final output has 500 status code. Here, I just opened a non-existent route:

I tried to implement your solution:

  \Symfony\Component\HttpKernel\Exception\HttpException::class => [
      'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class,
      'pri' => -100,
      'config' => [
          Symfony\Component\HttpFoundation\Response::HTTP_NOT_FOUND => [
              'http_code' => Symfony\Component\HttpFoundation\Response::HTTP_NOT_FOUND,
          ],

And after that, I receive this error whenever I try to access a wrong route:

{"success":false,"code":113,"locale":"en","message":"Undefined array key \u0022api_code\u0022","data":null,"debug":{"trace":{"class":"ErrorException","file":"\/var\/www\/api\/vendor\/marcin-orlowski\/laravel-api-response-builder\/src\/ExceptionHandlerHelper.php","line":104}}}

Originally posted by @beeyev in https://github.com/MarcinOrlowski/laravel-api-response-builder/discussions/225#discussioncomment-2238369