Added properties helpers

devices_module/bootstrap.py

@@ -26,7 +26,6 @@
 
 # Library libs
 from devices_module.exchange import ModuleExchange
-from devices_module.key import EntityKey
 from devices_module.models import db
 from devices_module.repositories import (
     ConnectorsRepository,
@@ -40,6 +39,7 @@
     ChannelsControlsRepository,
     ChannelsConfigurationRepository,
 )
+from devices_module.helpers import KeyHashHelpers, PropertiesHelpers
 
 default_settings: Dict[str, Dict[str, Union[str, int, bool, None]]] = {
     "database": {
@@ -84,8 +84,11 @@ def create_container(settings: Dict[str, Dict[str, Union[str, int, bool, None]]]
     di[ModuleExchange] = ModuleExchange()
     di["fb-devices-module_exchange"] = di[ModuleExchange]
 
-    di[EntityKey] = EntityKey()
-    di["fb-devices-module_entity-key-generator"] = di[EntityKey]
+    di[PropertiesHelpers] = PropertiesHelpers()
+    di["fb-devices-module_helpers-properties"] = di[PropertiesHelpers]
+
+    di[KeyHashHelpers] = KeyHashHelpers()
+    di["fb-devices-module_helpers-key-hash"] = di[KeyHashHelpers]
 
     db.bind(
         provider="mysql",

devices_module/key.py → devices_module/helpers.py

@@ -14,27 +14,75 @@
 #     See the License for the specific language governing permissions and
 #     limitations under the License.
 
-# pylint: disable=too-many-lines
-
 """
-Devices module entities key generator & utils
+Devices module helpers
 """
 
-# Library dependencies
+# App dependencies
 import math
 import time
-from typing import Callable, Optional
+from typing import Callable, Set, Union, Optional
 from kink import inject
 from pony.orm import core as orm
+from modules_metadata.types import DataType
+
+# Library libs
+from devices_module.items import DevicePropertyItem, ChannelPropertyItem
+
+
+@inject
+class PropertiesHelpers:  # pylint: disable=too-few-public-methods
+    """
+    Properties helpers
+
+    @package        FastyBird:DevicesModule!
+    @module         helpers
+
+    @author         Adam Kadlec <adam.kadlec@fastybird.com>
+    """
+    @staticmethod
+    def normalize_value(  # pylint: disable=too-many-return-statements
+        item: Union[DevicePropertyItem, ChannelPropertyItem],
+        value: Union[int, float, str, bool, None],
+    ) -> Union[int, float, str, bool, None]:
+        """Normalize property value based od property data type"""
+        if value is None or item.data_type is None:
+            return value
+
+        if item.data_type == DataType.INT:
+            return int(value)
+
+        if item.data_type == DataType.FLOAT:
+            return float(value)
+
+        if item.data_type == DataType.STRING:
+            return str(value)
+
+        if item.data_type == DataType.BOOLEAN:
+            value = str(value)
+
+            return value.lower() in ["true", "1", "t", "y", "yes", "on"]
+
+        if item.data_type == DataType.ENUM:
+            if (
+                item.get_format() is not None
+                and isinstance(item.get_format(), Set)
+                and str(value) in item.get_format()
+            ):
+                return str(value)
+
+            return None
+
+        return value
 
 
 @inject
-class EntityKey:
+class KeyHashHelpers:
     """
-    Entity key generator & parser
+    Key hash generator & parser
 
     @package        FastyBird:DevicesModule!
-    @module         key
+    @module         helpers
 
     @author         Adam Kadlec <adam.kadlec@fastybird.com>
     """
@@ -90,9 +138,7 @@ def encode(self, number: int, max_length: Optional[int] = None) -> str:
     # -----------------------------------------------------------------------------
 
     def decode(self, string: str, max_length: Optional[int] = None) -> int:
-        """
-        Convert key hash to number
-        """
+        """Convert key hash to number"""
         string = "".join(reversed(string))
         result = 0
         length = len(string) - 1

devices_module/models.py

@@ -39,7 +39,7 @@
 
 # Library libs
 from devices_module.events import ModelEntityCreatedEvent, ModelEntityUpdatedEvent, ModelEntityDeletedEvent
-from devices_module.key import EntityKey
+from devices_module.helpers import KeyHashHelpers
 
 # Create devices module database accessor
 db: Database = Database()
@@ -111,7 +111,7 @@ def before_insert(self) -> None:
         self.created_at = datetime.datetime.now()
 
         if self.key is None:
-            self.key = di[EntityKey].generate_key(self)
+            self.key = di[KeyHashHelpers].generate_key(self)
 
     # -----------------------------------------------------------------------------
 
@@ -443,7 +443,7 @@ def before_insert(self) -> None:
             self.firmware_manufacturer = self.firmware_manufacturer.lower()
 
         if self.key is None:
-            self.key = di[EntityKey].generate_key(self)
+            self.key = di[KeyHashHelpers].generate_key(self)
 
     # -----------------------------------------------------------------------------
 
@@ -556,7 +556,7 @@ def before_insert(self) -> None:
         self.created_at = datetime.datetime.now()
 
         if self.key is None:
-            self.key = di[EntityKey].generate_key(self)
+            self.key = di[KeyHashHelpers].generate_key(self)
 
     # -----------------------------------------------------------------------------
 
@@ -797,7 +797,7 @@ def before_insert(self) -> None:
         self.created_at = datetime.datetime.now()
 
         if self.key is None:
-            self.key = di[EntityKey].generate_key(self)
+            self.key = di[KeyHashHelpers].generate_key(self)
 
     # -----------------------------------------------------------------------------
 
@@ -1058,7 +1058,7 @@ def before_insert(self) -> None:
         self.created_at = datetime.datetime.now()
 
         if self.key is None:
-            self.key = di[EntityKey].generate_key(self)
+            self.key = di[KeyHashHelpers].generate_key(self)
 
     # -----------------------------------------------------------------------------
 
@@ -1167,7 +1167,7 @@ def before_insert(self) -> None:
         self.created_at = datetime.datetime.now()
 
         if self.key is None:
-            self.key = di[EntityKey].generate_key(self)
+            self.key = di[KeyHashHelpers].generate_key(self)
 
     # -----------------------------------------------------------------------------
 
@@ -1410,7 +1410,7 @@ def before_insert(self) -> None:
         self.created_at = datetime.datetime.now()
 
         if self.key is None:
-            self.key = di[EntityKey].generate_key(self)
+            self.key = di[KeyHashHelpers].generate_key(self)
 
     # -----------------------------------------------------------------------------
 

tests/cases/Unit/Subscribers/EntitiesSubscriberTest.phpt

@@ -9,6 +9,7 @@ use FastyBird\DevicesModule\Subscribers;
 use FastyBird\ExchangePlugin\Publisher as ExchangePluginPublisher;
 use FastyBird\ModulesMetadata;
 use Mockery;
+use Nette\Utils;
 use Ninjify\Nunjuck\TestCase\BaseMockeryTestCase;
 use stdClass;
 use Tester\Assert;
@@ -43,12 +44,12 @@ final class EntitiesSubscriberTest extends BaseMockeryTestCase
 		$publisher = Mockery::mock(ExchangePluginPublisher\IPublisher::class);
 		$publisher
 			->shouldReceive('publish')
-			->withArgs(function (string $origin, string $key, array $data): bool {
+			->withArgs(function (string $origin, string $key, Utils\ArrayHash $data): bool {
 				unset($data['id']);
 
 				Assert::same(ModulesMetadata\Constants::MODULE_DEVICES_ORIGIN, $origin);
 				Assert::same('fb.bus.entity.created.device', $key);
-				Assert::equal([
+				Assert::equal(Utils\ArrayHash::from([
 					'identifier'            => 'device-name',
 					'key'                   => 'bLikmS',
 					'parent'                => null,
@@ -63,7 +64,7 @@ final class EntitiesSubscriberTest extends BaseMockeryTestCase
 					'firmware_manufacturer' => 'generic',
 					'firmware_version'      => null,
 					'params'                => [],
-				], $data);
+				]), $data);
 
 				return true;
 			})
@@ -98,12 +99,12 @@ final class EntitiesSubscriberTest extends BaseMockeryTestCase
 		$publisher = Mockery::mock(ExchangePluginPublisher\IPublisher::class);
 		$publisher
 			->shouldReceive('publish')
-			->withArgs(function (string $origin, string $key, array $data): bool {
+			->withArgs(function (string $origin, string $key, Utils\ArrayHash $data): bool {
 				unset($data['id']);
 
 				Assert::same(ModulesMetadata\Constants::MODULE_DEVICES_ORIGIN, $origin);
 				Assert::same('fb.bus.entity.updated.device', $key);
-				Assert::equal([
+				Assert::equal(Utils\ArrayHash::from([
 					'identifier'            => 'device-name',
 					'key'                   => 'bLikmS',
 					'parent'                => null,
@@ -118,7 +119,7 @@ final class EntitiesSubscriberTest extends BaseMockeryTestCase
 					'firmware_manufacturer' => 'generic',
 					'firmware_version'      => null,
 					'params'                => [],
-				], $data);
+				]), $data);
 
 				return true;
 			})
@@ -152,12 +153,12 @@ final class EntitiesSubscriberTest extends BaseMockeryTestCase
 		$publisher = Mockery::mock(ExchangePluginPublisher\IPublisher::class);
 		$publisher
 			->shouldReceive('publish')
-			->withArgs(function (string $origin, string $key, array $data): bool {
+			->withArgs(function (string $origin, string $key, Utils\ArrayHash $data): bool {
 				unset($data['id']);
 
 				Assert::same(ModulesMetadata\Constants::MODULE_DEVICES_ORIGIN, $origin);
 				Assert::same('fb.bus.entity.deleted.device', $key);
-				Assert::equal([
+				Assert::equal(Utils\ArrayHash::from([
 					'identifier'            => 'device-name',
 					'key'                   => 'bLikmS',
 					'parent'                => null,
@@ -172,7 +173,7 @@ final class EntitiesSubscriberTest extends BaseMockeryTestCase
 					'firmware_manufacturer' => 'generic',
 					'firmware_version'      => null,
 					'params'                => [],
-				], $data);
+				]), $data);
 
 				return true;
 			})

tests/pytests/helpers/test_entity_key.py

@@ -18,15 +18,15 @@
 from pony.orm import core as orm
 
 # Library libs
-from devices_module.key import EntityKey
+from devices_module.helpers import KeyHashHelpers
 
 
-class TestEntityKey(unittest.TestCase):
+class TestKeyHashUtils(unittest.TestCase):
     @patch('devices_module.key.time')
     def test_default_generator(self, mock_time) -> None:
         mock_time.time_ns = Mock(return_value=1630831410968578000)
 
-        entity_key_generator = EntityKey()
+        entity_key_generator = KeyHashHelpers()
 
         entity = Mock()
 
@@ -35,7 +35,7 @@ def test_default_generator(self, mock_time) -> None:
     # -----------------------------------------------------------------------------
 
     def test_custom_generator(self) -> None:
-        entity_key_generator = EntityKey()
+        entity_key_generator = KeyHashHelpers()
         entity_key_generator.set_generator(self.__custom_generator)
 
         entity = Mock()