pyxecm 2.0.0__py3-none-any.whl → 2.0.2__py3-none-any.whl

pyxecm/__init__.py

@@ -4,10 +4,11 @@ from .avts import AVTS
 from .coreshare import CoreShare
 from .otac import OTAC
 from .otawp import OTAWP
+from .otca import OTCA
 from .otcs import OTCS
 from .otds import OTDS
 from .otiv import OTIV
 from .otmm import OTMM
 from .otpd import OTPD
 
-__all__ = ["AVTS", "OTAC", "OTAWP", "OTCS", "OTDS", "OTIV", "OTMM", "OTPD", "CoreShare"]
+__all__ = ["AVTS", "OTAC", "OTAWP", "OTCA", "OTCS", "OTDS", "OTIV", "OTMM", "OTPD", "CoreShare"]

pyxecm/avts.py

@@ -10,18 +10,35 @@ import base64
 import json
 import logging
 import os
+import platform
+import sys
 import time
+from importlib.metadata import version
 
 import requests
 
-default_logger = logging.getLogger("pyxecm.customizer.avts")
+APP_NAME = "pyxecm"
+APP_VERSION = version("pyxecm")
+MODULE_NAME = APP_NAME + ".avts"
 
-REQUEST_HEADERS = {"Accept": "application/json", "Content-Type": "application/json"}
+PYTHON_VERSION = f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}"
+OS_INFO = f"{platform.system()} {platform.release()}"
+ARCH_INFO = platform.machine()
+REQUESTS_VERSION = requests.__version__
+
+USER_AGENT = (
+    f"{APP_NAME}/{APP_VERSION} ({MODULE_NAME}/{APP_VERSION}; "
+    f"Python/{PYTHON_VERSION}; {OS_INFO}; {ARCH_INFO}; Requests/{REQUESTS_VERSION})"
+)
+
+REQUEST_HEADERS = {"User-Agent": USER_AGENT, "accept": "application/json", "Content-Type": "application/json"}
 
 REQUEST_TIMEOUT = 60
 REQUEST_RETRY_DELAY = 20
 REQUEST_MAX_RETRIES = 2
 
+default_logger = logging.getLogger(MODULE_NAME)
+
 
 class AVTS:
     """Configure and interact with Aviator Search REST API."""
@@ -33,19 +50,17 @@ class AVTS:
 
     def __init__(
         self,
-        otds_url: str,
         client_id: str,
         client_secret: str,
         base_url: str,
         username: str,
         password: str,
+        otds_url: str,
         logger: logging.Logger = default_logger,
     ) -> None:
-        """Initialize the AVTS object.
+        """Initialize the Aviator Search (AVTS) object.
 
         Args:
-            otds_url (str):
-                The URL of the OTDS Server used by Aviator Search.
             client_id (str):
                 The client ID for the Aviator Search oAuth client.
             client_secret (str):
@@ -56,6 +71,8 @@ class AVTS:
                 User with administrative permissions in Aviator Search.
             password (str):
                 Password of the user with administrative permissions in Aviator Search.
+            otds_url (str):
+                The URL of the OTDS Server used by Aviator Search.
             logger (logging.Logger, optional):
                 The logging object to use for all log messages. Defaults to default_logger.
 
@@ -69,15 +86,16 @@ class AVTS:
         avts_config = {}
 
         # Store the credentials and parameters in a config dictionary:
-        avts_config["otdsUrl"] = otds_url
         avts_config["clientId"] = client_id
         avts_config["clientSecret"] = client_secret
         avts_config["baseUrl"] = base_url
         avts_config["username"] = username
         avts_config["password"] = password
+        avts_config["otdsUrl"] = otds_url
 
         avts_config["tokenUrl"] = avts_config["otdsUrl"] + "/otdsws/oauth2/token"
         avts_config["repoUrl"] = avts_config["baseUrl"] + "/aviator-gateway/avts-api/admin/v1/repo"
+        avts_config["questionsUrl"] = avts_config["baseUrl"] + "/aviator-gateway/avts-api/search/v1/questions"
 
         self._config = avts_config
         self._accesstoken = None
@@ -136,7 +154,7 @@ class AVTS:
         url: str,
         method: str = "GET",
         headers: dict | None = None,
-        data: dict | None = None,
+        data: dict | list | None = None,
         json_data: dict | None = None,
         files: dict | None = None,
         timeout: int | None = REQUEST_TIMEOUT,
@@ -199,9 +217,17 @@ class AVTS:
                     if success_message:
                         self.logger.debug(success_message)
                     return self.parse_request_response(response)
+                elif (
+                    response.status_code == 500
+                    and "Cannot modify configuration" in response.text
+                    and "while the Processor is running" in response.text
+                ):
+                    self.logger.warning("Another operation is already running. Waiting 5 seconds to retry...")
+                    time.sleep(5)
+                    retries += 1
                 # Check if Session has expired - then re-authenticate and try once more
                 elif response.status_code == 401 and retries == 0:
-                    self.logger.debug("Session has expired - try to re-authenticate...")
+                    self.logger.info("Session has expired - try to re-authenticate...")
                     self.authenticate()
                     retries += 1
                 else:
@@ -289,7 +315,7 @@ class AVTS:
         the vars() built-in method.
 
         Args:
-            response_object (object):
+            response_object (requests.Response):
                 This is reponse object delivered by the request call.
             additional_error_message (str, optional):
                 Use a more specific error message in case of an error.
