docraptor 1.1.0 → 2.0.0

data/lib/docraptor/api_client.rb

@@ -1,9 +1,21 @@
+=begin
+#DocRaptor
+
+#A native client library for the DocRaptor HTML to PDF/XLS service.
+
+OpenAPI spec version: 1.4.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
 require 'date'
 require 'json'
 require 'logger'
 require 'tempfile'
 require 'typhoeus'
-require 'uri'
+require 'addressable/uri'
 
 module DocRaptor
   class ApiClient
@@ -15,11 +27,13 @@ module DocRaptor
     # @return [Hash]
     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 = "ruby-swagger-#{VERSION}"
       @default_headers = {
-        'Content-Type' => "application/json",
+        'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
       }
     end
@@ -41,10 +55,18 @@ module DocRaptor
       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.to_h,
+                            :response_body => response.body),
+               response.status_message
+        end
       end
 
       if opts[:return_type]
@@ -55,6 +77,15 @@ module DocRaptor
       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
@@ -63,21 +94,27 @@ module DocRaptor
       query_params = opts[: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,
+        :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
       }
 
+      req_opts.merge!(multipart: true) if header_params['Content-Type'].start_with? "multipart/"
+
+      # 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)
@@ -88,7 +125,9 @@ module DocRaptor
         end
       end
 
-      Typhoeus::Request.new(url, req_opts)
+      request = Typhoeus::Request.new(url, req_opts)
+      download_file(request) if opts[:return_type] == 'File'
+      request
     end
 
     # Check if the given MIME is a JSON MIME.
@@ -96,23 +135,29 @@ module DocRaptor
     #   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 =~ /\Aapplication\/json(;.*)?\z/i)
+      (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?
 
       # return response body directly for String return type
       return body if return_type == 'String'
 
-      # handle file downloading - save response body into a tmp file and return the File instance
-      return download_file(response) if return_type == 'File'
-
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
 
@@ -132,6 +177,9 @@ module DocRaptor
     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
@@ -155,12 +203,12 @@ module DocRaptor
       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
@@ -172,30 +220,38 @@ module DocRaptor
 
     # 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 [Tempfile] the file downloaded
-    def download_file(response)
-      content_disposition = response.headers['Content-Disposition']
-      if content_disposition
-        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-        prefix = sanitize_filename(filename)
-      else
-        prefix = 'download-'
-      end
-      prefix = prefix + '-' unless prefix.end_with?('-')
-
+    def download_file(request)
       tempfile = nil
-      encoding = response.body.encoding
-      Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) do |file|
-        file.write(response.body)
-        tempfile = file
+      encoding = nil
+      request.on_headers do |response|
+        content_disposition = response.headers['Content-Disposition']
+        if content_disposition && 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)
+      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
-      @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.
@@ -204,15 +260,21 @@ module DocRaptor
     # @param [String] filename the filename to be sanitized
     # @return [String] the sanitized filename
     def sanitize_filename(filename)
-      filename.gsub /.*[\/\\]/, ''
+      filename.gsub(/.*[\/\\]/, '')
     end
 
     def build_request_url(path)
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(@config.base_url + path)
+      Addressable::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' ||
@@ -220,7 +282,7 @@ module DocRaptor
         data = {}
         form_params.each do |key, value|
           case value
-          when File, Array, nil
+          when ::File, ::Array, nil
             # let typhoeus handle File, Array and nil parameters
             data[key] = value
           else
@@ -236,6 +298,10 @@ module DocRaptor
     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 = @config.auth_settings[auth_name]
@@ -248,6 +314,9 @@ module DocRaptor
       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
@@ -260,7 +329,7 @@ module DocRaptor
       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(',')
+      json_accept || accepts.join(',')
     end
 
     # Return Content-Type header based on an array of content types provided.
@@ -271,7 +340,7 @@ module DocRaptor
       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
+      json_content_type || content_types.first
     end
 
     # Convert object (array, hash, object, etc) to JSON string.
@@ -279,13 +348,13 @@ module DocRaptor
     # @return [String] JSON string representation of the object
     def object_to_http_body(model)
       return model if model.nil? || model.is_a?(String)
-      _body = nil
+      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.

data/lib/docraptor/api_error.rb

@@ -1,3 +1,15 @@
+=begin
+#DocRaptor
+
+#A native client library for the DocRaptor HTML to PDF/XLS service.
+
+OpenAPI spec version: 1.4.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
 module DocRaptor
   class ApiError < StandardError
     attr_reader :code, :response_headers, :response_body
@@ -9,12 +21,14 @@ module DocRaptor
     #   ApiError.new(:code => 404, :message => "Not Found")
     def initialize(arg = nil)
       if arg.is_a? Hash
+        if arg.key?(:message) || arg.key?('message')
+          super(arg[:message] || arg['message'])
+        else
+          super arg
+        end
+
         arg.each do |k, v|
