blizzard_api 0.5.1 → 0.5.6

data/lib/blizzard_api/wow/game_data/mythic_raid_leaderboard.rb

@@ -19,7 +19,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(raid, faction, options = {})
+      def get(raid, faction, **options)
         opts = options.merge(namespace: :dynamic, ttl: CACHE_DAY)
         api_request "#{base_url(:game_data)}/leaderboard/hall-of-fame/#{raid}/#{faction}", opts
       end

data/lib/blizzard_api/wow/game_data/pet.rb

@@ -18,7 +18,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def media(id, options = {})
+      def media(id, **options)
         api_request "#{base_url(:media)}/pet/#{id}", default_options.merge(options)
       end
 
@@ -28,7 +28,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def abilities(options = {})
+      def abilities(**options)
         api_request "#{endpoint_uri('ability')}/index", default_options.merge(options)
       end
 
@@ -40,7 +40,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def ability(id, options = {})
+      def ability(id, **options)
         api_request "#{endpoint_uri('ability')}/#{id}", default_options.merge(options)
       end
 
@@ -52,7 +52,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def ability_media(id, options = {})
+      def ability_media(id, **options)
         api_request "#{base_url(:media)}/pet-ability/#{id}", default_options.merge(options)
       end
 

data/lib/blizzard_api/wow/game_data/playable_class.rb

@@ -17,7 +17,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def talent_slots(id, options = {})
+      def talent_slots(id, **options)
         api_request "#{endpoint_uri}/#{id}/pvp-talent-slots", default_options.merge(options)
       end
 
@@ -25,7 +25,7 @@ module BlizzardApi
       # @!macro complete
       #
       # @option options [Boolean] :classic If set to true, this method will call the classic version
-      def complete(options = {})
+      def complete(**options)
         index_data = index options
         [].tap do |classes|
           index_data[:classes].each do |pclass|
@@ -45,7 +45,7 @@ module BlizzardApi
       # @option options [Boolean] :classic If set to true, this method will call the classic version
       #
       # @!macro response
-      def get(id, options = {})
+      def get(id, **options)
         data = api_request "#{endpoint_uri}/#{id}", default_options.merge(options)
         data[:icon] = get_class_icon data[:media], options
         data
@@ -59,7 +59,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def media(id, options = {})
+      def media(id, **options)
         api_request "#{base_url(:media)}/playable-class/#{id}", default_options.merge(options)
       end
 

data/lib/blizzard_api/wow/game_data/playable_specialization.rb

@@ -12,7 +12,7 @@ module BlizzardApi
     class PlayableSpecialization < Wow::GenericDataEndpoint
       ##
       # @!macro complete
-      def complete(options = {})
+      def complete(**options)
         index_data = index options
         response_data = OpenStruct.new
         response_data.character_specializations = character_data(index_data, options)
@@ -28,7 +28,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def media(id, options = {})
+      def media(id, **options)
         api_request "#{base_url(:media)}/playable-specialization/#{id}", default_options.merge(options)
       end
 

data/lib/blizzard_api/wow/game_data/profession.rb

@@ -18,7 +18,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def media(id, options = {})
+      def media(id, **options)
         api_request "#{base_url(:media)}/profession/#{id}", default_options.merge(options)
       end
 
@@ -31,7 +31,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def skill_tier(id, tier_id, options = {})
+      def skill_tier(id, tier_id, **options)
         api_request "#{base_url(:game_data)}/profession/#{id}/skill-tier/#{tier_id}", default_options.merge(options)
       end
 
@@ -43,7 +43,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def recipe(id, options = {})
+      def recipe(id, **options)
         api_request "#{base_url(:game_data)}/recipe/#{id}", default_options.merge(options)
       end
 
@@ -55,7 +55,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def recipe_media(id, options = {})
+      def recipe_media(id, **options)
         api_request "#{base_url(:media)}/recipe/#{id}", default_options.merge(options)
       end
 

data/lib/blizzard_api/wow/game_data/pvp_season.rb

@@ -16,7 +16,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def leaderboards(season_id, options = {})
+      def leaderboards(season_id, **options)
         api_request "#{endpoint_uri}/#{season_id}/pvp-leaderboard/index", default_options.merge(options)
       end
 
@@ -26,7 +26,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def leaderboard(season_id, brackets, options = {})
+      def leaderboard(season_id, brackets, **options)
         api_request "#{endpoint_uri}/#{season_id}/pvp-leaderboard/#{brackets}", default_options.merge(options)
       end
 
@@ -36,7 +36,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def rewards(season_id, options = {})
+      def rewards(season_id, **options)
         api_request "#{endpoint_uri}/#{season_id}/pvp-reward/index", default_options.merge(options)
       end
 

data/lib/blizzard_api/wow/game_data/pvp_tier.rb

@@ -16,7 +16,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def tier_media(id, options = {})
+      def tier_media(id, **options)
         api_request "#{base_url(:media)}/#{@endpoint}/#{id}", default_options.merge(options)
       end
 

data/lib/blizzard_api/wow/game_data/quest.rb

