blizzard_api 0.5.3 → 0.6.1

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

@@ -30,7 +30,7 @@ module BlizzardApi
       # This method overrides the inherited default behavior to prevent high server load and fetch time
       #
       # @!macro response
-      def get(_id, _options = {})
+      def get(_id)
         raise BlizzardApi::ApiException, 'This endpoint does not have a get method'
       end
 
@@ -40,8 +40,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def expansions(options = {})
-        api_request "#{endpoint_uri('expansion')}/index", default_options.merge(options)
+      def expansions(**options)
+        api_request "#{endpoint_uri('expansion')}/index", **default_options.merge(options)
       end
 
       ##
@@ -51,8 +51,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def expansion(id, options = {})
-        api_request "#{endpoint_uri('expansion')}/#{id}", default_options.merge(options)
+      def expansion(id, **options)
+        api_request "#{endpoint_uri('expansion')}/#{id}", **default_options.merge(options)
       end
 
       ##
@@ -61,8 +61,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def instances(options = {})
-        api_request "#{endpoint_uri('instance')}/index", default_options.merge(options)
+      def instances(**options)
+        api_request "#{endpoint_uri('instance')}/index", **default_options.merge(options)
       end
 
       ##
@@ -72,8 +72,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def instance(id, options = {})
-        api_request "#{endpoint_uri('instance')}/#{id}", default_options.merge(options)
+      def instance(id, **options)
+        api_request "#{endpoint_uri('instance')}/#{id}", **default_options.merge(options)
       end
 
       ##
@@ -82,8 +82,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def encounters(options = {})
-        api_request "#{endpoint_uri('encounter')}/index", default_options.merge(options)
+      def encounters(**options)
+        api_request "#{endpoint_uri('encounter')}/index", **default_options.merge(options)
       end
 
       ##
@@ -93,8 +93,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def encounter(id, options = {})
-        api_request "#{endpoint_uri('encounter')}/#{id}", default_options.merge(options)
+      def encounter(id, **options)
+        api_request "#{endpoint_uri('encounter')}/#{id}", **default_options.merge(options)
       end
 
       ##
@@ -105,11 +105,11 @@ module BlizzardApi
       #
       # @!macro request_options
       # @!macro response
-      def encounter_search(page = 1, page_size = 100, options = {})
+      def encounter_search(page = 1, page_size = 100, **options)
         search_options = SearchComposer.new(page, page_size)
         yield search_options if block_given?
 
-        api_request "#{endpoint_uri('encounter', :search)}?#{search_options.to_search_query}", default_options.merge(options)
+        api_request "#{endpoint_uri('encounter', :search)}?#{search_options.to_search_query}", **default_options.merge(options)
       end
 
       protected

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

@@ -18,8 +18,8 @@ module BlizzardApi
       # Fetch modified crafting category index
       #
       # @!macro request_options
-      def categories(options = {})
-        api_request "#{base_url(:game_data)}/modified-crafting/category/index", default_options.merge(options)
+      def categories(**options)
+        api_request "#{base_url(:game_data)}/modified-crafting/category/index", **default_options.merge(options)
       end
 
       ##
@@ -30,16 +30,16 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def category(id, options = {})
-        api_request "#{base_url(:game_data)}/modified-crafting/category/#{id}", default_options.merge(options)
+      def category(id, **options)
+        api_request "#{base_url(:game_data)}/modified-crafting/category/#{id}", **default_options.merge(options)
       end
 
       ##
       # Fetch modified crafting slot type index
       #
       # @!macro request_options
-      def slot_types(options = {})
-        api_request "#{base_url(:game_data)}/modified-crafting/reagent-slot-type/index", default_options.merge(options)
+      def slot_types(**options)
+        api_request "#{base_url(:game_data)}/modified-crafting/reagent-slot-type/index", **default_options.merge(options)
       end
 
       ##
@@ -50,8 +50,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def slot_type(id, options = {})
-        api_request "#{base_url(:game_data)}/modified-crafting/reagent-slot-type/#{id}", default_options.merge(options)
+      def slot_type(id, **options)
+        api_request "#{base_url(:game_data)}/modified-crafting/reagent-slot-type/#{id}", **default_options.merge(options)
       end
 
       protected

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

