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

update to 25.6

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.5
-- Add a method for comparing pdf files.
+## Enhancements in Version 25.6
+- Develop Rotate Document Pages method.
 - A new version of Aspose.PDF Cloud was prepared using the latest version of Aspose.PDF for .NET.
 
 ## Requirements.

Uses-Cases/Compares/compare_pdf_documents.py

@@ -0,0 +1,31 @@
+import logging
+from pathlib import Path
+from asposepdfcloud import PdfApi
+from compares_helper import CompareMain
+
+class Config:
+    """Configuration parameters."""
+    CREDENTIALS_FILE = Path(r"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()

asposepdfcloud/api_client.py

@@ -83,7 +83,7 @@ def __init__(self, app_key, app_sid, host=None, self_host=False):
         self.rest_client = RESTClientObject()
         self.default_headers = {}
         self.default_headers['x-aspose-client'] = 'python sdk'
-        self.default_headers['x-aspose-client-version'] = '25.5.0'
+        self.default_headers['x-aspose-client-version'] = '25.6.0'
 
         self.self_host = self_host
         self.app_key = app_key

asposepdfcloud/apis/pdf_api.py

@@ -24907,6 +24907,136 @@ def post_document_page_number_stamps_with_http_info(self, name, stamp, **kwargs)
                                         _request_timeout=params.get('_request_timeout'),
                                         collection_formats=collection_formats)
 
