pokeapi_client 0.10.0 → 1.0.0

data/lib/pokeapi_client/api/move_ailment_api.rb

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

data/lib/pokeapi_client/api/move_api.rb

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

data/lib/pokeapi_client/api/move_battle_style_api.rb

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

data/lib/pokeapi_client/api/move_category_api.rb

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

data/lib/pokeapi_client/api/move_damage_class_api.rb

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

data/lib/pokeapi_client/api/move_learn_method_api.rb

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

data/lib/pokeapi_client/api/move_target_api.rb

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

data/lib/pokeapi_client/api/nature_api.rb

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

data/lib/pokeapi_client/api/pal_park_area_api.rb

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

data/lib/pokeapi_client/api/pokeathlon_stat_api.rb

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

data/lib/pokeapi_client/api/pokedex_api.rb

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

data/lib/pokeapi_client/api/pokemon_api.rb

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

data/lib/pokeapi_client/api/pokemon_color_api.rb

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

data/lib/pokeapi_client/api/pokemon_form_api.rb

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

data/lib/pokeapi_client/api/pokemon_habitat_api.rb

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

data/lib/pokeapi_client/api/pokemon_shape_api.rb

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

data/lib/pokeapi_client/api/pokemon_species_api.rb

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

data/lib/pokeapi_client/api/region_api.rb

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

data/lib/pokeapi_client/api/stat_api.rb

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

data/lib/pokeapi_client/api/super_contest_effect_api.rb

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

data/lib/pokeapi_client/api/type_api.rb

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

data/lib/pokeapi_client/api/version_api.rb

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

data/lib/pokeapi_client/api/version_group_api.rb

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

data/lib/pokeapi_client/api_client.rb

@@ -4,9 +4,9 @@
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-Contact: blah@cliffano.com
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0-SNAPSHOT
+Generator version: 7.4.0
 
 =end
 
@@ -17,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.
@@ -45,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
@@ -69,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
@@ -124,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
@@ -164,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
@@ -178,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.
@@ -213,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

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

data/lib/pokeapi_client/configuration.rb

@@ -4,9 +4,9 @@
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-Contact: blah@cliffano.com
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0-SNAPSHOT
+Generator version: 7.4.0
 
 =end
 
@@ -62,6 +62,16 @@ module PokeApiClient
     # Defines the access token (Bearer) used with OAuth2.
     attr_accessor :access_token
 
+    # Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2.
+    # Overrides the access_token if set
+    # @return [Proc]
+    attr_accessor :access_token_getter
+
+    # Set this to return data as binary instead of downloading a temp file. When enabled (set to true)
+    # HTTP responses with return type `File` will be returned as a stream of binary data.
+    # Default to false.
+    attr_accessor :return_binary_data
+
     # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
     # details will be logged with `logger.debug` (see the `logger` attribute).
     # Default to false.
@@ -142,7 +152,7 @@ module PokeApiClient
       @scheme = 'https'
       @host = 'pokeapi.co'
       @base_path = ''
-      @server_index = 0
+      @server_index = nil
       @server_operation_index = {}
       @server_variables = {}
       @server_operation_variables = {}
@@ -190,10 +200,12 @@ module PokeApiClient
 
     # Returns base URL for specified operation based on server settings
     def base_url(operation = nil)
-      index = server_operation_index.fetch(operation, server_index)
-      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
-
-      server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      if operation_server_settings.key?(operation) then
+        index = server_operation_index.fetch(operation, server_index)
+        server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      else
+        server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
+      end
     end
 
     # Gets API key (with prefix if set).
@@ -208,6 +220,12 @@ module PokeApiClient
       end
     end
 
+    # Gets access_token using access_token_getter or uses the static access_token
+    def access_token_with_refresh
+      return access_token if access_token_getter.nil?
+      access_token_getter.call
+    end
+
     # Gets Basic Auth token string
     def basic_auth_token
       'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
@@ -242,8 +260,8 @@ module PokeApiClient
       servers = server_settings if servers == nil
 
       # check array index out of bound
-      if (index < 0 || index >= servers.size)
-        fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+      if (index.nil? || index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
       end
 
       server = servers[index]
@@ -268,5 +286,6 @@ module PokeApiClient
       url
     end
 
+
   end
 end

data/lib/pokeapi_client/version.rb

@@ -4,12 +4,12 @@
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-Contact: blah@cliffano.com
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0-SNAPSHOT
+Generator version: 7.4.0
 
 =end
 
 module PokeApiClient
-  VERSION = '0.10.0'
+  VERSION = '1.0.0'
 end

data/lib/pokeapi_client.rb

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

data/pokeapi_client.gemspec

@@ -6,9 +6,9 @@
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-Contact: blah@cliffano.com
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0-SNAPSHOT
+Generator version: 7.4.0
 
 =end
 
@@ -19,13 +19,14 @@ Gem::Specification.new do |s|
   s.name        = "pokeapi_client"
   s.version     = PokeApiClient::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Cliffano Subagio"]
-  s.email       = ["blah@cliffano.com"]
-  s.homepage    = "https://github.com/cliffano/pokeapi-clients"
+  s.authors     = ["OpenAPI Clients Factory"]
+  s.email       = ["blah+oapicf@cliffano.com"]
+  s.homepage    = "https://github.com/oapicf/pokeapi-clients"
   s.summary     = " Ruby Gem"
   s.description = "No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)"
   s.license     = "MIT"
   s.required_ruby_version = ">= 2.0"
+  s.metadata    = {}
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
 

data/spec/api/ability_api_spec.rb

@@ -4,9 +4,9 @@
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-Contact: blah@cliffano.com
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0-SNAPSHOT
+Generator version: 7.4.0
 
 =end
 
@@ -39,7 +39,7 @@ describe 'AbilityApi' do
   # @return [String]
   describe 'ability_list test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -49,7 +49,7 @@ describe 'AbilityApi' do
   # @return [String]
   describe 'ability_read test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 

data/spec/api/berry_api_spec.rb

@@ -4,9 +4,9 @@
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 20220523
-Contact: blah@cliffano.com
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0-SNAPSHOT
+Generator version: 7.4.0
 
 =end
 
@@ -39,7 +39,7 @@ describe 'BerryApi' do
   # @return [String]
   describe 'berry_list test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -49,7 +49,7 @@ describe 'BerryApi' do
   # @return [String]
   describe 'berry_read test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end