Skip to content

Update Attachments uses cases #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kaferi merged 4 commits into from
Feb 28, 2025
Merged

Update Attachments uses cases #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6cdb434
Update Attachments uses cases
Dmitriy-Xawstov Feb 28, 2025
df0f7d3
update-attachmants-get-uses-cases
Dmitriy-Xawstov Feb 28, 2025
4ea1703
Delete getAttachmentAndSave.py
Dmitriy-Xawstov Feb 28, 2025
ebb42f5
update-attachments-get-uses-cases
Dmitriy-Xawstov Feb 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 32 additions & 45 deletions Uses-Cases/Attachments/add/appendAttachments.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,67 +36,54 @@ def _init_api(self, credentials_file: Path):
except (FileNotFoundError, json.JSONDecodeError, ValueError) as e:
logging.error(f"init_api(): Failed to load credentials: {e}")

def _ensure_api_initialized(self):
"""Check if the API is initialized before making API calls."""
if not self.pdf_api:
logging.error("ensure_api_initialized(): PDF API is not initialized. Operation aborted.")
return False
return True

def upload_file(self, fileName: str):
""" Upload a local fileName to the Aspose Cloud server. """
if not self._ensure_api_initialized():
return

file_path = Config.LOCAL_FOLDER / 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}")
if self.pdf_api:
file_path = Config.LOCAL_FOLDER / 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.PDF_DOCUMENT_NAME)

def download_result(self):
""" Download the processed PDF document from the Aspose Cloud server. """
if not self._ensure_api_initialized():
return

try:
file_path = self.pdf_api.download_file(Config.PDF_DOCUMENT_NAME)
local_path = Config.LOCAL_FOLDER / Config.LOCAL_RESULT_DOCUMENT_NAME
shutil.move(file_path, 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}")
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_attachmnet(self):
"""Append a new attachment to the PDF document."""
if not self._ensure_api_initialized():
return

new_attachment = AttachmentInfo(
path = Config.NEW_ATTACHMENT_FILE,
description = 'This is a sample attachment',
mime_type = Config.NEW_ATTACHMENT_MIME,
name = Config.NEW_ATTACHMENT_FILE
)

try:
response = self.pdf_api.post_add_document_attachment(Config.PDF_DOCUMENT_NAME, new_attachment)
if response.code == 200:
logging.info(f"append_attachment(): attachment '{Config.NEW_ATTACHMENT_FILE}' added to the document '{Config.PDF_DOCUMENT_NAME}'.")
else:
logging.error(f"append_attachment(): Failed to add attachment to the document. Response code: {response.code}")
except Exception as e:
logging.error(f"append_attachment(): Error while adding attachment: {e}")
if self.pdf_api:
new_attachment = AttachmentInfo(
path = Config.NEW_ATTACHMENT_FILE,
description = 'This is a sample attachment',
mime_type = Config.NEW_ATTACHMENT_MIME,
name = Config.NEW_ATTACHMENT_FILE
)

try:
response = self.pdf_api.post_add_document_attachment(Config.PDF_DOCUMENT_NAME, new_attachment)
if response.code == 200:
logging.info(f"append_attachment(): attachment '{Config.NEW_ATTACHMENT_FILE}' added to the document '{Config.PDF_DOCUMENT_NAME}'.")
else:
logging.error(f"append_attachment(): Failed to add attachment to the document. Response code: {response.code}")
except Exception as e:
logging.error(f"append_attachment(): Error while adding attachment: {e}")


if __name__ == "__main__":
pdf_attachments = PdfAttachments()
pdf_attachments.upload_document()
pdf_attachments.upload_file(Config.NEW_ATTACHMENT_FILE)
pdf_attachments.append_attachmnet()
pdf_attachments.download_result()
pdf_attachments.download_result()
76 changes: 31 additions & 45 deletions Uses-Cases/Attachments/get/getAttachmentAndSave.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
# 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")
Expand All @@ -33,61 +32,48 @@ def _init_api(self, credentials_file: Path):
except (FileNotFoundError, json.JSONDecodeError, ValueError) as e:
logging.error(f"init_api(): Failed to load credentials: {e}")

def _ensure_api_initialized(self):
"""Check if the API is initialized before making API calls."""
if not self.pdf_api:
logging.error("ensure_api_initialized(): PDF API is not initialized. Operation aborted.")
return False
return True

def upload_document(self):
"""Upload a PDF document to the Aspose Cloud server."""
if not self._ensure_api_initialized():
return

file_path = Config.LOCAL_FOLDER / Config.PDF_DOCUMENT_NAME
try:
self.pdf_api.upload_file(Config.PDF_DOCUMENT_NAME, 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}")
if self.pdf_api:
file_path = Config.LOCAL_FOLDER / Config.PDF_DOCUMENT_NAME
try:
self.pdf_api.upload_file(Config.PDF_DOCUMENT_NAME, 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 get_attachments(self):
"""Get attachments for the PDF document."""
if not self._ensure_api_initialized():
return

try:
response : AttachmentsResponse = self.pdf_api.get_document_attachments(Config.PDF_DOCUMENT_NAME)
if response.code == 200:
logging.info(f"get_attachmnets(): attachments '{response.attachments}' for the document '{Config.PDF_DOCUMENT_NAME}'.")
Config.ATTACHMENT_PATH = response.attachments.list[0].links[0].href;
else:
logging.error(f"get_attachmnets(): Failed to get attachments to the document. Response code: {response.code}")
except Exception as e:
logging.error(f"get_attachmnets(): Error while adding attachment: {e}")
if self.pdf_api:
try:
response : AttachmentsResponse = self.pdf_api.get_document_attachments(Config.PDF_DOCUMENT_NAME)
if response.code == 200:
logging.info(f"get_attachmnets(): attachments '{response.attachments}' for the document '{Config.PDF_DOCUMENT_NAME}'.")
Config.ATTACHMENT_PATH = response.attachments.list[0].links[0].href
else:
logging.error(f"get_attachmnets(): Failed to get attachments to the document. Response code: {response.code}")
except Exception as e:
logging.error(f"get_attachmnets(): Error while adding attachment: {e}")

def get_attachment_by_id(self):
"""Get attachment by Id for the PDF document and save it to local file."""
if not self._ensure_api_initialized():
return

try:
response : AttachmentResponse = self.pdf_api.get_document_attachment_by_index(Config.PDF_DOCUMENT_NAME, Config.ATTACHMENT_PATH)
if response.code == 200:
attachment: Attachment = response.attachment
file_path = self.pdf_api.get_download_document_attachment_by_index(Config.PDF_DOCUMENT_NAME, Config.ATTACHMENT_PATH)
local_path = Config.LOCAL_FOLDER / attachment.name
shutil.copy(file_path, local_path)
logging.info(f"get_attachmnets(): attachments '{file_path}' for the document '{Config.PDF_DOCUMENT_NAME}' successfuly saved.")
else:
logging.error(f"get_attachmnets(): Failed to get attachments to the document. Response code: {response.code}")
except Exception as e:
logging.error(f"get_attachmnets(): Error while get attachment: {e}")
if self.pdf_api:
try:
response : AttachmentResponse = self.pdf_api.get_document_attachment_by_index(Config.PDF_DOCUMENT_NAME, Config.ATTACHMENT_PATH)
if response.code == 200:
attachment: Attachment = response.attachment
temp_file = self.pdf_api.get_download_document_attachment_by_index(Config.PDF_DOCUMENT_NAME, Config.ATTACHMENT_PATH)
local_path = Config.LOCAL_FOLDER / attachment.name
shutil.copy(temp_file, local_path)
logging.info(f"get_attachment_by_id(): attachment '{local_path}' for the document '{Config.PDF_DOCUMENT_NAME}' successfuly saved.")
else:
logging.error(f"get_attachment_by_id(): Failed to get attachment for the document '{Config.PDF_DOCUMENT_NAME}'. Response code: {response.code}")
except Exception as e:
logging.error(f"get_attachment_by_id(): Error while get attachment: {e}")


if __name__ == "__main__":
pdf_attachments = PdfAttachments()
pdf_attachments.upload_document()
pdf_attachments.get_attachments()
pdf_attachments.get_attachment_by_id()
pdf_attachments.get_attachment_by_id()