pokeapi_client 0.9.0

data/spec/api_client_spec.rb

@@ -0,0 +1,224 @@
+=begin
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'spec_helper'
+
+describe PokeApiClient::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          PokeApiClient.configure { |c| c.host = 'http://example.com' }
+          expect(PokeApiClient::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          PokeApiClient.configure { |c| c.host = 'https://wookiee.com' }
+          expect(PokeApiClient::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          PokeApiClient.configure { |c| c.host = 'hobo.com/v4' }
+          expect(PokeApiClient::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          PokeApiClient.configure { |c| c.base_path = 'v4/dog' }
+          expect(PokeApiClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          PokeApiClient.configure { |c| c.base_path = '/v4/dog' }
+          expect(PokeApiClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          PokeApiClient.configure { |c| c.base_path = nil }
+          expect(PokeApiClient::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { PokeApiClient::Configuration.new }
+    let(:api_client) { PokeApiClient::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(PokeApiClient::Configuration.default.params_encoding).to eq(nil)
+      expect(config.params_encoding).to eq(nil)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+
+    it 'can be customized' do
+      config.params_encoding = :multi
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+  end
+
+  describe 'timeout in #build_request' do
+    let(:config) { PokeApiClient::Configuration.new }
+    let(:api_client) { PokeApiClient::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(PokeApiClient::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it 'can be customized' do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = PokeApiClient::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it 'handles Array<Array<Integer>>' do
+      api_client = PokeApiClient::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it 'handles Hash<String, String>' do
+      api_client = PokeApiClient::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq(:message => 'Hello')
+    end
+  end
+
+  describe "#object_to_hash" do
+    it 'ignores nils and includes empty arrays' do
+      # uncomment below to test object_to_hash for model
+      # api_client = PokeApiClient::ApiClient.new
+      # _model = PokeApiClient::ModelName.new
+      # update the model attribute below
+      # _model.id = 1
+      # update the expected value (hash) below
+      # expected = {id: 1, name: '', tags: []}
+      # expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe '#build_collection_param' do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { PokeApiClient::ApiClient.new }
+
+    it 'works for csv' do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it 'works for ssv' do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it 'works for tsv' do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it 'works for pipes' do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it 'works for multi' do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it 'fails for invalid collection format' do
+      expect { api_client.build_collection_param(param, :INVALID) }.to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { PokeApiClient::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe '#select_header_accept' do
+    let(:api_client) { PokeApiClient::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe '#select_header_content_type' do
+    let(:api_client) { PokeApiClient::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_content_type(nil)).to be_nil
+      expect(api_client.select_header_content_type([])).to be_nil
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe '#sanitize_filename' do
+    let(:api_client) { PokeApiClient::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,40 @@
+=begin
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'spec_helper'
+
+describe PokeApiClient::Configuration do
+  let(:config) { PokeApiClient::Configuration.default }
+
+  before(:each) do
+    # uncomment below to setup host and base_path
+    # require 'URI'
+    # uri = URI.parse("https://pokeapi.co")
+    # PokeApiClient.configure do |c|
+    #   c.host = uri.host
+    #   c.base_path = uri.path
+    # end
+  end
+
+  describe '#base_url' do
+    it 'should have the default value' do
+      # uncomment below to test default value of the base path
+      # expect(config.base_url).to eq("https://pokeapi.co")
+    end
+
+    it 'should remove trailing slashes' do
+      [nil, '', '/', '//'].each do |base_path|
+        config.base_path = base_path
+        # uncomment below to test trailing slashes
+        # expect(config.base_url).to eq("https://pokeapi.co")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,109 @@
+=begin
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+# load the gem
+require 'pokeapi_client'
+
+# The following  was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,250 @@
+--- !ruby/object:Gem::Specification
+name: pokeapi_client
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Cliffano Subagio
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+description: No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+email:
+- blah@cliffano.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/bundle
+- bin/byebug
+- bin/coderay
+- bin/htmldiff
+- bin/ldiff
+- bin/pry
+- bin/rake
+- bin/rspec
+- bin/rubocop
+- bin/ruby-parse
+- bin/ruby-rewrite
+- docs/AbilityApi.md
+- docs/BerryApi.md
+- docs/BerryFirmnessApi.md
+- docs/BerryFlavorApi.md
+- docs/CharacteristicApi.md
+- docs/ContestEffectApi.md
+- docs/ContestTypeApi.md
+- docs/EggGroupApi.md
+- docs/EncounterConditionApi.md
+- docs/EncounterConditionValueApi.md
+- docs/EncounterMethodApi.md
+- docs/EvolutionChainApi.md
+- docs/EvolutionTriggerApi.md
+- docs/GenderApi.md
+- docs/GenerationApi.md
+- docs/GrowthRateApi.md
+- docs/ItemApi.md
+- docs/ItemAttributeApi.md
+- docs/ItemCategoryApi.md
+- docs/ItemFlingEffectApi.md
+- docs/ItemPocketApi.md
+- docs/LanguageApi.md
+- docs/LocationApi.md
+- docs/LocationAreaApi.md
+- docs/MachineApi.md
+- docs/MoveAilmentApi.md
+- docs/MoveApi.md
+- docs/MoveBattleStyleApi.md
+- docs/MoveCategoryApi.md
+- docs/MoveDamageClassApi.md
+- docs/MoveLearnMethodApi.md
+- docs/MoveTargetApi.md
+- docs/NatureApi.md
+- docs/PalParkAreaApi.md
+- docs/PokeathlonStatApi.md
+- docs/PokedexApi.md
+- docs/PokemonApi.md
+- docs/PokemonColorApi.md
+- docs/PokemonFormApi.md
+- docs/PokemonHabitatApi.md
+- docs/PokemonShapeApi.md
+- docs/PokemonSpeciesApi.md
+- docs/RegionApi.md
+- docs/StatApi.md
+- docs/SuperContestEffectApi.md
+- docs/TypeApi.md
+- docs/VersionApi.md
+- docs/VersionGroupApi.md
+- git_push.sh
+- pokeapi_client.gemspec
+- spec/api/ability_api_spec.rb
+- spec/api/berry_api_spec.rb
+- spec/api/berry_firmness_api_spec.rb
+- spec/api/berry_flavor_api_spec.rb
+- spec/api/characteristic_api_spec.rb
+- spec/api/contest_effect_api_spec.rb
+- spec/api/contest_type_api_spec.rb
+- spec/api/egg_group_api_spec.rb
+- spec/api/encounter_condition_api_spec.rb
+- spec/api/encounter_condition_value_api_spec.rb
+- spec/api/encounter_method_api_spec.rb
+- spec/api/evolution_chain_api_spec.rb
+- spec/api/evolution_trigger_api_spec.rb
+- spec/api/gender_api_spec.rb
+- spec/api/generation_api_spec.rb
+- spec/api/growth_rate_api_spec.rb
+- spec/api/item_api_spec.rb
+- spec/api/item_attribute_api_spec.rb
+- spec/api/item_category_api_spec.rb
+- spec/api/item_fling_effect_api_spec.rb
+- spec/api/item_pocket_api_spec.rb
+- spec/api/language_api_spec.rb
+- spec/api/location_api_spec.rb
+- spec/api/location_area_api_spec.rb
+- spec/api/machine_api_spec.rb
+- spec/api/move_ailment_api_spec.rb
+- spec/api/move_api_spec.rb
+- spec/api/move_battle_style_api_spec.rb
+- spec/api/move_category_api_spec.rb
+- spec/api/move_damage_class_api_spec.rb
+- spec/api/move_learn_method_api_spec.rb
+- spec/api/move_target_api_spec.rb
+- spec/api/nature_api_spec.rb
+- spec/api/pal_park_area_api_spec.rb
+- spec/api/pokeathlon_stat_api_spec.rb
+- spec/api/pokedex_api_spec.rb
+- spec/api/pokemon_api_spec.rb
+- spec/api/pokemon_color_api_spec.rb
+- spec/api/pokemon_form_api_spec.rb
+- spec/api/pokemon_habitat_api_spec.rb
+- spec/api/pokemon_shape_api_spec.rb
+- spec/api/pokemon_species_api_spec.rb
+- spec/api/region_api_spec.rb
+- spec/api/stat_api_spec.rb
+- spec/api/super_contest_effect_api_spec.rb
+- spec/api/type_api_spec.rb
+- spec/api/version_api_spec.rb
+- spec/api/version_group_api_spec.rb
+- spec/api_client_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cliffano/pokeapi-clients
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Ruby Gem
+test_files:
+- spec/api/ability_api_spec.rb
+- spec/api/berry_api_spec.rb
+- spec/api/berry_firmness_api_spec.rb
+- spec/api/berry_flavor_api_spec.rb
+- spec/api/characteristic_api_spec.rb
+- spec/api/contest_effect_api_spec.rb
+- spec/api/contest_type_api_spec.rb
+- spec/api/egg_group_api_spec.rb
+- spec/api/encounter_condition_api_spec.rb
+- spec/api/encounter_condition_value_api_spec.rb
+- spec/api/encounter_method_api_spec.rb
+- spec/api/evolution_chain_api_spec.rb
+- spec/api/evolution_trigger_api_spec.rb
+- spec/api/gender_api_spec.rb
+- spec/api/generation_api_spec.rb
+- spec/api/growth_rate_api_spec.rb
+- spec/api/item_api_spec.rb
+- spec/api/item_attribute_api_spec.rb
+- spec/api/item_category_api_spec.rb
+- spec/api/item_fling_effect_api_spec.rb
+- spec/api/item_pocket_api_spec.rb
+- spec/api/language_api_spec.rb
+- spec/api/location_api_spec.rb
+- spec/api/location_area_api_spec.rb
+- spec/api/machine_api_spec.rb
+- spec/api/move_ailment_api_spec.rb
+- spec/api/move_api_spec.rb
+- spec/api/move_battle_style_api_spec.rb
+- spec/api/move_category_api_spec.rb
+- spec/api/move_damage_class_api_spec.rb
+- spec/api/move_learn_method_api_spec.rb
+- spec/api/move_target_api_spec.rb
+- spec/api/nature_api_spec.rb
+- spec/api/pal_park_area_api_spec.rb
+- spec/api/pokeathlon_stat_api_spec.rb
+- spec/api/pokedex_api_spec.rb
+- spec/api/pokemon_api_spec.rb
+- spec/api/pokemon_color_api_spec.rb
+- spec/api/pokemon_form_api_spec.rb
+- spec/api/pokemon_habitat_api_spec.rb
+- spec/api/pokemon_shape_api_spec.rb
+- spec/api/pokemon_species_api_spec.rb
+- spec/api/region_api_spec.rb
+- spec/api/stat_api_spec.rb
+- spec/api/super_contest_effect_api_spec.rb
+- spec/api/type_api_spec.rb
+- spec/api/version_api_spec.rb
+- spec/api/version_group_api_spec.rb
+- spec/api_client_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb