Merge pull request #106 from aspose-pdf-cloud/develop

update to 25.5

Author: boiledgas

README.md

@@ -30,8 +30,8 @@ XLS, XLSX, PPTX, DOC, DOCX, MobiXML, JPEG, EMF, PNG, BMP, GIF, TIFF, Text
 ## Read PDF Formats
 MHT, PCL, PS, XSLFO, MD
 
-## Enhancements in Version 25.4
-- Add method for adding Stamp per page in batch.
+## Enhancements in Version 25.5
+- Add a method for comparing pdf files.
 - A new version of Aspose.PDF Cloud was prepared using the latest version of Aspose.PDF for .NET.
 
 ## Requirements.

Uses-Cases/CompressDocument/compressPdf.py

@@ -0,0 +1,90 @@
+import shutil
+import json
+import logging
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi, OptimizeOptions
+
+# Configure logging
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+
+class Config:
+    """Configuration parameters."""
+    CREDENTIALS_FILE = Path(r"C:\\Projects\\ASPOSE\\Pdf.Cloud\\Credentials\\credentials.json")
+    LOCAL_FOLDER = Path(r"C:\Samples")
+    TEMP_FOLDER = 'TempPdfCloud'
+    PDF_DOCUMENT_NAME = "sample.pdf"
+    LOCAL_RESULT_DOCUMENT_NAME = "output_sample.pdf"
+
+class PdfCompress:
+    """Class for compress PDF links using Aspose PDF Cloud API."""
+    def __init__(self, credentials_file: Path = Config.CREDENTIALS_FILE):
+        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("init_api(): 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"init_api(): Failed to load credentials: {e}")
+
+    def upload_document(self):
+        """Upload a PDF document to the Aspose Cloud server."""
+        if self.pdf_api:
+            file_path = Config.LOCAL_FOLDER / Config.PDF_DOCUMENT_NAME
+            stotage_path = Config.TEMP_FOLDER + '/' + Config.PDF_DOCUMENT_NAME
+            try:
+                self.pdf_api.upload_file(stotage_path, str(file_path))
+                logging.info(f"upload_document(): File {Config.PDF_DOCUMENT_NAME} uploaded successfully.")
+            except Exception as e:
+                logging.error(f"upload_document(): Failed to upload file: {e}")
+
+    def download_result(self):
+        """Download the processed PDF document from the Aspose Cloud server."""
+        if self.pdf_api:
+            try:
+                temp_file = self.pdf_api.download_file(Config.TEMP_FOLDER + '/' + Config.PDF_DOCUMENT_NAME)
+                local_path = Config.LOCAL_FOLDER / Config.LOCAL_RESULT_DOCUMENT_NAME
+                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}")
+
+    def compress_pdf_document(self):
+        """Compress the PDF document."""
+        if self.pdf_api:
+            optimize_options = OptimizeOptions(
+                allow_reuse_page_content=False,
+                compress_images=True,
+                image_quality=100,
+                link_duplcate_streams=True,
+                remove_unused_objects=True,
+                remove_unused_streams=True,            
+                unembed_fonts=True
+            )        
+        opts = {
+            "options" : optimize_options,
+            "folder" : Config.TEMP_FOLDER
+        }
+        try:
+            response = self.pdf_api.post_optimize_document(Config.PDF_DOCUMENT_NAME, **opts)
+
+            if response.code == 200:
+                logging.info(f"compress_pdf_document(): PDF document '{Config.PDF_DOCUMENT_NAME}' successfully compressed.")
+            else:
+                logging.error(f"compress_pdf_document(): Failed to compress document. Response code: {response.code}")
+        except Exception as e:
+            logging.error(f"compress_pdf_document(): Error while compress document: {e}")
+
+
+if __name__ == "__main__":
+    pdf_compress = PdfCompress()
+    pdf_compress.upload_document()
+    pdf_compress.compress_pdf_document()
+    pdf_compress.download_result()

Uses-Cases/CreateDocument/createPdf.py