@@ -349,8 +375,8 @@ class AVTS:
         }
         request_payload = {
             "client_id": self.config()["clientId"],
-            "grant_type": "password",
             "client_secret": self.config()["clientSecret"],
+            "grant_type": "password",
             "username": self.config()["username"],
             "password": self.config()["password"],
             "scope": "otds:roles",
@@ -362,7 +388,7 @@ class AVTS:
             headers=request_header,
             data=request_payload,
             timeout=None,
-            failure_message="Failed to authenticate to OTDS with username -> {} and client_id -> {}".format(
+            failure_message="Failed to authenticate to OTDS with username -> '{}' and client_id -> {}".format(
                 self.config()["username"],
                 self.config()["clientId"],
             ),
@@ -399,8 +425,6 @@ class AVTS:
                 The REST API URL of Content Server.
             node_id (int):
                 Root Node ID for crawling
-            version (str, optional):
-                TODO: The version number of ???
 
         Returns:
             dict | None:
@@ -593,7 +617,7 @@ class AVTS:
         )
 
         if response is None:
-            self.logger.error("Failed to create repository -> %s (%s)", name, node_id)
+            self.logger.error("Failed to create repository -> %s (%s)!", name, node_id)
 
         return response
 
@@ -632,9 +656,6 @@ class AVTS:
                 Whether or not to index / crawl message replies.
             index_user_chats (bool, optional):
                 Whether or not to index / crawl user chats.
-            version(str, optional): default 24.3.0
-
-            # TODO: add more params
 
         Returns:
             dict | None:
@@ -773,7 +794,7 @@ class AVTS:
                     "description": "",
                     "required": False,
                     "defaultValue": "false",
-                    "value": "true",
+                    "value": "false",
                     "visible": True,
                     "editable": True,
                 },
@@ -800,7 +821,7 @@ class AVTS:
                     "description": "",
                     "required": False,
                     "defaultValue": "",
-                    "value": "10.194.10.21",
+                    "value": "",
                     "visible": True,
                     "editable": True,
                 },
@@ -811,7 +832,7 @@ class AVTS:
                     "description": "",
                     "required": False,
                     "defaultValue": "",
-                    "value": "3128",
+                    "value": "",
                     "visible": True,
                     "editable": True,
                 },
@@ -900,7 +921,7 @@ class AVTS:
         )
 
         if response is None:
-            self.logger.error("Failed to create repository -> %s", name)
+            self.logger.error("Failed to create repository -> '%s'", name)
             return None
 
         self.repo_admin_consent(response["id"])
@@ -951,8 +972,6 @@ class AVTS:
                 TODO: _description_. Defaults to "AVTS".
             oauth2_sites_file (str, optional):
                 TODO: _description_. Defaults to "".
-            version (str, optional):
-                TODO: _description_. Defaults to "24.3.0".
 
         Returns:
             dict | None:
@@ -1142,7 +1161,7 @@ class AVTS:
                     "description": "",
                     "required": False,
                     "defaultValue": "false",
-                    "value": "true",
+                    "value": "false",
                     "visible": True,
                     "editable": True,
                 },
@@ -1169,7 +1188,7 @@ class AVTS:
                     "description": "",
                     "required": False,
                     "defaultValue": "",
-                    "value": "10.194.10.21",
+                    "value": "",
                     "visible": True,
                     "editable": True,
                 },
@@ -1180,7 +1199,7 @@ class AVTS:
                     "description": "",
                     "required": False,
                     "defaultValue": "",
-                    "value": "3128",
+                    "value": "",
                     "visible": True,
                     "editable": True,
                 },
@@ -1284,7 +1303,7 @@ class AVTS:
         )
 
         if response is None:
-            self.logger.error("Failed to create repository -> %s", name)
+            self.logger.error("Failed to create repository -> '%s'!", name)
             return None
 
         self.repo_admin_consent(response["id"])
@@ -1336,7 +1355,7 @@ class AVTS:
 
         """
 
-        self.logger.info("Start crawling repository -> %s", repo_name)
+        self.logger.info("Start crawling repository -> '%s'...", repo_name)
 
         repo = self.get_repo_by_name(name=repo_name)
         if repo is None:
@@ -1350,14 +1369,14 @@ class AVTS:
             method="POST",
             headers=request_header,
             timeout=None,
-            failure_message="Failed to start crawling repository -> '{}'".format(
+            failure_message="Failed to start crawling repository -> '{}'!".format(
                 repo_name,
             ),
         )
 
     # end method definition
 
-    def stop_crawling(self, repo_name: str) -> list | None:
+    def stop_crawling(self, repo_name: str) -> dict | None:
         """Stop the crawling of a repository.
 
         Args:
@@ -1365,7 +1384,7 @@ class AVTS:
                 The name of the repository.
 
         Returns:
-            list | None:
+            dict | None:
                 Parsed response object from the API or None in case of an error
 
         """
@@ -1382,7 +1401,7 @@ class AVTS:
             method="POST",
             headers=request_header,
             timeout=None,
-            failure_message="Failed to stop crawling repository -> '{}'".format(
+            failure_message="Failed to stop crawling repository -> '{}'!".format(
                 repo_name,
             ),
         )
@@ -1490,3 +1509,30 @@ class AVTS:
         return bool(os.getenv("KUBERNETES_SERVICE_HOST") and os.getenv("KUBERNETES_SERVICE_PORT"))
 
     # end method definition
+
+    def set_questions(self, questions: list) -> list | None:
+        """Get a list of all repositories.
+
+        Args:
+            questions (list):
+                List of proposed questions.
+
+        Returns:
+            list | None:
+                Parsed response object from the API listing all repositories or None in case of an error.
+
+        """
+
+        request_header = self.request_header()
+        request_url = self.config()["questionsUrl"]
+
+        return self.do_request(
+            url=request_url,
+            method="PUT",
+            headers=request_header,
+            data=json.dumps(questions),
+            timeout=None,
+            failure_message="Failed to set list of questions to ask",
+        )
+
+    # end method definition