aspose_pdf_cloud 1.0.2 → 18.2.0

data/lib/aspose_pdf_cloud/api_client.rb

@@ -1,3 +1,24 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+  Copyright (c) 2018 Aspose.Pdf for Cloud
+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'
@@ -8,93 +29,136 @@ require 'openssl'
 require 'base64'
 require 'rexml/document'
 
-module AsposePDFCloud
+module AsposePdfCloud
   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}"
+    # 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"
       @default_headers = {
-        'Content-Type' => "application/#{@format.downcase}",
+        'Content-Type' => "application/json",
         'User-Agent' => @user_agent
       }
     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
 
-      # record as last response
-      @last_response = response
-
-      if Configuration.debugging
-        Configuration.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+      if @config.debugging
+        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
       end
 
       unless response.success?
-        fail ApiError.new(:code => response.code,
-                          :response_headers => response.headers,
-                          :response_body => response.body),
-             response.status_message
+        if response.timed_out?
+          fail ApiError.new('Connection timed out')
+        elsif response.code == 0
+          # Errors from libcurl will be made visible here
+          fail ApiError.new(:code => 0,
+                            :message => response.return_message)
+        else
+          fail ApiError.new(:code => response.code,
+                            :response_headers => response.headers,
+                            :response_body => response.body),
+               response.status_message
+        end
       end
 
       if opts[:return_type]
-        deserialize(response, opts[:return_type])
+        data = deserialize(response, opts[:return_type])
       else
-        nil
+        data = nil
       end
+      return data, response.code, response.headers
     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(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] || {}
 
+      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,
-        :ssl_verifypeer => Configuration.verify_ssl,
-        :sslcert => Configuration.cert_file,
-        :sslkey => Configuration.key_file,
-        :cainfo => Configuration.ssl_ca_cert,
-        :verbose => Configuration.debugging
+        :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
       }
 
+      # 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 Configuration.debugging
-          Configuration.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
+        if @config.debugging
+          @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
         end
       end
-      
-      url = sign(url, opts[:query_params])
-      Typhoeus::Request.new(url, req_opts)
 
+      if @config.auth_type == Configuration::AUTH_TYPE_REQUEST_SIGNATURE
+        url = sign(url, opts[:query_params])
+      elsif @config.auth_type == Configuration::AUTH_TYPE_O_AUTH_2
+        # OAuth 2.0 
+        req_opts[:params] = opts[:query_params]
+        if @config.access_token.nil?
+          request_token
+        end
+        add_o_auth_token(req_opts)
+      end
+
+      request = Typhoeus::Request.new(url, req_opts)
+      download_file(request) if opts[:return_type] == 'File'
+      request
     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? '/'
@@ -106,10 +170,9 @@ module AsposePDFCloud
         }
         url = url[0..-2]
       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
@@ -139,23 +202,39 @@ module AsposePDFCloud
       url_to_sign + "&signature=#{signature}"
 
     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 @tempfile if return_type == 'File'
+
       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'
 
       # 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]
@@ -171,6 +250,9 @@ module AsposePDFCloud
     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
@@ -189,7 +271,7 @@ module AsposePDFCloud
         # 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>
@@ -203,7 +285,7 @@ module AsposePDFCloud
         end
       else
         # models, e.g. Pet
-        AsposePDFCloud.const_get(return_type).new.tap do |model|
+        AsposePdfCloud.const_get(return_type).new.tap do |model|
           model.build_from_hash data
         end
       end
@@ -211,46 +293,73 @@ module AsposePDFCloud
 
     # 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
-    # @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
-      else
-        path = tmp_file.path
+    def download_file(request)
+      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
-      # close and delete temp file
-      tmp_file.close!
+      request.on_body do |chunk|
+        chunk.force_encoding(encoding)
+        tempfile.write(chunk)
+      end
+      request.on_complete do |response|
+        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 "\
+                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                            "explicitly with `tempfile.delete`"
+      end
+    end
 
-      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)
+    # Sanitize filename by removing path.
+    # e.g. ../../sun.gif becomes sun.gif
+    #
+    # @param [String] filename the filename to be sanitized
+    # @return [String] the sanitized filename
+    def sanitize_filename(filename)
+      filename.gsub(/.*[\/\\]/, '')
     end
 
     def build_request_url(path)
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(host + path)
+      URI.encode(@config.base_url + path)
     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(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
+        data = {}
+        form_params.each do |key, value|
+          case value
+          when File, Array, nil
+            # let typhoeus handle File, Array and nil parameters
+            data[key] = value
           else
-            data[key] = value.to_s if value && !value.is_a?(File)
+            data[key] = value.to_s
           end
         end
       elsif body
@@ -262,9 +371,13 @@ module AsposePDFCloud
     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]
@@ -274,6 +387,9 @@ module AsposePDFCloud
       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
@@ -283,40 +399,35 @@ module AsposePDFCloud
     # @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) }
+      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)
-      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) }
+      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 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.
@@ -329,7 +440,84 @@ module AsposePDFCloud
         obj
       end
     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
+
+    # Request access and refresh tokens
+    def request_token
+      # resource path
+      local_var_path = "/oauth2/token"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = select_header_content_type(['application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+      form_params["grant_type"] = 'client_credentials'
+      form_params["client_id"] = AsposeApp.app_sid
+      form_params["client_secret"] = AsposeApp.app_key
+
+
+      url = build_request_url(local_var_path).gsub(@config.base_path, '')
+      http_method = :POST.to_sym.downcase
+
+
+      # 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,
+          :body => form_params
+      }
+
+      # set custom cert, if provided
+      req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
+
+      request = Typhoeus::Request.new(url, req_opts)
+      response = request.run
+
+      data = JSON.parse("[#{response.body}]", :symbolize_names => true)[0]
+
+      @config.access_token = data[:access_token]
+      @config.refresh_token = data[:refresh_token]
+    end
+
+    # Adds OAuth2.0 token
+    def add_o_auth_token(req_opts)
+      req_opts[:headers][:Authorization] = "Bearer " + @config.access_token
+    end
+
   end
 end