aspose_slides_cloud 1.0.3 → 19.9.0

data/lib/aspose_slides_cloud/api_client.rb

@@ -1,162 +1,226 @@
+=begin
+Copyright (c) 2019 Aspose Pty Ltd
+
+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.
+=end
+
 require 'date'
 require 'json'
 require 'logger'
 require 'tempfile'
-require 'typhoeus'
+require 'faraday'
 require 'uri'
-require 'openssl'
-require 'base64'
-require 'rexml/document'
 
 module AsposeSlidesCloud
   class ApiClient
-    
-    include AsposeStorageCloud
-    
-    attr_accessor :host
+    # The Configuration object holding settings to be used in the API client.
+    attr_accessor :config
 
     # Defines the headers to be used in HTTP requests of all API calls by default.
     #
     # @return [Hash]
     attr_accessor :default_headers
 
-    # Stores the HTTP response from the last API call using this API client.
-    attr_accessor :last_response
-
-    def initialize(host = nil)
-      @host = host || Configuration.base_url
-      @format = 'json'
-      @user_agent = "ruby-swagger-#{VERSION}"
-      @default_headers = {
-        'Content-Type' => "application/#{@format.downcase}",
-        'User-Agent' => @user_agent
-      }
+    # Initializes the ApiClient
+    # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
+    def initialize(config = Configuration.default)
+      @config = config
+    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 = call_api_method(http_method, path, opts)
+      if @config.debugging
+        @config.logger.debug "HTTP response\nHeaders: #{response.headers}\nStatus: #{response.status}\nBody: #{response.body}\n"
+      end
 
-      # record as last response
-      @last_response = response
+      if response.status == 401 and @config.access_token
+        @config.access_token = nil
+        return repeat_call_api(http_method, path, opts)
+      end
+
+      return process_response(response, opts)
+    end
 
-      if Configuration.debugging
-        Configuration.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+    # 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 repeat_call_api(http_method, path, opts = {})
+      response = call_api_method(http_method, path, opts)
+      if @config.debugging
+        @config.logger.debug "HTTP response\nHeaders: #{response.headers}\nStatus: #{response.status}\nBody: #{response.body}\n"
       end
 
+      return process_response(response, opts)
+    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 process_response(response, opts)
       unless response.success?
-        fail ApiError.new(:code => response.code,
-                          :response_headers => response.headers,
-                          :response_body => response.body),
-             response.status_message
+        if response.status == 0
+          # Errors from libcurl will be made visible here
+          fail ApiError.new(:code => 0,
+                            :message => response.return_message)
+        else
+          fail ApiError.new(:code => response.status,
+                            :response_headers => response.headers,
+                            :response_body => response.body),
+               response.reason_phrase
+        end
       end
 
       if opts[:return_type]
-        deserialize(response, opts[:return_type])
+        data = deserialize(response, opts[:return_type])
       else
-        nil
+        data = nil
       end
-    end
 
-    def build_request(http_method, path, opts = {})
-      url = build_request_url(path)
-      http_method = http_method.to_sym.downcase
-      
-      header_params = @default_headers.merge(opts[:header_params] || {})
-      query_params = {}
-      form_params = opts[:form_params] || {}
+      return data, response.status, response.headers
+    end
 
-      req_opts = {
-        :method => http_method,
-        :headers => header_params,
-        :params => query_params,
-        :ssl_verifypeer => Configuration.verify_ssl,
-        :sslcert => Configuration.cert_file,
-        :sslkey => Configuration.key_file,
-        :cainfo => Configuration.ssl_ca_cert,
-        :verbose => Configuration.debugging
-      }
-
-      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 Configuration.debugging
-          Configuration.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
+    # 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_method(http_method, path, opts = {})
+      connection = Faraday.new(:url => @config.base_path)
+      case http_method
+      when :GET
+        response = connection.get do |req|
+          build_request(req, http_method, path, opts)
+        end
+      when :POST
+        response = connection.post do |req|
+          build_request(req, http_method, path, opts)
+        end
+      when :PUT
+        response = connection.put do |req|
+          build_request(req, http_method, path, opts)
+        end
+      when :DELETE
+        response = connection.delete do |req|
+          build_request(req, http_method, path, opts)
         end
       end
-      
-      url = sign(url, opts[:query_params])
-      puts url
-      Typhoeus::Request.new(url, req_opts)
+      response
+    end
 
+    # Builds the HTTP request
+    #
+    # @param [String] http_method HTTP method/verb (e.g. POST)
+    # @param [String] path URL path (e.g. /account/new)
+    # @option opts [Hash] :header_params Header parameters
+    # @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
+    def build_request(req, http_method, path, opts = {})
+      opts[:query_params].each_key do |key|
+        if opts[:query_params][key].kind_of?(Array)
+          opts[:query_params][key] = opts[:query_params][key].join[","]
+        end
+      end
+      req.url path.sub(/^\/+/, '')
+      req.headers = opts[:header_params]
+      req.params = opts[:query_params]
+      form_params = opts[:form_params] || {}
+      req.body = build_request_body(req.headers, form_params, opts[:body], opts[:files])
+      if @config.debugging
+        @config.logger.debug "HTTP request\nMethod: #{req.method}\nPath: #{req.path}\nParams: #{req.params}\nHeaders: #{req.headers}\nBody: #{req.body}\n"
+      end
+      set_headers(req.headers)
     end
