From 52bcabd2be1edcf23979e4f060b1b389507c7bfa Mon Sep 17 00:00:00 2001
From: Sam Poyigi <6567634+sampoyigi@users.noreply.github.com>
Date: Tue, 10 May 2022 15:01:13 +0100
Subject: [PATCH] Ensure resource primary key is included in response

Signed-off-by: Sam Poyigi <6567634+sampoyigi@users.noreply.github.com>
---
 Extension.php                    |  6 ++++++
 classes/Scope.php                | 26 ++++++++++++++++++++++++++
 classes/ScopeFactory.php         | 15 +++++++++++++++
 classes/TransformerAbstract.php  |  4 ++++
 composer.json                    |  5 +++++
 serializer/JsonApiSerializer.php | 16 ----------------
 6 files changed, 56 insertions(+), 16 deletions(-)
 create mode 100644 classes/Scope.php
 create mode 100644 classes/ScopeFactory.php

diff --git a/Extension.php b/Extension.php
index de20fa2..8048b51 100755
--- a/Extension.php
+++ b/Extension.php
@@ -5,6 +5,7 @@
 use Admin\Models\Customers_model;
 use Admin\Models\Users_model;
 use Dingo\Api\Auth\Auth;
+use Igniter\Api\Classes\ScopeFactory;
 use Igniter\Flame\Database\Model;
 use Illuminate\Cache\RateLimiting\Limit;
 use Illuminate\Contracts\Http\Kernel;
@@ -12,6 +13,7 @@
 use Illuminate\Support\Facades\RateLimiter;
 use Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful;
 use Laravel\Sanctum\Sanctum;
+use League\Fractal\Manager;
 use System\Classes\BaseExtension;
 
 /**
@@ -193,6 +195,10 @@ public function registerApiResources()
      */
     protected function registerResponseFactory()
     {
+        $this->app->bind(Manager::class, function () {
+            return new Manager(new ScopeFactory);
+        });
+
         $this->app->alias('api.response', Classes\ResponseFactory::class);
 
         $this->app->singleton('api.response', function ($app) {
diff --git a/classes/Scope.php b/classes/Scope.php
new file mode 100644
index 0000000..522cb86
--- /dev/null
+++ b/classes/Scope.php
@@ -0,0 +1,26 @@
+<?php
+
+namespace Igniter\Api\Classes;
+
+use Igniter\Flame\Database\Model;
+use League\Fractal\Scope as FractalScope;
+
+/**
+ * Scope
+ *
+ * The scope class acts as a tracker, relating a specific resource in a specific
+ * context. For example, the same resource could be attached to multiple scopes.
+ * There are root scopes, parent scopes and child scopes.
+ */
+class Scope extends FractalScope
+{
+    protected function fireTransformer($transformer, $data)
+    {
+        [$transformedData, $includedData] = parent::fireTransformer($transformer, $data);
+
+        if (!array_key_exists('id', $transformedData) && $data instanceof Model)
+            $transformedData['id'] = $data->getKey();
+
+        return [$transformedData, $includedData];
+    }
+}
diff --git a/classes/ScopeFactory.php b/classes/ScopeFactory.php
new file mode 100644
index 0000000..49510d2
--- /dev/null
+++ b/classes/ScopeFactory.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace Igniter\Api\Classes;
+
+use League\Fractal\Manager;
+use League\Fractal\Resource\ResourceInterface;
+use League\Fractal\ScopeFactory as FractalScopeFactory;
+
+class ScopeFactory extends FractalScopeFactory
+{
+    public function createScopeFor(Manager $manager, ResourceInterface $resource, $scopeIdentifier = null)
+    {
+        return new Scope($manager, $resource, $scopeIdentifier);
+    }
+}
diff --git a/classes/TransformerAbstract.php b/classes/TransformerAbstract.php
index 0d5d8e4..73390e3 100644
--- a/classes/TransformerAbstract.php
+++ b/classes/TransformerAbstract.php
@@ -4,6 +4,10 @@
 
 use Illuminate\Http\Resources\Json\JsonResource;
 
+/**
+ * @deprecated
+ * @package Igniter\Api\Classes
+ */
 class TransformerAbstract extends JsonResource
 {
     /**
diff --git a/composer.json b/composer.json
index 3f01b42..b17baf9 100644
--- a/composer.json
+++ b/composer.json
@@ -19,6 +19,11 @@
     "laravel/sanctum": "~2.13.0"
   },
   "extra": {
+    "laravel": {
+      "dont-discover": [
+        "*"
+      ]
+    },
     "tastyigniter-extension": {
       "code": "igniter.api",
       "name": "APIs",
diff --git a/serializer/JsonApiSerializer.php b/serializer/JsonApiSerializer.php
index 5444ea8..f8a64dd 100644
--- a/serializer/JsonApiSerializer.php
+++ b/serializer/JsonApiSerializer.php
@@ -2,24 +2,8 @@
 
 namespace Igniter\Api\Serializer;
 
-use Igniter\Flame\Support\Str;
 use League\Fractal\Serializer\JsonApiSerializer as FractalJsonApiSerializer;
 
 class JsonApiSerializer extends FractalJsonApiSerializer
 {
-    public function item($resourceKey, array $data)
-    {
-        // Hacky way of ensuring the id key is always present
-        // in the data array, should probably change later
-        if (!array_key_exists('id', $data) && $resourceKey) {
-            $keyName = Str::singular($resourceKey).'_id';
-            $data = array_merge($data, [
-                'id' => array_get($data, $keyName),
-            ]);
-
-            unset($data[$keyName]);
-        }
-
-        return parent::item($resourceKey, $data);
-    }
 }