aspose_words_cloud 21.4.0 → 21.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f6ae457fbb9636be5ebcad3fb2061120c333d0a459c282ab00835d93daed45e
-  data.tar.gz: 894f9e0b0430eaf9797639fb15f0b134360f933d42d1721c161c373f5df0f7b7
+  metadata.gz: 29c8c47999e94a043e318ddd1d3de70881e7053f4a83219e4809a8ec0892b0c3
+  data.tar.gz: b9391c12b32f342f2be6cd908252b25e314f45bb8b9b8764acc512574d43af1b
 SHA512:
-  metadata.gz: 0be2453a9d75ad69568820fadb1b8368d98e806513226ac7533a4f36e2737073c1665ccf4ff79c7e062837b2976193071c5f12714ce97debe9a8f53963284779
-  data.tar.gz: 1196d69877539f2eb5efb44c603773bb428a98b39aa973dd3abce4a8b0fc8120eabfdaea7ed695c36e170ca7124fac59483a3a69c1030ac5f4f62c37533eef3d
+  metadata.gz: c3a4e7e453ebebe47c606b147b11d126ff68e9ed0549945d19124020697bb7df5dc4a735f309b7e43d95e2786c74e26839fd5811fe3a87da6eb45227b01ddb44
+  data.tar.gz: 284d614b204dd9312b3f3b2bc0b9e995eb6ee64d81d38c07195df420f56eae61d02d32397592164b21615a7294262210807bd6ec7783a4f6998693b88a8511d9

data/lib/aspose_words_cloud.rb

@@ -182,6 +182,7 @@ require_relative 'aspose_words_cloud/models/protection_data'
 require_relative 'aspose_words_cloud/models/protection_data_response'
 require_relative 'aspose_words_cloud/models/protection_request'
 require_relative 'aspose_words_cloud/models/ps_save_options_data'
+require_relative 'aspose_words_cloud/models/public_key_response'
 require_relative 'aspose_words_cloud/models/range_document'
 require_relative 'aspose_words_cloud/models/range_document_dto'
 require_relative 'aspose_words_cloud/models/range_text_response'
@@ -420,6 +421,7 @@ require_relative 'aspose_words_cloud/models/requests/get_paragraphs_request'
 require_relative 'aspose_words_cloud/models/requests/get_paragraphs_online_request'
 require_relative 'aspose_words_cloud/models/requests/get_paragraph_tab_stops_request'
 require_relative 'aspose_words_cloud/models/requests/get_paragraph_tab_stops_online_request'
+require_relative 'aspose_words_cloud/models/requests/get_public_key_request'
 require_relative 'aspose_words_cloud/models/requests/get_range_text_request'
 require_relative 'aspose_words_cloud/models/requests/get_range_text_online_request'
 require_relative 'aspose_words_cloud/models/requests/get_run_request'

data/lib/aspose_words_cloud/api/words_api.rb

@@ -25,6 +25,7 @@
 
 require 'uri'
 require 'json'
+require 'faraday'
 
 module AsposeWordsCloud
   #
@@ -40,6 +41,26 @@ module AsposeWordsCloud
       request_token
     end
 
+    def batch(requests)
+      raise ArgumentError, 'Requests array is nil' unless requests != nil
+      raise ArgumentError, 'There must be at least one request' unless requests.length != 0
+      form_params = {}
+      request_token
+      header_params = {'Content-Type' => 'multipart/form-data'}
+      @api_client.update_params_for_auth! header_params, {}, "JWT"
+      requests.each_with_index do |request, index|
+        form_params["request-#{index}"] = Faraday::ParamPart.new(request.to_batch_part(@api_client), "application/http; msgtype=request")
+      end
+      data, status_code, headers = @api_client.call_api(:PUT, "/v4.0/words/batch",
+                                                        header_params: header_params,
+                                                        query_params: {},
+                                                        form_params: form_params,
+                                                        body: nil,
+                                                        batch: true,
+                                                        parts: requests,
+                                                        auth_names: ['JWT'])
+    end
+
     # Accepts all revisions in the document.
     # @param request AcceptAllRevisionsRequest
     # @return [RevisionsModificationResponse]
@@ -966,6 +987,7 @@ module AsposeWordsCloud
         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