@@ -24,8 +24,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def dungeons(options = {})
-        api_request "#{endpoint_uri}/dungeon/index", default_options.merge(options)
+      def dungeons(**options)
+        api_request "#{endpoint_uri}/dungeon/index", **default_options.merge(options)
       end
 
       ##
@@ -36,8 +36,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def dungeon(id, options = {})
-        api_request "#{endpoint_uri}/dungeon/#{id}", default_options.merge(options)
+      def dungeon(id, **options)
+        api_request "#{endpoint_uri}/dungeon/#{id}", **default_options.merge(options)
       end
 
       ##
@@ -46,8 +46,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def periods(options = {})
-        api_request "#{endpoint_uri}/period/index", default_options.merge(options)
+      def periods(**options)
+        api_request "#{endpoint_uri}/period/index", **default_options.merge(options)
       end
 
       ##
@@ -58,8 +58,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def period(id, options = {})
-        api_request "#{endpoint_uri}/period/#{id}", default_options.merge(options)
+      def period(id, **options)
+        api_request "#{endpoint_uri}/period/#{id}", **default_options.merge(options)
       end
 
       ##
@@ -68,8 +68,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def seasons(options = {})
-        api_request "#{endpoint_uri}/season/index", default_options.merge(options)
+      def seasons(**options)
+        api_request "#{endpoint_uri}/season/index", **default_options.merge(options)
       end
 
       ##
@@ -80,8 +80,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def season(id, options = {})
-        api_request "#{endpoint_uri}/season/#{id}", default_options.merge(options)
+      def season(id, **options)
+        api_request "#{endpoint_uri}/season/#{id}", **default_options.merge(options)
       end
 
       protected

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

@@ -18,8 +18,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def media(id, options = {})
-        api_request "#{base_url(:media)}/keystone-affix/#{id}", default_options.merge(options)
+      def media(id, **options)
+        api_request "#{base_url(:media)}/keystone-affix/#{id}", **default_options.merge(options)
       end
 
       protected

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

@@ -18,8 +18,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def index(connected_realm_id, options = {})
-        api_request "#{endpoint_uri(connected_realm_id)}/index", default_options(options)
+      def index(connected_realm_id, **options)
+        api_request "#{endpoint_uri(connected_realm_id)}/index", **default_options(options)
       end
 
       ##
@@ -30,8 +30,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(connected_realm_id, dungeon_id, period, options = {})
-        api_request "#{endpoint_uri(connected_realm_id)}/#{dungeon_id}/period/#{period}", default_options(options)
+      def get(connected_realm_id, dungeon_id, period, **options)
+        api_request "#{endpoint_uri(connected_realm_id)}/#{dungeon_id}/period/#{period}", **default_options(options)
       end
 
       private

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

@@ -19,9 +19,9 @@ 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
+        api_request "#{base_url(:game_data)}/leaderboard/hall-of-fame/#{raid}/#{faction}", **opts
       end
     end
   end

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

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

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

@@ -17,20 +17,21 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def talent_slots(id, options = {})
-        api_request "#{endpoint_uri}/#{id}/pvp-talent-slots", default_options.merge(options)
+      def talent_slots(id, **options)
+        api_request "#{endpoint_uri}/#{id}/pvp-talent-slots", **default_options.merge(options)
       end
 
       ##
       # @!macro complete
       #
       # @option options [Boolean] :classic If set to true, this method will call the classic version
-      def complete(options = {})
-        index_data = index options
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      def complete(**options)
+        index_data = index(**options)
         [].tap do |classes|
           index_data[:classes].each do |pclass|
             class_id = %r{playable-class/([0-9]+)}.match(pclass[:key].to_s)[1]
-            class_data = get class_id, options
+            class_data = get class_id, **options
             classes.push class_data
           end
         end
@@ -43,11 +44,12 @@ module BlizzardApi
       #
       # @!macro request_options
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
-      def get(id, options = {})
-        data = api_request "#{endpoint_uri}/#{id}", default_options.merge(options)
-        data[:icon] = get_class_icon data[:media], options
+      def get(id, **options)
+        data = api_request "#{endpoint_uri}/#{id}", **default_options.merge(options)
+        data[:icon] = get_class_icon data[:media], **options
         data
       end
 