-          if k.to_s == 'message'
-            super v
-          else
-            instance_variable_set "@#{k}", v
-          end
+          instance_variable_set "@#{k}", v
         end
       else
         super arg

data/lib/docraptor/configuration.rb

@@ -1,4 +1,16 @@
-require 'uri'
+=begin
+#DocRaptor
+
+#A native client library for the DocRaptor HTML to PDF/XLS service.
+
+OpenAPI spec version: 1.4.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
+require 'addressable/uri'
 
 module DocRaptor
   class Configuration
@@ -64,7 +76,12 @@ module DocRaptor
     # Default to 0 (never times out).
     attr_accessor :timeout
 
-    ### TLS/SSL
+    # Set this to false to skip client side validation in the operation.
+    # Default to true.
+    # @return [true, false]
+    attr_accessor :client_side_validation
+
+    ### TLS/SSL setting
     # Set this to false to skip verifying SSL certificate when calling API from https server.
     # Default to true.
     #
@@ -73,6 +90,16 @@ module DocRaptor
     # @return [true, false]
     attr_accessor :verify_ssl
 
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL host name
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl_host
+
+    ### TLS/SSL setting
     # Set this to customize the certificate file to verify the peer.
     #
     # @return [String] the path to the certificate file
@@ -81,12 +108,21 @@ module DocRaptor
     # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
     attr_accessor :ssl_ca_cert
 
+    ### TLS/SSL setting
     # Client certificate file (for client certificate)
     attr_accessor :cert_file
 
+    ### TLS/SSL setting
     # Client private key file (for client certificate)
     attr_accessor :key_file
 
+    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+    # Default to nil.
+    #
+    # @see The params_encoding option of Ethon. Related source code:
+    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+    attr_accessor :params_encoding
+
     attr_accessor :inject_format
 
     attr_accessor :force_ending_format
@@ -98,7 +134,10 @@ module DocRaptor
       @api_key = {}
       @api_key_prefix = {}
       @timeout = 0
+      @client_side_validation = true
       @verify_ssl = true
+      @verify_ssl_host = true
+      @params_encoding = nil
       @cert_file = nil
       @key_file = nil
       @debugging = false
@@ -131,12 +170,12 @@ module DocRaptor
     def base_path=(base_path)
       # Add leading and trailing slashes to base_path
       @base_path = "/#{base_path}".gsub(/\/+/, '/')
-      @base_path = "" if @base_path == "/"
+      @base_path = '' if @base_path == '/'
     end
 
     def base_url
       url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
-      URI.encode(url)
+      Addressable::URI.encode(url)
     end
 
     # Gets API key (with prefix if set).

data/lib/docraptor/models/async_doc.rb

@@ -1,16 +1,26 @@
+=begin
+#DocRaptor
+
+#A native client library for the DocRaptor HTML to PDF/XLS service.
+
+OpenAPI spec version: 1.4.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
 require 'date'
 
 module DocRaptor
   class AsyncDoc
-    # The identifier used to get the status of the document using the status api.
+    # The identifier used to get the status of the document using the status API.
     attr_accessor :status_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-
         :'status_id' => :'status_id'
-
       }
     end
 
@@ -18,24 +28,37 @@ module DocRaptor
     def self.swagger_types
       {
         :'status_id' => :'String'
-
       }
     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.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
-
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes[:'status_id']
+      if attributes.has_key?(:'status_id')
         self.status_id = attributes[:'status_id']
       end
+    end
 
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
     end
 
-    # Check equality by comparing each attribute.
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -43,35 +66,41 @@ module DocRaptor
     end
 
     # @see the `==` method
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
 
-    # Calculate hash code according to all attributes.
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
     def hash
       [status_id].hash
     end
 
-    # build the object from hash
+    # 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 =~ /^Array<(.*)>/i
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that 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) } )
-          else
-            #TODO show warning in debug mode
+            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]]))
-        else
-          # data not found in attributes(hash), not an issue as the data can be optional
-        end
+        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
@@ -85,7 +114,7 @@ module DocRaptor
       when :Float
         value.to_f
       when :BOOLEAN
-        if value.to_s =~ /^(true|t|yes|y|1)$/i
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
           false
@@ -96,7 +125,7 @@ module DocRaptor
       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/
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
         k_type = Regexp.last_match[:k_type]
         v_type = Regexp.last_match[:v_type]
         {}.tap do |hash|
@@ -105,21 +134,25 @@ module DocRaptor
           end
         end
       else # model
-        _model = DocRaptor.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = DocRaptor.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_body (backward compatibility))
+    # 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
 
-    # return the object in the form of hash
+    # 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|
@@ -130,11 +163,13 @@ module DocRaptor
       hash
     end
 
-    # Method to output non-array value in the form of hash
+    # 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) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }