Fixing JSONapi pointer definition (#27)

FastyBird · Nov 6, 2022 · 3b844e0 · 3b844e0
1 parent feeb309
commit 3b844e0
Show file tree

Hide file tree

Showing 10 changed files with 67 additions and 20 deletions.
diff --git a/src/Controllers/ChannelPropertiesV1.php b/src/Controllers/ChannelPropertiesV1.php
@@ -25,6 +25,7 @@
 use FastyBird\Module\Devices\Queries;
 use FastyBird\Module\Devices\Router;
 use FastyBird\Module\Devices\Schemas;
+use FastyBird\Module\Devices\Utilities;
 use Fig\Http\Message\StatusCodeInterface;
 use InvalidArgumentException;
 use IPub\DoctrineCrud\Exceptions as DoctrineCrudExceptions;
@@ -148,7 +149,7 @@ public function create(
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.heading'),
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.message'),
 					[
-						'pointer' => 'data/attributes/' . $ex->getField(),
+						'/pointer' => 'data/attributes/' . $ex->getField(),
 					],
 				);
 			} catch (DoctrineCrudExceptions\EntityCreationException $ex) {
@@ -157,7 +158,7 @@ public function create(
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.heading'),
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.message'),
 					[
-						'pointer' => 'data/attributes/' . $ex->getField(),
+						'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi($ex->getField()),
 					],
 				);
 			} catch (Doctrine\DBAL\Exception\UniqueConstraintViolationException $ex) {
@@ -180,7 +181,9 @@ public function create(
 							$this->translator->translate('//devices-module.base.messages.uniqueAttribute.heading'),
 							$this->translator->translate('//devices-module.base.messages.uniqueAttribute.message'),
 							[
-								'pointer' => '/data/attributes/' . Utils\Strings::substring($columnKey, 7),
+								'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi(
+									Utils\Strings::substring($columnKey, 7),
+								),
 							],
 						);
 					}

diff --git a/src/Controllers/ChannelsV1.php b/src/Controllers/ChannelsV1.php
@@ -25,6 +25,7 @@
 use FastyBird\Module\Devices\Queries;
 use FastyBird\Module\Devices\Router;
 use FastyBird\Module\Devices\Schemas;
+use FastyBird\Module\Devices\Utilities;
 use Fig\Http\Message\StatusCodeInterface;
 use InvalidArgumentException;
 use IPub\DoctrineCrud\Exceptions as DoctrineCrudExceptions;
@@ -137,7 +138,7 @@ public function create(
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.heading'),
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.message'),
 					[
-						'pointer' => 'data/attributes/' . $ex->getField(),
+						'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi($ex->getField()),
 					],
 				);
 			} catch (DoctrineCrudExceptions\EntityCreationException $ex) {
@@ -146,7 +147,7 @@ public function create(
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.heading'),
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.message'),
 					[
-						'pointer' => 'data/attributes/' . $ex->getField(),
+						'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi($ex->getField()),
 					],
 				);
 			} catch (Doctrine\DBAL\Exception\UniqueConstraintViolationException $ex) {
@@ -169,7 +170,9 @@ public function create(
 							$this->translator->translate('//devices-module.base.messages.uniqueAttribute.heading'),
 							$this->translator->translate('//devices-module.base.messages.uniqueAttribute.message'),
 							[
-								'pointer' => '/data/attributes/' . Utils\Strings::substring($columnKey, 7),
+								'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi(
+									Utils\Strings::substring($columnKey, 7),
+								),
 							],
 						);
 					}

diff --git a/src/Controllers/ConnectorPropertiesV1.php b/src/Controllers/ConnectorPropertiesV1.php
@@ -26,6 +26,7 @@
 use FastyBird\Module\Devices\Queries;
 use FastyBird\Module\Devices\Router;
 use FastyBird\Module\Devices\Schemas;
+use FastyBird\Module\Devices\Utilities;
 use Fig\Http\Message\StatusCodeInterface;
 use InvalidArgumentException;
 use IPub\DoctrineCrud\Exceptions as DoctrineCrudExceptions;
@@ -141,7 +142,7 @@ public function create(
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.heading'),
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.message'),
 					[
-						'pointer' => 'data/attributes/' . $ex->getField(),
+						'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi($ex->getField()),
 					],
 				);
 			} catch (DoctrineCrudExceptions\EntityCreationException $ex) {
@@ -150,7 +151,7 @@ public function create(
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.heading'),
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.message'),
 					[
-						'pointer' => 'data/attributes/' . $ex->getField(),
+						'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi($ex->getField()),
 					],
 				);
 			} catch (Doctrine\DBAL\Exception\UniqueConstraintViolationException $ex) {
@@ -173,7 +174,9 @@ public function create(
 							$this->translator->translate('//devices-module.base.messages.uniqueAttribute.heading'),
 							$this->translator->translate('//devices-module.base.messages.uniqueAttribute.message'),
 							[
-								'pointer' => '/data/attributes/' . Utils\Strings::substring($columnKey, 7),
+								'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi(
+									Utils\Strings::substring($columnKey, 7),
+								),
 							],
 						);
 					}

diff --git a/src/Controllers/DevicePropertiesV1.php b/src/Controllers/DevicePropertiesV1.php
@@ -25,6 +25,7 @@
 use FastyBird\Module\Devices\Queries;
 use FastyBird\Module\Devices\Router;
 use FastyBird\Module\Devices\Schemas;
+use FastyBird\Module\Devices\Utilities;
 use Fig\Http\Message\StatusCodeInterface;
 use InvalidArgumentException;
 use IPub\DoctrineCrud\Exceptions as DoctrineCrudExceptions;
