Merge pull request #3 from niden/master

Corrected includes as per the specification

Author: niden

README.md

@@ -56,35 +56,15 @@ The routes available are:
                                              
 #### Relationships
 
-`/companies/<number>/individuals`
-`/companies/<number>/products`
-`/companies/<number>/individuals,products`
+`/companies/<number>?included=<individuals>,<products>`
 
-`/companies/<number>/relationships/individuals`
-`/companies/<number>/relationships/products`
-`/companies/<number>/relationships/individuals,products`
+`individuals/<number>?included=<companies>,<individual-types>`
 
-`individuals/<number>/companies`
-`individuals/<number>/individual-types`
-`individuals/<number>/companies,individual-types`
+`individual-types/<number>?included=<individuals>`
 
-`individuals/<number>/relationships/companies`
-`individuals/<number>/relationships/individual-types`
-`individuals/<number>/relationships/companies,individual-types`
+`products/<number>?included=<companies>,<product-types>`
 
-`individual-types/<number>/individuals`
-`individual-types/<number>/relationships/individuals`
-
-`products/<number>/companies`
-`products/<number>/product-types`
-`products/<number>/companies,product-types`
-
-`products/<number>/relationships/companies`
-`products/<number>/relationships/product-types`
-`products/<number>/relationships/companies,product-types`
-
-`product-types/<number>/products`                                             
-`product-types/<number>/relationships/products`                                             
+`product-types/<number>?included=<products>`                                             
 
 
 