@@ -7195,8 +7217,8 @@ module AsposeWordsCloud
         raise ArgumentError, 'Incorrect request type' unless request.is_a? GetDocumentFieldNamesOnlineRequest
 
         @api_client.config.logger.debug 'Calling API: WordsApi.get_document_field_names_online ...' if @api_client.config.debugging
-        # verify the required parameter 'document' is set
-        raise ArgumentError, 'Missing the required parameter document when calling WordsApi.get_document_field_names_online' if @api_client.config.client_side_validation && request.document.nil?
+        # verify the required parameter 'template' is set
+        raise ArgumentError, 'Missing the required parameter template when calling WordsApi.get_document_field_names_online' if @api_client.config.client_side_validation && request.template.nil?
 
         # resource path
         local_var_path = '/words/online/get/mailMerge/FieldNames'[1..-1]
@@ -7217,7 +7239,7 @@ module AsposeWordsCloud
 
         # form parameters
         form_params = {}
-        form_params[downcase_first_letter('Document')] = request.document
+        form_params[downcase_first_letter('Template')] = request.template
 
         # http body (model)
         post_body = nil
@@ -10770,6 +10792,67 @@ module AsposeWordsCloud
         [data, status_code, headers]
     end
 
+    # Get assymetric public key.
+    # @param request GetPublicKeyRequest
+    # @return [PublicKeyResponse]
+    def get_public_key(request)
+        begin
+        data, _status_code, _headers = get_public_key_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = get_public_key_with_http_info(request)
+            else
+            raise
+            end
+        end
+        data
+    end
+
+    # Get assymetric public key.
+    # @param request GetPublicKeyRequest
+    # @return [Array<(PublicKeyResponse, Fixnum, Hash)>]
+    # PublicKeyResponse, response status code and response headers
+    private def get_public_key_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? GetPublicKeyRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.get_public_key ...' if @api_client.config.debugging
+        # resource path
+        local_var_path = '/words/encryption/publickey'[1..-1]
+        local_var_path = local_var_path.sub('//', '/')
+
+        # query parameters
+        query_params = {}
+
+        # header parameters
+        header_params = {}
+        # HTTP header 'Accept' (if needed)
+        header_params['Accept'] = @api_client.select_header_accept(['application/xml', 'application/json'])
+        # HTTP header 'Content-Type'
+        header_params['Content-Type'] = @api_client.select_header_content_type(['application/xml', 'application/json'])
+
+        # form parameters
+        form_params = {}
+
+        # http body (model)
+        post_body = nil
+        auth_names = ['JWT']
+
+        data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+                                                        header_params: header_params,
+                                                        query_params: query_params,
+                                                        form_params: form_params,
+                                                        body: post_body,
+                                                        auth_names: auth_names,
+                                                        return_type: 'PublicKeyResponse')
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#get_public_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        [data, status_code, headers]
+    end
+
     # Reads range text from the document.
     # @param request GetRangeTextRequest
     # @return [RangeTextResponse]
@@ -17828,7 +17911,7 @@ module AsposeWordsCloud
         [data, status_code, headers]
     end
 
-    # Converts a document in cloud storage to the specified format.
+    # Converts a document to the specified format.
     # @param request SaveAsOnlineRequest
     # @return [SaveAsOnlineResponse]
     def save_as_online(request)
@@ -17845,7 +17928,7 @@ module AsposeWordsCloud
         data
     end
 
-    # Converts a document in cloud storage to the specified format.
+    # Converts a document to the specified format.
     # @param request SaveAsOnlineRequest
     # @return [Array<(SaveAsOnlineResponse, Fixnum, Hash)>]
     # SaveAsOnlineResponse, response status code and response headers
@@ -18145,7 +18228,7 @@ module AsposeWordsCloud
         [data, status_code, headers]
     end
 
-    # Converts a document in cloud storage to TIFF format using detailed conversion settings.
+    # Converts a document to TIFF format using detailed conversion settings.
     # @param request SaveAsTiffOnlineRequest
     # @return [SaveAsTiffOnlineResponse]
     def save_as_tiff_online(request)
@@ -18162,7 +18245,7 @@ module AsposeWordsCloud
         data
     end
 
