esi_client 1.2.0 → 1.3.0

data/lib/esi_client/api/wars_api.rb

@@ -3,9 +3,10 @@
 
 #An OpenAPI for EVE Online
 
-OpenAPI spec version: 0.5.0
+OpenAPI spec version: 0.6.2
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
 
 =end
 
@@ -44,11 +45,11 @@ module ESIClient
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: WarsApi.get_wars ..."
       end
-      if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
+      if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
         fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
       end
       # resource path
-      local_var_path = "/v1/wars/".sub('{format}','json')
+      local_var_path = "/v1/wars/"
 
       # query parameters
       query_params = {}
@@ -107,12 +108,14 @@ module ESIClient
         @api_client.config.logger.debug "Calling API: WarsApi.get_wars_war_id ..."
       end
       # verify the required parameter 'war_id' is set
-      fail ArgumentError, "Missing the required parameter 'war_id' when calling WarsApi.get_wars_war_id" if war_id.nil?
-      if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
+      if @api_client.config.client_side_validation && war_id.nil?
+        fail ArgumentError, "Missing the required parameter 'war_id' when calling WarsApi.get_wars_war_id"
+      end
+      if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
         fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
       end
       # resource path
-      local_var_path = "/v1/wars/{war_id}/".sub('{format}','json').sub('{' + 'war_id' + '}', war_id.to_s)
+      local_var_path = "/v1/wars/{war_id}/".sub('{' + 'war_id' + '}', war_id.to_s)
 
       # query parameters
       query_params = {}
@@ -149,7 +152,7 @@ module ESIClient
     # @param war_id A valid war ID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :datasource The server name you would like data from (default to tranquility)
-    # @option opts [Integer] :page Which page to query, starting at 1 (default to 1)
+    # @option opts [Integer] :page Which page of results to return (default to 1)
     # @option opts [String] :user_agent Client identifier, takes precedence over headers
     # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
     # @return [Array<GetWarsWarIdKillmails200Ok>]
@@ -163,7 +166,7 @@ module ESIClient
     # @param war_id A valid war ID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :datasource The server name you would like data from
-    # @option opts [Integer] :page Which page to query, starting at 1
+    # @option opts [Integer] :page Which page of results to return
     # @option opts [String] :user_agent Client identifier, takes precedence over headers
     # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
     # @return [Array<(Array<GetWarsWarIdKillmails200Ok>, Fixnum, Hash)>] Array<GetWarsWarIdKillmails200Ok> data, response status code and response headers
@@ -172,12 +175,14 @@ module ESIClient
         @api_client.config.logger.debug "Calling API: WarsApi.get_wars_war_id_killmails ..."
       end
       # verify the required parameter 'war_id' is set
-      fail ArgumentError, "Missing the required parameter 'war_id' when calling WarsApi.get_wars_war_id_killmails" if war_id.nil?
-      if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
+      if @api_client.config.client_side_validation && war_id.nil?
+        fail ArgumentError, "Missing the required parameter 'war_id' when calling WarsApi.get_wars_war_id_killmails"
+      end
+      if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
         fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
       end
       # resource path
-      local_var_path = "/v1/wars/{war_id}/killmails/".sub('{format}','json').sub('{' + 'war_id' + '}', war_id.to_s)
+      local_var_path = "/v1/wars/{war_id}/killmails/".sub('{' + 'war_id' + '}', war_id.to_s)
 
       # query parameters
       query_params = {}

data/lib/esi_client/api_client.rb

@@ -3,9 +3,10 @@
 
 #An OpenAPI for EVE Online
 
-OpenAPI spec version: 0.5.0
+OpenAPI spec version: 0.6.2
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
 
 =end
 
@@ -122,7 +123,9 @@ module ESIClient
         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.
@@ -134,7 +137,7 @@ module ESIClient
     # @param [String] mime MIME
     # @return [Boolean] True if the MIME is application/json
     def json_mime?(mime)
-       (mime == "*/*") || !(mime =~ /\Aapplication\/json(;.*)?\z/i).nil?
+       (mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
     end
 
     # Deserialize the response to the given return type.
@@ -143,14 +146,16 @@ module ESIClient
     # @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'
 
@@ -213,30 +218,38 @@ module ESIClient
 
     # 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 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?('-')
-
+    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 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)
+      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.
@@ -267,7 +280,7 @@ module ESIClient
         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

data/lib/esi_client/api_error.rb

@@ -3,9 +3,10 @@
 
 #An OpenAPI for EVE Online
 
-OpenAPI spec version: 0.5.0
+OpenAPI spec version: 0.6.2
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
 
 =end
 

data/lib/esi_client/configuration.rb

@@ -3,9 +3,10 @@
 
 #An OpenAPI for EVE Online
 
-OpenAPI spec version: 0.5.0
+OpenAPI spec version: 0.6.2
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
 
 =end
 
@@ -75,6 +76,11 @@ module ESIClient
     # Default to 0 (never times out).
     attr_accessor :timeout
 
+    # 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.
@@ -124,10 +130,11 @@ module ESIClient
     def initialize
       @scheme = 'https'
       @host = 'esi.tech.ccp.is'
-      @base_path = '/'
+      @base_path = ''
       @api_key = {}
       @api_key_prefix = {}
       @timeout = 0
+      @client_side_validation = true
       @verify_ssl = true
       @verify_ssl_host = true
       @params_encoding = nil

data/lib/esi_client/models/delete_characters_character_id_mail_labels_label_id_unprocessable_entity.rb

@@ -3,9 +3,10 @@
 
 #An OpenAPI for EVE Online
 
-OpenAPI spec version: 0.5.0
+OpenAPI spec version: 0.6.2
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
 
 =end
 

data/lib/esi_client/models/delete_fleets_fleet_id_members_member_id_not_found.rb

@@ -3,9 +3,10 @@
 
 #An OpenAPI for EVE Online
 
-OpenAPI spec version: 0.5.0
+OpenAPI spec version: 0.6.2
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
 
 =end
 

data/lib/esi_client/models/delete_fleets_fleet_id_squads_squad_id_not_found.rb

@@ -3,9 +3,10 @@
 
 #An OpenAPI for EVE Online
 
-OpenAPI spec version: 0.5.0
+OpenAPI spec version: 0.6.2
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
 
 =end
 

data/lib/esi_client/models/delete_fleets_fleet_id_wings_wing_id_not_found.rb

@@ -3,9 +3,10 @@
 
 #An OpenAPI for EVE Online
 
-OpenAPI spec version: 0.5.0
+OpenAPI spec version: 0.6.2
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
 
 =end
 

data/lib/esi_client/models/forbidden.rb

@@ -0,0 +1,204 @@
+=begin
+#EVE Swagger Interface
+
+#An OpenAPI for EVE Online
+
+OpenAPI spec version: 0.6.2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module ESIClient
+  # Forbidden model
+  class Forbidden
+    # Forbidden message
+    attr_accessor :error
+
+    # Status code received from SSO
+    attr_accessor :sso_status
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'sso_status' => :'sso_status'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error' => :'String',
+        :'sso_status' => :'Integer'
+      }
+    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.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'sso_status')
+        self.sso_status = attributes[:'sso_status']
+      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 = Array.new
+      if @error.nil?
+        invalid_properties.push("invalid value for 'error', error cannot be nil.")
+      end
+
+      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?
+      return false if @error.nil?
+      return 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 &&
+          error == o.error &&
+          sso_status == o.sso_status
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [error, sso_status].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
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      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 = ESIClient.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