@@ -16,7 +16,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def categories(options = {})
+      def categories(**options)
         api_request "#{endpoint_uri}/category/index", default_options.merge(options)
       end
 
@@ -27,7 +27,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def category(id, options = {})
+      def category(id, **options)
         api_request "#{endpoint_uri}/category/#{id}", default_options.merge(options)
       end
 
@@ -37,7 +37,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def areas(options = {})
+      def areas(**options)
         api_request "#{endpoint_uri}/area/index", default_options.merge(options)
       end
 
@@ -48,7 +48,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def area(id, options = {})
+      def area(id, **options)
         api_request "#{endpoint_uri}/area/#{id}", default_options.merge(options)
       end
 
@@ -58,7 +58,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def types(options = {})
+      def types(**options)
         api_request "#{endpoint_uri}/type/index", default_options.merge(options)
       end
 
@@ -69,7 +69,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def type(id, options = {})
+      def type(id, **options)
         api_request "#{endpoint_uri}/type/#{id}", default_options.merge(options)
       end
 

data/lib/blizzard_api/wow/game_data/reputation.rb

@@ -32,7 +32,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def factions(options = {})
+      def factions(**options)
         api_request "#{endpoint_uri('faction')}/index", default_options.merge(options)
       end
 
@@ -43,7 +43,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def faction(id, options = {})
+      def faction(id, **options)
         api_request "#{endpoint_uri('faction')}/#{id}", default_options.merge(options)
       end
 
@@ -53,7 +53,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def tiers(options = {})
+      def tiers(**options)
         api_request "#{endpoint_uri('tiers')}/index", default_options.merge(options)
       end
 
@@ -64,7 +64,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def tier(id, options = {})
+      def tier(id, **options)
         api_request "#{endpoint_uri('tiers')}/#{id}", default_options.merge(options)
       end
 

data/lib/blizzard_api/wow/game_data/spell.rb

@@ -36,7 +36,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def display_media(id, options = {})
+      def display_media(id, **options)
         api_request "#{base_url(:media)}/spell/#{id}", default_options.merge(options)
       end
 

data/lib/blizzard_api/wow/game_data/talent.rb

@@ -16,7 +16,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def pvp_talents(options = {})
+      def pvp_talents(**options)
         api_request "#{base_url(:game_data)}/pvp-talent/index", default_options.merge(options)
       end
 
@@ -28,7 +28,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def pvp_talent(id, options = {})
+      def pvp_talent(id, **options)
         api_request "#{base_url(:game_data)}/pvp-talent/#{id}", default_options.merge(options)
       end
 

data/lib/blizzard_api/wow/game_data/tech_talent.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft talent data
+    #
+    # @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.talent
+    class TechTalent < Wow::GenericDataEndpoint
+      ##
+      # Fetch tech talent trees
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def tech_talent_trees(**options)
+        api_request "#{base_url(:game_data)}/tech-talent-tree/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch a tech talent tree
+      #
+      # @param id [Integer] Tech talent id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def tech_talent_tree(id, **options)
+        api_request "#{base_url(:game_data)}/tech-talent-tree/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch a tech talent media
+      #
+      # @param id [Integer] Tech talent id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, **options)
+        api_request "#{base_url(:media)}/tech-talent/#{id}", default_options.merge(options)
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'tech-talent'
+        @namespace = :static
+        @collection = 'tech-talents'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

data/lib/blizzard_api/wow/game_data/wow_token.rb

@@ -16,7 +16,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(options = {})
+      def get(**options)
         opts = { namespace: :dynamic, ttl: CACHE_HOUR }.merge(options)
         api_request "#{base_url(:game_data)}/token/index", opts
       end

data/lib/blizzard_api/wow/profile/character_profile.rb

@@ -22,7 +22,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(realm, character, options = {})
+      def get(realm, character, **options)
         character_request realm, character, options
       end
 
@@ -36,8 +36,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def achievements(realm, character, options = {})
-        character_request realm, character, options, 'achievements'
+      def achievements(realm, character, **options)
+        character_request realm, character, 'achievements', options
       end
 
       ##
@@ -50,8 +50,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def achievement_statistics(realm, character, options = {})
-        character_request realm, character, options, 'achievements/statistics'
+      def achievement_statistics(realm, character, **options)
+        character_request realm, character, 'achievements/statistics', options
       end
 
       ##
@@ -64,8 +64,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def appearance(realm, character, options = {})
-        character_request realm, character, options, 'appearance'
+      def appearance(realm, character, **options)
+        character_request realm, character, 'appearance', options
       end
 
       ##
@@ -78,8 +78,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def collections(realm, character, options = {})
-        character_request realm, character, options, 'collections'
+      def collections(realm, character, **options)
+        character_request realm, character, 'collections', options
       end
 
       ##
@@ -92,8 +92,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def pets(realm, character, options = {})
-        character_request realm, character, options, 'collections/pets'
+      def pets(realm, character, **options)
+        character_request realm, character, 'collections/pets', options
       end
 
       ##
@@ -106,8 +106,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def mounts(realm, character, options = {})
-        character_request realm, character, options, 'collections/mounts'
+      def mounts(realm, character, **options)
+        character_request realm, character, 'collections/mounts', options
       end
 
       ##
@@ -120,8 +120,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def encounters(realm, character, options = {})
-        character_request realm, character, options, 'encounters'
+      def encounters(realm, character, **options)
+        character_request realm, character, 'encounters', options
       end
 
       ##
@@ -134,8 +134,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def dungeons(realm, character, options = {})
-        character_request realm, character, options, 'encounters/dungeons'
+      def dungeons(realm, character, **options)
+        character_request realm, character, 'encounters/dungeons', options
       end
 
       ##
@@ -148,8 +148,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def raids(realm, character, options = {})
-        character_request realm, character, options, 'encounters/raids'
+      def raids(realm, character, **options)
+        character_request realm, character, 'encounters/raids', options
       end
 
       ##
@@ -162,8 +162,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def equipment(realm, character, options = {})
-        character_request realm, character, options, 'equipment'
+      def equipment(realm, character, **options)
+        character_request realm, character, 'equipment', options
       end
 
       ##
@@ -176,8 +176,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def hunter_pets(realm, character, options = {})
-        character_request realm, character, options, 'hunter-pets'
+      def hunter_pets(realm, character, **options)
+        character_request realm, character, 'hunter-pets', options
       end
 
       ##
@@ -190,8 +190,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def media(realm, character, options = {})
-        character_request realm, character, options, 'character-media'
+      def media(realm, character, **options)
+        character_request realm, character, 'character-media', options
       end
 
       ##
@@ -204,8 +204,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def mythic_keystone_profile(realm, character, options = {})
-        character_request realm, character, options, 'mythic-keystone-profile'
+      def mythic_keystone_profile(realm, character, **options)
+        character_request realm, character, 'mythic-keystone-profile', options
       end
 
       ##
@@ -219,8 +219,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def mythic_keystone_seasons(realm, character, season = nil, options = {})
-        character_request realm, character, options, "mythic-keystone-profile/season/#{season}"
+      def mythic_keystone_seasons(realm, character, season = nil, **options)
+        character_request realm, character, "mythic-keystone-profile/season/#{season}", options
       end
 
       ##
@@ -233,8 +233,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def professions(realm, character, options = {})
-        character_request realm, character, options, 'professions'
+      def professions(realm, character, **options)
+        character_request realm, character, 'professions', options
       end
 
       ##
@@ -248,8 +248,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def status(realm, character, options = {})
-        character_request realm, character, options, 'status'
+      def status(realm, character, **options)
+        character_request realm, character, 'status', options
       end
 
       ##
@@ -263,8 +263,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def pvp_bracket(realm, character, bracket, options = {})
-        character_request realm, character, options, "pvp-bracket/#{bracket}"
+      def pvp_bracket(realm, character, bracket, **options)
+        character_request realm, character, "pvp-bracket/#{bracket}", options
       end
 
       ##
@@ -277,8 +277,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def pvp_summary(realm, character, options = {})
-        character_request realm, character, options, 'pvp-summary'
+      def pvp_summary(realm, character, **options)
+        character_request realm, character, 'pvp-summary', options
       end
 
       ##
@@ -292,11 +292,11 @@ module BlizzardApi
       #   @option options [Boolean] :completed Should return completed quests
       #
       # @!macro response
-      def quests(realm, character, options = {})
+      def quests(realm, character, **options)
         completed = options.delete(:completed) || false
-        return character_request realm, character, options, 'quests/completed' if completed
+        return character_request realm, character, 'quests/completed', options if completed
 
-        character_request realm, character, options, 'quests'
+        character_request realm, character, 'quests', options
       end
 
       ##
@@ -309,8 +309,22 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def reputation(realm, character, options = {})
-        character_request realm, character, options, 'reputations'
+      def reputation(realm, character, **options)
+        character_request realm, character, 'reputations', options
+      end
+
+      ##
+      # Return a character's soulbinds
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def soulbinds(realm, character, **options)
+        character_request realm, character, 'soulbinds', options
       end
 
       ##
@@ -323,8 +337,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def specializations(realm, character, options = {})
-        character_request realm, character, options, 'specializations'
+      def specializations(realm, character, **options)
+        character_request realm, character, 'specializations', options
       end
 
       ##
@@ -337,8 +351,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def statistics(realm, character, options = {})
-        character_request realm, character, options, 'statistics'
+      def statistics(realm, character, **options)
+        character_request realm, character, 'statistics', options
       end
 
       ##
@@ -351,8 +365,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def titles(realm, character, options = {})
-        character_request realm, character, options, 'titles'
+      def titles(realm, character, **options)
+        character_request realm, character, 'titles', options
       end
 
       private
@@ -363,7 +377,7 @@ module BlizzardApi
         opts
       end
 
-      def character_request(realm, character, options = {}, variant = nil)
+      def character_request(realm, character, variant = nil, **options)
         uri = "#{base_url(:profile)}/character/#{string_to_slug(realm)}/#{string_to_slug(character)}"
         uri += "/#{variant}" if variant
         api_request uri, default_options.merge(options)