Repo renamed in slim-json-api-helper

cristianp6 · Jan 27, 2016 · 19a5e60 · 19a5e60
1 parent f0fe496
commit 19a5e60
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-slim-json-api
+slim-json-api-helper
 =======
 
 
@@ -12,15 +12,15 @@ slim-json-api
 ```php
 
 use Slim\Http\Request as Request;
-use JsonAPI\Renderer as JsonRenderer;
+use JsonApiHelper\Renderer;
 
 $app = new \Slim\App($settings);
 $container = $app->getContainer();
 
 // register the json response and error handlers
-$jsonAPI = new JsonAPI\JsonAPI($app->getContainer());
-$jsonAPI->registerResponseView();
-$jsonAPI->registerErrorHandlers();
+$jsonApiHelper = new JsonApiHelper\JsonApiHelper($app->getContainer());
+$jsonApiHelper->registerResponseView();
+$jsonApiHelper->registerErrorHandlers();
 
 
 $this->post('/users', function (Request $request, Response $response, $args)

diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
-  "name" : "cristianp6/slim-json-api",
-  "description" : "Slim3 JSON API Request & Response Helpers inspired by jsonapi.org",
+  "name" : "cristianp6/slim-json-api-helper",
+  "description" : "Slim3 JSON API Request & Response Helper inspired by jsonapi.org",
   "type" : "library",
   "authors" : [
     {
@@ -15,7 +15,7 @@
     }
   ],
   "keywords" : [ "slim", "json", "api" ],
-  "homepage" : "https://github.com/cristianp6/slim-json-api",
+  "homepage" : "https://github.com/cristianp6/slim-json-api-helper",
   "license" : [ "Apache-2.0" ],
   "require" : {
     "php" : ">=5.5",
@@ -27,11 +27,11 @@
   },
   "autoload": {
     "psr-4": {
-      "JsonAPI\\": "src/"
+      "JsonApiHelper\\": "src/"
     }
   },
   "support" : {
     "email" : "[email protected]",
-    "issues" : "https://github.com/cristianp6/slim-json-api/issues"
+    "issues" : "https://github.com/cristianp6/slim-json-api-helper/issues"
   }
 }
diff --git a/src/JsonAPI.php → src/JsonApiHelper.php b/src/JsonAPI.php → src/JsonApiHelper.php
@@ -1,12 +1,11 @@
 <?php
 
-namespace JsonAPI;
+namespace JsonApiHelper;
 
 use Interop\Container\ContainerInterface;
-use JsonAPI\Renderer as JsonRenderer;
 use InvalidArgumentException;
 
-class JsonAPI
+class JsonApiHelper
 {
     /**
      * Container.
@@ -41,7 +40,7 @@ public function __construct($container = null)
     public function registerResponseView()
     {
         $this->container['result'] = function ($c) {
-            $result = new JsonRenderer();
+            $result = new JsonApiRenderer();
 
             return $result;
         };
@@ -54,7 +53,7 @@ public function registerErrorHandlers()
     {
         $this->container['notAllowedHandler'] = function ($c) {
             return function ($request, $response, $methods) use ($c) {
-                $result = new JsonRenderer();
+                $result = new Renderer();
 
                 $result->errors[] = [
                     'code' => 405,
@@ -67,7 +66,7 @@ public function registerErrorHandlers()
 
         $this->container['notFoundHandler'] = function ($c) {
             return function ($request, $response) use ($c) {
-                $result = new JsonRenderer();
+                $result = new Renderer();
 
                 $result->errors[] = [
                     'code' => 404,
@@ -80,7 +79,7 @@ public function registerErrorHandlers()
 
         $this->container['errorHandler'] = function ($c) {
             return function ($request, $response, $exception) use ($c) {
-                $result = new JsonRenderer();
+                $result = new Renderer();
 
                 $error_code = $exception->getCode();
                 if (is_numeric($error_code) && $error_code > 300 && $error_code < 600) {

diff --git a/src/Renderer.php b/src/Renderer.php
@@ -1,14 +1,14 @@
 <?php
 
-namespace JsonAPI;
+namespace JsonApiHelper;
 
 use Psr\Http\Message\ResponseInterface;
 use Slim\Http\Response;
 
 /**
- * JsonRenderer.
+ * JsonApiRenderer.
  *
- * Render JSON result into a PSR-7 Response object
+ * Render JSON result into a PSR-7 Response object according to jsonapi.org conventions
  */
 class Renderer
 {
@@ -27,7 +27,7 @@ public function __construct()
      */
     public function render(Response $response, $status = 200)
     {
-        // Put the default top-level members into the $result object
+        // Put the default top-level members into $result object
         $result = new \StdClass();
         $result->data = $this->data;
         $result->errors = $this->errors;

diff --git a/tests/JsonRendererTest.php b/tests/JsonRendererTest.php
@@ -2,7 +2,7 @@
 
 namespace JsonRendererTest;
 
-use JsonAPI\Renderer as Renderer;
+use JsonApiHelper\Renderer;
 use Slim\Http\Response;
 
 class JsonRendererTest extends \PHPUnit_Framework_TestCase
@@ -11,23 +11,21 @@ public function testValidConstuctor()
     {
         $jsonRenderer = new Renderer();
 
-        $this->assertInstanceOf('\JsonAPI\Renderer', $jsonRenderer);
+        $this->assertInstanceOf('\JsonApiHelper\Renderer', $jsonRenderer);
     }
 
     public function testValidResponse()
     {
         $body = ['status' => 'ok'];
+
         $jsonRenderer = new Renderer();
         $jsonRenderer->data = $body;
 
         $response = new Response();
-        $response = $jsonRenderer->render($response, 200);
-
-        $result = new \StdClass();
-        $result->data = $body;
-        $result->errors = [];
+        $response = $jsonRenderer->render($response);
 
-        $this->assertTrue($response->getStatusCode() === 200);
-        $this->assertTrue($response->getBody() === json_encode($result));
+        $this->assertEquals($response->getStatusCode(), 200);
+        $this->assertEquals($response->getHeaderLine('Content-Type'), 'application/json;charset=utf-8');
+        $this->assertTrue($response->getBody() === json_encode($jsonRenderer)); // TODO: response->getBody() is empty!
     }
 }