-    # Converts a document in cloud storage to TIFF format using detailed conversion settings.
+    # Converts a document to TIFF format using detailed conversion settings.
     # @param request SaveAsTiffOnlineRequest
     # @return [Array<(SaveAsTiffOnlineResponse, Fixnum, Hash)>]
     # SaveAsTiffOnlineResponse, response status code and response headers

data/lib/aspose_words_cloud/api_client.rb

@@ -29,7 +29,7 @@ require 'logger'
 require 'tempfile'
 require 'uri'
 require 'faraday'
-require 'mimemagic'
+require 'marcel'
 require 'multipart_parser/reader'
 require_relative 'version'
 require_relative 'api_error'
@@ -96,6 +96,8 @@ module AsposeWordsCloud
 
       if opts[:multipart_response] == true
         data = deserialize_multipart(response)
+      elsif opts[:batch] == true
+        data = deserialize_batch(response, opts[:parts])
       else
         data = deserialize(response.body, opts[:return_type]) if opts[:return_type]
       end
@@ -223,6 +225,50 @@ module AsposeWordsCloud
       parts
     end
 
+    # Deserialize batch
+    def deserialize_batch(response, requests)
+      result = { errors: [], parts: [] }
+      def result.part(name)
+        hash = self[:parts].detect { |h| h[:part].name == name }
+        [hash[:part], hash[:body].join]
+      end
+      responses_data = []
+      content_type = response.headers['content-type']
+      reader = MultipartParser::Reader.new(MultipartParser::Reader::extract_boundary_value(content_type))
+      reader.on_part do |part|
+        result[:parts] << thispart = {
+          part: part,
+          body: []
+        }
+        part.on_data do |chunk|
+          thispart[:body] << chunk
+        end
+      end
+      reader.on_error do |msg|
+        result[:errors] << msg
+      end
+      reader.write response.body
+      reader.ended? or raise Exception, 'Truncated multipart message'
+
+      separator = "\r\n\r\n"
+      result[:parts].each do |part|
+        part[:body] = part[:body].join("")
+        part_body = part[:body]
+        data_index = part_body.index(separator)
+        if data_index != nil
+          header_data = part_body[0..data_index]
+          body_data = part_body[data_index+separator.length, part_body.length]
+          part[:body] = body_data
+        end
+      end
+
+      result[:parts].each_with_index do |response_data, index|
+        return_type = requests[index].get_response_type
+        responses_data.push(deserialize(response_data[:body], return_type))
+      end
+      responses_data
+    end
+
     # Convert data to the given return type.
     # @param [Object] data Data to be converted
     # @param [String] return_type Return type
@@ -306,9 +352,10 @@ module AsposeWordsCloud
   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 "\
@@ -339,14 +386,43 @@ module AsposeWordsCloud
     # @return [String] HTTP body data in the form of string
     def build_request_body(header_params, form_params, body)
       # http form
-      if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
-          header_params['Content-Type'] == 'multipart/form-data'
+      if header_params['Content-Type']['application/x-www-form-urlencoded'] ||
+          header_params['Content-Type']['multipart/form-data']
+        data = {}
+        form_params.each do |key, value|
+          case value
+          when ::File, ::Tempfile
+            data[key] = Faraday::UploadIO.new(value.path, Marcel::Magic.by_magic(value).to_s, key)
+          when ::Array, nil, Faraday::ParamPart
+            data[key] = value
+          else
+            data[key] = value.to_s
+          end
+        end
+      elsif body
+        data = body.is_a?(String) ? body : body.to_json
+      else
+        data = nil
+      end
+      data
+    end
+
+    # Builds the HTTP request body
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] form_params Query parameters
+    # @param [Object] body HTTP body (JSON/XML)
+    # @return [String] HTTP body data in the form of string
+    def build_request_body_batch(header_params, form_params, body)
+      # http form
+      if header_params['Content-Type']['application/x-www-form-urlencoded'] ||
+        header_params['Content-Type']['multipart/form-data']
         data = {}
         form_params.each do |key, value|
           case value
-          when ::File
-            data[key] = Faraday::UploadIO.new(value.path, MimeMagic.by_magic(value).to_s, key)
-          when ::Array, nil
+          when ::File, ::Tempfile
+            data[key] = File.open(value.path, 'rb') { |f| f.read }
+          when ::Array, nil, Faraday::ParamPart
             data[key] = value
           else
             data[key] = value.to_s
