pokeapi_client 0.9.1 → 1.0.0

data/lib/pokeapi_client/api/location_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/location_area_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/machine_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/move_ailment_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/move_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/move_battle_style_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/move_category_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/move_damage_class_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/move_learn_method_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/move_target_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/nature_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/pal_park_area_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/pokeathlon_stat_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/pokedex_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/pokemon_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/pokemon_color_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/pokemon_form_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/pokemon_habitat_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/pokemon_shape_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/pokemon_species_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/region_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/stat_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/super_contest_effect_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/type_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/version_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api/version_group_api.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 

data/lib/pokeapi_client/api_client.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 
@@ -15,6 +17,7 @@ require 'tempfile'
 require 'time'
 require 'typhoeus'
 
+
 module PokeApiClient
   class ApiClient
     # The Configuration object holding settings to be used in the API client.
@@ -43,9 +46,10 @@ module PokeApiClient
     # Call an API with given options.
     #
     # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
-    #   the data deserialized from response body (could be nil), response status code and response headers.
+    #   the data deserialized from response body (may be a Tempfile or nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
       request = build_request(http_method, path, opts)
+      tempfile = download_file(request) if opts[:return_type] == 'File'
       response = request.run
 
       if @config.debugging
@@ -67,7 +71,9 @@ module PokeApiClient
         end
       end
 
-      if opts[:return_type]
+      if opts[:return_type] == 'File'
+        data = tempfile
+      elsif opts[:return_type]
         data = deserialize(response, opts[:return_type])
       else
         data = nil
@@ -91,6 +97,7 @@ module PokeApiClient
       header_params = @default_headers.merge(opts[:header_params] || {})
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
+      follow_location = opts[:follow_location] || true
 
 
       # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
@@ -106,7 +113,8 @@ module PokeApiClient
         :ssl_verifyhost => _verify_ssl_host,
         :sslcert => @config.cert_file,
         :sslkey => @config.key_file,
-        :verbose => @config.debugging
+        :verbose => @config.debugging,
+        :followlocation => follow_location
       }
 
       # set custom cert, if provided
@@ -120,9 +128,7 @@ module PokeApiClient
         end
       end
 
-      request = Typhoeus::Request.new(url, req_opts)
-      download_file(request) if opts[:return_type] == 'File'
-      request
+      Typhoeus::Request.new(url, req_opts)
     end
 
     # Builds the HTTP request body
@@ -160,6 +166,8 @@ module PokeApiClient
     # process can use.
     #
     # @see Configuration#temp_folder_path
+    #
+    # @return [Tempfile] the tempfile generated
     def download_file(request)
       tempfile = nil
       encoding = nil
@@ -174,21 +182,24 @@ module PokeApiClient
         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|
-        if tempfile
-          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
+      # run the request to ensure the tempfile is created successfully before returning it
+      request.run
+      if tempfile
+        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`"
+      else
+        fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}") 
       end
+
+      tempfile
     end
 
     # Check if the given MIME is a JSON MIME.
@@ -209,15 +220,10 @@ module PokeApiClient
     # @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'
+      return body.to_s if return_type == 'String'
 
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'

data/lib/pokeapi_client/api_error.rb

@@ -1,10 +1,12 @@
 =begin
+#
+
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 
@@ -30,6 +32,7 @@ module PokeApiClient
         end
       else
         super arg
+        @message = arg
       end
     end