@@ -140,7 +141,7 @@ public function create(
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.heading'),
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.message'),
 					[
-						'pointer' => 'data/attributes/' . $ex->getField(),
+						'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi($ex->getField()),
 					],
 				);
 			} catch (DoctrineCrudExceptions\EntityCreationException $ex) {
@@ -149,7 +150,7 @@ public function create(
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.heading'),
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.message'),
 					[
-						'pointer' => 'data/attributes/' . $ex->getField(),
+						'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi($ex->getField()),
 					],
 				);
 			} catch (Doctrine\DBAL\Exception\UniqueConstraintViolationException $ex) {
@@ -172,7 +173,9 @@ public function create(
 							$this->translator->translate('//devices-module.base.messages.uniqueAttribute.heading'),
 							$this->translator->translate('//devices-module.base.messages.uniqueAttribute.message'),
 							[
-								'pointer' => '/data/attributes/' . Utils\Strings::substring($columnKey, 7),
+								'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi(
+									Utils\Strings::substring($columnKey, 7),
+								),
 							],
 						);
 					}

diff --git a/src/Controllers/DevicesV1.php b/src/Controllers/DevicesV1.php
@@ -25,6 +25,7 @@
 use FastyBird\Module\Devices\Queries;
 use FastyBird\Module\Devices\Router;
 use FastyBird\Module\Devices\Schemas;
+use FastyBird\Module\Devices\Utilities;
 use Fig\Http\Message\StatusCodeInterface;
 use InvalidArgumentException;
 use IPub\DoctrineCrud\Exceptions as DoctrineCrudExceptions;
@@ -128,7 +129,7 @@ public function create(
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.heading'),
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.message'),
 					[
-						'pointer' => 'data/attributes/' . $ex->getField(),
+						'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi($ex->getField()),
 					],
 				);
 			} catch (DoctrineCrudExceptions\EntityCreationException $ex) {
@@ -137,7 +138,7 @@ public function create(
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.heading'),
 					$this->translator->translate('//devices-module.base.messages.missingAttribute.message'),
 					[
-						'pointer' => 'data/attributes/' . $ex->getField(),
+						'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi($ex->getField()),
 					],
 				);
 			} catch (Doctrine\DBAL\Exception\UniqueConstraintViolationException $ex) {
@@ -160,7 +161,9 @@ public function create(
 							$this->translator->translate('//devices-module.base.messages.uniqueAttribute.heading'),
 							$this->translator->translate('//devices-module.base.messages.uniqueAttribute.message'),
 							[
-								'pointer' => '/data/attributes/' . Utils\Strings::substring($columnKey, 7),
+								'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi(
+									Utils\Strings::substring($columnKey, 7),
+								),
 							],
 						);
 					}
@@ -254,7 +257,9 @@ public function update(
 							$this->translator->translate('//devices-module.base.messages.uniqueAttribute.heading'),
 							$this->translator->translate('//devices-module.base.messages.uniqueAttribute.message'),
 							[
-								'pointer' => '/data/attributes/' . Utils\Strings::substring($columnKey, 7),
+								'pointer' => '/data/attributes/' . Utilities\Api::fieldToJsonApi(
+									Utils\Strings::substring($columnKey, 7),
+								),
 							],
 						);
 					}

diff --git a/src/Utilities/Api.php b/src/Utilities/Api.php
@@ -0,0 +1,30 @@
+<?php declare(strict_types = 1);
+
+/**
+ * Database.php
+ *
+ * @license        More in LICENSE.md
+ * @copyright      https://www.fastybird.com
+ * @author         Adam Kadlec <adam.kadlec@fastybird.com>
+ * @package        FastyBird:DevicesModule!
+ * @subpackage     Utilities
+ * @since          0.73.0
+ *
+ * @date           26.10.22
+ */
+
+namespace FastyBird\Module\Devices\Utilities;
+
+use function preg_replace;
+use function strtolower;
+use function strval;
+
+class Api
+{
+
+	public static function fieldToJsonApi(string $field): string
+	{
+		return strtolower(strval(preg_replace('/(?<!^)[A-Z]/', '_$0', $field)));
+	}
+
+}
diff --git a/tests/fixtures/Controllers/responses/channel.properties.create.missing.required.json b/tests/fixtures/Controllers/responses/channel.properties.create.missing.required.json
@@ -6,7 +6,7 @@
       "title" : "Missing attribute",
       "detail" : "Provided request is missing required attribute",
       "source" : {
-        "pointer" : "data/attributes/identifier"
+        "pointer" : "/data/attributes/identifier"
       }
     }
   ],

diff --git a/tests/fixtures/Controllers/responses/channels.create.missing.required.json b/tests/fixtures/Controllers/responses/channels.create.missing.required.json
@@ -6,7 +6,7 @@
       "title" : "Missing attribute",
       "detail" : "Provided request is missing required attribute",
       "source" : {
-        "pointer" : "data/attributes/identifier"
+        "pointer" : "/data/attributes/identifier"
       }
     }
   ],

diff --git a/tests/fixtures/Controllers/responses/device.properties.create.missing.required.json b/tests/fixtures/Controllers/responses/device.properties.create.missing.required.json
@@ -6,7 +6,7 @@
       "title" : "Missing attribute",
       "detail" : "Provided request is missing required attribute",
       "source" : {
-        "pointer" : "data/attributes/identifier"
+        "pointer" : "/data/attributes/identifier"
       }
     }
   ],

diff --git a/tests/fixtures/Controllers/responses/devices.create.missing.required.json b/tests/fixtures/Controllers/responses/devices.create.missing.required.json
@@ -6,7 +6,7 @@
       "title" : "Missing attribute",
       "detail" : "Provided request is missing required attribute",
       "source" : {
-        "pointer" : "data/attributes/identifier"
+        "pointer" : "/data/attributes/identifier"
       }
     }
   ],