+    def post_document_pages_rotate(self, name, rotation_angle, pages, **kwargs):
+        """
+        Rotate PDF document.
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please define a `callback` function
+        to be invoked when receiving the response.
+        >>> def callback_function(response):
+        >>>     pprint(response)
+        >>>
+        >>> thread = api.post_document_pages_rotate(name, rotation_angle, pages, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str name: The document name. (required)
+        :param str rotation_angle: Rotation Angle (CKW). Can be 90, 180, 270. (required)
+        :param str pages: Comma separated list of pages and page ranges. (Example: 1,3-5,8) (required)
+        :param str storage: The document storage.
+        :param str folder: The document folder.
+        :param str password: Base64 encoded password.
+        :return: AsposeResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.post_document_pages_rotate_with_http_info(name, rotation_angle, pages, **kwargs)
+        else:
+            (data) = self.post_document_pages_rotate_with_http_info(name, rotation_angle, pages, **kwargs)
+            return data
+
+    def post_document_pages_rotate_with_http_info(self, name, rotation_angle, pages, **kwargs):
+        """
+        Rotate PDF document.
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please define a `callback` function
+        to be invoked when receiving the response.
+        >>> def callback_function(response):
+        >>>     pprint(response)
+        >>>
+        >>> thread = api.post_document_pages_rotate_with_http_info(name, rotation_angle, pages, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str name: The document name. (required)
+        :param str rotation_angle: Rotation Angle (CKW). Can be 90, 180, 270. (required)
+        :param str pages: Comma separated list of pages and page ranges. (Example: 1,3-5,8) (required)
+        :param str storage: The document storage.
+        :param str folder: The document folder.
+        :param str password: Base64 encoded password.
+        :return: AsposeResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['name', 'rotation_angle', 'pages', 'storage', 'folder', 'password']
+        all_params.append('callback')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method post_document_pages_rotate" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'name' is set
+        if ('name' not in params) or (params['name'] is None):
+            raise ValueError("Missing the required parameter `name` when calling `post_document_pages_rotate`")
+        # verify the required parameter 'rotation_angle' is set
+        if ('rotation_angle' not in params) or (params['rotation_angle'] is None):
+            raise ValueError("Missing the required parameter `rotation_angle` when calling `post_document_pages_rotate`")
+        # verify the required parameter 'pages' is set
+        if ('pages' not in params) or (params['pages'] is None):
+            raise ValueError("Missing the required parameter `pages` when calling `post_document_pages_rotate`")
+
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'name' in params:
+            path_params['name'] = params['name']
+
+        query_params = []
+        if 'rotation_angle' in params:
+            query_params.append(('rotationAngle', params['rotation_angle']))
+        if 'pages' in params:
+            query_params.append(('pages', params['pages']))
+        if 'storage' in params:
+            query_params.append(('storage', params['storage']))
+        if 'folder' in params:
+            query_params.append(('folder', params['folder']))
+        if 'password' in params:
+            query_params.append(('password', params['password']))
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.\
+            select_header_accept(['application/json'])
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.\
+            select_header_content_type(['application/json'])
+
+        # Authentication setting
+        auth_settings = ['JWT']
+
+        return self.api_client.call_api('/pdf/{name}/rotate', 'POST',
+                                        path_params,
+                                        query_params,
+                                        header_params,
+                                        body=body_params,
+                                        post_params=form_params,
+                                        files=local_var_files,
+                                        response_type='AsposeResponse',
+                                        auth_settings=auth_settings,
+                                        callback=params.get('callback'),
+                                        _return_http_data_only=params.get('_return_http_data_only'),
+                                        _preload_content=params.get('_preload_content', True),
+                                        _request_timeout=params.get('_request_timeout'),
+                                        collection_formats=collection_formats)
+
     def post_document_text_footer(self, name, text_footer, **kwargs):
         """
         Add document text footer.

asposepdfcloud/configuration.py

@@ -199,5 +199,5 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 3.0\n"\
-               "SDK Package Version: 25.5.0".\
+               "SDK Package Version: 25.6.0".\
                format(env=sys.platform, pyversion=sys.version)

docs/PdfApi.md

@@ -212,6 +212,7 @@ Method | HTTP request | Description
 [**post_document_image_stamps**](PdfApi.md#post_document_image_stamps) | **POST** /pdf/\{name}/stamps/image | Add document pages image stamps.
 [**post_document_image_stamps_page_specified**](PdfApi.md#post_document_image_stamps_page_specified) | **POST** /pdf/\{name}/stamps/image/pagespecified | Add document image stamps to specified pages.
 [**post_document_page_number_stamps**](PdfApi.md#post_document_page_number_stamps) | **POST** /pdf/\{name}/stamps/pagenumber | Add document page number stamps.
+[**post_document_pages_rotate**](PdfApi.md#post_document_pages_rotate) | **POST** /pdf/\{name}/rotate | Rotate PDF document.
 [**post_document_text_footer**](PdfApi.md#post_document_text_footer) | **POST** /pdf/\{name}/footer/text | Add document text footer.
 [**post_document_text_header**](PdfApi.md#post_document_text_header) | **POST** /pdf/\{name}/header/text | Add document text header.
 [**post_document_text_replace**](PdfApi.md#post_document_text_replace) | **POST** /pdf/\{name}/text/replace | Document's replace text method.
@@ -5660,6 +5661,33 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **post_document_pages_rotate**
+> AsposeResponse post_document_pages_rotate(name, rotation_angle, pages, storage=storage, folder=folder, password=password)
+
+Rotate PDF document.
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| The document name. | 
+ **rotation_angle** | **str**| Rotation Angle (CKW). Can be 90, 180, 270. | 
+ **pages** | **str**| Comma separated list of pages and page ranges. (Example: 1,3-5,8) | 
+ **storage** | **str**| The document storage. | [optional] 
+ **folder** | **str**| The document folder. | [optional] 
+ **password** | **str**| Base64 encoded password. | [optional] 
+
+### Return type
+
+[**AsposeResponse**](AsposeResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **post_document_text_footer**
 > AsposeResponse post_document_text_footer(name, text_footer, start_page_number=start_page_number, end_page_number=end_page_number, storage=storage, folder=folder)
 

setup.py

@@ -32,7 +32,7 @@
 from setuptools import setup, find_packages
 
 NAME = "asposepdfcloud"
-VERSION = "25.5.0"
+VERSION = "25.6.0"
 # To install the library, run the following
 #
 # python setup.py install

test/pdf_test.py

@@ -3444,6 +3444,15 @@ def testPostOrganizeDocuments(self):
         response = self.pdf_api.post_organize_documents(request, self.temp_folder + '/OrganizeMany.pdf')
         self.assertEqual(response.code, 200)
 
+    def testPostDocumentPagesRotate(self):
+        file_name = '4pages.pdf'
+        self.uploadFile(file_name)
+        opts = {
+            "folder" : self.temp_folder
+        }
+        response = self.pdf_api.post_document_pages_rotate(file_name, asposepdfcloud.models.Rotation.ON90, '2-3', **opts)
+        self.assertEqual(response.code, 200)
+
     # Fields Tests
 
     def testGetField(self):
@@ -4123,11 +4132,23 @@ def testPutReplaceMultipleImage(self):
         self.uploadFile(file_name)
         image_file_name = 'butterfly.jpg'
         self.uploadFile(image_file_name)
-        image_ids = ['GE5TENJVGQZTWMJYGQWDINRUFQ2DCMRMGY4TC', 'GE5TIMJSGY3TWMJXG4WDIMBZFQ2DCOJMGQ3DK']
+
+        opts1 = {
+              "folder" : self.temp_folder
+        }
+        responseImages1 = self.pdf_api.get_images(file_name, 1, **opts1)
+        self.assertEqual(responseImages1.code, 200)
+        image_id1 = responseImages1.images.list[0].id
+        responseImages2 = self.pdf_api.get_images(file_name, 16, **opts1)
+        self.assertEqual(responseImages2.code, 200)
+        image_id2 = responseImages2.images.list[0].id
+
+
         opts = {
               "image_file_path" : self.temp_folder + '/' + image_file_name,
               "folder" : self.temp_folder
         }
+        image_ids = [image_id1, image_id2]
         response = self.pdf_api.put_replace_multiple_image(file_name, image_ids, **opts)
         self.assertEqual(response.code, 200)