Merge pull request #69 from MarcinOrlowski/dev

Release 4.0.2

Author: MarcinOrlowski

CHANGES.md

@@ -4,6 +4,11 @@ See [compatibility docs](docs/compatibility.md) for details about backward compa
 
 ## CHANGE LOG ##
 
+* v4.0.2 (2017-04-13)
+   * Enforced HTTP code for error messages fits 400-499 range
+   * `validateResponseStructure()` deprecated in favor of `assertValidResponse()` 
+   * Moved Orchestra's `getPackageProviders()` out of `TestingHelpers` trait
+
 * v4.0.1 (2017-04-10)
    * TestingHelpers trait's `validateResponseStructure()` method is now public
    * [RB-64] Fixed Exception Handler generated HTTP code being out of allowed range in some cases

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": "4.0.1",
+  "version": "4.0.2",
   "keywords": [
     "laravel",
     "json",

docs/testing.md

@@ -3,7 +3,6 @@
 `ResponseBuilder` is [Laravel](https://laravel.com/)'s helper designed to simplify building
 nice, normalized and easy to consume REST API responses.
 
-
 ## Unit testing your ApiCodes ##
 
 `ResponseBuilder` ships with traits that you can use to ensure your ApiCodes class and its values
@@ -51,3 +50,33 @@ and its namespace is `App`.
 
 
  And that's it. From now on, you have your `ApiCodes` covered with tests too.
+
+
+## Testing other code using ResponseBuilder ##
+
+ If you want to test other code that uses response builder, then there provided traits can also be 
+ helpful. Let's say your Laravel API exposes `/v1/session/foo` which is expected to return some
+ data. Let's test the response structure and data:
+ 
+    <?php
+    
+    use MarcinOrlowski\ResponseBuilder\Tests\Traits\TestingHelpers;
+    class LoginTest extends \Illuminate\Foundation\Testing\TestCase
+    {
+        use TestingHelpers;
+        
+        public function testLogin()
+        {
+            // call your method
+            $response = $this->call('POST', '/v1/session/foo');
+            
+            // get the JSON object
+            $j = json_decode($response->getContent());
+            
+            // validate JSON structure matches what ResponseBuilder produced
+            $this->assertValidResponse($j);
+            
+            // some other tests of your choice
+            $this->assertTrue($j->success);
+        }
+    }

src/ResponseBuilder.php

@@ -428,8 +428,8 @@ protected static function buildErrorResponse($data, $api_code, $http_code, $lang
 		if (!is_int($http_code)) {
 			throw new \InvalidArgumentException(sprintf('http_code must be integer (%s given)', gettype($http_code)));
 		}
-		if ($http_code < 400) {
-			throw new \InvalidArgumentException('http_code cannot be lower than 400');
+		if (($http_code < 400) || ($http_code > 499)) {
+			throw new \InvalidArgumentException('http_code must be in range from 400 to 499 inclusive');
 		}
 
 		if ($message === null) {

tests/TestCase.php

@@ -24,4 +24,21 @@ public function getApiCodesClassName()
 		return \MarcinOrlowski\ResponseBuilder\BaseApiCodes::class;
 	}
 
+
+	// -----------------------------------------------------------
+
+	/**
+	 * [Orchestra] Load service providers we need during the tests
+	 *
+	 * @param \Illuminate\Foundation\Application $app
+	 *
+	 * @return array
+	 */
+	protected function getPackageProviders($app)
+	{
+		return [
+			\MarcinOrlowski\ResponseBuilder\Tests\Providers\ResponseBuilderServiceProvider::class,
+		];
+	}
+
 }

tests/Traits/TestingHelpers.php

@@ -19,7 +19,8 @@
 /**
  * Unit test helper trait
  */
-trait TestingHelpers {
+trait TestingHelpers
+{
 
 	/**
 	 * @return string
@@ -62,8 +63,6 @@ public function setUp()
 	{
 		parent::setUp();
 
-		$this->clearCache();
-
 		// Obtain configuration params
 		$class_name = $this->getApiCodesClassName();
 		$obj = new $class_name();
@@ -82,7 +81,7 @@ public function setUp()
 		$map = $this->getProtectedMember(\MarcinOrlowski\ResponseBuilder\BaseApiCodes::class, 'base_map');
 		$idx = mt_rand(1, count($map));
 
-		$this->random_api_code_message_key = $map[array_keys($map)[$idx-1]];
+		$this->random_api_code_message_key = $map[ array_keys($map)[ $idx - 1 ] ];
 		$this->random_api_code_message = \Lang::get($this->random_api_code_message_key, [
 			'api_code' => $this->random_api_code,
 		]);
@@ -93,31 +92,6 @@ public function setUp()
 	}
 
 
-	/**
-	 * Clears Laravel config/route etc caches...
-	 */
-	protected function clearCache()
-	{
-//		$commands = ['clear-compiled', 'cache:clear', 'view:clear', 'config:clear', 'route:clear'];
-//		foreach ($commands as $command) {
-//			\Illuminate\Support\Facades\Artisan::call($command);
-//		}
-	}
-
-	/**
-	 * Load service providers we need during the tests
-	 *
-	 * @param \Illuminate\Foundation\Application $app
-	 *
-	 * @return array
-	 */
-	protected function getPackageProviders($app)
-	{
-		return [
-			\MarcinOrlowski\ResponseBuilder\Tests\Providers\ResponseBuilderServiceProvider::class,
-		];
-	}
-
 	// -----------------------------------------------------------
 
 
@@ -230,6 +204,21 @@ private function getResponseObjectRaw($expected_api_code, $expected_http_code, $
 	}
 
 
+	/**
+	 * Use assertValidResponse() instead
+	 *
+	 * @param StdClass $json_object
+	 * @param array    $extra_keys
+	 *
+	 * @return void
+	 *
+	 * @deprecated Use assertValidResponse() instead
+	 */
+	public function validateResponseStructure($json_object, array $extra_keys = [])
+	{
+		$this->assertValidResponse($json_object, $extra_keys);
+	}
+
 	/**
 	 * Validates if given $json_object contains all expected elements
 	 *
@@ -238,7 +227,7 @@ private function getResponseObjectRaw($expected_api_code, $expected_http_code, $
 	 *
 	 * @return void
 	 */
-	public function validateResponseStructure($json_object, array $extra_keys = [])
+	public function assertValidResponse($json_object, array $extra_keys = [])
 	{
 		$this->assertTrue(is_object($json_object));
 
@@ -260,7 +249,7 @@ public function validateResponseStructure($json_object, array $extra_keys = [])
 			$this->assertObjectHasAttribute($item, $json_object, "No '{$item}' element in response structure found");
 		}
 
-		$this->assertTrue(is_bool($json_object->{$items[ResponseBuilder::KEY_SUCCESS]}));
+		$this->assertTrue(is_bool($json_object->{$items[ ResponseBuilder::KEY_SUCCESS ]}));
 		$this->assertTrue(is_int($json_object->code));
 		$this->assertTrue(is_string($json_object->locale));
 		/** @noinspection UnNecessaryDoubleQuotesInspection */
@@ -484,5 +473,4 @@ protected function escape8($string)
 		return $escaped;
 	}
 
-
 }