aspose_words_cloud 20.11.0 → 21.5.0

data/lib/aspose_words_cloud/api_client.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="api_client.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -29,7 +29,8 @@ require 'logger'
 require 'tempfile'
 require 'uri'
 require 'faraday'
-require 'mimemagic'
+require 'marcel'
+require 'multipart_parser/reader'
 require_relative 'version'
 require_relative 'api_error'
 
@@ -93,8 +94,14 @@ module AsposeWordsCloud
         end
       end
 
+      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
 
-      data = deserialize(response, opts[:return_type]) if opts[:return_type]
       [data, response.status, response.headers]
     end
 
@@ -147,7 +154,7 @@ module AsposeWordsCloud
       when :get
         return conn.get url, req_opts[:body]
       else
-        return conn.delete url do |c|
+        conn.delete url do |c|
           c.body = req_opts[:body]
         end
       end
@@ -167,11 +174,9 @@ module AsposeWordsCloud
 
     # Deserialize the response to the given return type.
     #
-    # @param [Response] response HTTP response
+    # @param [String] response HTTP response
     # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
-    def deserialize(response, return_type)
-      body = response.body
-
+    def deserialize(body, return_type)
       # handle file downloading - return the File instance processed in request callbacks
       # note that response body is empty when the file is written in chunks in request on_body callback
       return @tempfile if return_type == 'File'
@@ -181,11 +186,6 @@ module AsposeWordsCloud
       # return response body directly for String return type
       return body if return_type == 'String'
 
-      # ensuring a default content type
-      content_type = response.headers['Content-Type'] || 'application/json'
-
-      raise "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
-
       begin
         data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
       rescue JSON::ParserError => e
@@ -199,6 +199,76 @@ module AsposeWordsCloud
       convert_to_type data, return_type
     end
 
+    # Deserialize multipart the response to the given return type.
+    #
+    # @param [Response] response HTTP response
+    def deserialize_multipart(response)
+      parts={}
+      content_type = response.headers['content-type']
+      reader = MultipartParser::Reader.new(MultipartParser::Reader::extract_boundary_value(content_type))
+
+      reader.on_part do |part|
+        pn = part.headers['content-type'] == 'application/json' ? 'model' : 'document'
+        part.on_data do |partial_data|
+          if parts[pn].nil?
+            parts[pn] = partial_data
+          else
+            parts[pn] = [parts[pn]] if parts[pn].kind_of?(Array)
+            parts[pn] << partial_data
+          end
+        end
+      end
+
+      reader.write response.body
+      reader.ended? or raise Exception, 'Truncated multipart message'
+
+      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
@@ -272,6 +342,26 @@ module AsposeWordsCloud
       end
     end
 
+  # Save response body into a file in (the defined) temporary folder, using the filename
+  # from the "Content-Disposition" header if provided, otherwise a random filename.
+  # The response body is written to the file in chunks in order to handle files which
+  # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
+  # process can use.
+  #
+  # @see Configuration#temp_folder_path
+  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
+    tempfile.write(body)
+    @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 "\
+                            "explicitly with `tempfile.delete`"
+    @tempfile
+  end
+
     # Sanitize filename by removing path.
     # e.g. ../../sun.gif becomes sun.gif
     #
@@ -295,14 +385,14 @@ 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
-            data[key] = Faraday::UploadIO.new(value.path, MimeMagic.by_magic(value).to_s, key)
-          when ::Array, nil
+          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
@@ -316,6 +406,47 @@ module AsposeWordsCloud
       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, ::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
+          end
+        end
+      elsif body
+        data = body.is_a?(String) ? body : body.to_json
+      else
+        data = nil
+      end
+      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/api_error.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="api_error.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/aspose_words_cloud/configuration.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="configuration.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -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/available_fonts_response.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="available_fonts_response.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/aspose_words_cloud/models/bmp_save_options_data.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="bmp_save_options_data.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -29,6 +29,12 @@ module AsposeWordsCloud
 
   # Container class for bmp save options.
   class BmpSaveOptionsData
+    # Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false..
+    attr_accessor :allow_embedding_post_script_fonts
+
+    # Gets or sets CustomTimeZoneInfo.
+    attr_accessor :custom_time_zone_info_data
+
     # Gets or sets the value determining how 3D effects are rendered.
     attr_accessor :dml3_d_effects_rendering_mode
 
