PDFCLOUD-4979: added snippets for Compare

Author: Dmitriy-Xawstov

Uses-Cases/Compares/compare_pdf_documents.py

@@ -0,0 +1,32 @@
+import logging
+import os
+from pathlib import Path
+from asposepdfcloud import PdfApi
+from compares_helper import CompareMain
+
+class Config:
+    """Configuration parameters."""
+    CREDENTIALS_FILE = Path(r"C:\\Projects\\ASPOSE\\Pdf.Cloud\\Credentials\\credentials.json")
+    LOCAL_FOLDER = Path(r"C:\Samples")
+    REMOTE_FOLDER = "Your_Temp_Pdf_Cloud"
+    PDF_DOCUMENT_1 = "sample_compare_1.pdf"
+    PDF_DOCUMENT_2 = "sample_compare_2.pdf"
+    PDF_OUTPUT     = "output_compare.pdf"
+
+class ComparePdfDocuments:
+	def __init__(self, pdf_api: PdfApi, compare_main: CompareMain):
+		self.pdfApi = pdf_api
+		self.compareMain = compare_main
+
+	def compareDocument(self):
+		self.compareMain.upload_file(Config.PDF_DOCUMENT_1, Config.LOCAL_FOLDER)
+		self.compareMain.upload_file(Config.PDF_DOCUMENT_2, Config.LOCAL_FOLDER)
+		try:
+			response = self.pdfApi.post_compare_pdf(Config.PDF_DOCUMENT_1, Config.PDF_DOCUMENT_2, Config.PDF_OUTPUT)
+			if response.code == 200:
+				logging.info(f"compareDocument(): Succsessfully compared.")
+				self.compareMain.download_result(Config.PDF_OUTPUT, Config.PDF_OUTPUT, Config.LOCAL_FOLDER)
+			else:
+				logging.error(f"compareDocument(): Failed to compare Pdf documents! Response code: {response.code}")
+		except Exception as e:
+			logging.error(f"compareDocument(): Error while comparing Pdf documents: {e}")

Uses-Cases/Compares/compares_helper.py

@@ -0,0 +1,47 @@
+import os
+import shutil
+import json
+import logging
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi
+
+# Configure logging
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+class CompareMain:
+	def __init__(self, credentials_file: Path):
+		self.pdf_api = None
+		self._init_api(credentials_file)
+
+	def _init_api(self, credentials_file: Path):
+		"""Initialize the API client."""
+		try:
+			with credentials_file.open("r", encoding="utf-8") as file:
+				credentials = json.load(file)
+			api_key, app_id = credentials.get("key"), credentials.get("id")
+			if not api_key or not app_id:
+				raise ValueError("Error: Missing API keys in the credentials file.")
+			self.pdf_api = PdfApi(ApiClient(api_key, app_id))
+		except (FileNotFoundError, json.JSONDecodeError, ValueError) as e:
+			logging.error(f"Failed to load credentials: {e}")
+	
+	def upload_file(self, fileName: str, localFolder: Path):
+		""" Upload a local fileName to the Aspose Cloud server. """
+		if self.pdf_api:
+			file_path = localFolder / fileName
+			try:
+				self.pdf_api.upload_file(fileName, str(file_path))
+				logging.info(f"upload_file(): File '{fileName}' uploaded successfully.")
+			except Exception as e:
+				logging.error(f"upload_document(): Failed to upload file: {e}")
+
+	def download_result(self, document: str, outputDocument: str, localFolder: Path):
+		"""Download the processed PDF document from the Aspose Cloud server."""
+		if self.pdf_api:
+			try:
+				temp_file = self.pdf_api.download_file(document)
+				local_path = localFolder / outputDocument
+				shutil.move(temp_file, str(local_path))
+				logging.info(f"download_result(): File successfully downloaded: {local_path}")
+			except Exception as e:
+				logging.error(f"download_result(): Failed to download file: {e}")

Uses-Cases/Compares/compares_launch.py

@@ -0,0 +1,7 @@
+from compares_helper import CompareMain
+from compare_pdf_documents import Config, ComparePdfDocuments
+
+if __name__ == "__main__":
+    comparator = CompareMain(Config.CREDENTIALS_FILE)
+    pdf_compares = ComparePdfDocuments(comparator.pdf_api, comparator)
+    pdf_compares.compareDocument()