aspose_email_cloud 18.7.0 → 19.11.0

data/{src/asposeemailcloud → lib/aspose-email-cloud}/api_client.rb

@@ -1,23 +1,40 @@
-=begin
-#Aspose.Email for Cloud API Reference
-
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
-
-OpenAPI spec version: 1.1
-
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
-
-=end
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="api_client.rb">
+#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#  </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'
 require 'json'
 require 'logger'
 require 'tempfile'
-require 'typhoeus'
+require 'faraday'
+require 'mimemagic'
 require 'uri'
 
-module asposeemailcloud
+module AsposeEmailCloud
+  # Generic API client
+  # Swagger generic API client. This client handles the client-
+  # server communication, and is invariant across implementations.
   class ApiClient
     # The Configuration object holding settings to be used in the API client.
     attr_accessor :config
@@ -28,53 +45,47 @@ module asposeemailcloud
     attr_accessor :default_headers
 
     # Initializes the ApiClient
-    # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
-    def initialize(config = Configuration.default)
-      @config = config
-      @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
+    # @param [String] app_key Key to access the server.
+    # @param [String] app_sid ID to access the server.
+    # @param [String] base_url Server URL.
+    # @param [String] api_version Api version.
+    # @param [Object] debug Debug switch [true, false].
+    def initialize(app_key = nil, app_sid = nil, base_url = 'api-qa.aspose.cloud', api_version = 'v3.0', debug = false)
+      @config = Configuration.new(app_key, app_sid, base_url, api_version, debug)
       @default_headers = {
-        'Content-Type' => "application/json",
-        'User-Agent' => @user_agent
+        'x-aspose-client' => 'ruby sdk',
+        'x-aspose-version' => '19.7'
       }
     end
 
-    def self.default
-      @@default ||= ApiClient.new
-    end
-
     # Call an API with given options.
     #
     # @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 = {})
-      request = build_request(http_method, path, opts)
-      response = request.run
+      response = build_request(http_method, path, opts)
+      download_file response if opts[:return_type] == 'File'
 
       if @config.debugging
-        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+        @config.logger.debug "'HTTP' response body '~BEGIN~'\n #{response.body}\n'~END~'\n"
       end
 
       unless response.success?
-        if response.timed_out?
-          fail ApiError.new('Connection timed out')
-        elsif response.code == 0
+        if response.status.zero?
           # Errors from libcurl will be made visible here
-          fail ApiError.new(:code => 0,
-                            :message => response.return_message)
+          raise ApiError.new(response.return_message, 0)
         else
-          fail ApiError.new(:code => response.code,
-                            :response_headers => response.headers,
-                            :response_body => response.body),
-               response.status_message
+          begin
+            error = convert_to_type(JSON.parse(response.body, symbolize_names: true)[:error], "Error")
+          ensure
+            raise ApiError.new("#{response.status} Error connecting to the API #{path}; Message: #{error}",
+                                response.status, error)
+          end
         end
       end
 
-      if opts[:return_type]
-        data = deserialize(response, opts[:return_type])
-      else
-        data = nil
-      end
-      return data, response.code, response.headers
+      data = (deserialize(response, opts[:return_type]) if opts[:return_type])
+      [data, response.status, response.headers]
     end
 
     # Builds the HTTP request
@@ -85,7 +96,7 @@ module asposeemailcloud
     # @option opts [Hash] :query_params Query parameters
     # @option opts [Hash] :form_params Query parameters
     # @option opts [Object] :body HTTP body (JSON/XML)
-    # @return [Typhoeus::Request] A Typhoeus Request
+    # @return [Faraday::Response] A Faraday Response
     def build_request(http_method, path, opts = {})
       url = build_request_url(path)
       http_method = http_method.to_sym.downcase
@@ -93,39 +104,45 @@ module asposeemailcloud
       header_params = @default_headers.merge(opts[:header_params] || {})
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
+      body = opts[:body] if opts[:body] || nil?
 
       update_params_for_auth! header_params, query_params, opts[:auth_names]
 
-      # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
-      _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
-
       req_opts = {
-        :method => http_method,
-        :headers => header_params,
-        :params => query_params,
-        :params_encoding => @config.params_encoding,
-        :timeout => @config.timeout,
-        :ssl_verifypeer => @config.verify_ssl,
-        :ssl_verifyhost => _verify_ssl_host,
-        :sslcert => @config.cert_file,
-        :sslkey => @config.key_file,
-        :verbose => @config.debugging
+          :method => http_method,
+          :headers => header_params,
+          :params => query_params,
+          :body => body
       }
 
