Added ability to use context manager with REST client( Token auto-update ).

Author: imbeacon

examples/example_application.py

@@ -11,26 +11,24 @@
 username = "tenant@thingsboard.org"
 password = "tenant"
 
-rest_client = RestClientCE(base_url=url)
-rest_client.login(username=username, password=password)
+with RestClientCE(base_url=url) as rest_client:
+    try:
+        rest_client.login(username=username, password=password)
 
-try:
+        asset = Asset(name="Building 1", type="building")
+        asset = rest_client.save_asset(asset)
 
-    asset = Asset(name="Building 1", type="building")
-    asset = rest_client.save_asset(asset)
+        logging.info("Asset was created:\n%r\n", asset)
 
-    logging.info("Asset was created:\n%r\n", asset)
+        device = Device(name="Thermometer 1", type="thermometer")
+        device = rest_client.save_device(device)
 
-    device = Device(name="Thermometer 1", type="thermometer")
-    device = rest_client.save_device(device)
+        logging.info(" Device was created:\n%r\n", device)
 
-    logging.info(" Device was created:\n%r\n", device)
+        relation = EntityRelation(_from=asset.id, to=device.id, type="Contains")
+        relation = rest_client.save_relation(relation)
 
-    relation = EntityRelation(_from=asset.id, to=device.id, type="Contains")
-    relation = rest_client.save_relation(relation)
+        logging.info(" Relation was created:\n%r\n", relation)
+    except ApiException as e:
+        logging.exception(e)
 
-    logging.info(" Relation was created:\n%r\n", relation)
-except ApiException as e:
-    logging.exception(e)
-
-rest_client.stop()

examples/example_application_2.py

@@ -1,6 +1,6 @@
 import logging
 from json import load
-from tb_rest_client import *
+from tb_rest_client.rest_client_pe import *
 from tb_rest_client.rest import ApiException
 
 
@@ -13,67 +13,66 @@
 username = "tenant@thingsboard.org"
 password = "tenant"
 
-rest_client = RestClient(base_url=url)
-rest_client.login(username=username, password=password)
-
-current_user = rest_client.get_user()
-
-try:
-    # Creating Dashboard Group on the Tenant Level
-    shared_dashboards_group = EntityGroup(name="Shared Dashboards", type="DASHBOARD")
-    shared_dashboards_group = rest_client.save_entity_group(shared_dashboards_group)
-
-    # Loading Dashboard from file
-    dashboard_json = None
-    with open("watermeters.json", "r") as dashboard_file:
-        dashboard_json = load(dashboard_file)
-    dashboard = Dashboard(title=dashboard_json["title"], configuration=dashboard_json["configuration"])
-    dashboard = rest_client.save_dashboard(dashboard)
-
-    # Adding Dashboard to the Shared Dashboards Group
-    rest_client.add_entities_to_entity_group(shared_dashboards_group.id, [dashboard.id.id])
-
-    # Creating Customer 1
-    customer1 = Customer(title="Customer 1")
-    customer1 = rest_client.save_customer(customer1)
-
-    # Creating Device
-    device = Device(name="WaterMeter1", type="waterMeter")
-    device = rest_client.save_device(device)
-
-    # Fetching automatically created "Customer Administrators" Group.
-    customer1_administrators = rest_client.get_entity_group_info_by_owner_and_name_and_type(customer1.id, "USER", "Customer Administrators")
-
-    # Creating Read-Only Role
-    read_only_role = Role(name="Read-Only", permissions=['READ', 'READ_ATTRIBUTES', 'READ_TELEMETRY', 'READ_CREDENTIALS'], type="GROUP")
-    read_only_role = rest_client.save_role(read_only_role)
-
-    # Assigning Shared Dashboards to the Customer 1 Administrators
-    tenant_id = current_user.tenant_id
-    group_permission = GroupPermission(role_id=read_only_role.id,
-                                       name="Read Only Permission",
-                                       is_public=False,
-                                       user_group_id=customer1_administrators.id,
-                                       tenant_id=tenant_id,
-                                       entity_group_id=shared_dashboards_group.id,
-                                       entity_group_type=shared_dashboards_group.type)
-    group_permission = rest_client.save_group_permission(group_permission)
-
-    # Creating User for Customer 1 with default dashboard from Tenant "Shared Dashboards" group.
-    user_email = "user@thingsboard.org"
-    user_password = "secret"
-
-    additional_info = {
-        "defaultDashboardId": dashboard.id.id,
-        "defaultDashboardFullscreen": False
-    }
-    user = User(authority="CUSTOMER_USER",
-                customer_id=customer1.id,
-                email=user_email,
-                additional_info=additional_info)
-    user = rest_client.save_user(user, send_activation_mail=False)
-    rest_client.activate_user(user.id, user_password)
-    rest_client.add_entities_to_entity_group(customer1_administrators.id, [user.id.id])
-
-except ApiException as e:
-    logging.exception(e)
+
+with RestClientPE(base_url=url) as rest_client:
+    try:
+        rest_client.login(username=username, password=password)
+        current_user = rest_client.get_user()
+        # Creating Dashboard Group on the Tenant Level
+        shared_dashboards_group = EntityGroup(name="Shared Dashboards", type="DASHBOARD")
+        shared_dashboards_group = rest_client.save_entity_group(shared_dashboards_group)
+
+        # Loading Dashboard from file
+        dashboard_json = None
+        with open("watermeters.json", "r") as dashboard_file:
+            dashboard_json = load(dashboard_file)
+        dashboard = Dashboard(title=dashboard_json["title"], configuration=dashboard_json["configuration"])
+        dashboard = rest_client.save_dashboard(dashboard)
+
+        # Adding Dashboard to the Shared Dashboards Group
+        rest_client.add_entities_to_entity_group(shared_dashboards_group.id, [dashboard.id.id])
+
+        # Creating Customer 1
+        customer1 = Customer(title="Customer 1")
+        customer1 = rest_client.save_customer(customer1)
+
+        # Creating Device
+        device = Device(name="WaterMeter1", type="waterMeter")
+        device = rest_client.save_device(device)
+
+        # Fetching automatically created "Customer Administrators" Group.
+        customer1_administrators = rest_client.get_entity_group_info_by_owner_and_name_and_type(customer1.id, "USER", "Customer Administrators")
+
+        # Creating Read-Only Role
+        read_only_role = Role(name="Read-Only", permissions=['READ', 'READ_ATTRIBUTES', 'READ_TELEMETRY', 'READ_CREDENTIALS'], type="GROUP")
+        read_only_role = rest_client.save_role(read_only_role)
+
+        # Assigning Shared Dashboards to the Customer 1 Administrators
+        tenant_id = current_user.tenant_id
+        group_permission = GroupPermission(role_id=read_only_role.id,
+                                           name="Read Only Permission",
+                                           is_public=False,
+                                           user_group_id=customer1_administrators.id,
+                                           tenant_id=tenant_id,
+                                           entity_group_id=shared_dashboards_group.id,
+                                           entity_group_type=shared_dashboards_group.type)
+        group_permission = rest_client.save_group_permission(group_permission)
+
+        # Creating User for Customer 1 with default dashboard from Tenant "Shared Dashboards" group.
+        user_email = "user@thingsboard.org"
+        user_password = "secret"
+
+        additional_info = {
+            "defaultDashboardId": dashboard.id.id,
+            "defaultDashboardFullscreen": False
+        }
+        user = User(authority="CUSTOMER_USER",
+                    customer_id=customer1.id,
+                    email=user_email,
+                    additional_info=additional_info)
+        user = rest_client.save_user(user, send_activation_mail=False)
+        rest_client.activate_user(user.id, user_password)
+        rest_client.add_entities_to_entity_group(customer1_administrators.id, [user.id.id])
+
+    except ApiException as e:
+        logging.exception(e)

