aspose_words_cloud 21.11.0 → 21.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ab59b1dec3b4da141e5e6bc0644aaf33de67afaedefba975edc3c0e5257be3f
-  data.tar.gz: 82b484455da21ba104e912f1f5690326bf01b523ac93cd84931aa6960f94a009
+  metadata.gz: 0536fd5bbb7039e51b88bff391f2338d166ee1ba121ecdff0f0955b806eca9d0
+  data.tar.gz: 505b49d1119f05207e7e777cf17ecd9ed3ee101f044fa269105ddcb0eae42d46
 SHA512:
-  metadata.gz: 43d87480eb0f5d7dc9568079984015bb0d4a245e087e8d70bca44bad038e56e25e3683fe7092fc220aa719fccb2a5102d96097dd613d38da885a8add226db428
-  data.tar.gz: d6190ab713c931d5e971bdbc870ad1b36f74947bf77f5cef0ac7b3e0d930a777757d6eb0b5a5f78998f32c4a95d072b56382b8027e2c0bb4fa4cb54ab4b064f0
+  metadata.gz: fc22fa40e58489f941800f96b157a8a9b226396d614d21e27c023703d3626bb23dcc5cdeace96dcf80464e8c51788f6dd47ca151a8886137c3fd90cbc4d602af
+  data.tar.gz: bdf28c93a4e6636bd820f2209f9dd6a2768f02f802d5616889569fbe9da3d52343851ce9d50f657df0fbb123f5f00d09f62e0ce733492ad99db5c3d429f2104d

data/lib/aspose_words_cloud/api/words_api.rb

@@ -39,26 +39,31 @@ module AsposeWordsCloud
       require_all '../models/requests'
       require_all '../models/responses'
       request_token
+      request_rsa_key
     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
+    def batch(batch_requests, display_intermediate_result = true)
+      raise ArgumentError, 'Requests array is nil' unless batch_requests != nil
+      raise ArgumentError, 'There must be at least one request' unless batch_requests.length != 0
       form_params = {}
+      id_request_to_map = {}
       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")
+      batch_requests.each_with_index do |batch_request, index|
+        guid = batch_request.request_id
+        form_params["request-#{index}"] = Faraday::ParamPart.new(batch_request.request.to_batch_part(@api_client, guid), "application/http; msgtype=request")
+        id_request_to_map[guid] = batch_request
       end
-      data, status_code, headers = @api_client.call_api(:PUT, "/v4.0/words/batch",
+      url = display_intermediate_result ? "/v4.0/words/batch" : "/v4.0/words/batch?displayIntermediateResults=false"
+      data, status_code, headers = @api_client.call_api(:PUT, url,
                                                         header_params: header_params,
                                                         query_params: {},
                                                         form_params: form_params,
                                                         body: nil,
                                                         batch: true,
-                                                        parts: requests,
-                                                        auth_names: ['JWT'])
+                                                        auth_names: ['JWT'],
+                                                        request_map: id_request_to_map)
     end
 
     # Accepts all revisions in the document.
@@ -5780,6 +5785,7 @@ module AsposeWordsCloud
         # form parameters
         form_params = {}
         form_params[downcase_first_letter('Data')] = request.data
+        form_params[downcase_first_letter('Options')] = request.options.to_body.to_json unless request.options.nil?
 
         # http body (model)
         post_body = nil
@@ -5851,6 +5857,7 @@ module AsposeWordsCloud
         form_params = {}
         form_params[downcase_first_letter('Template')] = request.template
         form_params[downcase_first_letter('Data')] = request.data
+        form_params[downcase_first_letter('Options')] = request.options.to_body.to_json unless request.options.nil?
 
         # http body (model)
         post_body = nil
@@ -10084,6 +10091,67 @@ module AsposeWordsCloud
         [data, status_code, headers]
     end
 
+    # Returns application info.
+    # @param request GetInfoRequest
+    # @return [InfoResponse]
+    def get_info(request)
+        begin
+        data, _status_code, _headers = get_info_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = get_info_with_http_info(request)
+            else
+            raise
+            end
+        end
+        data
+    end
+
+    # Returns application info.
+    # @param request GetInfoRequest
+    # @return [Array<(InfoResponse, Fixnum, Hash)>]
+    # InfoResponse, response status code and response headers
+    private def get_info_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? GetInfoRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.get_info ...' if @api_client.config.debugging
+        # resource path
+        local_var_path = '/words/info'[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: 'InfoResponse')
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#get_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        [data, status_code, headers]
+    end
+
     # Reads a list from the document.
     # @param request GetListRequest
     # @return [ListResponse]
@@ -22755,5 +22823,29 @@ module AsposeWordsCloud
         require file
       end
     end
+
+     #
+     # Gets a rsa key from server
+     #
+    private def request_rsa_key
+      config = @api_client.config
+      data = self.get_public_key GetPublicKeyRequest.new
+      modulus = data.modulus
+      exponent = data.exponent
+
+      config.rsa_key = OpenSSL::PKey::RSA.new
+      config.rsa_key.set_key(base64_to_long(modulus), base64_to_long(exponent), nil)
+    end
+
+    private def base64_to_long(data)
+      decoded_with_padding = Base64.urlsafe_decode64(data) + Base64.decode64('==')
+      decoded_with_padding.to_s.unpack('C*').map do |byte|
+        to_hex(byte)
+      end.join.to_i(16)
+    end
+
+    private def to_hex(int)
+      int < 16 ? '0' + int.to_s(16) : int.to_s(16)
+    end
   end
 end

data/lib/aspose_words_cloud/api_client.rb

@@ -27,8 +27,10 @@ require 'date'
 require 'json'
 require 'logger'
 require 'tempfile'
+require 'timeout'
 require 'uri'
 require 'faraday'
+require 'base64'
 require 'marcel'
 require 'multipart_parser/reader'
 require_relative 'version'
@@ -97,7 +99,7 @@ module AsposeWordsCloud
       if opts[:multipart_response] == true
         data = deserialize_multipart(response)
       elsif opts[:batch] == true
-        data = deserialize_batch(response, opts[:parts])
+        data = deserialize_batch(response, opts[:request_map])
       else
         data = deserialize(response.body, opts[:return_type]) if opts[:return_type]
       end
@@ -146,16 +148,18 @@ module AsposeWordsCloud
       f.adapter Faraday.default_adapter
       end
 
-      case http_method
-      when :post
-        return conn.post url, req_opts[:body]
-      when :put
-        return conn.put url, req_opts[:body]
-      when :get
-        return conn.get url, req_opts[:body]
-      else
-        conn.delete url do |c|
-          c.body = req_opts[:body]
+      Timeout.timeout(@config.timeout) do
+        case http_method
+        when :post
+          return conn.post url, req_opts[:body]
+        when :put
+          return conn.put url, req_opts[:body]
+        when :get
+          return conn.get url, req_opts[:body]
+        else
+          conn.delete url do |c|
+            c.body = req_opts[:body]
+          end
         end
       end
     end
@@ -226,7 +230,7 @@ module AsposeWordsCloud
     end
 
     # Deserialize batch
-    def deserialize_batch(response, requests)
+    def deserialize_batch(response, request_map)
       result = { errors: [], parts: [] }
       def result.part(name)
         hash = self[:parts].detect { |h| h[:part].name == name }
@@ -263,7 +267,9 @@ module AsposeWordsCloud
       end
 
       result[:parts].each_with_index do |response_data, index|
-        return_type = requests[index].get_response_type
+        req_id = response_data[:part].headers['requestid']
+        batch_request = request_map[req_id]
+        return_type = batch_request.request.get_response_type
         responses_data.push(deserialize(response_data[:body], return_type))
       end
       responses_data
@@ -443,7 +449,12 @@ module AsposeWordsCloud
     # @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]
+      if param_name == 'password' && !param_value.empty?
+        params = URI.decode_www_form(uri.query || "") << ['encryptedPassword', Base64.encode64(self.config.rsa_key.public_encrypt(param_value.to_s.force_encoding("utf-8")))]
+      else
+        params = URI.decode_www_form(uri.query || "") << [param_name, param_value]
+      end
+
       uri.query = URI.encode_www_form(params)
       uri.to_s
     end

