Improve ResponseException title #9 (#10)

* Improve ResponseException title #9

Fix slim exception response
Add coveralls
Fix lint errors

CHANGELOG.md

@@ -0,0 +1,2 @@
+## 2.0.0
+- Add AbstractEndpoint, to allow extending Endpoint class 

README.md

@@ -1,6 +1,10 @@
 # jsonapi-client
 JSONAPI client, helps creating SDK to consume your JSON RESTful APIs
 
+[![Build Status](https://travis-ci.org/phramework/jsonapi-client.svg?branch=2.x)](https://travis-ci.org/phramework/jsonapi-client)
+
+[![Coverage Status](https://coveralls.io/repos/github/phramework/jsonapi-client/badge.svg?branch=2.x)](https://coveralls.io/github/phramework/jsonapi-client?branch=2.x)
+
 ## Usage
 Require package using composer
 ```bash

composer.json

@@ -23,10 +23,12 @@
   },
   "require-dev": {
     "squizlabs/php_codesniffer": "*",
+    "satooshi/php-coveralls": "^1.0",
     "phpunit/phpunit": "5.*",
     "slim/slim": "^3.0",
     "ext-pdo_sqlite": "*",
-    "oscarotero/psr7-middlewares": "^3.16"
+    "oscarotero/psr7-middlewares": "^3.16",
+    "codacy/coverage": "^1.0"
   },
   "minimum-stability": "dev",
   "prefer-stable": true,

src/AbstractEndpoint.php

@@ -1,5 +1,5 @@
 <?php
-namespace Phramework\JSONAPI\Client;
+declare(strict_types=1);
 /*
  * Copyright 2016-2017 Xenofon Spafaridis
  *
@@ -15,6 +15,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+namespace Phramework\JSONAPI\Client;
+
 use Phramework\JSONAPI\Client\Directive\Directive;
 use Phramework\JSONAPI\Client\Exceptions\ResponseException;
 use Phramework\JSONAPI\Client\Response\Collection;
@@ -30,7 +32,7 @@ abstract class AbstractEndpoint
      * @return Collection
      * @throws ResponseException
      */
-    public abstract function get(
+    abstract public function get(
         Directive ...$directives
     ) : Collection;
 
@@ -40,7 +42,7 @@ public abstract function get(
      * @return JSONAPIResource
      * @throws ResponseException
      */
-    public abstract function getById(
+    abstract public function getById(
         string $id,
         Directive ...$directives
     ) : JSONAPIResource;
@@ -52,7 +54,7 @@ public abstract function getById(
      * @return JSONAPIResource
      * @throws ResponseException
      */
-    public abstract function post(
+    abstract public function post(
         \stdClass $attributes = null,
         RelationshipsData  $relationships = null,
         Directive ...$directives
@@ -66,7 +68,7 @@ public abstract function post(
      * @return JSONAPIResource
      * @throws ResponseException
      */
-    public abstract function patch(
+    abstract public function patch(
         string $id,
         \stdClass $attributes = null,
         RelationshipsData  $relationships = null,
@@ -81,7 +83,7 @@ public abstract function patch(
      * @return JSONAPIResource
      * @throws ResponseException
      */
-    public abstract function delete(
+    abstract public function delete(
         string $id,
         \stdClass $attributes = null,
         RelationshipsData  $relationships = null,
@@ -96,7 +98,7 @@ public abstract function delete(
      * @return JSONAPIResource
      * @throws ResponseException
      */
-    public abstract function put(
+    abstract public function put(
         string $id,
         \stdClass $attributes = null,
         RelationshipsData  $relationships = null,

src/Directive/Directive.php

@@ -27,7 +27,8 @@ abstract class Directive
     /**
      * @return string
      */
-    public function getURL(): string {
+    public function getURL(): string
+    {
         return '';
     }
 

src/Directive/Page.php

@@ -87,4 +87,4 @@ public function getLimit()
     {
         return $this->limit;
     }
-}
+}

src/Endpoint/Get.php

@@ -72,4 +72,4 @@ public function get(
 
         return (new Collection($response));
     }
-}
+}

src/Exceptions/ResponseException.php

@@ -36,9 +36,18 @@ class ResponseException extends \Exception
      */
     public function __construct(Errors $errors)
     {
-        $this->errors = $errors;
+        $title = 'Response exception';
+
+        if (isset(
+            $errors->getErrors()[0],
+            $errors->getErrors()[0]->title
+        )) {
+            $title = $errors->getErrors()[0]->title;
+        }
 
-        parent::__construct('Response exception');
+        parent::__construct($title);
+
+        $this->errors = $errors;
     }
 
     /**

src/Response/Collection.php

@@ -82,4 +82,4 @@ public function offsetGet($offset)
     {
         return isset($this->data[$offset]) ? $this->data[$offset] : null;
     }
-}
+}

src/Response/Errors.php

@@ -18,6 +18,7 @@
 namespace Phramework\JSONAPI\Client\Response;
 
 use Phramework\JSONAPI\Client\Error;
+use Psr\Http\Message\ResponseInterface;
 
 /**
  * @author Xenofon Spafaridis <nohponex@gmail.com>
@@ -31,6 +32,13 @@ class Errors extends Response
      */
     protected $errors;
 
+    public function __construct(ResponseInterface $response)
+    {
+        $this->errors = [];
+
+        parent::__construct($response);
+    }
+
     /**
      * @return \Phramework\JSONAPI\Client\Error[]
      */

src/Response/Response.php

@@ -51,7 +51,6 @@ public function __construct(ResponseInterface $response)
         $body = json_decode($response->getBody()->getContents());
 
         if ($body) {
-
             $members = array_keys(get_object_vars($this));
 
             foreach ($members as $member) {

tests/src/Endpoint/BaseEndpoint.php → tests/APP/BaseEndpoint.php

@@ -15,10 +15,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-namespace Phramework\JSONAPI\Client;
+namespace Phramework\JSONAPI\APP;
 
 use Phramework\JSONAPI\Client\Directive\IncludeRelationship;
 use Phramework\JSONAPI\Client\Directive\Page;
+use Phramework\JSONAPI\Client\Endpoint;
 
 trait BaseEndpoint
 {

tests/APP/public/index.php

@@ -22,11 +22,12 @@ class Ctrl
 }
 
 $c = new \Slim\Container();
+
 $c['errorHandler'] = function ($c) {
     return function ($request, $response, \Exception $exception) use ($c) {
         switch (get_class($exception)) {
             case \Phramework\Exceptions\NotFoundException::class:
-                return $c['errors']->withStatus($exception->getCode())
+                return $c['response']->withStatus($exception->getCode())
                     ->withHeader('Content-Type', 'application/json')
                     ->write(json_encode((object) [
                         'errors' => [(object) [
@@ -36,7 +37,7 @@ class Ctrl
                         ]]
                     ]));
             case \Phramework\Exceptions\MissingParametersException::class:
-                return $c['errors']->withStatus($exception->getCode())
+                return $c['response']->withStatus($exception->getCode())
                     ->withHeader('Content-Type', 'application/json')
                     //->write($exception->getMessage())
                     ->write(json_encode((object) [
@@ -51,7 +52,7 @@ class Ctrl
                         ]]
                     ]));
             case \Phramework\Exceptions\IncorrectParameterException::class:
-                return $c['errors']->withStatus($exception->getCode())
+                return $c['response']->withStatus($exception->getCode())
                     ->withHeader('Content-Type', 'application/json')
                     //->write($exception->getMessage())
                     ->write(json_encode((object) [
@@ -64,7 +65,7 @@ class Ctrl
                         ]]
                     ]));
             case \Phramework\Exceptions\IncorrectParametersException::class:
-                return $c['errors']->withStatus($exception->getCode())
+                return $c['response']->withStatus($exception->getCode())
                     ->withHeader('Content-Type', 'application/json')
                     //->write($exception->getMessage())
                     ->write(json_encode((object) [
@@ -73,7 +74,7 @@ class Ctrl
                     ]));
             case \Exception::class:
             default:
-                return $c['errors']->withStatus(400)
+                return $c['response']->withStatus(400)
                     ->withHeader('Content-Type', 'application')
                     //->write($exception->getMessage())
                     ->write($exception);

tests/src/Endpoint/EndpointPatchTest.php

@@ -17,8 +17,7 @@
  */
 namespace Phramework\JSONAPI\Client;
 
-require_once __DIR__ . '/BaseEndpoint.php';
-
+use Phramework\JSONAPI\APP\BaseEndpoint;
 use Phramework\JSONAPI\Client\Response\JSONAPIResource;
 
 /**
@@ -38,16 +37,7 @@ public function testPost()
             (object) [
                 'title' => 'do this from phpunit',
                 'body' => 'do this from phpunit - body',
-            ]/*,
-            (new RelationshipsData())
-                ->append(
-                    'tag',
-                    '1'
-                )
-                ->append(
-                    'tag',
-                    '2'
-                )*/
+            ]
         );
 
         $this->markTestIncomplete();

tests/src/Endpoint/GetByIdTest.php

@@ -17,8 +17,7 @@
  */
 namespace Phramework\JSONAPI\Client;
 
-require_once __DIR__ . '/BaseEndpoint.php';
-
+use Phramework\JSONAPI\APP\BaseEndpoint;
 use Phramework\JSONAPI\Client\Directive\IncludeRelationship;
 use Phramework\JSONAPI\Client\Directive\Page;
 use Phramework\JSONAPI\Client\Exceptions\ResponseException;
@@ -34,7 +33,6 @@ class GetByIdTest extends \PHPUnit_Framework_TestCase
     use BaseEndpoint;
 
     /**
-     * @param string $id
      * @covers ::getById
      */
     public function testGeyById()

tests/src/Endpoint/GetTest.php

@@ -17,8 +17,7 @@
  */
 namespace Phramework\JSONAPI\Client;
 
-require_once __DIR__ . '/BaseEndpoint.php';
-
+use Phramework\JSONAPI\APP\BaseEndpoint;
 use Phramework\JSONAPI\Client\Directive\IncludeRelationship;
 use Phramework\JSONAPI\Client\Directive\Page;
 use Phramework\JSONAPI\Client\Exceptions\ResponseException;

tests/src/Endpoint/PostTest.php

@@ -17,11 +17,7 @@
  */
 namespace Phramework\JSONAPI\Client;
 
-require_once __DIR__ . '/BaseEndpoint.php';
-
-use Phramework\JSONAPI\Client\Directive\IncludeRelationship;
-use Phramework\JSONAPI\Client\Directive\Page;
-use Phramework\JSONAPI\Client\Exceptions\ResponseException;
+use Phramework\JSONAPI\APP\BaseEndpoint;
 use Phramework\JSONAPI\Client\Response\JSONAPIResource;
 
 /**
@@ -40,17 +36,8 @@ public function testPost()
         $post = $this->endpoint->post(
             (object) [
                 'title' => 'do this from phpunit',
-                'body' => 'do this from phpunit - body',
-            ]/*,
-            (new RelationshipsData())
-                ->append(
-                    'tag',
-                    '1'
-                )
-                ->append(
-                    'tag',
-                    '2'
-                )*/
+                'body'  => 'do this from phpunit - body',
+            ]
         );
 
         $this->markTestIncomplete();

tests/src/EndpointTest.php

@@ -16,8 +16,3 @@
  * limitations under the License.
  */
 namespace Phramework\JSONAPI\Client;
-
-use Phramework\JSONAPI\Client\Directive\IncludeRelationship;
-use Phramework\JSONAPI\Client\Directive\Page;
-use Phramework\JSONAPI\Client\Exceptions\ResponseException;
-use Phramework\JSONAPI\Client\Response\JSONAPIResource;