@@ -360,6 +436,18 @@ module AsposeWordsCloud
       data
     end
 
+    # Append query parameter to url
+    #
+    # @param [String] url current url
+    # @param [String] param_name query parameter name
+    # @param [String] param_value query parameter value
+    def add_param_to_query(url, param_name, param_value)
+      uri = URI(url)
+      params = URI.decode_www_form(uri.query || "") << [param_name, param_value]
+      uri.query = URI.encode_www_form(params)
+      uri.to_s
+    end
+
     # Update hearder and query params based on authentication settings.
     #
     # @param [Hash] header_params Header parameters

data/lib/aspose_words_cloud/configuration.rb

@@ -119,7 +119,8 @@ module AsposeWordsCloud
         return URI.join(baseUrl, path).to_s
       end
 
-      return URI.join(baseUrl, "/v4.0/", URI.encode(path)).to_s
+      p = URI::Parser.new
+      URI.join(baseUrl, "/v4.0/", p.escape(path)).to_s
     end
 
     # Gets API key (with prefix if set).

data/lib/aspose_words_cloud/models/bmp_save_options_data.rb

@@ -48,6 +48,9 @@ module AsposeWordsCloud
     # Gets or sets the name of destination file.
     attr_accessor :file_name
 
+    # Gets or sets the value determining how ink (InkML) objects are rendered.
+    attr_accessor :iml_rendering_mode
+
     # Gets or sets the format of save.
     attr_accessor :save_format
 
@@ -171,6 +174,7 @@ module AsposeWordsCloud
         :'dml_effects_rendering_mode' => :'DmlEffectsRenderingMode',
         :'dml_rendering_mode' => :'DmlRenderingMode',
         :'file_name' => :'FileName',
+        :'iml_rendering_mode' => :'ImlRenderingMode',
         :'save_format' => :'SaveFormat',
         :'update_created_time_property' => :'UpdateCreatedTimeProperty',
         :'update_fields' => :'UpdateFields',
@@ -210,6 +214,7 @@ module AsposeWordsCloud
         :'dml_effects_rendering_mode' => :'String',
         :'dml_rendering_mode' => :'String',
         :'file_name' => :'String',
+        :'iml_rendering_mode' => :'String',
         :'save_format' => :'String',
         :'update_created_time_property' => :'BOOLEAN',
         :'update_fields' => :'BOOLEAN',
@@ -272,6 +277,10 @@ module AsposeWordsCloud
         self.file_name = attributes[:'FileName']
       end
 
+      if attributes.key?(:'ImlRenderingMode')
+        self.iml_rendering_mode = attributes[:'ImlRenderingMode']
+      end
+
       if attributes.key?(:'SaveFormat')
         self.save_format = attributes[:'SaveFormat']
       end
@@ -423,6 +432,7 @@ module AsposeWordsCloud
           dml_effects_rendering_mode == other.dml_effects_rendering_mode &&
           dml_rendering_mode == other.dml_rendering_mode &&
           file_name == other.file_name &&
+          iml_rendering_mode == other.iml_rendering_mode &&
           save_format == other.save_format &&
           update_created_time_property == other.update_created_time_property &&
           update_fields == other.update_fields &&
@@ -461,7 +471,7 @@ module AsposeWordsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [allow_embedding_post_script_fonts, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, save_format, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, update_sdt_content, zip_output, color_mode, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, graphics_quality_options, horizontal_resolution, image_brightness, image_color_mode, image_contrast, paper_color, pixel_format, resolution, scale, use_anti_aliasing, use_gdi_emf_renderer, use_high_quality_rendering, vertical_resolution].hash
+      [allow_embedding_post_script_fonts, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, iml_rendering_mode, save_format, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, update_sdt_content, zip_output, color_mode, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, graphics_quality_options, horizontal_resolution, image_brightness, image_color_mode, image_contrast, paper_color, pixel_format, resolution, scale, use_anti_aliasing, use_gdi_emf_renderer, use_high_quality_rendering, vertical_resolution].hash
     end
 
     # Builds the object from hash

data/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 @@ module AsposeWordsCloud
     # 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 @@ module AsposeWordsCloud
     # 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 @@ module AsposeWordsCloud
       # 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 @@ module AsposeWordsCloud
     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 @@ module AsposeWordsCloud
     # 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