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

update to 25.5

Author: boiledgas

README.md

@@ -29,8 +29,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.
 
 ## Installation
@@ -46,15 +46,15 @@ gem build aspose_pdf_cloud.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./aspose_pdf_cloud-25.4.0.gem
+gem install ./aspose_pdf_cloud-25.5.0.gem
 ```
-(for development, run `gem install --dev ./aspose_pdf_cloud-25.4.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./aspose_pdf_cloud-25.5.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'aspose_pdf_cloud', '~> 25.4.0'
+    gem 'aspose_pdf_cloud', '~> 25.5.0'
 
 ### Install from Git
 

docs/PdfApi.md

@@ -203,6 +203,7 @@ Method | HTTP request | Description
 [**post_change_password_document_in_storage**](PdfApi.md#post_change_password_document_in_storage) | **POST** /pdf/\{name}/changepassword | Change document password in storage.
 [**post_check_box_fields**](PdfApi.md#post_check_box_fields) | **POST** /pdf/\{name}/fields/checkbox | Add document checkbox fields.
 [**post_combo_box_fields**](PdfApi.md#post_combo_box_fields) | **POST** /pdf/\{name}/fields/combobox | Add document combobox fields.
+[**post_compare_pdf**](PdfApi.md#post_compare_pdf) | **POST** /pdf/compare | Compare two PDF documents.
 [**post_create_document**](PdfApi.md#post_create_document) | **POST** /pdf/\{name} | Create empty document.
 [**post_create_field**](PdfApi.md#post_create_field) | **POST** /pdf/\{name}/fields | Create field.
 [**post_decrypt_document_in_storage**](PdfApi.md#post_decrypt_document_in_storage) | **POST** /pdf/\{name}/decrypt | Decrypt document in storage.
@@ -2863,6 +2864,12 @@ Convert MHT file (located on storage) to PDF format and return resulting file in
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **src_path** | **String**| Full source filename (ex. /folder1/folder2/template.mht) | 
+ **height** | **Float**| Page height | [optional] 
+ **width** | **Float**| Page width | [optional] 
+ **margin_left** | **Float**| Page margin left | [optional] 
+ **margin_bottom** | **Float**| Page margin bottom | [optional] 
+ **margin_right** | **Float**| Page margin right | [optional] 
+ **margin_top** | **Float**| Page margin top | [optional] 
  **storage** | **String**| The document storage. | [optional] 
 
 ### Return type
@@ -5418,6 +5425,31 @@ Name | Type | Description  | Notes
 
 
 
+# **post_compare_pdf**
+> AsposeResponse post_compare_pdf(path1, path2, out_path, opts)
+
+Compare two PDF documents.
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path1** | **String**| Path to first PDF document. | 
+ **path2** | **String**| Path to second PDF document. | 
+ **out_path** | **String**| Full filename of the resulting document. | 
+ **storage** | **String**| The documents storage. | [optional] 
+
+### Return type
+
+[**AsposeResponse**](AsposeResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **post_create_document**
 > DocumentResponse post_create_document(name, document_config, opts)
 
@@ -8131,6 +8163,12 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **name** | **String**| The document name. | 
  **src_path** | **String**| Full source filename (ex. /folder1/folder2/template.mht) | 
+ **height** | **Float**| Page height | [optional] 
+ **width** | **Float**| Page width | [optional] 
+ **margin_left** | **Float**| Page margin left | [optional] 
+ **margin_bottom** | **Float**| Page margin bottom | [optional] 
+ **margin_right** | **Float**| Page margin right | [optional] 
+ **margin_top** | **Float**| Page margin top | [optional] 
  **dst_folder** | **String**| The destination document folder. | [optional] 
  **storage** | **String**| The document storage. | [optional] 
 

lib/aspose_pdf_cloud/api/pdf_api.rb

@@ -7597,6 +7597,12 @@ def get_markdown_in_storage_to_pdf_with_http_info(src_path, opts = {})
     # 
     # @param src_path Full source filename (ex. /folder1/folder2/template.mht)
     # @param [Hash] opts the optional parameters
+    # @option opts [Float] :height Page height
+    # @option opts [Float] :width Page width
+    # @option opts [Float] :margin_left Page margin left
+    # @option opts [Float] :margin_bottom Page margin bottom
+    # @option opts [Float] :margin_right Page margin right
+    # @option opts [Float] :margin_top Page margin top
     # @option opts [String] :storage The document storage.
     # @return [File]
     def get_mht_in_storage_to_pdf(src_path, opts = {})
@@ -7616,6 +7622,12 @@ def get_mht_in_storage_to_pdf(src_path, opts = {})
     # 
     # @param src_path Full source filename (ex. /folder1/folder2/template.mht)
     # @param [Hash] opts the optional parameters
+    # @option opts [Float] :height Page height
+    # @option opts [Float] :width Page width
+    # @option opts [Float] :margin_left Page margin left
+    # @option opts [Float] :margin_bottom Page margin bottom
+    # @option opts [Float] :margin_right Page margin right
+    # @option opts [Float] :margin_top Page margin top
     # @option opts [String] :storage The document storage.
     # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
     def get_mht_in_storage_to_pdf_with_http_info(src_path, opts = {})
@@ -7632,6 +7644,12 @@ def get_mht_in_storage_to_pdf_with_http_info(src_path, opts = {})
       # query parameters
       query_params = {}
       query_params[:'srcPath'] = src_path
+      query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
+      query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
+      query_params[:'marginLeft'] = opts[:'margin_left'] if !opts[:'margin_left'].nil?
+      query_params[:'marginBottom'] = opts[:'margin_bottom'] if !opts[:'margin_bottom'].nil?
+      query_params[:'marginRight'] = opts[:'margin_right'] if !opts[:'margin_right'].nil?
+      query_params[:'marginTop'] = opts[:'margin_top'] if !opts[:'margin_top'].nil?
       query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
 
       # header parameters
@@ -15597,6 +15615,90 @@ def post_combo_box_fields_with_http_info(name, fields, opts = {})
       return data, status_code, headers
     end
 
+    # Compare two PDF documents.
+    # 
+    # @param path1 Path to first PDF document.
+    # @param path2 Path to second PDF document.
+    # @param out_path Full filename of the resulting document.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage The documents storage.
+    # @return [AsposeResponse]
+    def post_compare_pdf(path1, path2, out_path, opts = {})
+      @api_client.request_token_if_needed
+      data, _status_code, _headers = post_compare_pdf_with_http_info(path1, path2, out_path, opts)
+      rescue ApiError => error
+        if error.code == 401
+          @api_client.request_token_if_needed
+          data, _status_code, _headers = post_compare_pdf_with_http_info(path1, path2, out_path, opts)
+        else
+          raise
+        end
+      return data
+    end
+
+    # Compare two PDF documents.
+    # 
+    # @param path1 Path to first PDF document.
+    # @param path2 Path to second PDF document.
+    # @param out_path Full filename of the resulting document.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage The documents storage.
+    # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
+    def post_compare_pdf_with_http_info(path1, path2, out_path, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PdfApi.post_compare_pdf ..."
+      end
+      # verify the required parameter 'path1' is set
+      if @api_client.config.client_side_validation && path1.nil?
+        fail ArgumentError, "Missing the required parameter 'path1' when calling PdfApi.post_compare_pdf"
+      end
+      # verify the required parameter 'path2' is set
+      if @api_client.config.client_side_validation && path2.nil?
+        fail ArgumentError, "Missing the required parameter 'path2' when calling PdfApi.post_compare_pdf"
+      end
+      # verify the required parameter 'out_path' is set
+      if @api_client.config.client_side_validation && out_path.nil?
+        fail ArgumentError, "Missing the required parameter 'out_path' when calling PdfApi.post_compare_pdf"
+      end
+      # resource path
+      local_var_path = "/pdf/compare"
+
+      # query parameters
+      query_params = {}
+      query_params[:'path1'] = path1
+      query_params[:'path2'] = path2
+      query_params[:'outPath'] = out_path
+      query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+      # Fix header in file
+      post_body = nil
+
+      # http body (model)
+      # Fix header in file
+      # post_body = nil
+      auth_names = ['JWT']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'AsposeResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PdfApi#post_compare_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create empty document.
     # 
     # @param name The new document name.
@@ -24152,6 +24254,12 @@ def put_merge_documents_with_http_info(name, merge_documents, opts = {})
     # @param name The document name.
     # @param src_path Full source filename (ex. /folder1/folder2/template.mht)
     # @param [Hash] opts the optional parameters
+    # @option opts [Float] :height Page height
+    # @option opts [Float] :width Page width
+    # @option opts [Float] :margin_left Page margin left
+    # @option opts [Float] :margin_bottom Page margin bottom
+    # @option opts [Float] :margin_right Page margin right
+    # @option opts [Float] :margin_top Page margin top
     # @option opts [String] :dst_folder The destination document folder.
     # @option opts [String] :storage The document storage.
     # @return [AsposeResponse]
@@ -24173,6 +24281,12 @@ def put_mht_in_storage_to_pdf(name, src_path, opts = {})
     # @param name The document name.
     # @param src_path Full source filename (ex. /folder1/folder2/template.mht)
     # @param [Hash] opts the optional parameters
+    # @option opts [Float] :height Page height
+    # @option opts [Float] :width Page width
+    # @option opts [Float] :margin_left Page margin left
+    # @option opts [Float] :margin_bottom Page margin bottom
+    # @option opts [Float] :margin_right Page margin right
+    # @option opts [Float] :margin_top Page margin top
     # @option opts [String] :dst_folder The destination document folder.
     # @option opts [String] :storage The document storage.
     # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
@@ -24194,6 +24308,12 @@ def put_mht_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
       # query parameters
       query_params = {}
       query_params[:'srcPath'] = src_path
+      query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
+      query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
+      query_params[:'marginLeft'] = opts[:'margin_left'] if !opts[:'margin_left'].nil?
+      query_params[:'marginBottom'] = opts[:'margin_bottom'] if !opts[:'margin_bottom'].nil?
+      query_params[:'marginRight'] = opts[:'margin_right'] if !opts[:'margin_right'].nil?
+      query_params[:'marginTop'] = opts[:'margin_top'] if !opts[:'margin_top'].nil?
       query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
       query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
 

lib/aspose_pdf_cloud/version.rb

@@ -20,5 +20,5 @@
 =end
 
 module AsposePdfCloud
-  VERSION = "25.4.0"
+  VERSION = "25.5.0"
 end

test/pdf_tests.rb

@@ -40,7 +40,7 @@ def setup
     @temp_folder = 'TempPdfCloud'
     @test_data_folder = 'test_data/'
     config = @pdf_api.api_client.config
-    config.scheme = 'https'
+    config.scheme = 'http'
   end
 
   def teardown
@@ -6755,4 +6755,19 @@ def test_post_xmp_metadata
     assert(response, 'Failed to get xmp metadata in json format')
     assert_equal(9, response[0].properties.count, 'Failed to read document xmp metadata.')
   end
+
+  def test_post_compare_pdf
+    file_name_1 = '4pages.pdf'
+    upload_file(file_name_1)
+
+    file_name_2 = '4pagesPdfA.pdf'
+    upload_file(file_name_2)
+
+    opts = {
+      folder: @temp_folder
+    }
+
+    response = @pdf_api.post_compare_pdf(@temp_folder + '/' + file_name_1, @temp_folder + '/' + file_name_2, @temp_folder + '/' + 'output.pdf', opts)
+    assert(response, 'Failed to compare a PDF files.')
+  end
 end