-    
-    # Signs a URI with your appSID and Key.
-    # * :url describes the URL to sign
-    
-    def sign(url, query_params)
-        
-      fail "Please set Aspose App key and SID first. You can get App key and App SID from https://cloud.aspose.com" if AsposeApp.app_key.nil? || AsposeApp.app_sid.nil?
-      
-      url = url[0..-2] if url[-1].eql? '/'
-
-      unless query_params.empty?
-        url = "#{url}?"
-        query_params.each { |key, value|
-          url = "#{url}#{key}=#{value}&"
-        }
-        url = url[0..-2]
+
+    def set_headers(headers)
+      headers['x-aspose-client'] = 'ruby sdk'
+      headers['x-aspose-version'] = AsposeSlidesCloud::VERSION
+      if @config.timeout > 0
+        headers['x-aspose-timeout'] = @config.timeout
       end
+      set_auth_header(headers)
+    end
 
-      url = URI.escape(url)
-      parsed_url = URI.parse(url)
-        
-      url_to_sign = "#{parsed_url.scheme}://#{parsed_url.host}#{parsed_url.path}"
-      url_to_sign += "?#{parsed_url.query}" if parsed_url.query
-      if parsed_url.query
-        url_to_sign += "&appSID=#{AsposeApp.app_sid}"
-      else
-        url_to_sign += "?appSID=#{AsposeApp.app_sid}"
-      end  
-        
-      # create a signature using the private key and the URL
-      raw_signature = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), AsposeApp.app_key, url_to_sign)
-        
-      #Convert raw to encoded string
-      signature = Base64.strict_encode64(raw_signature).tr('+/', '-_')
-        
-      #remove invalid character
-      signature = signature.gsub(/[=_-]/, '=' => '', '_' => '%2f', '-' => '%2b')
-        
-      #Define expression
-      pat = Regexp.new('%[0-9a-f]{2}')
-        
-      #Replace the portion matched to the above pattern to upper case
-      6.times do
-        signature = signature.sub(pat, pat.match(signature).to_s.upcase)
+    def set_auth_header(headers)
+      unless @config.access_token
+        auth_token_response = Faraday.post(
+          @config.auth_base_url + '/connect/token',
+          { :grant_type => 'client_credentials', 'client_id' => @config.app_sid, 'client_secret' => @config.app_key })
+
+        unless auth_token_response.success?
+          if auth_token_response.status == 0
+            # Errors from libcurl will be made visible here
+            fail ApiError.new(:code => 0,
+                            :message => auth_token_response.return_message)
+          else
+            fail ApiError.new(:code => 401,
+                            :response_headers => auth_token_response.headers,
+                            :response_body => auth_token_response.body),
+                 "unauthorized"
+          end
+        end
+        @config.access_token = JSON.parse("[#{auth_token_response.body}]", :symbolize_names => true)[0][:access_token]
       end
-      
-      # prepend the server and append the signature.
-      url_to_sign + "&signature=#{signature}"
+      headers['Authorization'] = 'Bearer ' + @config.access_token
+    end
 
