Merge pull request #40 from MarcinOrlowski/dev

Release 3.1.0

Author: MarcinOrlowski

CHANGES.md

@@ -6,6 +6,12 @@ See [compatibility docs](docs/compatibility.md) for details about backward compa
 
 ## CHANGE LOG ##
 
+* v3.1.0 (2017-02-28)
+   * [RB-38] Added `encoding-options` to control data-to-json conversion.
+   * [RB-38] Added optional encoding options args to all methods accepting `data` argument
+   * [RB-34] Added option to control ExceptionHandeler behavior on debug builds
+   * ExceptionHandler's debug is now added as `debug` node to make it more clear where it comes from
+
 * v3.0.3 (2017-02-24)
    * No changes. v3.0.2 was incorrectly released
 

composer.json

@@ -2,7 +2,7 @@
   "name": "marcin-orlowski/laravel-api-response-builder",
   "description": "Helps building nice, normalized and easy to consume REST API responses.",
   "homepage": "https://github.com/MarcinOrlowski/laravel-api-response-builder",
-  "version": "3.0.3",
+  "version": "3.1.0",
   "keywords": [
     "laravel",
     "json",

config/response_builder.php

@@ -84,6 +84,28 @@
 
 	],
 
+	/*
+	|--------------------------------------------------------------------------
+	| data-to-json encodong options
+	|--------------------------------------------------------------------------
+	|
+	| This controls data JSON encoding. Since 3.1, encoding was relying on
+	| framework defaults, however this caused valid UTF8 characters (i.e. accents)
+	| to be returned escaped, which while technically correct (ant theoretically
+	| transparent) might not be desired effects.
+	|
+	| To prevent escaping, add JSON_UNESCAPED_UNICODE:
+	|    JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT|JSON_UNESCAPED_UNICODE
+	|
+	| Default value:
+	|    JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT
+	|
+	| See http://php.net/manual/en/function.json-encode.php for details
+	|
+	*/
+	'encoding_options' => JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT,
+
+
 	/*
 	|--------------------------------------------------------------------------
 	| Exception handler error codes
@@ -131,4 +153,25 @@
 
 	],
 
+
+	/*
+	|--------------------------------------------------------------------------
+	| Debug config
+	|--------------------------------------------------------------------------
+	|
+	*/
+
+	'debug' => [
+		'exception_handler' => [
+			/**
+			 * When ExceptionHandler kicks in and this is set to @true (default),
+			 * then **if** your `app.debug` is `true` too, returned JSON structure
+			 * will contain `debug` node with additional exception base trace (class
+			 * name, file name, line number). If `app.debug` is anything but @true,
+			 * no debug info is added.
+			 */
+			'trace_enabled' => true,
+		],
+	],
+
 ];

src/ExceptionHandlerHelper.php

@@ -65,8 +65,10 @@ public static function render($request, Exception $exception)
 	protected static function error(Exception $exception, $exception_type,
 	                                $default_api_code, $default_http_code = HttpResponse::HTTP_BAD_REQUEST)
 	{
-		$api_code = Config::get("response_builder.exception_handler.exception.{$exception_type}.code", $default_api_code);
-		$http_code = Config::get("response_builder.exception_handler.exception.{$exception_type}.http_code", 0);
+		$base_config = 'response_builder.exception_handler.exception';
+
+		$api_code = Config::get("{$base_config}.{$exception_type}.code", $default_api_code);
+		$http_code = Config::get("{$base_config}.{$exception_type}.http_code", 0);
 
 		// check if this is valid HTTP error code
 		if ($http_code === 0) {
@@ -92,15 +94,16 @@ protected static function error(Exception $exception, $exception_type,
 
 		$data = [];
 		if (Config::get('app.debug')) {
-			$data = [
-				'class' => get_class($exception),
-				'file'  => $exception->getFile(),
-				'line'  => $exception->getLine(),
-			];
+			if (Config::get('response_builder.debug.exception_handler.trace_enabled', true)) {
+				$data = ['debug' => [
+					'class' => get_class($exception),
+					'file'  => $exception->getFile(),
+					'line'  => $exception->getLine(),
+				]];
+			}
 		}
 
 		// let's figure out what event we are handling now
-		$base_config = 'response_builder.exception_handler.exception';
 		if (Config::get("{$base_config}.http_not_found.code", ApiCodeBase::EX_HTTP_NOT_FOUND) === $api_code) {
 			$base_api_code = ApiCodeBase::EX_HTTP_NOT_FOUND;
 		} elseif (Config::get("{$base_config}.http_service_unavailable.code", ApiCodeBase::EX_HTTP_SERVICE_UNAVAILABLE) === $api_code) {
@@ -131,7 +134,6 @@ protected static function error(Exception $exception, $exception_type,
 
 		if ($error_message === '') {
 			$error_message = Lang::get($key, [
-				'error_code' => $api_code,      // LEGACY!
 				'api_code' => $api_code,
 				'message'    => $ex_message,
 				'class'      => get_class($exception),