From 56501c84c1a2c74a08179a9d91221ee077e4254e Mon Sep 17 00:00:00 2001 From: loyal812 Date: Thu, 28 Mar 2024 07:53:56 -0400 Subject: [PATCH] feat: api class --- src/api_access/cl_api_access.py | 147 ++++++++++++++++++++++++++++++++ src/mongodb/cl_mongodb.py | 68 +-------------- src/utils/chatting.py | 6 +- src/utils/check_api.py | 6 +- src/utils/create_api.py | 6 +- src/utils/delete_api.py | 6 +- src/utils/total_process.py | 6 +- 7 files changed, 163 insertions(+), 82 deletions(-) create mode 100644 src/api_access/cl_api_access.py diff --git a/src/api_access/cl_api_access.py b/src/api_access/cl_api_access.py new file mode 100644 index 0000000..e9bd41e --- /dev/null +++ b/src/api_access/cl_api_access.py @@ -0,0 +1,147 @@ +import os +from dotenv import load_dotenv +from pymongo import MongoClient +from pymongo.errors import ServerSelectionTimeoutError +from urllib.parse import quote_plus + +from src.models.api_model import APIModel + +class ApiAccess(): + def __init__(self, db_name, collection_name, mongo_uri=""): + """Initialize the MongoDB with the database and collection names. + + Args: + - db_name (str): Name of the MongoDB database. + - collection_name (str): Name of the collection within the database. + - mongo_uri (str, optional): MongoDB connection URI. + """ + self.db_name = db_name + self.collection_name = collection_name + self.__set_mongo_uri() + + def __set_mongo_uri(self): + """Set the MongoDB connection URI using environment variables.""" + load_dotenv() + mongodb_username = os.getenv("MONGODB_USERNAME") + mongodb_password = os.getenv("MONGODB_PASSWORD") + mongodb_cluster_name = os.getenv("MONGODB_CLUSTER_NAME") + # Escape the mongodb_username and mongodb_password + mongodb_escaped_username = quote_plus(mongodb_username) + mongodb_escaped_password = quote_plus(mongodb_password) + + # Extract MongoDB URI from payload data + mongo_uri = f"mongodb+srv://{mongodb_escaped_username}:{mongodb_escaped_password}@{mongodb_cluster_name}.mongodb.net" + + self.mongo_uri = mongo_uri + + + def __mongo_connect(self): + """Connect to the MongoDB server and database, and get the specified collection.""" + try: + # mongo config + print(self.mongo_uri) + + client = MongoClient(self.mongo_uri) + # Test the connection by accessing a database (e.g., admin) + client.admin.command('ismaster') + + print("MongoDB Server Connected.") + + # Access the database + db = client[self.db_name] + + # Check if the database exists + db_list = client.list_database_names() + if self.db_name in db_list: + print(f"The {self.db_name} database exists.") + else: + print(f"The {self.db_name} database does not exist.") + print(f"Creating {self.db_name} database.") + db = client[self.db_name] + + # Access the collection + collection_list = db.list_collection_names() + if self.collection_name in collection_list: + print(f"The {self.collection_name} collection exists.") + collection = db[self.collection_name] + else: + print(f"The {self.collection_name} collection does not exist.") + print(f"Creating {self.collection_name} collection.") + collection = db[self.collection_name] + + return {"result": True, "message": collection} + + except ServerSelectionTimeoutError as err: + print("MongoDB Server Connection Error:", err) + return {"result": False, "message": "MongoDB Server Connection Error: " + str(err)} + except Exception as e: + print("An error occurred:", e) + return {"result": False, "message": "An error occurred: " + str(e)} + + + def create_api(self, data:APIModel): + """Create a new API document in the collection.""" + # Connect to MongoDB and get the collection + db = self.__mongo_connect() + + if db["result"] == True: + collection = db['message'] + + # Insert the new document into the collection + result = collection.insert_one(data) + + # Check if the insertion was successful + if result.inserted_id: + print("New item has been added to the collection with ID:", result.inserted_id) + return {"status": "success", "api_key": data['api'], "message": f"New item has been added to the collection with ID: {result.inserted_id}"} + else: + print("Failed to add a new item to the collection") + return {"status": "failed", "message": "Failed to add a new item to the collection"} + else: + return {"status": "failed", "message": "Failed to add a new item to the collection"} + + def delete_api(self, api_key, user): + """Soft delete an API document based on the API key and user.""" + # Connect to MongoDB and get the collection + db = self.__mongo_connect() + + if db["result"] == True: + collection = db['message'] + + # Define the filter condition to identify the document to delete + filter_condition = {"api": api_key, "user": user} + # Define the update operation + update_operation = {"$set": { "is_removed": True }} + + # Update a single document that matches the filter condition + result = collection.update_one(filter_condition, update_operation) + if result.modified_count == 1: + print("Document updated successfully") + return {"status": "success", "message": "Successfully deleted"} + else: + print("No matching document found") + return {"status": "failed", "message": "No matching document found"} + else: + return {"status": "failed", "message": "No matching document found"} + + def check_validation_api(self, api_key, user): + """Check if an API document exists and is not soft deleted.""" + # Connect to MongoDB and get the collection + db = self.__mongo_connect() + + if db["result"] == True: + collection = db['message'] + + # Define the filter condition to check for document existence + filter_condition = {"api": api_key, "user": user, "is_removed": False} + + # Check if a document exists that matches the filter condition + existing_document = collection.find_one(filter_condition) + if existing_document: + print("Document exists in the collection") + return {"status": "success", "message": "Document exists in the collection"} + else: + print("Document does not exist in the collection") + return {"status": "failed", "message": "Document does not exist in the collection"} + else: + return {"status": "failed", "message": "Document does not exist in the collection"} \ No newline at end of file diff --git a/src/mongodb/cl_mongodb.py b/src/mongodb/cl_mongodb.py index 283cca3..4589287 100644 --- a/src/mongodb/cl_mongodb.py +++ b/src/mongodb/cl_mongodb.py @@ -121,70 +121,4 @@ def __mongo_connect(self): # return {"result": False ,"message": f"The {self.collection_name} collection not exists."} # # return {"result": True, "message": f"The {self.db_name} database has been created with {self.collection_name} collection."} - - def create_api(self, data:APIModel): - """Create a new API document in the collection.""" - # Connect to MongoDB and get the collection - db = self.__mongo_connect() - - if db["result"] == True: - collection = db['message'] - - # Insert the new document into the collection - result = collection.insert_one(data) - - # Check if the insertion was successful - if result.inserted_id: - print("New item has been added to the collection with ID:", result.inserted_id) - return {"status": "success", "api_key": data['api'], "message": f"New item has been added to the collection with ID: {result.inserted_id}"} - else: - print("Failed to add a new item to the collection") - return {"status": "failed", "message": "Failed to add a new item to the collection"} - else: - return {"status": "failed", "message": "Failed to add a new item to the collection"} - - def delete_api(self, api_key, user): - """Soft delete an API document based on the API key and user.""" - # Connect to MongoDB and get the collection - db = self.__mongo_connect() - - if db["result"] == True: - collection = db['message'] - - # Define the filter condition to identify the document to delete - filter_condition = {"api": api_key, "user": user} - # Define the update operation - update_operation = {"$set": { "is_removed": True }} - - # Update a single document that matches the filter condition - result = collection.update_one(filter_condition, update_operation) - if result.modified_count == 1: - print("Document updated successfully") - return {"status": "success", "message": "Successfully deleted"} - else: - print("No matching document found") - return {"status": "failed", "message": "No matching document found"} - else: - return {"status": "failed", "message": "No matching document found"} - - def check_validation_api(self, api_key, user): - """Check if an API document exists and is not soft deleted.""" - # Connect to MongoDB and get the collection - db = self.__mongo_connect() - - if db["result"] == True: - collection = db['message'] - - # Define the filter condition to check for document existence - filter_condition = {"api": api_key, "user": user, "is_removed": False} - - # Check if a document exists that matches the filter condition - existing_document = collection.find_one(filter_condition) - if existing_document: - print("Document exists in the collection") - return {"status": "success", "message": "Document exists in the collection"} - else: - print("Document does not exist in the collection") - return {"status": "failed", "message": "Document does not exist in the collection"} - else: - return {"status": "failed", "message": "Document does not exist in the collection"} \ No newline at end of file + \ No newline at end of file diff --git a/src/utils/chatting.py b/src/utils/chatting.py index 46de246..de33a00 100644 --- a/src/utils/chatting.py +++ b/src/utils/chatting.py @@ -3,7 +3,7 @@ from src.utils.read_json import read_json from src.chatting.cl_chat_bot import ChatBot -from src.mongodb.cl_mongodb import MongoDB +from src.api_access.cl_api_access import ApiAccess def chatting(args): """ @@ -19,13 +19,13 @@ def chatting(args): mongo_uri = payload_data["mongo_uri"] # Create an instance of MongoDB connection - mongodb = MongoDB( + apiAccess = ApiAccess( db_name=payload_data["db_name"], collection_name=payload_data["collection_name"], mongo_uri=mongo_uri) # Check if the API key is valid using MongoDB - is_available = mongodb.check_validation_api(api_key=str(Path(args['api_key'])), user=str(Path(args['user']))) + is_available = apiAccess.check_validation_api(api_key=str(Path(args['api_key'])), user=str(Path(args['user']))) if is_available: print("valid api key") diff --git a/src/utils/check_api.py b/src/utils/check_api.py index 9107e41..c9e1627 100644 --- a/src/utils/check_api.py +++ b/src/utils/check_api.py @@ -2,7 +2,7 @@ from pathlib import Path from src.utils.read_json import read_json -from src.mongodb.cl_mongodb import MongoDB +from src.api_access.cl_api_access import ApiAccess def check_api_key(args): @@ -19,13 +19,13 @@ def check_api_key(args): mongo_uri = payload_data["mongo_uri"] # Create an instance of MongoDB connection - mongodb = MongoDB( + apiAccess = ApiAccess( db_name=payload_data["db_name"], collection_name=payload_data["collection_name"], mongo_uri=mongo_uri) # Check the validation of the API key using MongoDB - result = mongodb.check_validation_api(api_key=str(Path(args['api_key'])), user=str(Path(args['user']))) + result = apiAccess.check_validation_api(api_key=str(Path(args['api_key'])), user=str(Path(args['user']))) # Perform garbage collection to free up memory gc.collect() diff --git a/src/utils/create_api.py b/src/utils/create_api.py index 40d813e..26e63d0 100644 --- a/src/utils/create_api.py +++ b/src/utils/create_api.py @@ -3,7 +3,7 @@ from datetime import datetime from src.utils.read_json import read_json -from src.mongodb.cl_mongodb import MongoDB +from src.api_access.cl_api_access import ApiAccess from src.utils.utils_funcs import generate_api_key from src.models.api_model import APIModel @@ -21,7 +21,7 @@ def create_api_key(args): mongo_uri = payload_data["mongo_uri"] # Create an instance of MongoDB connection - mongodb = MongoDB( + apiAccess = ApiAccess( db_name=payload_data["db_name"], collection_name=payload_data["collection_name"], mongo_uri=mongo_uri) @@ -41,7 +41,7 @@ def create_api_key(args): } # Create the API key in the MongoDB database - result = mongodb.create_api(data) + result = apiAccess.create_api(data) # Perform garbage collection to free up memory gc.collect() diff --git a/src/utils/delete_api.py b/src/utils/delete_api.py index f655229..8a00cc6 100644 --- a/src/utils/delete_api.py +++ b/src/utils/delete_api.py @@ -2,7 +2,7 @@ from pathlib import Path from src.utils.read_json import read_json -from src.mongodb.cl_mongodb import MongoDB +from src.api_access.cl_api_access import ApiAccess def delete_api_key(args): """ @@ -18,13 +18,13 @@ def delete_api_key(args): mongo_uri = payload_data["mongo_uri"] # Create an instance of MongoDB connection - mongodb = MongoDB( + apiAccess = ApiAccess( db_name=payload_data["db_name"], collection_name=payload_data["collection_name"], mongo_uri=mongo_uri) # Delete the API key from the MongoDB database - result = mongodb.delete_api(api_key=str(Path(args['api_key'])), user=str(Path(args['user']))) + result = apiAccess.delete_api(api_key=str(Path(args['api_key'])), user=str(Path(args['user']))) # Perform garbage collection to free up memory gc.collect() diff --git a/src/utils/total_process.py b/src/utils/total_process.py index 802b10a..aa7344c 100644 --- a/src/utils/total_process.py +++ b/src/utils/total_process.py @@ -13,7 +13,7 @@ from src.pdf2img.cl_pdf_to_image import Pdf2Img from src.finetune.cl_fine_tuning import FineTuning from src.mathpix.cl_mathpix import Mathpix -from src.mongodb.cl_mongodb import MongoDB +from src.api_access.cl_api_access import ApiAccess from src.utils.utils_funcs import is_image_file, is_pdf_file, is_text_file, copy_file_to_folder, get_image_pages_percentage @@ -26,12 +26,12 @@ def total_process(args): mongo_uri = payload_data["mongo_uri"] # Call class instance - mongodb = MongoDB( + apiAccess = ApiAccess( db_name=payload_data["db_name"], collection_name=payload_data["collection_name"], mongo_uri=mongo_uri) - is_available = mongodb.check_validation_api(api_key=str(Path(args['api_key'])), user=str(Path(args['user']))) + is_available = apiAccess.check_validation_api(api_key=str(Path(args['api_key'])), user=str(Path(args['user']))) if is_available['status'] == "success": print("valid api key")