aspose_words_cloud 26.3 → 26.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6758e416cdc838911ea5690ce20f84a57f52f6e86069cdf3a097f856fc731d9d
-  data.tar.gz: 0b51be00b8fc980e85f4010ade9f6fe8b21c7f6da3d23576d8b5ceb876e871ff
+  metadata.gz: e1ad70cd347ed907b5da91fd244e94a64662c3c029a5784bf3b7af5ba1e33f37
+  data.tar.gz: 40df43e4a0962b7ae0a27f07e59cf4fd85dfe81079e4bc9a7c5d11c3564834f5
 SHA512:
-  metadata.gz: '088117cbb8c60ea5529a68040527ddcd53f32b0267a318f42ddb2de1cf9cc9a12ca0d75445bee34fa49c8c5e9ca64c7cfc41ad3eccb1f02b551f536379d05850'
-  data.tar.gz: bf072bca97e3ab254d50e3f54349eed2f47b75f25696333a12215ef91a35b18d0b8dd368dd5e6021cd8b04415af1a070411f28afc8cec759dc7d4c5c9f2ac0e6
+  metadata.gz: 9d78af6e75a38e821e194b987a85eda8807977170c3690cdffaae6b9b1e9c234fbcb758261e483d2599941ef45f07f38246faee316e5058c28630da5abbe3839
+  data.tar.gz: da5ff638f27a2f4e4ed6dc8f3a8d8b08dba28b9cad106296c1af9d18d3867038216bc9114bb416bbf08d25f7179948e6af5cf744e8df87c0d29beefc6c83bf5c

data/lib/aspose_words_cloud/api/words_api.rb

@@ -65,6 +65,36 @@ module AsposeWordsCloud
       [data, status_code, headers]
     end
 
+    def call_job_result(job_id)
+      begin
+        data, _status_code, _headers = call_job_result_with_http_info(job_id)
+      rescue ApiError => e
+        if e.code == 401
+          request_token
+          data, _status_code, _headers = call_job_result_with_http_info(job_id)
+        else
+          raise
+        end
+      end
+      data
+    end
+
+    private def call_job_result_with_http_info(job_id)
+        raise ArgumentError, 'Missing the required parameter job_id when calling call_job_result' if job_id.nil?
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.call_job_result ...' if @api_client.config.debugging
+        header_params = {}
+        query_params = { 'id' => job_id }
+            data, status_code, headers = @api_client.call_api(
+                                                            :GET,
+                                                            'words/job',
+                                                            header_params: header_params,
+                                                            query_params: query_params,
+                                                            body: nil,
+                                                            return_raw: true)
+            [@api_client.deserialize_multipart_array(data, headers), status_code, headers]
+    end
+
     # Accepts all the revisions in the document.
     # @param request AcceptAllRevisionsRequest
     # @return [RevisionsModificationResponse]
@@ -195,6 +225,48 @@ module AsposeWordsCloud
         [data, status_code, headers]
     end
 
+    # Appends documents to the original document.
+    # @param request AppendDocumentJobRequest
+    # @return [JobHandler]
+    def append_document_job(request)
+        begin
+        data, _status_code, _headers = append_document_job_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = append_document_job_with_http_info(request)
+            else
+            raise
+            end
+        end
+        data
+    end
+
+    # Appends documents to the original document.
+    # @param request AppendDocumentJobRequest
+    # @return [Array<(JobHandler, Fixnum, Hash)>]
+    # JobHandler, response status code and response headers
+    private def append_document_job_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? AppendDocumentJobRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.append_document_job ...' if @api_client.config.debugging
+        request_data = request.create_http_request(@api_client)
+
+        data, status_code, headers = @api_client.call_api(
+                                                        request_data[:'method'],
+                                                        request_data[:'path'],
+                                                        header_params: request_data[:'header_params'],
+                                                        query_params: request_data[:'query_params'],
+                                                        body: request_data[:'body'],
+                                                        return_type: 'JobInfo')
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#append_document_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        [JobHandler.new(self, request.get_original_request, data), status_code, headers]
+    end
+
     # Appends documents to the original document.
     # @param request AppendDocumentOnlineRequest
     # @return [AppendDocumentOnlineResponse]
@@ -241,6 +313,48 @@ module AsposeWordsCloud
         [mp_data, status_code, headers]
     end
 
