new: CAPEC / CWE Endpoints, check system status calls

Fix #75

Author: Rafiot

pyvulnerabilitylookup/api.py

@@ -65,21 +65,40 @@ def is_up(self) -> bool:
             return False
         return r.status_code == 200
 
-    def redis_up(self) -> bool:
-        '''Check if redis is up and running'''
-        r = self.session.get(urljoin(self.root_url, str(PurePosixPath('api', 'system', 'redis_up'))))
+    # #### DB & system status ####
+
+    def check_process(self) -> dict[str, Any]:
+        '''[Authentication Required] Checks the hearbeats of the various processes.'''
+        r = self.session.get(urljoin(self.root_url, str(PurePosixPath('system', 'checkProcess'))))
+        return r.json()
+
+    def check_smtp(self) -> dict[str, Any]:
+        '''[Authentication Required] Checks the SMTP connection.'''
+        r = self.session.get(urljoin(self.root_url, str(PurePosixPath('system', 'checkSMTP'))))
         return r.json()
 
-    # #### DB status ####
+    def get_config_info(self) -> dict[str, Any]:
+        '''Returns non-sensitive information about the configuration of the system.'''
+        r = self.session.get(urljoin(self.root_url, str(PurePosixPath('api', 'system', 'configInfo'))))
+        return r.json()
 
     def get_info(self) -> dict[str, Any]:
-        '''Get more information about the current databases in use and when it was updated'''
+        '''Returns information about the current sources in the Kvrocks database in use and when it was updated.'''
         r = self.session.get(urljoin(self.root_url, str(PurePosixPath('api', 'system', 'dbInfo'))))
         return r.json()
 
-    def get_config_info(self) -> dict[str, Any]:
-        '''Get more information about the current databases in use and when it was updated'''
-        r = self.session.get(urljoin(self.root_url, str(PurePosixPath('api', 'system', 'configInfo'))))
+    def get_pg_info(self) -> dict[str, Any]:
+        '''[Authentication Required] Returns information about the PostgreSQL database.'''
+        r = self.session.get(urljoin(self.root_url, str(PurePosixPath('api', 'system', 'pgInfo'))))
+        return r.json()
+
+    def redis_up(self) -> bool:
+        '''[Deprecated] Check if redis/valkey is up and running'''
+        return self.valkey_up()
+
+    def valkey_up(self) -> bool:
+        '''Check if valkey is up and running'''
+        r = self.session.get(urljoin(self.root_url, str(PurePosixPath('api', 'system', 'redis_up'))))
         return r.json()
 
     # #### Vulnerabilities ####
@@ -432,3 +451,33 @@ def get_epss(self, vulnerability: str) -> dict[str, Any]:
         '''
         r = self.session.get(urljoin(self.root_url, str(PurePosixPath('api', 'epss', vulnerability))))
         return r.json()
+
+    # #### CWE ####
+
+    def get_cwes(self) -> dict[str, Any]:
+        '''Get the list of CWEs'''
+        r = self.session.get(urljoin(self.root_url, str(PurePosixPath('api', 'cwe'))))
+        return r.json()
+
+    def get_cwe(self, cwe_id: str) -> dict[str, Any]:
+        '''Get a CWE
+
+        :param cwe_id: The CWE ID
+        '''
+        r = self.session.get(urljoin(self.root_url, str(PurePosixPath('api', 'cwe', cwe_id))))
+        return r.json()
+
+    # #### CAPEC ####
+
+    def get_capecs(self) -> dict[str, Any]:
+        '''Get the list of CAPECs'''
+        r = self.session.get(urljoin(self.root_url, str(PurePosixPath('api', 'capec'))))
+        return r.json()
+
+    def get_capec(self, capec_id: str) -> dict[str, Any]:
+        '''Get a CAPEC
+
+        :param capec_id: The CAPEC ID
+        '''
+        r = self.session.get(urljoin(self.root_url, str(PurePosixPath('api', 'capec', capec_id))))
+        return r.json()