@@ -59,8 +61,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def media(id, options = {})
-        api_request "#{base_url(:media)}/playable-class/#{id}", default_options.merge(options)
+      def media(id, **options)
+        api_request "#{base_url(:media)}/playable-class/#{id}", **default_options.merge(options)
       end
 
       protected
@@ -72,10 +74,10 @@ module BlizzardApi
         @ttl = CACHE_TRIMESTER
       end
 
-      def get_class_icon(media_url, options)
+      def get_class_icon(media_url, **options)
         return if options.include? :classic
 
-        media_data = request media_url[:key][:href], options
+        media_data = request media_url[:key][:href], **options
         %r{56/([a-z_]+).jpg}.match(media_data[:assets][0][:value].to_s)[1]
       end
     end

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

@@ -12,12 +12,12 @@ module BlizzardApi
     class PlayableSpecialization < Wow::GenericDataEndpoint
       ##
       # @!macro complete
-      def complete(options = {})
-        index_data = index options
-        response_data = OpenStruct.new
-        response_data.character_specializations = character_data(index_data, options)
-        response_data.pet_specializations = pet_data(index_data, options)
-        response_data
+      def complete(**options)
+        index_data = index(**options)
+        {}.tap do |response_data|
+          response_data[:character_specializations] = character_data(index_data, options)
+          response_data[:pet_specializations] = pet_data(index_data, options)
+        end
       end
 
       ##
@@ -28,8 +28,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def media(id, options = {})
-        api_request "#{base_url(:media)}/playable-specialization/#{id}", default_options.merge(options)
+      def media(id, **options)
+        api_request "#{base_url(:media)}/playable-specialization/#{id}", **default_options.merge(options)
       end
 
       protected
@@ -47,7 +47,7 @@ module BlizzardApi
         [].tap do |specs|
           index_data[:character_specializations].each do |spec|
             spec_id = %r{playable-specialization/([0-9]+)}.match(spec[:key].to_s)[1]
-            spec_data = get spec_id, options
+            spec_data = get spec_id, **options
             spec_data[:icon] = resolve_icon(spec_data[:media][:key][:href])
             cleanup spec_data
             specs.push spec_data
@@ -59,7 +59,7 @@ module BlizzardApi
         [].tap do |specs|
           index_data[:pet_specializations].each do |spec|
             spec_id = %r{playable-specialization/([0-9]+)}.match(spec[:key].to_s)[1]
-            spec_data = get spec_id, options
+            spec_data = get spec_id, **options
             spec_data[:icon] = resolve_icon(spec_data[:media][:key][:href])
             cleanup spec_data
             specs.push spec_data

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

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

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

@@ -14,20 +14,22 @@ module BlizzardApi
       # Returns a index of pvp leaderboard for a season
       #
       # @!macro request_options
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
-      def leaderboards(season_id, options = {})
-        api_request "#{endpoint_uri}/#{season_id}/pvp-leaderboard/index", default_options.merge(options)
+      def leaderboards(season_id, **options)
+        api_request "#{endpoint_uri}/#{season_id}/pvp-leaderboard/index", **default_options.merge(options)
       end
 
       ##
       # Returns the leaderboard for a given season and bracket
       #
       # @!macro request_options
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
-      def leaderboard(season_id, brackets, options = {})
-        api_request "#{endpoint_uri}/#{season_id}/pvp-leaderboard/#{brackets}", default_options.merge(options)
+      def leaderboard(season_id, brackets, **options)
+        api_request "#{endpoint_uri}/#{season_id}/pvp-leaderboard/#{brackets}", **default_options.merge(options)
       end
 
       ##
@@ -36,8 +38,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def rewards(season_id, options = {})
-        api_request "#{endpoint_uri}/#{season_id}/pvp-reward/index", default_options.merge(options)
+      def rewards(season_id, **options)
+        api_request "#{endpoint_uri}/#{season_id}/pvp-reward/index", **default_options.merge(options)
       end
 
       protected