@@ -165,13 +145,111 @@ The record always has `id` and `type` present at the top level. `id` is the uniq
 }
 ```
 
+`/products/1134?includes=companies,product-types`
+
+```json
+{
+  "jsonapi": {
+    "version": "1.0"
+  },
+  "data": [
+    {
+      "type": "products",
+      "id": "1134",
+      "attributes": {
+        "typeId": 890,
+        "name": "prd-a-5b64af7e70741",
+        "description": "5b64af7e7074a",
+        "quantity": 25,
+        "price": "19.99"
+      },
+      "links": {
+        "self": "http:\/\/api.phalcon.ld\/products\/1134"
+      },
+      "relationships": {
+        "companies": {
+          "links": {
+            "self": "http:\/\/api.phalcon.ld\/products\/1134\/relationships\/companies",
+            "related": "http:\/\/api.phalcon.ld\/products\/1134\/companies"
+          },
+          "data": [
+            {
+              "type": "companies",
+              "id": "1430"
+            },
+            {
+              "type": "companies",
+              "id": "1431"
+            }
+          ]
+        },
+        "product-types": {
+          "links": {
+            "self": "http:\/\/api.phalcon.ld\/products\/1134\/relationships\/product-types",
+            "related": "http:\/\/api.phalcon.ld\/products\/1134\/product-types"
+          },
+          "data": {
+            "type": "product-types",
+            "id": "890"
+          }
+        }
+      }
+    }
+  ],
+  "included": [
+    {
+      "type": "companies",
+      "id": "1430",
+      "attributes": {
+        "name": "com-a5b64af7e6c846",
+        "address": "5b64af7e6c84f",
+        "city": "5b64af7e6c855",
+        "phone": "5b64af7e6c85c"
+      },
+      "links": {
+        "self": "http:\/\/api.phalcon.ld\/companies\/1430"
+      }
+    },
+    {
+      "type": "companies",
+      "id": "1431",
+      "attributes": {
+        "name": "com-b5b64af7e6e3d3",
+        "address": "5b64af7e6e3dc",
+        "city": "5b64af7e6e3e2",
+        "phone": "5b64af7e6e3e9"
+      },
+      "links": {
+        "self": "http:\/\/api.phalcon.ld\/companies\/1431"
+      }
+    },
+    {
+      "type": "product-types",
+      "id": "890",
+      "attributes": {
+        "name": "prt-a-5b64af7e6f638",
+        "description": "5b64af7e6f641"
+      },
+      "links": {
+        "self": "http:\/\/api.phalcon.ld\/product-types\/890"
+      }
+    }
+  ],
+  "meta": {
+    "timestamp": "2018-08-03T19:39:42+00:00",
+    "hash": "384c6b3772727b1a9532865d2ae2d51c095c0fd9"
+  }
+}
+```
+
 For more information regarding responses, please check [JSON API](https://jsonapi.org)
 
 ### TODO
 - ~~Work on companies GET~~
-- ~~Work on relationships and data returned~~
+- ~~Work on included data~~
 - Write examples of code to send to the client
 - Create docs endpoint
+- Work on relationships
 - Work on pagination
 - Work on filters
 - Work on sorting

api/controllers/BaseController.php

@@ -37,7 +37,7 @@ class BaseController extends Controller
     protected $model = '';
 
     /** @var array */
-    protected $relationships = [];
+    protected $includes = [];
 
     /** @var string */
     protected $resource = '';
@@ -52,28 +52,25 @@ class BaseController extends Controller
      * Get the company/companies
      *
      * @param int    $id
-     * @param string $relationships
      *
      * @return array
      */
-    public function callAction($id = 0, $relationships = '')
+    public function callAction($id = 0)
     {
+        $includes   = $this->request->getQuery('includes', [Filter::FILTER_STRING, Filter::FILTER_TRIM], '');
         $parameters = $this->checkIdParameter($id);
-        $parameter  = $this->filter->sanitize($relationships, [Filter::FILTER_STRING, Filter::FILTER_TRIM]);
         $results    = $this->getRecords($this->config, $this->cache, $this->model, $parameters, $this->orderBy);
         $related    = [];
 
         if (count($parameters) > 0 && 0 === count($results)) {
             return $this->send404();
         } else {
-            if (true !== empty($parameter)) {
-                $allRelationships = explode(',', $relationships);
-                foreach ($allRelationships as $relationship) {
-                    if (true !== in_array($relationship, $this->relationships)) {
-                        return $this->send404();
+            if (true !== empty($includes)) {
+                $requestedIncludes = explode(',', $includes);
+                foreach ($requestedIncludes as $include) {
+                    if (true === in_array($include, $this->includes)) {
+                        $related[] = strtolower($include);
                     }
-
-                    $related[] = strtolower($relationship);
                 }
             }
         }

api/controllers/Companies/GetController.php

@@ -17,17 +17,17 @@
 class GetController extends BaseController
 {
     /** @var string */
-    protected $model         = Companies::class;
+    protected $model       = Companies::class;
 
     /** @var array */
-    protected $relationships = [
+    protected $includes    = [
         Relationships::INDIVIDUALS,
         Relationships::PRODUCTS,
     ];
 
     /** @var string */
-    protected $resource      = Relationships::COMPANIES;
+    protected $resource    = Relationships::COMPANIES;
 
     /** @var string */
-    protected $transformer   = CompaniesTransformer::class;
+    protected $transformer = CompaniesTransformer::class;
 }

api/controllers/IndividualTypes/GetController.php

@@ -20,7 +20,7 @@ class GetController extends BaseController
     protected $model       = IndividualTypes::class;
 
     /** @var array */
-    protected $relationships = [
+    protected $includes    = [
         Relationships::INDIVIDUALS,
     ];
 

api/controllers/Individuals/GetController.php

@@ -17,20 +17,20 @@
 class GetController extends BaseController
 {
     /** @var string */
-    protected $model         = Individuals::class;
+    protected $model       = Individuals::class;
 
     /** @var array */
-    protected $relationships = [
+    protected $includes    = [
         Relationships::COMPANIES,
         Relationships::INDIVIDUAL_TYPES,
     ];
 
     /** @var string */
-    protected $resource      = Relationships::INDIVIDUALS;
+    protected $resource    = Relationships::INDIVIDUALS;
 
     /** @var string */
-    protected $transformer   = IndividualsTransformer::class;
+    protected $transformer = IndividualsTransformer::class;
 
     /** @var string */
-    protected $orderBy       = 'last, first';
+    protected $orderBy     = 'last, first';
 }

api/controllers/ProductTypes/GetController.php

@@ -20,7 +20,7 @@ class GetController extends BaseController
     protected $model       = ProductTypes::class;
 
     /** @var array */
-    protected $relationships = [
+    protected $includes    = [
         Relationships::PRODUCTS,
     ];
 

api/controllers/Products/GetController.php

@@ -20,7 +20,7 @@ class GetController extends BaseController
     protected $model       = Products::class;
 
     /** @var array */
-    protected $relationships = [
+    protected $includes    = [
         Relationships::COMPANIES,
         Relationships::PRODUCT_TYPES,
     ];

library/Providers/CacheDataProvider.php

@@ -17,51 +17,30 @@ public function register(DiInterface $container)
     {
         $container->setShared(
             'cache',
-            $this->createCache('data')
-        );
-    }
-
-    /**
-     * Returns a cache object
-     *
-     * @param string $prefix
-     *
-     * @return Libmemcached
-     */
-    protected function createCache(string $prefix): Libmemcached
-    {
-        $frontAdapter = Data::class;
-        $frontOptions = [
-            'lifetime' => envValue('CACHE_LIFETIME', 86400),
-        ];
-        $backOptions  = $this->createOptions($prefix);
+            function () {
+                $prefix       = 'data';
+                $frontAdapter = Data::class;
+                $frontOptions = [
+                    'lifetime' => envValue('CACHE_LIFETIME', 86400),
+                ];
+                $backOptions = [
+                    'servers'  => [
+                        0 => [
+                            'host'   => envValue('DATA_API_MEMCACHED_HOST', '127.0.0.1'),
+                            'port'   => envValue('DATA_API_MEMCACHED_PORT', 11211),
+                            'weight' => envValue('DATA_API_MEMCACHED_WEIGHT', 100),
+                        ],
+                    ],
+                    'client'   => [
+                        \Memcached::OPT_HASH       => \Memcached::HASH_MD5,
+                        \Memcached::OPT_PREFIX_KEY => 'api-',
+                    ],
+                    'lifetime' => 3600,
+                    'prefix'   => $prefix . '-',
+                ];
 
-        return new Libmemcached(new $frontAdapter($frontOptions), $backOptions);
-    }
-
-    /**
-     * Returns memcached options
-     *
-     * @param string $prefix
-     *
-     * @return array
-     */
-    protected function createOptions(string $prefix): array
-    {
-        return [
-            'servers'  => [
-                0 => [
-                    'host'   => envValue('DATA_API_MEMCACHED_HOST', '127.0.0.1'),
-                    'port'   => envValue('DATA_API_MEMCACHED_PORT', 11211),
-                    'weight' => envValue('DATA_API_MEMCACHED_WEIGHT', 100),
-                ],
-            ],
-            'client'   => [
-                \Memcached::OPT_HASH       => \Memcached::HASH_MD5,
-                \Memcached::OPT_PREFIX_KEY => 'api-',
-            ],
-            'lifetime' => 3600,
-            'prefix'   => $prefix . '-',
-        ];
+                return new Libmemcached(new $frontAdapter($frontOptions), $backOptions);
+            }
+        );
     }
 }

library/Providers/ResponseProvider.php

@@ -15,16 +15,21 @@ class ResponseProvider implements ServiceProviderInterface
      */
     public function register(DiInterface $container)
     {
-        $response = new Response();
+        $container->setShared(
+            'response',
+            function () {
+                $response = new Response();
 
-        /**
-         * Assume success. We will work with the edge cases in the code
-         */
-        $response
-            ->setStatusCode(200)
-            ->setContentType('application/vnd.api+json', 'UTF-8')
-        ;
+                /**
+                 * Assume success. We will work with the edge cases in the code
+                 */
+                $response
+                    ->setStatusCode(200)
+                    ->setContentType('application/vnd.api+json', 'UTF-8')
+                ;
 
-        $container->setShared('response', $response);
+                return $response;
+            }
+        );
     }
 }