+    # Appends documents to the original document.
+    # @param request AppendDocumentOnlineJobRequest
+    # @return [JobHandler]
+    def append_document_online_job(request)
+        begin
+        data, _status_code, _headers = append_document_online_job_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = append_document_online_job_with_http_info(request)
+            else
+            raise
+            end
+        end
+        data
+    end
+
+    # Appends documents to the original document.
+    # @param request AppendDocumentOnlineJobRequest
+    # @return [Array<(JobHandler, Fixnum, Hash)>]
+    # JobHandler, response status code and response headers
+    private def append_document_online_job_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? AppendDocumentOnlineJobRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.append_document_online_job ...' if @api_client.config.debugging
+        request_data = request.create_http_request(@api_client)
+
+        data, status_code, headers = @api_client.call_api(
+                                                        request_data[:'method'],
+                                                        request_data[:'path'],
+                                                        header_params: request_data[:'header_params'],
+                                                        query_params: request_data[:'query_params'],
+                                                        body: request_data[:'body'],
+                                                        return_type: 'JobInfo')
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#append_document_online_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        [JobHandler.new(self, request.get_original_request, data), status_code, headers]
+    end
+
     # Applies a style to the document node.
     # @param request ApplyStyleToDocumentElementRequest
     # @return [WordsResponse]
@@ -635,6 +749,48 @@ module AsposeWordsCloud
         [data, status_code, headers]
     end
 
+    # Converts a document on a local drive to the specified format.
+    # @param request ConvertDocumentJobRequest
+    # @return [JobHandler]
+    def convert_document_job(request)
+        begin
+        data, _status_code, _headers = convert_document_job_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = convert_document_job_with_http_info(request)
+            else
+            raise
+            end
+        end
+        data
+    end
+
+    # Converts a document on a local drive to the specified format.
+    # @param request ConvertDocumentJobRequest
+    # @return [Array<(JobHandler, Fixnum, Hash)>]
+    # JobHandler, response status code and response headers
+    private def convert_document_job_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? ConvertDocumentJobRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.convert_document_job ...' if @api_client.config.debugging
+        request_data = request.create_http_request(@api_client)
+
+        data, status_code, headers = @api_client.call_api(
+                                                        request_data[:'method'],
+                                                        request_data[:'path'],
+                                                        header_params: request_data[:'header_params'],
+                                                        query_params: request_data[:'query_params'],
+                                                        body: request_data[:'body'],
+                                                        return_type: 'JobInfo')
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#convert_document_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        [JobHandler.new(self, request.get_original_request, data), status_code, headers]
+    end
+
     # Copy file.
     # @param request CopyFileRequest
     # @return [nil]
@@ -3738,6 +3894,48 @@ module AsposeWordsCloud
         [data, status_code, headers]
     end
 
+    # Executes a Mail Merge operation.
+    # @param request ExecuteMailMergeJobRequest
+    # @return [JobHandler]
+    def execute_mail_merge_job(request)
+        begin
+        data, _status_code, _headers = execute_mail_merge_job_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = execute_mail_merge_job_with_http_info(request)
+            else
+            raise
+            end
+        end
+        data
+    end
+
+    # Executes a Mail Merge operation.
+    # @param request ExecuteMailMergeJobRequest
+    # @return [Array<(JobHandler, Fixnum, Hash)>]
+    # JobHandler, response status code and response headers
+    private def execute_mail_merge_job_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? ExecuteMailMergeJobRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.execute_mail_merge_job ...' if @api_client.config.debugging
+        request_data = request.create_http_request(@api_client)
+
+        data, status_code, headers = @api_client.call_api(
+                                                        request_data[:'method'],
+                                                        request_data[:'path'],
+                                                        header_params: request_data[:'header_params'],
+                                                        query_params: request_data[:'query_params'],
+                                                        body: request_data[:'body'],
+                                                        return_type: 'JobInfo')
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#execute_mail_merge_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        [JobHandler.new(self, request.get_original_request, data), status_code, headers]
+    end
+
     # Executes a Mail Merge operation online.
     # @param request ExecuteMailMergeOnlineRequest
     # @return [File]
@@ -3780,6 +3978,48 @@ module AsposeWordsCloud
         [data, status_code, headers]
     end
 
