aspose_words_cloud 20.7.0 → 21.1.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
@@ -30,6 +30,7 @@ require 'tempfile'
 require 'uri'
 require 'faraday'
 require 'mimemagic'
+require 'multipart_parser/reader'
 require_relative 'version'
 require_relative 'api_error'
 
@@ -66,12 +67,12 @@ module AsposeWordsCloud
     # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
     #   the data deserialized from response body (could be nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
-      if @config.api_key['app_sid'].nil? || @config.api_key['app_sid'] == ''
-        raise "AppSid could not be an empty string."
+      if @config.client_data['ClientId'].nil? || @config.client_data['ClientId'] == ''
+        raise "ClientId could not be an empty string."
       end
 
-      if @config.api_key['api_key'].nil? || @config.api_key['api_key'] == ''
-        raise "AppKey could not be an empty string."
+      if @config.client_data['ClientSecret'].nil? || @config.client_data['ClientSecret'] == ''
+        raise "ClientSecret could not be an empty string."
       end
 
       response = build_request(http_method, path, opts)
@@ -93,8 +94,12 @@ module AsposeWordsCloud
         end
       end
 
+      if opts[:multipart_response] == true
+        data = deserialize_multipart(response)
+      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 +152,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 +172,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 +184,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 +197,32 @@ 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
+
     # Convert data to the given return type.
     # @param [Object] data Data to be converted
     # @param [String] return_type Return type
@@ -272,6 +296,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
     #
@@ -284,7 +328,6 @@ module AsposeWordsCloud
     def build_request_url(path)
       # remove empty path parameter artifacts
       path = path.gsub(/\/+/, '/')
-      path = path.gsub(" ", "%20")
       return @config.getFullUrl(path, path == "/connect/token")
     end
 

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
@@ -37,17 +37,17 @@ module AsposeWordsCloud
     #
     # @return [Hash] key: parameter name, value: parameter value (API key)
     #
-    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
-    #   config.api_key['api_key'] = 'xxx'
-    attr_accessor :api_key
+    # @example parameter name is "ClientSecret", client secret is "xxx" (e.g. "ClientSecret=xxx" in query string)
+    #   config.client_data['ClientSecret'] = 'xxx'
+    attr_accessor :client_data
 
     # Defines API key prefixes used with API Key authentications.
     #
     # @return [Hash] key: parameter name, value: API key prefix
     #
     # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
-    #   config.api_key_prefix['api_key'] = 'Token'
-    attr_accessor :api_key_prefix
+    #   config.client_data_prefix['client_secret'] = 'Token'
+    attr_accessor :client_data_prefix
 
     # Defines the username used with HTTP basic authentication.
     #
@@ -94,8 +94,8 @@ module AsposeWordsCloud
     def initialize
       @baseUrl = "https://api.aspose.cloud"
       @api_version = "/v4.0/"
-      @api_key = {}
-      @api_key_prefix = {}
+      @client_data = {}
+      @client_data_prefix = {}
       @client_side_validation = true
       @debugging = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
@@ -119,16 +119,16 @@ module AsposeWordsCloud
         return URI.join(baseUrl, path).to_s
       end
 
-      return  URI.join(baseUrl, "/v4.0/", path).to_s
+      return URI.join(baseUrl, "/v4.0/", URI.encode(path)).to_s
     end
 
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth
-    def api_key_with_prefix(param_name)
-      if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+    def client_data_with_prefix(param_name)
+      if @client_data_prefix[param_name]
+        "#{@client_data_prefix[param_name]} #{@client_data[param_name]}"
       else
-        @api_key[param_name]
+        @client_data[param_name]
       end
     end
 

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
@@ -27,18 +27,18 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # The list of fonts, available for document processing.
+  # The REST response with data on system, additional and custom fonts, available for document processing.
   class AvailableFontsResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets the list of addititional fonts, provided by aspose team.
+    # Gets or sets the list of additional fonts, provided by Aspose team.
     attr_accessor :additional_fonts
 
-    # Gets or sets custom user fonts (from user file storage). To use them, you should specify "fontsLocation" parameter in any request.
+    # Gets or sets the list of custom user fonts from user cloud storage. To use them, you should specify "fontsLocation" parameter in any request.
     attr_accessor :custom_fonts
 
-    # Gets or sets the list of system fonts, availiable on the server.
+    # Gets or sets the list of system fonts, available on the server.
     attr_accessor :system_fonts
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

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,106 +29,103 @@ module AsposeWordsCloud
 
   # Container class for bmp save options.
   class BmpSaveOptionsData
-    # Gets or sets a value determining how 3D effects are rendered.
+    # Gets or sets the value determining how 3D effects are rendered.
     attr_accessor :dml3_d_effects_rendering_mode
 
-    # Gets or sets a value determining how DrawingML effects are rendered.
+    # Gets or sets the value determining how DrawingML effects are rendered.
     # { Simplified | None | Fine }.
     attr_accessor :dml_effects_rendering_mode
 
-    # Gets or sets a value determining how DrawingML shapes are rendered.
-    # { Fallback | DrawingML }.
+    # Gets or sets the option that controls how DrawingML shapes are rendered.
     attr_accessor :dml_rendering_mode
 
-    # Gets or sets name of destination file.
+    # Gets or sets the name of destination file.
     attr_accessor :file_name
 
-    # Gets or sets format of save.
+    # Gets or sets the format of save.
     attr_accessor :save_format
 
