Merge branch 'master' into release

YaroslawEkimov · YaroslawEkimov · commit a4d360224aa2 · 2021-06-30T19:36:05.000+07:00
diff --git a/README.md b/README.md
@@ -13,10 +13,15 @@ This repository contains Aspose.Words Cloud SDK for Ruby source code. This SDK a
 * Watermarks and protection
 * Full read & write access to Document Object Model, including sections, paragraphs, text, images, tables, headers/footers and many others
 
+## Enhancements in Version 21.6
+
+- Implemented beta version of CompareDocumentOnline feature with both document sending in request
+- CompareDocument method now can handle PDF files
+
+
 ## Enhancements in Version 21.5
 
-- Updated dependencies in sdk
-- Implemented Batch API
+- Update dependencies in sdk
 
 
 ## Enhancements in Version 21.4
@@ -130,7 +135,7 @@ To use Aspose Words for Cloud Ruby SDK you need to register an account with [Asp
 To install this package do the following:
 update your Gemfile
 ```ruby
-gem 'aspose_words_cloud', '~> 21.5'
+gem 'aspose_words_cloud', '~> 21.6'
 ```
 or install directly
 ```bash
diff --git a/TestData/DocumentActions/CompareDocument/compareTestDoc1.pdf b/TestData/DocumentActions/CompareDocument/compareTestDoc1.pdf
diff --git a/TestData/DocumentActions/CompareDocument/compareTestDoc2.pdf b/TestData/DocumentActions/CompareDocument/compareTestDoc2.pdf
diff --git a/lib/aspose_words_cloud/api/words_api.rb b/lib/aspose_words_cloud/api/words_api.rb
@@ -987,6 +987,7 @@ def compare_document_online(request)
         form_params = {}
         form_params[downcase_first_letter('Document')] = request.document
         form_params[downcase_first_letter('CompareData')] = request.compare_data.to_body.to_json
+        form_params[downcase_first_letter('ComparingDocument')] = request.comparing_document
 
         # http body (model)
         post_body = nil
diff --git a/lib/aspose_words_cloud/api_client.rb b/lib/aspose_words_cloud/api_client.rb
@@ -352,9 +352,10 @@ def download_file(response)
   def download_file_from_multipart(body)
     prefix = 'download-'
     prefix += '-' unless prefix.end_with?('-')
-    tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding:body.encoding)
+    tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding:body.encoding, binmode: true)
     @tempfile = tempfile
     tempfile.write(body)
+    tempfile.size
     @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
                             "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
                             "will be deleted automatically with GC. It's also recommended to delete the temp file "\
diff --git a/lib/aspose_words_cloud/models/compare_options.rb b/lib/aspose_words_cloud/models/compare_options.rb
@@ -29,6 +29,9 @@ module AsposeWordsCloud
 
   # DTO container with compare documents options.
   class CompareOptions
+    # Gets or sets whether accept revisions before comparison or not.
+    attr_accessor :accept_all_revisions_before_comparison
+
     # Gets or sets a value indicating whether documents comparison is case insensitive. By default comparison is case sensitive.
     attr_accessor :ignore_case_changes
 
@@ -81,6 +84,7 @@ def valid?(value)
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'accept_all_revisions_before_comparison' => :'AcceptAllRevisionsBeforeComparison',
         :'ignore_case_changes' => :'IgnoreCaseChanges',
         :'ignore_comments' => :'IgnoreComments',
         :'ignore_fields' => :'IgnoreFields',
@@ -96,6 +100,7 @@ def self.attribute_map
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'accept_all_revisions_before_comparison' => :'BOOLEAN',
         :'ignore_case_changes' => :'BOOLEAN',
         :'ignore_comments' => :'BOOLEAN',
         :'ignore_fields' => :'BOOLEAN',
@@ -116,6 +121,10 @@ def initialize(attributes = {})
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.key?(:'AcceptAllRevisionsBeforeComparison')
+        self.accept_all_revisions_before_comparison = attributes[:'AcceptAllRevisionsBeforeComparison']
+      end
+
       if attributes.key?(:'IgnoreCaseChanges')
         self.ignore_case_changes = attributes[:'IgnoreCaseChanges']
       end
@@ -189,6 +198,7 @@ def target=(target)
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
+          accept_all_revisions_before_comparison == other.accept_all_revisions_before_comparison &&
           ignore_case_changes == other.ignore_case_changes &&
           ignore_comments == other.ignore_comments &&
           ignore_fields == other.ignore_fields &&
@@ -209,7 +219,7 @@ def eql?(other)
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [ignore_case_changes, ignore_comments, ignore_fields, ignore_footnotes, ignore_formatting, ignore_headers_and_footers, ignore_tables, ignore_textboxes, target].hash
+      [accept_all_revisions_before_comparison, ignore_case_changes, ignore_comments, ignore_fields, ignore_footnotes, ignore_formatting, ignore_headers_and_footers, ignore_tables, ignore_textboxes, target].hash
     end
 
     # Builds the object from hash
diff --git a/lib/aspose_words_cloud/models/requests/compare_document_online_request.rb b/lib/aspose_words_cloud/models/requests/compare_document_online_request.rb
@@ -35,6 +35,9 @@ class CompareDocumentOnlineRequest
     # Compare data.
     attr_accessor :compare_data
 
+    # The comparing document.
+    attr_accessor :comparing_document
+
     # Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     attr_accessor :load_encoding
 
@@ -48,13 +51,15 @@ class CompareDocumentOnlineRequest
     # Initializes a new instance.
     # @param document The document.
     # @param compare_data Compare data.
+    # @param comparing_document The comparing document.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
     # @param dest_file_name Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
 
-    def initialize(document, compare_data, load_encoding = nil, password = nil, dest_file_name = nil)
+    def initialize(document, compare_data, comparing_document = nil, load_encoding = nil, password = nil, dest_file_name = nil)
       self.document = document
       self.compare_data = compare_data
+      self.comparing_document = comparing_document
       self.load_encoding = load_encoding
       self.password = password
       self.dest_file_name = dest_file_name
@@ -90,6 +95,7 @@ def to_batch_part(api_client)
       form_params = {}
       form_params[downcase_first_letter('Document')] = self.document
       form_params[downcase_first_letter('CompareData')] = self.compare_data.to_body.to_json
+      form_params[downcase_first_letter('ComparingDocument')] = self.comparing_document unless self.comparing_document.nil?
 
       # http body (model)
       post_body = nil
@@ -139,6 +145,7 @@ def create_http_request(api_client)
       form_params = {}
       form_params[downcase_first_letter('Document')] = self.document
       form_params[downcase_first_letter('CompareData')] = self.compare_data.to_body.to_json
+      form_params[downcase_first_letter('ComparingDocument')] = self.comparing_document unless self.comparing_document.nil?
 
       # http body (model)
       post_body = nil
diff --git a/lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb b/lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb
@@ -123,7 +123,7 @@ def to_batch_part(api_client)
 
       # form parameters
       form_params = {}
-      form_params[downcase_first_letter('Data')] = self.data
+      form_params[downcase_first_letter('Data')] = self.data unless self.data.nil?
 
       # http body (model)
       post_body = nil
@@ -176,7 +176,7 @@ def create_http_request(api_client)
 
       # form parameters
       form_params = {}
-      form_params[downcase_first_letter('Data')] = self.data
+      form_params[downcase_first_letter('Data')] = self.data unless self.data.nil?
 
       # http body (model)
       post_body = nil
diff --git a/lib/aspose_words_cloud/models/requests/insert_watermark_image_request.rb b/lib/aspose_words_cloud/models/requests/insert_watermark_image_request.rb
@@ -123,7 +123,7 @@ def to_batch_part(api_client)
 
       # form parameters
       form_params = {}
-      form_params[downcase_first_letter('ImageFile')] = self.image_file
+      form_params[downcase_first_letter('ImageFile')] = self.image_file unless self.image_file.nil?
 
       # http body (model)
       post_body = nil
@@ -176,7 +176,7 @@ def create_http_request(api_client)
 
       # form parameters
       form_params = {}
-      form_params[downcase_first_letter('ImageFile')] = self.image_file
+      form_params[downcase_first_letter('ImageFile')] = self.image_file unless self.image_file.nil?
 
       # http body (model)
       post_body = nil
diff --git a/lib/aspose_words_cloud/version.rb b/lib/aspose_words_cloud/version.rb
@@ -24,5 +24,5 @@
 # ------------------------------------------------------------------------------------
 
 module AsposeWordsCloud
-  VERSION = "21.5.1".freeze
+  VERSION = "21.6.0".freeze
 end
diff --git a/tests/Document/compare_document_tests.rb b/tests/Document/compare_document_tests.rb
@@ -68,7 +68,24 @@ def test_compare_document_online
       upload_file File.join(local_test_folder, local_folder + '/' + local_name2), remote_folder + '/' + remote_name2
 
       request_compare_data = CompareData.new({:Author => 'author', :ComparingWithDocument => remote_folder + '/' + remote_name2, :DateTime => Date.iso8601('2015-10-26T00:00:00.0000000Z')})
-      request = CompareDocumentOnlineRequest.new(File.open(File.join(local_test_folder, local_folder + '/' + local_name1)), request_compare_data, nil, nil, remote_test_out + '/TestCompareDocumentOut.doc')
+      request = CompareDocumentOnlineRequest.new(File.open(File.join(local_test_folder, local_folder + '/' + local_name1)), request_compare_data, nil, nil, nil, remote_test_out + '/TestCompareDocumentOut.doc')
+
+      result = @words_api.compare_document_online(request)
+      assert_equal false, result.nil?
+    end
+
+    #
+    # Test for document comparison online.
+    #
+    def test_compare_two_document_online
+      local_name1 = 'compareTestDoc1.doc'
+      local_name2 = 'compareTestDoc2.doc'
+      remote_name2 = 'TestCompareDocument2.doc'
+
+      upload_file File.join(local_test_folder, local_folder + '/' + local_name2), remote_folder + '/' + remote_name2
+
+      request_compare_data = CompareData.new({:Author => 'author', :ComparingWithDocument => remote_folder + '/' + remote_name2, :DateTime => Date.iso8601('2015-10-26T00:00:00.0000000Z')})
+      request = CompareDocumentOnlineRequest.new(File.open(File.join(local_test_folder, local_folder + '/' + local_name1)), request_compare_data, File.open(File.join(local_test_folder, local_folder + '/' + local_name2)), nil, nil, remote_test_out + '/TestCompareDocumentOut.doc')
 
       result = @words_api.compare_document_online(request)
       assert_equal false, result.nil?
diff --git a/tests/document/compare_feature_tests.rb b/tests/document/compare_feature_tests.rb
@@ -0,0 +1,130 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="compare_feature_tests.rb">
+#   Copyright (c) 2021 Aspose.Words for Cloud
+# </copyright>
+# <summary>
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in all
+#  copies or substantial portions of the Software.
+#
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#  SOFTWARE.
+# </summary>
+# ------------------------------------------------------------------------------------
+
+module AsposeWordsCloud
+  require_relative '../base_test_context'
+  class CompareFeatureTests < BaseTestContext
+
+    def remote_folder
+      remote_test_folder + '/DocumentActions/CompareDocument'
+    end
+
+    def local_folder
+      'DocumentActions/CompareDocument'
+    end
+
+    #
+    # Test for document comparison.
+    #
+    def test_compare_doc_documents_from_storage
+      local_name1 = 'compareTestDoc1.doc'
+      local_name2 = 'compareTestDoc2.doc'
+      remote_name1 = 'TestCompareDocument1.doc'
+      remote_name2 = 'TestCompareDocument2.doc'
+
+      upload_file File.join(local_test_folder, local_folder + '/' + local_name1), remote_folder + '/' + remote_name1
+      upload_file File.join(local_test_folder, local_folder + '/' + local_name2), remote_folder + '/' + remote_name2
+
+      request_compare_data = CompareData.new({:Author => 'author', :ComparingWithDocument => remote_folder + '/' + remote_name2, :DateTime => Date.iso8601('2015-10-26T00:00:00.0000000Z')})
+      request = CompareDocumentRequest.new(remote_name1, request_compare_data, remote_folder, nil, nil, nil, remote_test_out + '/TestCompareDocumentOut.doc')
+
+      result = @words_api.compare_document(request)
+      assert_equal false, result.nil?
+    end
+
+    #
+    # Test for document comparison.
+    #
+    def test_compare_doc_documents_online
+      local_name1 = 'compareTestDoc1.doc'
+      local_name2 = 'compareTestDoc2.doc'
+      remote_name2 = 'TestCompareDocument2.doc'
+
+      upload_file File.join(local_test_folder, local_folder + '/' + local_name2), remote_folder + '/' + remote_name2
+
+      request_compare_data = CompareData.new({:Author => 'author', :ComparingWithDocument => remote_folder + '/' + remote_name2, :DateTime => Date.iso8601('2015-10-26T00:00:00.0000000Z')})
+      request = CompareDocumentOnlineRequest.new(File.open(File.join(local_test_folder, local_folder + '/' + local_name1)), request_compare_data, nil, nil, nil, remote_test_out + '/TestCompareDocumentOut.doc')
+
+      result = @words_api.compare_document_online(request)
+      assert_equal false, result.nil?
+      assert_equal AsposeWordsCloud::DocumentResponse, result.model.class
+    end
+
+    #
+    # Test for document comparison.
+    #
+    def test_compare_pdf_documents_from_storage
+      local_name1 = 'compareTestDoc1.pdf'
+      local_name2 = 'compareTestDoc2.pdf'
+      remote_name1 = 'TestCompareDocument1.pdf'
+      remote_name2 = 'TestCompareDocument2.pdf'
+
+      upload_file File.join(local_test_folder, local_folder + '/' + local_name1), remote_folder + '/' + remote_name1
+      upload_file File.join(local_test_folder, local_folder + '/' + local_name2), remote_folder + '/' + remote_name2
+
+      request_compare_data = CompareData.new({:Author => 'author', :ComparingWithDocument => remote_folder + '/' + remote_name2, :DateTime => Date.iso8601('2015-10-26T00:00:00.0000000Z')})
+      request = CompareDocumentRequest.new(remote_name1, request_compare_data, remote_folder, nil, nil, nil, remote_test_out + '/TestCompareDocumentOut.doc')
+
+      result = @words_api.compare_document(request)
+      assert_equal false, result.nil?
+    end
+
+    #
+    # Test for document comparison.
+    #
+    def test_compare_two_doc_documents_online
+      local_name1 = 'compareTestDoc1.doc'
+      local_name2 = 'compareTestDoc2.doc'
+      remote_name2 = 'TestCompareDocument2.doc'
+
+      upload_file File.join(local_test_folder, local_folder + '/' + local_name2), remote_folder + '/' + remote_name2
+
+      request_compare_data = CompareData.new({:Author => 'author', :ComparingWithDocument => remote_folder + '/' + remote_name2, :DateTime => Date.iso8601('2015-10-26T00:00:00.0000000Z')})
+      request = CompareDocumentOnlineRequest.new(File.open(File.join(local_test_folder, local_folder + '/' + local_name1)), request_compare_data, File.open(File.join(local_test_folder, local_folder + '/' + local_name2)), nil, nil, remote_test_out + '/TestCompareDocumentOut.doc')
+
+      result = @words_api.compare_document_online(request)
+      assert_equal false, result.nil?
+      assert_equal AsposeWordsCloud::DocumentResponse, result.model.class
+    end
+
+    #
+    # Test for document comparison.
+    #
+    def test_compare_two_pdf_documents_online
+      local_name1 = 'compareTestDoc1.pdf'
+      local_name2 = 'compareTestDoc2.pdf'
+      remote_name2 = 'TestCompareDocument2.pdf'
+
+      upload_file File.join(local_test_folder, local_folder + '/' + local_name2), remote_folder + '/' + remote_name2
+
+      request_compare_data = CompareData.new({:Author => 'author', :ComparingWithDocument => remote_folder + '/' + remote_name2, :DateTime => Date.iso8601('2015-10-26T00:00:00.0000000Z')})
+      request = CompareDocumentOnlineRequest.new(File.open(File.join(local_test_folder, local_folder + '/' + local_name1)), request_compare_data, File.open(File.join(local_test_folder, local_folder + '/' + local_name2)), nil, nil, remote_test_out + '/TestCompareDocumentOut.doc')
+
+      result = @words_api.compare_document_online(request)
+      assert_equal false, result.nil?
+      assert_equal AsposeWordsCloud::DocumentResponse, result.model.class
+    end
+  end
+end