+    # Executes a Mail Merge operation online.
+    # @param request ExecuteMailMergeOnlineJobRequest
+    # @return [JobHandler]
+    def execute_mail_merge_online_job(request)
+        begin
+        data, _status_code, _headers = execute_mail_merge_online_job_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = execute_mail_merge_online_job_with_http_info(request)
+            else
+            raise
+            end
+        end
+        data
+    end
+
+    # Executes a Mail Merge operation online.
+    # @param request ExecuteMailMergeOnlineJobRequest
+    # @return [Array<(JobHandler, Fixnum, Hash)>]
+    # JobHandler, response status code and response headers
+    private def execute_mail_merge_online_job_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? ExecuteMailMergeOnlineJobRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.execute_mail_merge_online_job ...' if @api_client.config.debugging
+        request_data = request.create_http_request(@api_client)
+
+        data, status_code, headers = @api_client.call_api(
+                                                        request_data[:'method'],
+                                                        request_data[:'path'],
+                                                        header_params: request_data[:'header_params'],
+                                                        query_params: request_data[:'query_params'],
+                                                        body: request_data[:'body'],
+                                                        return_type: 'JobInfo')
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#execute_mail_merge_online_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        [JobHandler.new(self, request.get_original_request, data), status_code, headers]
+    end
+
     # Get all information about revisions.
     # @param request GetAllRevisionsRequest
     # @return [RevisionsResponse]
@@ -12692,6 +12932,48 @@ module AsposeWordsCloud
         [data, status_code, headers]
     end
 
+    # Splits a document into parts and saves them in the specified format.
+    # @param request SplitDocumentJobRequest
+    # @return [JobHandler]
+    def split_document_job(request)
+        begin
+        data, _status_code, _headers = split_document_job_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = split_document_job_with_http_info(request)
+            else
+            raise
+            end
+        end
+        data
+    end
+
+    # Splits a document into parts and saves them in the specified format.
+    # @param request SplitDocumentJobRequest
+    # @return [Array<(JobHandler, Fixnum, Hash)>]
+    # JobHandler, response status code and response headers
+    private def split_document_job_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? SplitDocumentJobRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.split_document_job ...' if @api_client.config.debugging
+        request_data = request.create_http_request(@api_client)
+
+        data, status_code, headers = @api_client.call_api(
+                                                        request_data[:'method'],
+                                                        request_data[:'path'],
+                                                        header_params: request_data[:'header_params'],
+                                                        query_params: request_data[:'query_params'],
+                                                        body: request_data[:'body'],
+                                                        return_type: 'JobInfo')
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#split_document_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        [JobHandler.new(self, request.get_original_request, data), status_code, headers]
+    end
+
     # Splits a document into parts and saves them in the specified format.
     # @param request SplitDocumentOnlineRequest
     # @return [SplitDocumentOnlineResponse]
@@ -12738,6 +13020,48 @@ module AsposeWordsCloud
         [mp_data, status_code, headers]
     end
 
+    # Splits a document into parts and saves them in the specified format.
+    # @param request SplitDocumentOnlineJobRequest
+    # @return [JobHandler]
+    def split_document_online_job(request)
+        begin
+        data, _status_code, _headers = split_document_online_job_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = split_document_online_job_with_http_info(request)
+            else
+            raise
+            end
+        end
+        data
+    end
+
+    # Splits a document into parts and saves them in the specified format.
+    # @param request SplitDocumentOnlineJobRequest
+    # @return [Array<(JobHandler, Fixnum, Hash)>]
+    # JobHandler, response status code and response headers
+    private def split_document_online_job_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? SplitDocumentOnlineJobRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.split_document_online_job ...' if @api_client.config.debugging
+        request_data = request.create_http_request(@api_client)
+
+        data, status_code, headers = @api_client.call_api(
+                                                        request_data[:'method'],
+                                                        request_data[:'path'],
+                                                        header_params: request_data[:'header_params'],
+                                                        query_params: request_data[:'query_params'],
+                                                        body: request_data[:'body'],
+                                                        return_type: 'JobInfo')
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#split_document_online_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        [JobHandler.new(self, request.get_original_request, data), status_code, headers]
+    end
+
     # Translate a node id to a node path.
     # @param request TranslateNodeIdRequest
     # @return [TranslateNodeIdResponse]

data/lib/aspose_words_cloud/api_client.rb

