mbu-dev-shared-components 0.4.3__tar.gz → 0.4.4__tar.gz

{mbu_dev_shared_components-0.4.3 → mbu_dev_shared_components-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mbu_dev_shared_components
-Version: 0.4.3
+Version: 0.4.4
 Summary: Shared components to use in RPA projects
 Author-email: MBU <rpa@mbu.aarhus.dk>
 Classifier: Programming Language :: Python :: 3

mbu_dev_shared_components-0.4.4/mbu_dev_shared_components/database/constants.py

@@ -0,0 +1,131 @@
+"""This module handles generating and fetching constants and credentials from the database"""
+
+import os
+import pyodbc
+from datetime import datetime
+
+from mbu_dev_shared_components.utils.fernet_encryptor import Encryptor
+from mbu_dev_shared_components.database.utility import connect_to_db, execute_query
+
+
+def add_credential(
+        credential_name: str,
+        username: str,
+        password: str,
+        changed_at: datetime = datetime.now(),
+        db_env: str = "PROD"
+):
+    encryptor = Encryptor()
+    encrypted_password = encryptor.encrypt(password)
+
+    rpa_conn = connect_to_db(db_env=db_env)
+    cursor = rpa_conn.cursor()
+
+    query = """
+        INSERT INTO [RPA].[rpa].[Credentials]
+            ([name]
+            ,[username]
+            ,[password]
+            ,[changed_at])
+        VALUES
+            (?
+            ,?
+            ,?
+            ,?)
+        """
+    params = [credential_name, username, encrypted_password, changed_at]
+    execute_query(query=query, cursor=cursor, params=params)
+
+
+def get_credential(
+        credential_name: str,
+        db_env: str = "PROD"
+    ) -> dict:
+    
+    rpa_conn = connect_to_db(db_env=db_env)
+    cursor = rpa_conn.cursor()
+    encryptor = Encryptor()
+
+    query = """
+        SELECT 
+            Username
+            ,cast(Password as varbinary(max))
+        FROM [RPA].[rpa].[Credentials]
+        WHERE
+            name = ?
+        """
+    
+    params = [credential_name]
+
+    res = execute_query(query=query, cursor=cursor, params=params)
+    if res is not None:
+        res = res[0]
+        username = res[0]
+        encrypted_password = res[1]
+
+        decrypted_password = encryptor.decrypt(encrypted_password)
+
+        return  {
+            "username": username, 
+            "decrypted_password": decrypted_password, 
+            "encrypted_password": encrypted_password
+        } 
+    else:
+        print(f"No credential found with name {credential_name}")
+
+def get_constant(
+        constant_name: str,
+        db_env: str = "PROD"
+    ) -> tuple:
+    
+    rpa_conn = connect_to_db(db_env=db_env)
+    cursor = rpa_conn.cursor()
+    encryptor = Encryptor()
+
+    query = """
+        SELECT 
+            name
+            ,value
+        FROM [RPA].[rpa].[Constants]
+        WHERE
+            name = ?
+        """
+    
+    params = [constant_name]
+
+    res = execute_query(query=query, cursor=cursor, params=params)
+    if res is not None:
+
+        returned_constant = res[0]
+        constant_name = returned_constant[0]
+        value = returned_constant[1]
+
+        return {"constant_name": constant_name, "value": value}
+    else:
+        print(f"No constant found with name: {constant_name}")
+
+
+def add_constant(
+        constant_name: str,
+        value: str,
+        changed_at: datetime = datetime.now(),
+        db_env: str = "PROD"
+):
+    query = """
+        INSERT INTO [RPA].[rpa].[Constants]
+            ([name]
+            ,[value]
+            ,[changed_at])
+        VALUES
+            (?
+            ,?
+            ,?)
+        """
+    
+    rpa_conn = connect_to_db(db_env=db_env)
+    cursor = rpa_conn.cursor()
+
+    params = [constant_name, value, changed_at]
+    execute_query(query=query, cursor=cursor, params=params)
+
+

mbu_dev_shared_components-0.4.4/mbu_dev_shared_components/database/logging.py

@@ -0,0 +1,86 @@
+"""This module handles logging in the RPA database"""
+
+from datetime import datetime
+import time
+import os
+import socket
+
+from mbu_dev_shared_components.database.utility import execute_query, connect_to_db, fetch_env
+from mbu_dev_shared_components.utils.db_stored_procedure_executor import execute_stored_procedure
+
+def log_event(
+        log_db: str,
+        level: str, 
+        message: str, 
+        context: str, 
+        db_env="TEST"
+    ):
+    created_at = datetime.now()
+    """Logs the inputted parameters in """
+    query = f"""
+        INSERT INTO RPA.{log_db}
+            ([level]
+            ,[message]
+            ,[created_at]
+            ,[context])
+        VALUES
+            (?
+            ,?
+            ,?
+            ,?)
+        """
+    rpa_conn = connect_to_db(db_env=db_env)
+    cursor = rpa_conn.cursor()
+
+    params = [level, message, created_at, context]
+    execute_query(query=query, cursor=cursor, params=params)
+
+def _send_heartbeat(
+        servicename,
+        status,
+        details,
+        db_env,
+):
+    conn_env = fetch_env(db_env=db_env)
+    conn_str = os.getenv(conn_env)
+    hostname = socket.gethostname()
+    params = {
+        "ServiceName": (str, servicename), 
+        "Status": (str, status), 
+        "HostName": (str, hostname), 
+        "Details": (str, details)
+    }
+    result = execute_stored_procedure(
+        connection_string=conn_str,
+        stored_procedure='rpa.sp_UpdateHeartbeat',
+        params=params)
+    if result["success"] is not True:
+        print(result["error_message"])
+    
+def log_heartbeat(
+        stop: str|bool,
+        servicename: str,
+        heartbeat_interval: int,
+        details: str = "",
+        db_env: str = "PROD"
+    ):
+    if isinstance(stop,str):
+        stop = stop == "True"
+    if not isinstance(heartbeat_interval, int):
+        heartbeat_interval = int(heartbeat_interval)
+    while not stop:
+        status = "RUNNING"
+        _send_heartbeat(
+            servicename,
+            status,
+            details,
+            db_env,
+        )
+        time.sleep(heartbeat_interval)
+    status = "STOPPED"
+    _send_heartbeat(
+        servicename,
+        status,
+        details,
+        db_env,
+    )

mbu_dev_shared_components-0.4.4/mbu_dev_shared_components/database/utility.py

@@ -0,0 +1,44 @@
+"""This module handles general database connection and calls"""
+
+import os
+import pyodbc
+from datetime import datetime
+
+def connect_to_db(autocommit=True, db_env="PROD") -> pyodbc.Connection:
+    """Establish connection to sql database
+
+    Returns:
+        rpa_conn (pyodbc.Connection): The connection object to the SQL database.
+    """
+    connection_env = fetch_env(db_env)
+    rpa_conn_string = os.getenv(connection_env)
+    rpa_conn = pyodbc.connect(rpa_conn_string, autocommit=autocommit)
+    return rpa_conn
+
+def execute_query(query: str, cursor: pyodbc.Cursor, params: list) -> pyodbc.Cursor:
+    is_select = query.strip().upper().startswith('SELECT')
+    try:
+        res = cursor.execute(query, params)
+        if is_select:
+            res = cursor.fetchall()
+            if len(res) == 0:
+                print("No results from query")
+                return None
+            return res
+        else:
+            return None
+    except pyodbc.Error as e:
+        print(e)
+    finally:
+        cursor.close()
+
+
+def fetch_env(db_env):
+    if db_env.upper() == "PROD":
+        connection_env = "DbConnectionString"
+        return connection_env
+    if db_env.upper() == "TEST":
+        connection_env = "DbConnectionStringTest"
+        return connection_env
+    
+    raise ValueError(f"arg db_env is {db_env.upper()} but should be 'PROD' or 'TEST'")

{mbu_dev_shared_components-0.4.3 → mbu_dev_shared_components-0.4.4}/mbu_dev_shared_components.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mbu_dev_shared_components
-Version: 0.4.3
+Version: 0.4.4
 Summary: Shared components to use in RPA projects
 Author-email: MBU <rpa@mbu.aarhus.dk>
 Classifier: Programming Language :: Python :: 3

{mbu_dev_shared_components-0.4.3 → mbu_dev_shared_components-0.4.4}/mbu_dev_shared_components.egg-info/SOURCES.txt

@@ -6,6 +6,10 @@ mbu_dev_shared_components.egg-info/SOURCES.txt
 mbu_dev_shared_components.egg-info/dependency_links.txt
 mbu_dev_shared_components.egg-info/requires.txt
 mbu_dev_shared_components.egg-info/top_level.txt
+mbu_dev_shared_components/database/__init__.py
+mbu_dev_shared_components/database/constants.py
+mbu_dev_shared_components/database/logging.py
+mbu_dev_shared_components/database/utility.py
 mbu_dev_shared_components/getorganized/__init__.py
 mbu_dev_shared_components/getorganized/auth.py
 mbu_dev_shared_components/getorganized/cases.py

{mbu_dev_shared_components-0.4.3 → mbu_dev_shared_components-0.4.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mbu_dev_shared_components"
-version = "0.4.3"  # Specify the version manually here
+version = "0.4.4"  # Specify the version manually here
 authors = [
   { name="MBU", email="rpa@mbu.aarhus.dk" },
 ]