+    # Check if the given MIME is a JSON MIME.
+    # JSON MIME examples:
+    #   application/json
+    #   application/json; charset=UTF8
+    #   APPLICATION/JSON
+    #   */*
+    # @param [String] mime MIME
+    # @return [Boolean] True if the MIME is application/json
+    def json_mime?(mime)
+      (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
     end
 
     # Deserialize the response to the given return type.
     #
+    # @param [Response] response HTTP response
     # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
     def deserialize(response, return_type)
       body = response.body
+
+      # 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 nil if body.nil? || body.empty?
 
-      # handle file downloading - save response body into a tmp file and return the File instance
-      return download_file(response) if return_type == 'File'
+      # return response body directly for String return type
+      return body if return_type == 'String' or return_type == 'File'
 
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
 
-      unless content_type.start_with?('application/json')
-        fail "Content-Type is not supported: #{content_type}"
-      end
+      fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
 
       begin
         data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
@@ -172,6 +236,9 @@ module AsposeSlidesCloud
     end
 
     # Convert data to the given return type.
+    # @param [Object] data Data to be converted
+    # @param [String] return_type Return type
+    # @return [Mixed] Data in a particular type
     def convert_to_type(data, return_type)
       return nil if data.nil?
       case return_type
@@ -190,17 +257,17 @@ module AsposeSlidesCloud
         # parse date time (expecting ISO 8601 format)
         Date.parse data
       when 'Object'
-        # generic object, return directly
+        # generic object (usually a Hash), return directly
         data
       when /\AArray<(.+)>\z/
         # e.g. Array<Pet>
         sub_type = $1
-        data.map {|item| convert_to_type(item, sub_type) }
+        data.map { |item| convert_to_type(item, sub_type) }
       when /\AHash\<String, (.+)\>\z/
         # e.g. Hash<String, Integer>
         sub_type = $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
@@ -210,62 +277,64 @@ module AsposeSlidesCloud
       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.
+    # Builds the HTTP request body
     #
-    # @see Configuration#temp_folder_path
-    # @return [File] the file downloaded
-    def download_file(response)
-      tmp_file = Tempfile.new '', Configuration.temp_folder_path
-      content_disposition = response.headers['Content-Disposition']
-
-      if content_disposition
-        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-        path = File.join File.dirname(tmp_file), filename
+    # @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(header_params, form_params, body, files)
+      if files and files.length > 0
+        boundary = "7d70fb31-0eb9-4846-9ea8-933dfb69d8f1"
+        header_params['Content-Type'] = "multipart/form-data; boundary=#{boundary}"
+        data = ""
+        if body
+          put_multipart!(data, boundary, 0, body)
+        end        
+        files.each_with_index do |val, index|
+          put_multipart!(data, boundary, index + 1, val)
+        end
+        data << "\r\n--#{boundary}--\r\n"
+        data
       else
-        path = tmp_file.path
+        header_params['Content-Type'] = 'text/json'
+        if body
+          data = body.is_a?(String) ? body : body.to_json
+        else
+          data = nil
+        end
       end
-      # close and delete temp file
-      tmp_file.close!
-
-      File.open(path, 'wb') { |file| file.write(response.body) }
-      Configuration.logger.info "File written to #{path}. Please move the file to a proper "\
-                                "folder for further processing and delete the temp afterwards"
-      File.new(path)
-    end
-
-    def build_request_url(path)
-      # Add leading and trailing slashes to path
-      path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(host + path)
+      data
     end
 
-    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'
-        
-        data = form_params.dup
-        data.each do |key, value|
-          if key.eql? "file"
-            data = value
-            break
-          else
-            data[key] = value.to_s if value && !value.is_a?(File)
-          end
-        end
-      elsif body
-        data = body.is_a?(String) ? body : body.to_json
-      else
-        data = nil
+    # 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 put_multipart!(data, boundary, part_index, part_data)
+      data << "\r\n--#{boundary}\r\n"
+      if part_index > 0
+        data << "Content-Disposition: form-data; name=\"file#{part_index}\";filename=\"null\"\r\n"
+        data << "Content-Type: application/octet-stream\r\n"
+      elsif
+        data << "Content-Disposition: form-data; name=\"data\"\r\n"
+        data << "Content-Type: text/json\r\n"
       end
-      data
+      data << "Content-Length: #{part_data.length}\r\n"
+      data << "\r\n"
+      data << part_data
     end
 
     # Update hearder and query params based on authentication settings.
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] query_params Query parameters
+    # @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 = Configuration.auth_settings[auth_name]
+        auth_setting = @config.auth_settings[auth_name]
         next unless auth_setting
         case auth_setting[:in]
         when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
@@ -275,49 +344,39 @@ module AsposeSlidesCloud
       end
     end
 
-    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)
-      if accepts.empty?
-        return
-      elsif accepts.any?{ |s| s.casecmp('application/json') == 0 }
-        'application/json' # look for json data by default
-      else
-        accepts.join(',')
-      end
+      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) }
+      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)
-      if content_types.empty?
-        'application/json' # use application/json by default
-      elsif content_types.any?{ |s| s.casecmp('application/json')==0 }
-        'application/json' # use application/json if it's included
-      else
-        content_types[0] # otherwise, use the first one
-      end
+      # 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) }
+      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 if model.nil?
-      _body = nil
+      return model if model.nil? || model.is_a?(String)
+      local_body = nil
       if model.is_a?(Array)
-        _body = model.map{|m| object_to_hash(m) }
+        local_body = model.map { |m| object_to_hash(m) }
       else
-        _body = object_to_hash(model)
+        local_body = object_to_hash(model)
       end
-      _body.to_json
+      local_body.to_json
     end
 
     # Convert object(non-array) to hash.
@@ -330,7 +389,38 @@ module AsposeSlidesCloud
         obj
       end
     end
-     
-    
+
+    # Convert object(non-array) to hash.
+    # @param [Object] obj object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def replace_path_parameter(path, name, value)
+      if value == nil
+        value = ""
+      end
+      if value.to_s != ""
+        value = "/" + value.to_s
+      end
+      path.sub('/{' + name + '}', URI::encode(value))
+    end
+
+    # Build parameter value according to the given collection format.
+    # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
+    def build_collection_param(param, collection_format)
+      case collection_format
+      when :csv
+        param.join(',')
+      when :ssv
+        param.join(' ')
+      when :tsv
+        param.join("\t")
+      when :pipes
+        param.join('|')
+      when :multi
+        # return the array directly as typhoeus will handle it as expected
+        param
+      else
+        fail "unknown collection format: #{collection_format.inspect}"
+      end
+    end
   end
 end