Merge branch 'release/1.1.0'

Author: oniice

.gitignore

@@ -0,0 +1,4 @@
+vendor
+coverage
+composer.lock
+.phpunit.result.cache

README.md

@@ -1,10 +1,12 @@
 # Laravel API Response
-> A fluent helper class to ensure idempotent API responses in Laravel and Lumen
+> A fluent helper to provide a consistent shaped API responses in Laravel
 
 [![Latest Stable Version](https://poser.pugx.org/myerscode/laravel-api-response/v/stable)](https://packagist.org/packages/myerscode/laravel-api-response)
 [![Total Downloads](https://poser.pugx.org/myerscode/laravel-api-response/downloads)](https://packagist.org/packages/myerscode/laravel-api-response)
 [![License](https://poser.pugx.org/myerscode/laravel-api-response/license)](https://packagist.org/packages/myerscode/laravel-api-response)
 
+## Why is this package helpful?
+
 This package ensures your API will always return the same envelope shape, so consuming apps always know what to expect!
 
 ## Install
@@ -17,18 +19,31 @@ composer require myerscode/laravel-api-response
 
 ## Usage
 
-When using a Laravel controller you can simply return a chained `Builder` from the `api()` helper, 
-as it implements the [Responsable](https://laravel.com/api/master/Illuminate/Contracts/Support/Responsable.html) trait.
+In a Laravel controller you just to build up your response and return it! 
 
-```php
+The `api()` helper return a Response `Builder` and as it implements the [Responsable](https://laravel.com/api/master/Illuminate/Contracts/Support/Responsable.html) 
+trait you dont need to do anything more than return the builder
 
-function handler()
+### Using the api() helper function
+```php
+function resource()
 {
     return api()->status(201)->data(['name' => 'Foo Bar'])->message('Record Created!');
 }
 ```
 
-Would return the following `JSON`
+### Using a Builder class
+```php
+
+function resource() {
+    $buillder = new Builder();
+    $builder->status(201)->data(['name' => 'Foo Bar'])->message('Record Created!');
+    return $builder;
+}
+```
+
+
+Would return the following `JSON` response.
 
 ```json
 {
@@ -43,9 +58,6 @@ Would return the following `JSON`
 }
 ```
 
-You can alternatively call `api()->respond()` to get a `JsonResponse`
-
-
 ## License
 
-The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -25,10 +25,11 @@
     }
   ],
   "require": {
-    "php": ">=7.0"
+    "php": "^7.1"
   },
   "require-dev": {
-    "phpunit/phpunit": "^6.0"
+    "orchestra/testbench": "~3.6.0",
+    "phpunit/phpunit": "^7.3"
   },
   "autoload": {
     "psr-4": {

phpunit.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         cacheResult="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <logging>
+        <log type="coverage-html" target="./coverage/coverage"/>
+        <log type="testdox-html" target="./coverage/tests.html"/>
+        <log type="coverage-clover" target="./coverage/coverage.xml"/>
+    </logging>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src/</directory>
+            <exclude>
+            </exclude>
+        </whitelist>
+    </filter>
+    <php>
+    </php>
+</phpunit>

src/Builder.php

@@ -34,6 +34,16 @@ public function fresh(): Builder
         return $this;
     }
 
+    /**
+     * Return the set response body
+     *
+     * @return Body
+     */
+    public function body()
+    {
+        return $this->body;
+    }
+
     /**
      * Set the api data response
      *

tests/BodyTest.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Tests;
+
+use Illuminate\Database\Eloquent\JsonEncodingException;
+use Myerscode\Laravel\ApiResponse\Body;
+
+class BodyTest extends TestCase
+{
+
+    public function provider()
+    {
+        return [
+            [200, [], [], []],
+        ];
+    }
+
+
+    /**
+     * @dataProvider provider
+     */
+    public function testResponsePropertiesAreSet($status, $data, $messages, $meta)
+    {
+        $body = new Body();
+        $body->setStatus(($status))->setData($data)->setMessages($messages)->setMeta($meta);
+
+        $this->assertEquals($status, $body->getStatus());
+        $this->assertEquals($data, $body->getData());
+        $this->assertEquals($messages, $body->getMessages());
+        $this->assertEquals($meta, $body->getMeta());
+    }
+
+    public function testAddMessageToBody()
+    {
+        $body = new Body();
+        $body->addMessage(('Hello World'));
+
+        $this->assertEquals(['Hello World'], $body->getMessages());
+    }
+
+
+    /**
+     * @dataProvider provider
+     */
+    public function testBodyConvertedToJson($status, $data, $messages, $meta)
+    {
+        $body = new Body();
+        $body->setStatus(($status))->setData($data)->setMessages($messages)->setMeta($meta);
+
+        $this->assertJson($body->toJson());
+    }
+}

tests/BuilderTest.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Tests;
+
+class BuilderTest extends TestCase
+{
+
+    public function provider()
+    {
+        return [
+            [200, [], [], []],
+        ];
+    }
+
+
+    /**
+     * @dataProvider provider
+     */
+    public function testResponsePropertiesAreSet($status, $data, $messages, $meta)
+    {
+        $builder = api()->status($status)->data($data)->messages($messages)->meta($meta);
+
+        $this->assertEquals($status, $builder->body()->getStatus());
+        $this->assertEquals($data, $builder->body()->getData());
+        $this->assertEquals($messages, $builder->body()->getMessages());
+        $this->assertEquals($meta, $builder->body()->getMeta());
+    }
+
+    public function testAddMessageToResponse()
+    {
+        $builder = api()->message('Hello World');
+
+        $this->assertEquals(['Hello World'], $builder->body()->getMessages());
+    }
+
+}

tests/RespondTest.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Tests;
+
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+use Myerscode\Laravel\ApiResponse\Builder;
+
+class RespondTest extends TestCase
+{
+
+    public function testHelperMakesBuilder()
+    {
+        $this->assertInstanceOf(Builder::class, api());
+    }
+
+    public function testRespondCreatesJsonResponse()
+    {
+        $this->assertInstanceOf(JsonResponse::class, api()->respond());
+        $this->assertInstanceOf(JsonResponse::class,  api()->toResponse( new Request()));
+    }
+
+
+
+}

tests/TestCase.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Tests;
+
+use Orchestra\Testbench\TestCase as Orchestra;
+
+class TestCase extends Orchestra
+{
+
+}