-      # set custom cert, if provided
-      req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
-
       if [:post, :patch, :put, :delete].include?(http_method)
         req_body = build_request_body(header_params, form_params, opts[:body])
         req_opts.update :body => req_body
         if @config.debugging
           @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
         end
+      elsif http_method == :get && body.nil? && !form_params.any? && header_params['Content-Type'] == 'multipart/form-data'
+        req_opts[:headers].delete('Content-Type')
+      end
+
+      conn = Faraday.new url, { :params => query_params, :headers => header_params } do |f|
+        f.request :multipart
+        f.request :url_encoded
+        f.adapter Faraday.default_adapter
       end
 
-      request = Typhoeus::Request.new(url, req_opts)
-      download_file(request) if opts[:return_type] == 'File'
-      request
+      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
+        return conn.delete url do |c|
+          c.body = req_opts[:body]
+        end
+      end
     end
 
     # Check if the given MIME is a JSON MIME.
@@ -137,7 +154,7 @@ module asposeemailcloud
     # @param [String] mime MIME
     # @return [Boolean] True if the MIME is application/json
     def json_mime?(mime)
-       (mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
+      (mime == '*/*') || !(mime =~ %r{Application/.*json(?!p)(;.*)?}i).nil?
     end
 
     # Deserialize the response to the given return type.
@@ -159,12 +176,12 @@ module asposeemailcloud
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
 
-      fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
+      raise "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
 
       begin
-        data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
+        data = JSON.parse("[#{body}]", symbolize_names: true)[0]
       rescue JSON::ParserError => e
-        if %w(String Date DateTime).include?(return_type)
+        if %w[String Date DateTime].include?(return_type)
           data = body
         else
           raise e
@@ -180,6 +197,7 @@ module asposeemailcloud
     # @return [Mixed] Data in a particular type
     def convert_to_type(data, return_type)
       return nil if data.nil?
+
       case return_type
       when 'String'
         data.to_s
@@ -200,17 +218,17 @@ module asposeemailcloud
         data
       when /\AArray<(.+)>\z/
         # e.g. Array<Pet>
-        sub_type = $1
-        data.map {|item| convert_to_type(item, sub_type) }
+        sub_type = Regexp.last_match(1)
+        data.map { |item| convert_to_type(item, sub_type) }
       when /\AHash\<String, (.+)\>\z/
         # e.g. Hash<String, Integer>
-        sub_type = $1
+        sub_type = Regexp.last_match(1)
         {}.tap do |hash|
-          data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
+          data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
         end
       else
         # models, e.g. Pet
-        asposeemailcloud.const_get(return_type).new.tap do |model|
+        AsposeEmailCloud.const_get(return_type).new.tap do |model|
           model.build_from_hash data
         end
       end
@@ -223,27 +241,22 @@ module asposeemailcloud
     # process can use.
     #
     # @see Configuration#temp_folder_path
-    def download_file(request)
+    def download_file(response)
       tempfile = nil
       encoding = nil
-      request.on_headers do |response|
-        content_disposition = response.headers['Content-Disposition']
-        if content_disposition and content_disposition =~ /filename=/i
-          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-          prefix = sanitize_filename(filename)
-        else
-          prefix = 'download-'
-        end
-        prefix = prefix + '-' unless prefix.end_with?('-')
-        encoding = response.body.encoding
-        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-        @tempfile = tempfile
-      end
-      request.on_body do |chunk|
-        chunk.force_encoding(encoding)
-        tempfile.write(chunk)
+      content_disposition = response.headers['Content-Disposition']
+      if content_disposition and content_disposition =~ /filename=/i
+        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+        prefix = sanitize_filename(filename)
+      else
+        prefix = 'download-'
       end
-      request.on_complete do |response|
+      prefix += '-' unless prefix.end_with?('-')
+      encoding = response.body.encoding
+      tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+      @tempfile = tempfile
+      tempfile.write(response.body)
+      response.on_complete do |resp|
         tempfile.close
         @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 "\
@@ -258,12 +271,12 @@ module asposeemailcloud
     # @param [String] filename the filename to be sanitized
     # @return [String] the sanitized filename
     def sanitize_filename(filename)
-      filename.gsub(/.*[\/\\]/, '')
+      filename.gsub(%r{.*[/\\]}, '')
     end
 
     def build_request_url(path)
       # Add leading and trailing slashes to path
-      path = "/#{path}".gsub(/\/+/, '/')
+      path = "/#{path}".gsub(%r{/+}, '/')
       URI.encode(@config.base_url + path)
     end
 
@@ -275,13 +288,16 @@ module asposeemailcloud
     # @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') && form_params.any?
         data = {}
         form_params.each do |key, value|
           case value
-          when File, Array, nil
-            # let typhoeus handle File, Array and nil parameters
+          when ::File
+            data[key] = Faraday::UploadIO.new(value.path, MimeMagic.by_magic(value).to_s, key)
+          when ::Tempfile
+            data[key] = Faraday::UploadIO.new(value.path, key)
+          when ::Array, nil
             data[key] = value
           else
             data[key] = value.to_s
@@ -302,56 +318,32 @@ module asposeemailcloud
     # @param [String] auth_names Authentication scheme name
     def update_params_for_auth!(header_params, query_params, auth_names)
       Array(auth_names).each do |auth_name|
-        auth_setting = @config.auth_settings[auth_name]
+        auth_setting = @config.auth_settings[auth_name.to_sym]
         next unless auth_setting
+
         case auth_setting[:in]
-        when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
-        when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
-        else fail ArgumentError, 'Authentication token must be in `query` of `header`'
+        when 'header'
+          header_params[auth_setting[:key]] = auth_setting[:value]
+        when 'query'
+          query_params[auth_setting[:key]] = auth_setting[:value]
+        else
+          raise ArgumentError, 'Authentication token must be in `query` of `header`'
         end
       end
     end
 
-    # Sets user agent in HTTP header
-    #
-    # @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
-    def user_agent=(user_agent)
-      @user_agent = user_agent
-      @default_headers['User-Agent'] = @user_agent
-    end
-
-    # Return Accept header based on an array of accepts provided.
-    # @param [Array] accepts array for Accept
-    # @return [String] the Accept header (e.g. application/json)
-    def select_header_accept(accepts)
-      return nil if accepts.nil? || accepts.empty?
-      # use JSON when present, otherwise use all of the provided
-      json_accept = accepts.find { |s| json_mime?(s) }
-      return json_accept || accepts.join(',')
-    end
-
-    # Return Content-Type header based on an array of content types provided.
-    # @param [Array] content_types array for Content-Type
-    # @return [String] the Content-Type header  (e.g. application/json)
-    def select_header_content_type(content_types)
-      # use application/json by default
-      return 'application/json' if content_types.nil? || content_types.empty?
-      # use JSON when present, otherwise use the first one
-      json_content_type = content_types.find { |s| json_mime?(s) }
-      return json_content_type || content_types.first
-    end
-
     # Convert object (array, hash, object, etc) to JSON string.
     # @param [Object] model object to be converted into JSON string
     # @return [String] JSON string representation of the object
     def object_to_http_body(model)
       return model if model.nil? || model.is_a?(String)
+
       local_body = nil
-      if model.is_a?(Array)
-        local_body = model.map{|m| object_to_hash(m) }
-      else
-        local_body = object_to_hash(model)
-      end
+      local_body = if model.is_a?(Array)
+                     model.map { |m| object_to_hash(m) }
+                   else
+                     object_to_hash(model)
+                   end
       local_body.to_json
     end
 
@@ -382,7 +374,7 @@ module asposeemailcloud
         # return the array directly as typhoeus will handle it as expected
         param
       else
-        fail "unknown collection format: #{collection_format.inspect}"
+        raise "unknown collection format: #{collection_format.inspect}"
       end
     end
   end

data/lib/aspose-email-cloud/api_error.rb

@@ -0,0 +1,42 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="api_error.rb">
+#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#  </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 AsposeEmailCloud
+  # Email API Exception
+  class ApiError < StandardError
+    attr_reader :message, :code, :error
+
+    # Initializes a new instance of the ApiError class
+    # @param [String] message
+    # @param [String] code
+    # @param [String] error
+    def initialize(message, code, error = nil)
+      @message = message
+      @code = code
+      @error = error
+    end
+  end
+end