Merge pull request #165 from MarcinOrlowski/dev

Release 9.0.1

Author: MarcinOrlowski

CHANGES.md

@@ -8,6 +8,10 @@ before doing major upgrade!
 
 ## CHANGE LOG ##
 
+* v9.0.1 (2020-10-22)
+   * Fixed failing `ServiceProvider` (reported by Efriandika Pratama).
+   * Corrected documentation and usage examples.
+
 * v9.0.0 (2020-10-17)
    * **BACKWARD INCOMPATIBLE CHANGES** ([more info](docs/compatibility.md))
    * [RB-156] Added logic to deal with directly returned objects or arrays.

composer.json

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

docs/docs.md

@@ -114,7 +114,7 @@
 
 ### Builder ###
 
-To obtain instance of the Builder, two static methods: `asSuccess()` and `asError()` are now exposed. For example, the following
+ There are two static methods that return instance of the Builder: `asSuccess()` and `asError()`. For example, the following
  code would return response indicating a success, with additional data and custom HTTP code:
 
 ```php
@@ -124,19 +124,8 @@ return RB::asSuccess()
       ->build();
 ```
 
- For simplicity of use, it's recommended to add the following `use` to your code:
-
-```php
-use MarcinOrlowski\ResponseBuilder\ResponseBuilder as RB;
-```
-
- If you dislike typing `ResponseBuilder` you can use [namespace aliasing](https://www.php.net/manual/en/language.namespaces.importing.php):
-
-```php
-use MarcinOrlowski\ResponseBuilder\ResponseBuilder as RB;
-```
-
- Then use short form in your code:
+ Naturally, if you just need to return success without any payload, just call `success()` as you would have in previous
+ versions:
 
 ```php
 return RB::success();
@@ -169,7 +158,7 @@ return RB::success();
    response `message` based on localization files (as configured in i.e. `map`) or strings with placeholders.
  * `withHttpHeaders($headers)`
 
- Once all is arguments are passed, call `build()` to conclude building and have final `HttpResponse` object returned.
+ Once all the arguments are passed, call `build()` to have final `HttpResponse` object returned.
 
  **IMPORTANT:** To enforce constant JSON structure of the response, `data` node is always an JSON object, therefore passing
  anything but `object` or `array` to `withData()` would trigger internal type casting. There's no smart logic here, just

docs/examples.md

@@ -7,6 +7,7 @@
 
 ## Table of contents ##
 
+
  * [Usage examples](#usage-examples)
    * [Use clause](#use-clause)
    * [Success](#success)
@@ -17,20 +18,15 @@
 ## Usage examples ##
 
  The following examples assume `ResponseBuilder` is properly installed and available to your Laravel application.
- Installation steps are described in details in further chapters, if help is needed.
+ See [Installation and Configuration](docs.md#installation-and-configuration) for more details.
 
 ### Use clause ###
 
- The library is namespaced, so to simplify the use cases, it's recommended to add propr `use` at the beginning
- of your controller to "import" `Builder` class:
-
-```php
-use MarcinOrlowski\ResponseBuilder\ResponseBuilder as RB;
-```
+ Basic, and mosts common usage examples.
 
 #### Success ####
 
- To report response indicating i.e. operation success, simply your Controller method with:
+ To create response indicating operation success, simply conclude your Controller method with:
 
 ```php
 return RB::success();
@@ -48,14 +44,15 @@ return RB::success();
 }
 ```
 
- If you would like to return some data with it (which pretty much always the case :), pass it to `success()` as argument:
+ If you would like to return some data in your response, which is pretty much always the case for success type of responses:), pass  
+ your payload as `success()`'s argument:
 
 ```php
 $data = [ 'foo' => 'bar' ];
 return RB::success($data);
 ```
 
- which would return:
+ This which would produce:
 
 ```json
 {
@@ -69,17 +66,12 @@ return RB::success($data);
 }
 ```
 
- **NOTE:** As all the data in the response structure must be represented in JSON, `ResponseBuilder` only accepts certain types of
- data - you can either pass an `array` or object of any class that can be converted to valid JSON (i.e. Eloquent's Model or
- Collection). Data conversion goes on-the-fly, if you need any additional classes supported than said Model or Collection (which
- are pre-configured), you need to instruct `ResponseBuilder` how to deal with it. See [Data Conversion](#data-conversion) chapter
- for more details. Attempt to pass unsupported data type (i.e. literals) will throw the exception.
+ **NOTE:** As all the data in the response structure must strictly follow response structure and end up in form os valid JSON data.
+ `ResponseBuilder` deals with all the primitives and most commonly used classes, using on-the-fly data conversion. You can easily
+ add own converters if none of built-in handles your data or fits your needs.See [Data Conversion](#data-conversion) chapter details.
 
- **IMPORTANT:** `data` node is **always** an JSON Object. This is **enforced** by the library design, therefore if you need to
- return your data array as array and just its elements as shown in above example, it will be wrapped into additional array:
 
 ```php
-// this is CORRECT
 $returned_array = [1,2,3];
 return RB::success($data);
 ```
@@ -93,26 +85,6 @@ return RB::success($data);
       "items": [1, 2, 3]
    }
 }
-```
-
- **IMPORTANT:** If provided array has at least one non numeric index, then wrapping will not occur:
-
-```php
-// this is WRONG
-$returned_array = ['foo' => 1, 'bar' => 2];
-return RB::success($returned_array);
-```
-
-would give you `data` structure:
-
-```json
-{
-  ...
-  "data": {
-     "foo": 1,
-     "bar": 2
-  }
-}
 ```
 
 #### Errors ####

src/ResponseBuilderServiceProvider.php

@@ -3,7 +3,7 @@
  * Disable return type hint inspection as we do not have it specified in that
  * class for a purpose. The base class is also not having return type hints.
  *
- * @noinspection ReturnTypeCanBeDeclaredInspection
+ * @noinspection RAeturnTypeCanBeDeclaredInspection
  */
 
 declare(strict_types=1);
@@ -37,7 +37,7 @@ class ResponseBuilderServiceProvider extends ServiceProvider
     public function register()
     {
         foreach ($this->config_files as $file) {
-            $this->mergeConfigFrom(__DIR__ . "/../config/{$file}", RB::CONF_CONFIG);
+            $this->mergeConfigFrom(__DIR__ . "/../config/{$file}", ResponseBuilder::CONF_CONFIG);
         }
     }