tb_rest_client/api_client.py

@@ -319,15 +319,18 @@ def __deserialize(self, data, klass):
             else:
                 try:
                     found_class = getattr(tb_rest_client.models.models_pe, klass)
-                    if sorted(list(found_class.attribute_map.values())) == sorted(list(data.keys())):
+                    # if sorted(list(found_class.attribute_map.values())) == sorted(list(data.keys())):
+                    if all(attr in list(found_class.attribute_map.values()) for attr in list(data.keys())):
                         klass = found_class
                     else:
                         found_class = getattr(tb_rest_client.models.models_ce, klass)
-                        if sorted(list(found_class.attribute_map.values())) == sorted(list(data.keys())):
+                        # if sorted(list(found_class.attribute_map.values())) == sorted(list(data.keys())):
+                        if all(attr in list(found_class.attribute_map.values()) for attr in list(data.keys())):
                             klass = found_class
                 except AttributeError:
                     found_class = getattr(tb_rest_client.models.models_ce, klass)
-                    if sorted(list(found_class.attribute_map.values())) == sorted(list(data.keys())):
+                    if all(attr in list(found_class.attribute_map.values()) for attr in list(data.keys())):
+                        # if sorted(list(found_class.attribute_map.values())) == sorted(list(data.keys())):
                         klass = found_class
             return self.__deserialize_data(data, klass)
 

tb_rest_client/rest_client_base.py

@@ -28,7 +28,6 @@ def __init__(self, base_url):
         self.stopped = True
         self.configuration = Configuration()
         self.configuration.host = self.base_url
-        self.start()
 
     def run(self):
         self.stopped = False
@@ -50,6 +49,13 @@ def run(self):
     def stop(self):
         self.stopped = True
 
+    def __enter__(self):
+        self.start()
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.stop()
+
     def login(self, username, password):
         """Authorization on the host and saving the toke information"""
         if self.username is None and self.password is None:

tb_rest_client/rest_client_pe.py

@@ -10,6 +10,11 @@
 class RestClientPE(RestClientBase):
     def __init__(self, base_url):
         super().__init__(base_url)
+
+    def login(self, username, password):
+        super(RestClientPE, self).login(username=username, password=password)
+        self.__load_controllers()
+
     """Admin controller endpoints"""
 
     def get_admin_settings(self, key, system_by_default=False):