@@ -99,6 +99,8 @@ module AsposeWordsCloud
         data = deserialize_multipart(response.body, response.headers)
       elsif opts[:batch] == true
         data = deserialize_batch(response, opts[:request_map])
+      elsif opts[:return_raw] == true
+        data = response.body
       else
         data = deserialize(response.body, response.headers, opts[:return_type]) if opts[:return_type]
       end
@@ -289,6 +291,63 @@ module AsposeWordsCloud
       parts
     end
 
+    def deserialize_multipart_array(body, headers)
+      parts = []
+      content_type = headers['content-type']
+      reader = MultipartParser::Reader.new(MultipartParser::Reader::extract_boundary_value(content_type))
+
+      reader.on_part do |part|
+        part_data = { data: "", headers: part.headers }
+        parts << part_data
+        part.on_data do |partial_data|
+          part_data[:data] << partial_data
+        end
+      end
+
+      reader.write body
+      reader.ended? or raise Exception, 'Truncated multipart message'
+
+      parts
+    end
+
+    def deserialize_job_info_part(part)
+      deserialize(part[:data], part[:headers], 'JobInfo')
+    end
+
+    def deserialize_http_response_part(request, part_data)
+      status_line_index = part_data.index("\r\n")
+      raise ApiError.new(code: 400, message: 'Failed to parse HTTP response part.', response_headers: {}, response_body: '') if status_line_index.nil?
+
+      status_line = part_data[0...status_line_index]
+      status_line_parts = status_line.split(' ', 3)
+      if status_line_parts.length < 3 || !status_line_parts[0].start_with?('HTTP/')
+        raise ApiError.new(code: 400, message: 'Failed to parse HTTP response part.', response_headers: {}, response_body: '')
+      end
+
+      status_code = status_line_parts[1].to_i
+      headers_end_index = part_data.index("\r\n\r\n")
+      response_headers = {}
+      response_body = ''
+
+      if headers_end_index.nil?
+        response_body = part_data[(status_line_index + 2)..-1] || ''
+      else
+        header_lines = part_data[(status_line_index + 2)...headers_end_index].split("\r\n")
+        header_lines.each do |header_line|
+          next unless header_line.include?(':')
+          key, value = header_line.split(':', 2)
+          response_headers[key.strip.downcase] = value.strip
+        end
+        response_body = part_data[(headers_end_index + 4)..-1] || ''
+      end
+
+      if status_code < 200 || status_code >= 300
+        raise ApiError.new(code: status_code, message: response_body, response_headers: response_headers, response_body: response_body)
+      end
+
+      request.deserialize_response(self, response_body, response_headers)
+    end
+
     # Deserialize batch
     def deserialize_batch(response, request_map)
       result = { errors: [], parts: [] }

data/lib/aspose_words_cloud/job_handler.rb

@@ -0,0 +1,93 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="job_handler.rb">
+#   Copyright (c) 2026 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
+  class JobHandler
+    attr_reader :result
+
+    def initialize(api, request, info)
+      @api = api
+      @request = request
+      @info = info
+      @result = nil
+    end
+
+    def status
+      @info.status || ''
+    end
+
+    def message
+      @info.message || ''
+    end
+
+    def update
+      raise ApiError.new(code: 400, message: 'Invalid job id.', response_headers: {}, response_body: '') if @info.job_id.nil?
+
+      parts = @api.call_job_result(@info.job_id)
+      if parts.length >= 1
+        @info = @api.api_client.deserialize_job_info_part(parts[0])
+        if parts.length >= 2 && succeeded?
+          @result = @api.api_client.deserialize_http_response_part(@request, parts[1][:data])
+        end
+      end
+
+      @result
+    end
+
+    def wait_result(update_interval = 3)
+      while queued? || processing?
+        sleep(update_interval)
+        update
+      end
+
+      update if succeeded? && @result.nil?
+
+      unless succeeded?
+        raise ApiError.new(
+          code: 400,
+          message: "Job failed with status \"#{status}\" - \"#{message}\".",
+          response_headers: {},
+          response_body: ''
+        )
+      end
+
+      @result
+    end
+
+    private
+
+    def queued?
+      status.casecmp('Queued').zero?
+    end
+
+    def processing?
+      status.casecmp('Processing').zero?
+    end
+
+    def succeeded?
+      status.casecmp('Succeded').zero? || status.casecmp('Succeeded').zero?
+    end
+  end
+end