Merge pull request #45 from MarcinOrlowski/dev

MarcinOrlowski · web-flow · commit 0e58d7fd5b70 · 2017-03-02T17:30:35.000+01:00
Release v3.2.0
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,13 +1,15 @@
 # API Response Builder for Laravel 5 #
 
-
 See [compatibility docs](docs/compatibility.md) for details about backward compatibility!
 
-
 ## CHANGE LOG ##
 
+* v3.2.0 (2017-03-02)
+   * [RB-42] Default value of `encoding_options` include `JSON_UNESCAPED_UNICODE` to prevent unicode escaping
+   * [RB-41] Updated documentation
+
 * v3.1.0 (2017-02-28)
-   * [RB-38] Added `encoding-options` to control data-to-json conversion.
+   * [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
@@ -106,3 +108,4 @@ See [compatibility docs](docs/compatibility.md) for details about backward compa
 
 * v1.0.0 (2016-04-11)
    * Initial public release
+
diff --git a/composer.json b/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.1.0",
+  "version": "3.2.0",
   "keywords": [
     "laravel",
     "json",
diff --git a/config/response_builder.php b/config/response_builder.php
@@ -94,16 +94,16 @@
 	| to be returned escaped, which while technically correct (ant theoretically
 	| transparent) might not be desired effects.
 	|
-	| To prevent escaping, add JSON_UNESCAPED_UNICODE:
+	| To prevent escaping, add JSON_UNESCAPED_UNICODE (default since v3.2):
 	|    JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT|JSON_UNESCAPED_UNICODE
 	|
-	| Default value:
+	| Laravel's 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,
+	'encoding_options' => JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT|JSON_UNESCAPED_UNICODE,
 
 
 	/*
diff --git a/docs/docs.md b/docs/docs.md
@@ -228,6 +228,7 @@ Methods' arguments:
  * `$http_code` (**int**) valid HTTP return code (see `HttpResponse` class for useful constants),
  * `$lang_args` (**array**) array of arguments passed to `Lang::get()` while building `message`,
  * `$message` (**string**) custom message to be returned as part of error response (avoid, use error code mapping feature).
+ * `$encoding_options` (**int**) data-to-json conversion options as [described in documentation of json_encode()](http://php.net/manual/en/function.json-encode.php). Pass `null` for default `ResponseBuilder::DEFAULT_ENCODING_OPTIONS` ([source](https://github.com/MarcinOrlowski/laravel-api-response-builder/blob/master/src/ResponseBuilder.php#L47)). See [configuration](https://github.com/MarcinOrlowski/laravel-api-response-builder/blob/master/config/response_builder.php#L106) key `encoding_options` too!  
 
 Most arguments of `success()` and `error()` methods are optional, with exception for `$api_code`
 for the latter. Helper methods arguments are partially optional - see signatures below for details.
@@ -253,8 +254,8 @@ See [W3 specs page](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html) for
 
 #### Reporting Success ####
 
-    success($data = null, $api_code = null, array $lang_args = [], $http_code = null);
-    successWithCode($api_code = null, array $lang_args = [], $http_code = null);
+    success($data=null, $api_code=null, array $lang_args=[], $http_code=null, $encoding_options=null);
+    successWithCode($api_code=null, array $lang_args=[], $http_code=null);
     successWithHttpCode($http_code);
 
 Usage restrictions:
@@ -263,11 +264,11 @@ Usage restrictions:
 
 #### Reporting Error ####
 
-    error($api_code, $lang_args = [], $data = null, $http_code = HttpResponse::HTTP_BAD_REQUEST);
-    errorWithData($api_code, $data, array $lang_args = []);
-    errorWithDataAndHttpCode($api_code, $data, $http_code, array $lang_args = []);
-    errorWithHttpCode($api_code, $http_code, $lang_args = []);
-    errorWithMessage($api_code, $error_message, $http_code = HttpResponse::HTTP_BAD_REQUEST);
+    error($api_code, $lang_args=[], $data=null, $http_code=HttpResponse::HTTP_BAD_REQUEST);
+    errorWithData($api_code, $data, array $lang_args=[], $encoding_options=null);
+    errorWithDataAndHttpCode($api_code, $data, $http_code, array $lang_args=[], $encoding_options=null);
+    errorWithHttpCode($api_code, $http_code, $lang_args=[]);
+    errorWithMessage($api_code, $error_message, $http_code=HttpResponse::HTTP_BAD_REQUEST);
 
 Usage restrictions:
 
diff --git a/src/ResponseBuilder.php b/src/ResponseBuilder.php
@@ -40,11 +40,11 @@ class ResponseBuilder
 	/**
 	 * Default JSON encoding options
 	 *
-	 * 15 = JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT
+	 * 271 = JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT|JSON_UNESCAPED_UNICODE
 	 *
 	 * This must be as int due to const limits in PHP disallowing expressions.
 	 */
-	const DEFAULT_ENCODING_OPTIONS = 15;
+	const DEFAULT_ENCODING_OPTIONS = 271;
 
 	/**
 	 * Reads and validates "classes" config mapping
diff --git a/tests/InternalsTest.php b/tests/InternalsTest.php
@@ -69,13 +69,14 @@ public function testMake_InvalidEncodingOptions()
 	}
 
 	/**
-	 * Tests if JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT matches const value of DEFAULT_ENODING_OPTIONS
+	 * Tests if dist's config detaults matches ResponseBuilder::DEFAULT_ENODING_OPTIONS
 	 *
 	 * @return void
 	 */
 	public function testDefaultEncodingOptionValue()
 	{
-		$this->assertEquals(JSON_HEX_TAG|JSON_HEX_APOS|JSON_HEX_AMP|JSON_HEX_QUOT, ResponseBuilder::DEFAULT_ENCODING_OPTIONS);
+		$config_defaults = \Config::get('response_builder.encoding_options');
+		$this->assertEquals($config_defaults, ResponseBuilder::DEFAULT_ENCODING_OPTIONS);
 	}
 
 	/**
@@ -87,7 +88,7 @@ public function testMake_DefaultEncodingOptions()
 	{
 		// source data
 		$test_string = 'ąćę';
-		$test_string_escaped = $this->escape8($test_string);
+//		$test_string_escaped = $this->escape8($test_string);
 		$data = ['test' => $test_string];
 
 		// fallback defaults in action

Original file line number	Diff line number	Diff line change
`@@ -94,16 +94,16 @@`
`94`	`94`	`\| to be returned escaped, which while technically correct (ant theoretically`
`95`	`95`	`\| transparent) might not be desired effects.`
`96`	`96`	`\|`
`97`		`- \| To prevent escaping, add JSON_UNESCAPED_UNICODE:`
	`97`	`+ \| To prevent escaping, add JSON_UNESCAPED_UNICODE (default since v3.2):`
`98`	`98`	`\| JSON_HEX_TAG\|JSON_HEX_APOS\|JSON_HEX_AMP\|JSON_HEX_QUOT\|JSON_UNESCAPED_UNICODE`
`99`	`99`	`\|`
`100`		`- \| Default value:`
	`100`	`+ \| Laravel's value:`
`101`	`101`	`\| JSON_HEX_TAG\|JSON_HEX_APOS\|JSON_HEX_AMP\|JSON_HEX_QUOT`
`102`	`102`	`\|`
`103`	`103`	`\| See http://php.net/manual/en/function.json-encode.php for details`
`104`	`104`	`\|`
`105`	`105`	`*/`
`106`		`- 'encoding_options' => JSON_HEX_TAG\|JSON_HEX_APOS\|JSON_HEX_AMP\|JSON_HEX_QUOT,`
	`106`	`+ 'encoding_options' => JSON_HEX_TAG\|JSON_HEX_APOS\|JSON_HEX_AMP\|JSON_HEX_QUOT\|JSON_UNESCAPED_UNICODE,`
`107`	`107`
`108`	`108`
`109`	`109`	`/*`
Original file line number	Diff line number	Diff line change
`@@ -40,11 +40,11 @@ class ResponseBuilder`
`40`	`40`	`/**`
`41`	`41`	`* Default JSON encoding options`
`42`	`42`	`*`
`43`		`- * 15 = JSON_HEX_TAG\|JSON_HEX_APOS\|JSON_HEX_AMP\|JSON_HEX_QUOT`
	`43`	`+ * 271 = JSON_HEX_TAG\|JSON_HEX_APOS\|JSON_HEX_AMP\|JSON_HEX_QUOT\|JSON_UNESCAPED_UNICODE`
`44`	`44`	`*`
`45`	`45`	`* This must be as int due to const limits in PHP disallowing expressions.`
`46`	`46`	`*/`
`47`		`- const DEFAULT_ENCODING_OPTIONS = 15;`
	`47`	`+ const DEFAULT_ENCODING_OPTIONS = 271;`
`48`	`48`
`49`	`49`	`/**`
`50`	`50`	`* Reads and validates "classes" config mapping`
Original file line number	Diff line number	Diff line change
`@@ -69,13 +69,14 @@ public function testMake_InvalidEncodingOptions()`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`/**`
`72`		`- * Tests if JSON_HEX_TAG\|JSON_HEX_APOS\|JSON_HEX_AMP\|JSON_HEX_QUOT matches const value of DEFAULT_ENODING_OPTIONS`
	`72`	`+ * Tests if dist's config detaults matches ResponseBuilder::DEFAULT_ENODING_OPTIONS`
`73`	`73`	`*`
`74`	`74`	`* @return void`
`75`	`75`	`*/`
`76`	`76`	`public function testDefaultEncodingOptionValue()`
`77`	`77`	`{`
`78`		`- $this->assertEquals(JSON_HEX_TAG\|JSON_HEX_APOS\|JSON_HEX_AMP\|JSON_HEX_QUOT, ResponseBuilder::DEFAULT_ENCODING_OPTIONS);`
	`78`	`+ $config_defaults = \Config::get('response_builder.encoding_options');`
	`79`	`+ $this->assertEquals($config_defaults, ResponseBuilder::DEFAULT_ENCODING_OPTIONS);`
`79`	`80`	`}`
`80`	`81`
`81`	`82`	`/**`
`@@ -87,7 +88,7 @@ public function testMake_DefaultEncodingOptions()`
`87`	`88`	`{`
`88`	`89`	`// source data`
`89`	`90`	`$test_string = 'ąćę';`
`90`		`- $test_string_escaped = $this->escape8($test_string);`
	`91`	`+// $test_string_escaped = $this->escape8($test_string);`
`91`	`92`	`$data = ['test' => $test_string];`
`92`	`93`
`93`	`94`	`// fallback defaults in action`