@@ -0,0 +1,90 @@
+import shutil
+import json
+import logging
+import pathlib
+import math
+from asposepdfcloud import ApiClient, PdfApi, Direction, PageMode, PageLayout, DocumentConfig, DocumentProperties, DocumentProperty, DisplayProperties, DefaultPageConfig
+
+# Configure logging
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+class Config:
+    """Configuration parameters."""
+    CREDENTIALS_FILE = pathlib.Path(r"C:\\Projects\\ASPOSE\\Pdf.Cloud\\Credentials\\credentials.json")
+    LOCAL_FOLDER = pathlib.Path(r"C:\Samples")
+    TEMP_FOLDER = 'TempPdfCloud'
+    LOCAL_RESULT_DOCUMENT_NAME = "output_sample.pdf"
+    PAGE_WIDTH = 590
+    PAGE_HEIGHT = 894
+    PAGES_COUNT = 5
+
+class PdfPageChanges:
+    """ Class for managing PDF page changes using Aspose PDF Cloud API. """
+    def __init__(self, credentials_file: pathlib.Path = Config.CREDENTIALS_FILE):
+        self.pdf_api = None
+        self._init_api(credentials_file)
+
+    def _init_api(self, credentials_file: pathlib.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("init_api(): 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"init_api(): Failed to load credentials: {e}")
+
+    def download_result(self):
+        """ Download the processed PDF document from the Aspose Cloud server. """
+        if self.pdf_api:
+            try:
+                temp_file = self.pdf_api.download_file(Config.TEMP_FOLDER + '/' + Config.LOCAL_RESULT_DOCUMENT_NAME)
+                local_path = Config.LOCAL_FOLDER / Config.LOCAL_RESULT_DOCUMENT_NAME
+                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}")
+
+    
+    def create_document(self):
+        """ Create PDF document with required properties. """
+        opts = {
+            "folder" : Config.TEMP_FOLDER
+        }
+
+        document_config = DocumentConfig(
+            document_properties=DocumentProperties(
+                list=[
+                    DocumentProperty(
+                        built_in=False,
+                        name='prop1',
+                        value='Val1',
+                    )
+                ]),
+            display_properties=DisplayProperties(
+                center_window = True,
+                hide_menu_bar = True,
+                direction = Direction.L2R,
+                display_doc_title = True,
+                hide_tool_bar = True,
+                hide_window_ui = True,
+                non_full_screen_page_mode = PageMode.USETHUMBS,
+                page_layout = PageLayout.TWOPAGELEFT,
+                page_mode = PageMode.USETHUMBS
+            ),
+            default_page_config=DefaultPageConfig(
+                height=Config.PAGE_HEIGHT,
+                width=Config.PAGE_WIDTH
+            ),
+            pages_count=Config.PAGES_COUNT
+        )
+        response = self.pdf_api.post_create_document(Config.LOCAL_RESULT_DOCUMENT_NAME, document_config, **opts)
+        logging.info(f"Document #{Config.LOCAL_RESULT_DOCUMENT_NAME} created.")
+        return response
+
+if __name__ == "__main__":
+    pdf_pages = PdfPageChanges()
+    pdf_pages.create_document()
+    pdf_pages.download_result()

Uses-Cases/CreateDocument/createPdfSimple.py

@@ -0,0 +1,39 @@
+import shutil
+import json
+import logging
+import os
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi
+
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+credentials_file = Path( os.path.join(os.path.dirname(os.path.realpath('__file__')), "..\Credentials\credentials.json"))
+local_folder = Path(r"C:\Samples")
+pdf_document = "output_sample.pdf"
+
+pdf_api = None
+
+try:
+    """ Load credentials and create PDF Rest API object """
+    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("init_api(): Error: Missing API keys in the credentials file.")
+        pdf_api = PdfApi(ApiClient(api_key, app_id))
+
+    if pdf_api:
+        """ Create empty PDF document """
+        pdf_response = pdf_api.put_create_document(pdf_document)
+        if pdf_response.code == 200:
+            logging.info(f"Document #{pdf_document} created.")
+
+            """ Download empty PDF document to local folder """
+            temp_file = pdf_api.download_file(pdf_document)
+            local_path = local_folder / pdf_document
+            shutil.move(temp_file, str(local_path))
+            logging.info(f"download_result(): File successfully downloaded: {local_path}")
+except Exception as err:
+
+    logging.error(f"Failed to create empty Pdfdocument '{pdf_document}'!.")
+    logging.error(f"Unexpected {err=}, {type(err)=}")

Uses-Cases/Signatures/addDocumentSignature.py

@@ -0,0 +1,109 @@
+import shutil
+import json
+import logging
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi, Signature, SignatureType, SignatureField, Rectangle
+
+# Configure logging
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+
+class Config:
+    """Configuration parameters."""
+    CREDENTIALS_FILE = Path(r"C:\\Projects\\ASPOSE\\Pdf.Cloud\\Credentials\\credentials.json")
+    LOCAL_FOLDER = Path(r"C:\Samples")
+    PDF_DOCUMENT_NAME = "sample.pdf"
+    LOCAL_RESULT_DOCUMENT_NAME = "output_sample.pdf"
+    LOCAL_SIGNATURE_PATH = Path(r"C:\Samples\Signatures\3")
+    SIGNATURE_PFX = "signature.pfx"
+    SIGNATURE_FORM_FIELD = 'Signature_1'
+    SIGNATURE_PASSWORD='Password'
+    SIGNATURE_CONTACT='Contact'
+    SIGNATURE_LOCATION='Location'
+    SIGNATURE_AUTHORITY='Issuer'
+    SIGNATURE_DATE='04/19/2025 12:15:00.000 PM'
+    SIGNATURE_RECT = Rectangle(100, 100, 500, 500)
+
+
+class PdfSignatures:
+    """Class for managing PDF signatures using Aspose PDF Cloud API."""
+    def __init__(self, credentials_file: Path = Config.CREDENTIALS_FILE):
+        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("init_api(): 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"init_api(): Failed to load credentials: {e}")
+
+    def upload_file(self, local_path: Path, fileName: str):
+        """ Upload a local fileName to the Aspose Cloud server. """
+        if self.pdf_api:
+            file_path = local_path / 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 upload_document(self):
+        """ Upload a PDF document to the Aspose Cloud server. """
+        self.upload_file(Config.LOCAL_FOLDER, Config.PDF_DOCUMENT_NAME)
+
+
+    def download_result(self):
+        """Download the processed PDF document from the Aspose Cloud server."""
+        if self.pdf_api:
+            try:
+                temp_file = self.pdf_api.download_file(Config.PDF_DOCUMENT_NAME)
+                local_path = Config.LOCAL_FOLDER / Config.LOCAL_RESULT_DOCUMENT_NAME
+                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}")
+
+    def append_signature(self):
+        """Append a new signature to the PDF document."""
+        if self.pdf_api:
+            
+            signature = Signature(
+                signature_path=Config.SIGNATURE_PFX,
+                signature_type=SignatureType.PKCS7,
+                password=Config.SIGNATURE_PASSWORD,
+                contact=Config.SIGNATURE_CONTACT,
+                location=Config.SIGNATURE_LOCATION,
+                visible=True,
+                rectangle=Config.SIGNATURE_RECT,
+                form_field_name=Config.SIGNATURE_FORM_FIELD,
+                authority=Config.SIGNATURE_AUTHORITY,
+                date=Config.SIGNATURE_DATE,
+                show_properties=False)
+            
+            field = SignatureField(page_index=1)
+            field.signature = signature
+            field.partial_name = 'sign1'
+            field.rect = Config.SIGNATURE_RECT
+
+            try:
+                response = self.pdf_api.post_signature_field(Config.PDF_DOCUMENT_NAME, field)
+                if response.code == 200:
+                    logging.info(f"append_signature(): Signature '{Config.SIGNATURE_CONTACT}' successfully added to the document.")
+                else:
+                    logging.error(f"append_signature(): Failed to add signature to the document. Response code: {response.code}")
+            except Exception as e:
+                logging.error(f"append_signature(): Error while adding signature: {e}")
+
+
+if __name__ == "__main__":
+    pdf_sign = PdfSignatures()
+    pdf_sign.upload_document()
+    pdf_sign.upload_file(Config.LOCAL_SIGNATURE_PATH, Config.SIGNATURE_PFX)
+    pdf_sign.append_signature()
+    pdf_sign.download_result()