-    # Gets or sets a value determining if fields should be updated before saving the document to a fixed page format.
-    # Default value for this property is. true.
+    # 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
 
-    # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted
-    # property is updated before saving.
+    # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted property is updated before saving.
     attr_accessor :update_last_printed_property
 
-    # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
+    # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
     attr_accessor :update_last_saved_time_property
 
-    # Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
+    # Gets or sets a value indicating whether content of StructuredDocumentTag is updated before saving.
     attr_accessor :update_sdt_content
 
-    # Gets or sets controls zip output or not.
-    # Default value is false.
+    # Gets or sets a value indicating whether to zip output or not.
+    # The default value is false.
     attr_accessor :zip_output
 
-    # Gets or sets a value determining how colors are rendered.
+    # Gets or sets the value determining how colors are rendered.
     # { Normal | Grayscale}.
     attr_accessor :color_mode
 
-    # Gets or sets determines the quality of the JPEG images inside PDF document.
+    # Gets or sets the quality of the JPEG images inside PDF document.
     attr_accessor :jpeg_quality
 
-    # Gets or sets allows to specify metafile rendering options.
+    # Gets or sets the metafile rendering options.
     attr_accessor :metafile_rendering_options
 
-    # Gets or sets indicates the symbol set that is used to represent numbers while rendering to fixed page formats.
+    # Gets or sets the symbol set, that is used to represent numbers while rendering to fixed page formats.
     attr_accessor :numeral_format
 
-    # Gets or sets flag indicates whether it is required to optimize output of XPS.
+    # Gets or sets a value indicating whether it is required to optimize output of XPS.
     # If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated.
-    # Note: The accuracy of the content display may be affected if this property is set to true.  Default is false.
+    # Note: The accuracy of the content display may be affected if this property is set to true.. The default value is false.
     attr_accessor :optimize_output
 
-    # Gets or sets determines number of pages to render.
+    # Gets or sets the number of pages to render.
     attr_accessor :page_count
 
-    # Gets or sets determines 0-based index of the first page to render.
+    # Gets or sets the 0-based index of the first page to render.
     attr_accessor :page_index
 
-    # Gets or sets allows to specify additional System.Drawing.Graphics quality options.
+    # Gets or sets the additional System.Drawing.Graphics quality options.
     attr_accessor :graphics_quality_options
 
-    # Gets or sets the horizontal resolution for the generated images, in dots per inch.
+    # Gets or sets the horizontal resolution in dots per inch for the generated images.
     # This property has effect only when saving to raster image formats.
     # The default value is 96.
     attr_accessor :horizontal_resolution
 
-    # Gets or sets brightness of image.
+    # Gets or sets the brightness level of the image.
     attr_accessor :image_brightness
 
-    # Gets or sets color mode of image.
+    # Gets or sets the color mode of the image.
     attr_accessor :image_color_mode
 
-    # Gets or sets contrast of image.
+    # Gets or sets the contrast level of the image.
     attr_accessor :image_contrast
 
-    # Gets or sets background (paper) color of image.
+    # Gets or sets the background (paper) color of the image.
     attr_accessor :paper_color
 
-    # Gets or sets pixel format of image.
+    # Gets or sets the pixel format of the image.
     attr_accessor :pixel_format
 
-    # Gets or sets both horizontal and vertical resolution for the generated images, in dots per inch.
+    # Gets or sets both horizontal and vertical resolution in dots per inch for the generated images.
     # This property has effect only when saving to raster image formats.
     # The default value is 96.
     attr_accessor :resolution
 
-    # Gets or sets zoom factor of image.
+    # Gets or sets the zoom factor of the image.
     attr_accessor :scale
 
-    # Gets or sets determine whether or not to use anti-aliasing for rendering.
+    # Gets or sets a value indicating whether to use anti-aliasing for rendering.
     attr_accessor :use_anti_aliasing
 
-    # Gets or sets a value determining whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF.
+    # Gets or sets a value indicating whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF.
     attr_accessor :use_gdi_emf_renderer
 
-    # Gets or sets determine whether or not to use high quality (i.e. slow) rendering algorithms.
+    # Gets or sets a value indicating whether to use high quality (i.e. slow) rendering algorithms.
     attr_accessor :use_high_quality_rendering
 
-    # Gets or sets the vertical resolution for the generated images, in dots per inch.
+    # Gets or sets the vertical resolution in dots per inch for the generated images.
     # This property has effect only when saving to raster image formats.
     # The default value is 96.
     attr_accessor :vertical_resolution

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
@@ -29,13 +29,13 @@ module AsposeWordsCloud
 
   # Represents a single bookmark.
   class Bookmark
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
     # Gets or sets the name of the bookmark.
     attr_accessor :name
 
-    # Gets or sets the text enclosed in the bookmark.
+    # Gets or sets text, enclosed in the bookmark.
     attr_accessor :text
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

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
@@ -32,7 +32,7 @@ module AsposeWordsCloud
     # Gets or sets the name of the bookmark.
     attr_accessor :name
 
-    # Gets or sets the text enclosed in the bookmark.
+    # Gets or sets text, enclosed in the bookmark.
     attr_accessor :text
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

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
@@ -27,12 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # This response should be returned by the service when handling:  GET bookmarks/{bookmarkName}.
+  # The REST response with a bookmark.
   class BookmarkResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets bookmark.
+    # Gets or sets the bookmark.
     attr_accessor :bookmark
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map