blizzard_api_rb_rb 3.4.2

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft achievements
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.mythic_keystone
+    class MythicKeystone < Wow::GenericDataEndpoint
+      setup 'mythic-keystone', :dynamic, CACHE_TRIMESTER
+
+      def get
+        raise BlizzardApi::ApiException, 'Mythic keystone endpoint does not have a get method'
+      end
+
+      ##
+      # Fetch all mythic keystone dungeons
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def dungeons(**options)
+        api_request "#{endpoint_uri}/dungeon/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch all possible data for one of the items listed by the {#dungeons} using its *id*
+      #
+      # @param id [Integer] Dungeon id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def dungeon(id, **options)
+        api_request "#{endpoint_uri}/dungeon/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch all mythic keystone periods
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def periods(**options)
+        api_request "#{endpoint_uri}/period/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch all possible data for one of the items listed by the {#periods} using its *id*
+      #
+      # @param id [Integer] Mythic keystone period id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def period(id, **options)
+        api_request "#{endpoint_uri}/period/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch all mythic keystone seasons
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def seasons(**options)
+        api_request "#{endpoint_uri}/season/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch all possible data for one of the items listed by the {#seasons} using its *id*
+      #
+      # @param id [Integer] Mythic keystone season id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def season(id, **options)
+        api_request "#{endpoint_uri}/season/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft mythic keystone affixes
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.mythic_keystone_affix
+    class MythicKeystoneAffix < Wow::GenericDataEndpoint
+      setup 'keystone-affix', :static, CACHE_TRIMESTER
+
+      ##
+      # Fetch media for one of the affixes listed by the {#index} using its *id*
+      #
+      # @param id [Integer] Keystone affix id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, **options)
+        api_request "#{base_url(:media)}/keystone-affix/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft mythic raid leaderboard
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.mythic_keystone_leaderboard
+    class MythicKeystoneLeaderboard < Wow::Request
+      ##
+      # Fetch mythic keystone leaderboards for the specified realm
+      #
+      # @param connected_realm_id [Integer] One of the IDs returned by the {ConnectedRealm#index}
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def index(connected_realm_id, **options)
+        api_request "#{endpoint_uri(connected_realm_id)}/index", **default_options(options)
+      end
+
+      ##
+      # Fetch mythic keystone leaderboard for the specified realm, dungeon and period
+      #
+      # @param connected_realm_id [Integer] One of the IDs returned by the {ConnectedRealm#index}
+      #
+      # @!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)
+      end
+
+      private
+
+      def default_options(options)
+        { ttl: CACHE_DAY, namespace: :dynamic }.merge options
+      end
+
+      def endpoint_uri(connected_realm_id)
+        "#{base_url(:game_data)}/connected-realm/#{connected_realm_id}/mythic-leaderboard"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft mythic raid leaderboard
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.mythic_raid_leaderboard
+    class MythicRaidLeaderboard < Wow::Request
+      ##
+      # Fetch leaderboard data for given raid and faction
+      #
+      # @param raid [String] Raid slug
+      # @param faction [String] Faction slug
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      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
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft pet 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.pet
+    class Pet < Wow::GenericDataEndpoint
+      setup 'pet', :static, CACHE_TRIMESTER
+
+      ##
+      # Fetch media for one of the pets listed by the {#index} using its *id*
+      #
+      # @param id [Integer] Pet id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, **options)
+        api_request "#{base_url(:media)}/pet/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch all pet abilities
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def abilities(**options)
+        api_request "#{endpoint_uri('ability')}/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch a pet ability
+      #
+      # @param id [Integer] Pet id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def ability(id, **options)
+        api_request "#{endpoint_uri('ability')}/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch media for one of the pet abilities listed by the {#abilities} using its *id*
+      #
+      # @param id [Integer] Pet ability id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def ability_media(id, **options)
+        api_request "#{base_url(:media)}/pet-ability/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft playable classes
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.playable_class
+    class PlayableClass < Wow::GenericDataEndpoint
+      setup 'playable-class', :static, CACHE_TRIMESTER
+
+      ##
+      # Returns the PvP talent slots data of a specific class
+      #
+      # @param id [Integer] Class id to fetch talent data. One of the IDs returned by the {index} method
+      # @!macro request_options
+      #
+      # @!macro response
+      def talent_slots(id, **options)
+        api_request "#{endpoint_uri}/#{id}/pvp-talent-slots", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch media for one of the playable classes listed by the {#index} using its *id*
+      #
+      # @param id [Integer] Playable class id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, **options)
+        api_request "#{base_url(:media)}/playable-class/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/wow/game_data/playable_race.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft playable races
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   race = BlizzardApi::Wow.playable_race
+    class PlayableRace < Wow::GenericDataEndpoint
+      setup 'playable-race', :static, CACHE_TRIMESTER
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft playable specializations
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   spec = BlizzardApi::Wow.playable_specialization
+    class PlayableSpecialization < Wow::GenericDataEndpoint
+      setup 'playable-specialization', :static, CACHE_TRIMESTER
+
+      ##
+      # Fetch media for one of the playable specializations listed by the {#index} using its *id*
+      #
+      # @param id [Integer] Playable specialization id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, **options)
+        api_request "#{base_url(:media)}/playable-specialization/#{id}", **default_options.merge(options)
+      end
+
+      private
+
+      def character_data(index_data, options)
+        [].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[:icon] = resolve_icon(spec_data[:media][:key][:href])
+            cleanup spec_data
+            specs.push spec_data
+          end
+        end
+      end
+
+      def pet_data(index_data, options)
+        [].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[:icon] = resolve_icon(spec_data[:media][:key][:href])
+            cleanup spec_data
+            specs.push spec_data
+          end
+        end
+      end
+
+      def cleanup(data)
+        data.delete :_links
+        data[:playable_class].delete :key
+        data.delete :media
+      end
+
+      def resolve_icon(media_url)
+        media_data = api_request(media_url)
+        media_data.dig(:assets, 0, :value)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/wow/game_data/power_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft power types
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.power_type
+    class PowerType < Wow::GenericDataEndpoint
+      setup 'power-type', :static, CACHE_TRIMESTER
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft professions
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.profession
+    class Profession < Wow::GenericDataEndpoint
+      setup 'profession', :static, CACHE_TRIMESTER
+
+      ##
+      # Fetch media for a profession using its *id*
+      #
+      # @param id [Integer] Profession id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, **options)
+        api_request "#{base_url(:media)}/profession/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch skill tier for a profession using its *ids*
+      #
+      # @param id [Integer] Profession id
+      # @param tier_id [Integer] Profession skill tier id
+      #
+      # @!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)
+      end
+
+      ##
+      # Fetch data for a recipe using its *ids*
+      #
+      # @param id [Integer] Recipe id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def recipe(id, **options)
+        api_request "#{base_url(:game_data)}/recipe/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch media for a recipe using its *ids*
+      #
+      # @param id [Integer] Recipe id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def recipe_media(id, **options)
+        api_request "#{base_url(:media)}/recipe/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/wow/game_data/pvp_region.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft PvP seasons
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.pvp_season
+    class PvpRegion < Wow::GenericDataEndpoint
+      setup 'pvp-region', :dynamic, CACHE_TRIMESTER
+
+      ##
+      # Returns a index of pvp seasons within the region
+      #
+      # @param [Integer] region_id Region ID
+      #
+      # @!macro request_options
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      def seasons(region_id, **options)
+        api_request "#{endpoint_uri}/#{region_id}/pvp-season/index", **default_options.merge(options)
+      end
+
+      ##
+      # Returns a index of pvp seasons within the region
+      #
+      # @param [Integer] region_id Region ID
+      # @param [Integer] season_id Season ID
+      #
+      # @!macro request_options
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      def season(region_id, season_id, **options)
+        api_request "#{endpoint_uri}/#{region_id}/pvp-season/#{season_id}", **default_options.merge(options)
+      end
+
+      ##
+      # Returns a index of pvp leaderboard for a season
+      #
+      # @param [Integer] region_id Region ID
+      # @param [Integer] season_id Season ID
+      #
+      # @!macro request_options
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      def leaderboards(region_id, season_id, **options)
+        api_request "#{endpoint_uri}/#{region_id}/pvp-season/#{season_id}/pvp-leaderboard/index", **default_options.merge(options)
+      end
+
+      ##
+      # Returns the leaderboard for a given season and bracket
+      #
+      # @param [Integer] region_id Region ID
+      # @param [Integer] season_id Season ID
+      # @param [String] brackets Brackets
+      #
+      # @!macro request_options
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      def leaderboard(region_id, season_id, brackets, **options)
+        api_request "#{endpoint_uri}/#{region_id}/pvp-season/#{season_id}/pvp-leaderboard/#{brackets}", **default_options.merge(options)
+      end
+
+      ##
+      # Returns a list of pvp rewards for a season
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def rewards(region_id, season_id, **options)
+        api_request "#{endpoint_uri}/#{region_id}/pvp-season/#{season_id}/pvp-reward/index", **default_options.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft PvP seasons
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.pvp_season
+    class PvpSeason < Wow::GenericDataEndpoint
+      setup 'pvp-season', :dynamic, CACHE_TRIMESTER
+
+      ##
+      # Returns a index of pvp leaderboard for a season
+      #
+      # @param [Integer] season_id Season ID
+      #
+      # @!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)
+      end
+
+      ##
+      # Returns the leaderboard for a given season and bracket
+      #
+      # @param [Integer] season_id Season ID
+      # @param [String] brackets Brackets
+      #
+      # @!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)
+      end
+
+      ##
+      # Returns a list of pvp rewards for a season
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def rewards(season_id, **options)
+        api_request "#{endpoint_uri}/#{season_id}/pvp-reward/index", **default_options.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft power types
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.pvp_tier
+    class PvpTier < Wow::GenericDataEndpoint
+      setup 'pvp-tier',  :static, CACHE_TRIMESTER
+
+      ##
+      # Returns media assets for a pvp tier
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def tier_media(id, **options)
+        api_request "#{base_url(:media)}/#{self.class.endpoint}/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end