made refactoring of the API implementation code

Author: aiantsen

.github/scripts/additional_api_tests.py

@@ -37,7 +37,7 @@ def test_login(self):
             type(self.api.api_version()), ZabbixAPIVersion, "Version getting was going wrong")
 
     def test_basic_auth(self):
-        """Tests basic_auth function works properly"""
+        """Tests __basic_auth function works properly"""
 
         self.assertEqual(
             self.api.use_basic, True, "Basic auth was going wrong")

.github/scripts/compatibility_api_test_5.py

@@ -40,9 +40,9 @@ def test_classic_auth(self):
             password=self.password
         )
 
-        self.assertIsNotNone(self.zapi.session_id, "Login by user and password was going wrong")
+        self.assertIsNotNone(self.zapi._ZabbixAPI__session_id, "Login by user and password was going wrong")
 
-        resp = self.zapi.user.checkAuthentication(sessionid=self.zapi.session_id)
+        resp = self.zapi.user.checkAuthentication(sessionid=self.zapi._ZabbixAPI__session_id)
 
         self.assertEqual(
             type(resp), dict, "Request user.checkAuthentication was going wrong")
@@ -54,11 +54,11 @@ def test_classic_auth(self):
 
         self.zapi.logout()
 
-        self.assertIsNone(self.zapi.session_id, "Logout was going wrong")
+        self.assertIsNone(self.zapi._ZabbixAPI__session_id, "Logout was going wrong")
 
         with self.assertRaises(ZabbixAPIException,
                                msg="Request user.checkAuthentication after logout was going wrong"):
-            resp = self.zapi.user.checkAuthentication(sessionid=self.zapi.session_id)
+            resp = self.zapi.user.checkAuthentication(sessionid=self.zapi._ZabbixAPI__session_id)
 
     def test_token_auth(self):
         """Tests auth using token"""

.github/scripts/compatibility_api_test_6.py

@@ -42,9 +42,9 @@ def _create_token(self):
             password=self.password
         )
 
-        self.assertIsNotNone(self.zapi.session_id, "Login was going wrong")
+        self.assertIsNotNone(self.zapi._ZabbixAPI__session_id, "Login was going wrong")
 
-        resp = self.zapi.user.checkAuthentication(sessionid=self.zapi.session_id)
+        resp = self.zapi.user.checkAuthentication(sessionid=self.zapi._ZabbixAPI__session_id)
 
         self.assertEqual(
             type(resp), dict, "Request user.checkAuthentication was going wrong")
@@ -70,11 +70,11 @@ def _create_token(self):
 
         self.zapi.logout()
 
-        self.assertIsNone(self.zapi.session_id, "Logout was going wrong")
+        self.assertIsNone(self.zapi._ZabbixAPI__session_id, "Logout was going wrong")
 
         with self.assertRaises(ZabbixAPIException,
                                msg="Request user.checkAuthentication after logout was going wrong"):
-            resp = self.zapi.user.checkAuthentication(sessionid=self.zapi.session_id)
+            resp = self.zapi.user.checkAuthentication(sessionid=self.zapi._ZabbixAPI__session_id)
 
     def test_classic_auth(self):
         """Tests auth using username and password"""
@@ -92,7 +92,7 @@ def test_token_auth(self):
 
         self.zapi.login(token=self.token)
 
-        self.assertIsNotNone(self.zapi.session_id, "Login was going wrong")
+        self.assertIsNotNone(self.zapi._ZabbixAPI__session_id, "Login was going wrong")
 
         resp = self.zapi.user.checkAuthentication(token=self.token)
 

.github/scripts/compatibility_api_test_latest.py

@@ -42,9 +42,9 @@ def _create_token(self):
             password=self.password
         )
 
-        self.assertIsNotNone(self.zapi.session_id, "Login by user and password was going wrong")
+        self.assertIsNotNone(self.zapi._ZabbixAPI__session_id, "Login by user and password was going wrong")
 
-        resp = self.zapi.user.checkAuthentication(sessionid=self.zapi.session_id)
+        resp = self.zapi.user.checkAuthentication(sessionid=self.zapi._ZabbixAPI__session_id)
 
         self.assertEqual(
             type(resp), dict, "Request user.checkAuthentication was going wrong")
@@ -70,11 +70,11 @@ def _create_token(self):
 
         self.zapi.logout()
 
-        self.assertIsNone(self.zapi.session_id, "Logout was going wrong")
+        self.assertIsNone(self.zapi._ZabbixAPI__session_id, "Logout was going wrong")
 
         with self.assertRaises(ZabbixAPIException,
                                msg="Request user.checkAuthentication after logout was going wrong"):
-            resp = self.zapi.user.checkAuthentication(sessionid=self.zapi.session_id)
+            resp = self.zapi.user.checkAuthentication(sessionid=self.zapi._ZabbixAPI__session_id)
 
     def test_classic_auth(self):
         """Tests auth using username and password"""
@@ -92,7 +92,7 @@ def test_token_auth(self):
 
         self.zapi.login(token=self.token)
 
-        self.assertIsNotNone(self.zapi.session_id, "Login by token was going wrong")
+        self.assertIsNotNone(self.zapi._ZabbixAPI__session_id, "Login by token was going wrong")
 
         resp = self.zapi.user.checkAuthentication(token=self.token)
 
@@ -106,7 +106,7 @@ def test_token_auth(self):
 
         self.zapi.logout()
 
-        self.assertIsNone(self.zapi.session_id, "Logout was going wrong")
+        self.assertIsNone(self.zapi._ZabbixAPI__session_id, "Logout was going wrong")
 
         self.assertEqual(
             type(resp), dict, "Request user.checkAuthentication was going wrong")

.github/scripts/integration_api_test.py

@@ -46,10 +46,10 @@ def test_check_auth(self):
 
         resp = None
         if self.zapi:
-            if self.zapi.session_id == self.zapi.token:
-                resp = self.zapi.user.checkAuthentication(token=self.zapi.session_id)
+            if self.zapi._ZabbixAPI__session_id == self.zapi._ZabbixAPI__token:
+                resp = self.zapi.user.checkAuthentication(token=self.zapi._ZabbixAPI__session_id)
             else:
-                resp = self.zapi.user.checkAuthentication(sessionid=self.zapi.session_id)
+                resp = self.zapi.user.checkAuthentication(sessionid=self.zapi._ZabbixAPI__session_id)
         self.assertEqual(
             type(resp), dict, "Request user.checkAuthentication was going wrong")
 

examples/api/using_http_auth.py

@@ -1,12 +1,14 @@
 from zabbix_utils import ZabbixAPI
 
 # Create an instance of the ZabbixAPI class with the Zabbix server URL
-api = ZabbixAPI(url="http://127.0.0.1")
-
 # Set Basic Authentication credentials for Zabbix API requests
 # Basic Authentication - a simple authentication mechanism used in HTTP.
 # It involves sending a username and password with each HTTP request.
-api.basic_auth(user="user", password="p@$sw0rd")
+api = ZabbixAPI(
+    url="http://127.0.0.1",
+    http_user="user",
+    http_password="p@$sw0rd"
+)
 
 # Login to the Zabbix API using provided user credentials
 api.login(user="Admin", password="zabbix")