data/lib/aspose_words_cloud/configuration.rb

@@ -90,6 +90,13 @@ module AsposeWordsCloud
     # @return [true, false]
     attr_accessor :client_side_validation
 
+    # Defines RSA key
+    attr_accessor :rsa_key
+
+    # Defines request timeout
+    attr_accessor :timeout
+
+
 
     def initialize
       @baseUrl = "https://api.aspose.cloud"

data/lib/aspose_words_cloud/models/field_options.rb

@@ -0,0 +1,370 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="field_options.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>
+# ------------------------------------------------------------------------------------
+
+require 'date'
+
+module AsposeWordsCloud
+
+  # DTO for field options.
+  class FieldOptions
+    # Gets or sets BuiltIn Templates Paths.
+    attr_accessor :built_in_templates_paths
+
+    # Gets or sets Curren tUser.
+    attr_accessor :current_user
+
+    # Gets or sets Custom Toc Style Separator.
+    attr_accessor :custom_toc_style_separator
+
+    # Gets or sets Default Document Author.
+    attr_accessor :default_document_author
+
+    # Gets or sets Field Index Format.
+    attr_accessor :field_index_format
+
+    # Gets or sets Field Update Culture Source.
+    attr_accessor :field_update_culture_source
+
+    # Gets or sets File Name.
+    attr_accessor :file_name
+
+    # Gets or sets if Bidi Text Supported OnUpdate.
+    attr_accessor :is_bidi_text_supported_on_update
+
+    # Gets or sets if Legacy Number Format.
+    attr_accessor :legacy_number_format
+
+    # Gets or sets PreProcess Culture Name.
+    attr_accessor :pre_process_culture_name
+
+    # Gets or sets Template Name.
+    attr_accessor :template_name
+
+    # Gets or sets if Use Invariant Culture Number Format.
+    attr_accessor :use_invariant_culture_number_format
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'built_in_templates_paths' => :'BuiltInTemplatesPaths',
+        :'current_user' => :'CurrentUser',
+        :'custom_toc_style_separator' => :'CustomTocStyleSeparator',
+        :'default_document_author' => :'DefaultDocumentAuthor',
+        :'field_index_format' => :'FieldIndexFormat',
+        :'field_update_culture_source' => :'FieldUpdateCultureSource',
+        :'file_name' => :'FileName',
+        :'is_bidi_text_supported_on_update' => :'IsBidiTextSupportedOnUpdate',
+        :'legacy_number_format' => :'LegacyNumberFormat',
+        :'pre_process_culture_name' => :'PreProcessCultureName',
+        :'template_name' => :'TemplateName',
+        :'use_invariant_culture_number_format' => :'UseInvariantCultureNumberFormat'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'built_in_templates_paths' => :'Array<String>',
+        :'current_user' => :'UserInformation',
+        :'custom_toc_style_separator' => :'String',
+        :'default_document_author' => :'String',
+        :'field_index_format' => :'String',
+        :'field_update_culture_source' => :'String',
+        :'file_name' => :'String',
+        :'is_bidi_text_supported_on_update' => :'BOOLEAN',
+        :'legacy_number_format' => :'BOOLEAN',
+        :'pre_process_culture_name' => :'String',
+        :'template_name' => :'String',
+        :'use_invariant_culture_number_format' => :'BOOLEAN'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.key?(:'BuiltInTemplatesPaths')
+        if (value = attributes[:'BuiltInTemplatesPaths']).is_a?(Array)
+          self.built_in_templates_paths = value
+        end
+      end
+
+      if attributes.key?(:'CurrentUser')
+        self.current_user = attributes[:'CurrentUser']
+      end
+
+      if attributes.key?(:'CustomTocStyleSeparator')
+        self.custom_toc_style_separator = attributes[:'CustomTocStyleSeparator']
+      end
+
+      if attributes.key?(:'DefaultDocumentAuthor')
+        self.default_document_author = attributes[:'DefaultDocumentAuthor']
+      end
+
+      if attributes.key?(:'FieldIndexFormat')
+        self.field_index_format = attributes[:'FieldIndexFormat']
+      end
+
+      if attributes.key?(:'FieldUpdateCultureSource')
+        self.field_update_culture_source = attributes[:'FieldUpdateCultureSource']
+      end
+
+      if attributes.key?(:'FileName')
+        self.file_name = attributes[:'FileName']
+      end
+
+      if attributes.key?(:'IsBidiTextSupportedOnUpdate')
+        self.is_bidi_text_supported_on_update = attributes[:'IsBidiTextSupportedOnUpdate']
+      end
+
+      if attributes.key?(:'LegacyNumberFormat')
+        self.legacy_number_format = attributes[:'LegacyNumberFormat']
+      end
+
+      if attributes.key?(:'PreProcessCultureName')
+        self.pre_process_culture_name = attributes[:'PreProcessCultureName']
+      end
+
+      if attributes.key?(:'TemplateName')
+        self.template_name = attributes[:'TemplateName']
+      end
+
+      if attributes.key?(:'UseInvariantCultureNumberFormat')
+        self.use_invariant_culture_number_format = attributes[:'UseInvariantCultureNumberFormat']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = []
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      field_index_format_validator = EnumAttributeValidator.new('String', ["Template", "Classic", "Fancy", "Modern", "Bulleted", "Formal", "Simple"])
+      return false unless field_index_format_validator.valid?(@field_index_format)
+      field_update_culture_source_validator = EnumAttributeValidator.new('String', ["CurrentThread", "FieldCode"])
+      return false unless field_update_culture_source_validator.valid?(@field_update_culture_source)
+
+      return true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] field_index_format Object to be assigned
+    def field_index_format=(field_index_format)
+      validator = EnumAttributeValidator.new('String', ["Template", "Classic", "Fancy", "Modern", "Bulleted", "Formal", "Simple"])
+      if field_index_format.to_i == 0
+        unless validator.valid?(field_index_format)
+          raise ArgumentError, "invalid value for 'field_index_format', must be one of #{validator.allowable_values}."
+        end
+        @field_index_format = field_index_format
+      else
+        @field_index_format = validator.allowable_values[field_index_format.to_i]
+      end
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] field_update_culture_source Object to be assigned
+    def field_update_culture_source=(field_update_culture_source)
+      validator = EnumAttributeValidator.new('String', ["CurrentThread", "FieldCode"])
+      if field_update_culture_source.to_i == 0
+        unless validator.valid?(field_update_culture_source)
+          raise ArgumentError, "invalid value for 'field_update_culture_source', must be one of #{validator.allowable_values}."
+        end
+        @field_update_culture_source = field_update_culture_source
+      else
+        @field_update_culture_source = validator.allowable_values[field_update_culture_source.to_i]
+      end
+    end
+
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(other)
+      return true if self.equal?(other)
+      self.class == other.class &&
+          built_in_templates_paths == other.built_in_templates_paths &&
+          current_user == other.current_user &&
+          custom_toc_style_separator == other.custom_toc_style_separator &&
+          default_document_author == other.default_document_author &&
+          field_index_format == other.field_index_format &&
+          field_update_culture_source == other.field_update_culture_source &&
+          file_name == other.file_name &&
+          is_bidi_text_supported_on_update == other.is_bidi_text_supported_on_update &&
+          legacy_number_format == other.legacy_number_format &&
+          pre_process_culture_name == other.pre_process_culture_name &&
+          template_name == other.template_name &&
+          use_invariant_culture_number_format == other.use_invariant_culture_number_format
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [built_in_templates_paths, current_user, custom_toc_style_separator, default_document_author, field_index_format, field_update_culture_source, file_name, is_bidi_text_supported_on_update, legacy_number_format, pre_process_culture_name, template_name, use_invariant_culture_number_format].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+        # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        Time.at(/\d/.match(value)[0].to_f).to_datetime
+      when :Date
+        Time.at(/\d/.match(value)[0].to_f).to_date
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else
+      # model
+        temp_model = AsposeWordsCloud.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end