@@ -45,6 +51,10 @@ module AsposeWordsCloud
     # Gets or sets the format of save.
     attr_accessor :save_format
 
+    # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
+    # Default value is false.
+    attr_accessor :update_created_time_property
+
     # Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
     attr_accessor :update_fields
 
@@ -155,11 +165,14 @@ module AsposeWordsCloud
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'allow_embedding_post_script_fonts' => :'AllowEmbeddingPostScriptFonts',
+        :'custom_time_zone_info_data' => :'CustomTimeZoneInfoData',
         :'dml3_d_effects_rendering_mode' => :'Dml3DEffectsRenderingMode',
         :'dml_effects_rendering_mode' => :'DmlEffectsRenderingMode',
         :'dml_rendering_mode' => :'DmlRenderingMode',
         :'file_name' => :'FileName',
         :'save_format' => :'SaveFormat',
+        :'update_created_time_property' => :'UpdateCreatedTimeProperty',
         :'update_fields' => :'UpdateFields',
         :'update_last_printed_property' => :'UpdateLastPrintedProperty',
         :'update_last_saved_time_property' => :'UpdateLastSavedTimeProperty',
@@ -191,11 +204,14 @@ module AsposeWordsCloud
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'allow_embedding_post_script_fonts' => :'BOOLEAN',
+        :'custom_time_zone_info_data' => :'TimeZoneInfoData',
         :'dml3_d_effects_rendering_mode' => :'String',
         :'dml_effects_rendering_mode' => :'String',
         :'dml_rendering_mode' => :'String',
         :'file_name' => :'String',
         :'save_format' => :'String',
+        :'update_created_time_property' => :'BOOLEAN',
         :'update_fields' => :'BOOLEAN',
         :'update_last_printed_property' => :'BOOLEAN',
         :'update_last_saved_time_property' => :'BOOLEAN',
@@ -232,6 +248,14 @@ 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?(:'AllowEmbeddingPostScriptFonts')
+        self.allow_embedding_post_script_fonts = attributes[:'AllowEmbeddingPostScriptFonts']
+      end
+
+      if attributes.key?(:'CustomTimeZoneInfoData')
+        self.custom_time_zone_info_data = attributes[:'CustomTimeZoneInfoData']
+      end
+
       if attributes.key?(:'Dml3DEffectsRenderingMode')
         self.dml3_d_effects_rendering_mode = attributes[:'Dml3DEffectsRenderingMode']
       end
@@ -252,6 +276,10 @@ module AsposeWordsCloud
         self.save_format = attributes[:'SaveFormat']
       end
 
+      if attributes.key?(:'UpdateCreatedTimeProperty')
+        self.update_created_time_property = attributes[:'UpdateCreatedTimeProperty']
+      end
+
       if attributes.key?(:'UpdateFields')
         self.update_fields = attributes[:'UpdateFields']
       end
@@ -389,11 +417,14 @@ module AsposeWordsCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
+          allow_embedding_post_script_fonts == other.allow_embedding_post_script_fonts &&
+          custom_time_zone_info_data == other.custom_time_zone_info_data &&
           dml3_d_effects_rendering_mode == other.dml3_d_effects_rendering_mode &&
           dml_effects_rendering_mode == other.dml_effects_rendering_mode &&
           dml_rendering_mode == other.dml_rendering_mode &&
           file_name == other.file_name &&
           save_format == other.save_format &&
+          update_created_time_property == other.update_created_time_property &&
           update_fields == other.update_fields &&
           update_last_printed_property == other.update_last_printed_property &&
           update_last_saved_time_property == other.update_last_saved_time_property &&
@@ -430,7 +461,7 @@ module AsposeWordsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, save_format, 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, 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/bookmark.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="bookmark.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/aspose_words_cloud/models/bookmark_data.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="bookmark_data.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/aspose_words_cloud/models/bookmark_response.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="bookmark_response.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/aspose_words_cloud/models/bookmarks.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="bookmarks.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/aspose_words_cloud/models/bookmarks_outline_level_data.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="bookmarks_outline_level_data.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/aspose_words_cloud/models/bookmarks_response.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="bookmarks_response.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/aspose_words_cloud/models/border.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="border.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/aspose_words_cloud/models/border_response.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="border_response.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy