blizzard_api 0.6.2 → 2.0.0

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # 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
       #
@@ -21,38 +23,6 @@ module BlizzardApi
         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
-      # @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
-            classes.push class_data
-          end
-        end
-      end
-
-      ##
-      # Return playable class data by its id
-      #
-      # @param id [Integer] Playable class id
-      #
-      # @!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
-        data
-      end
-
       ##
       # Fetch media for one of the playable classes listed by the {#index} using its *id*
       #
@@ -64,22 +34,6 @@ module BlizzardApi
       def media(id, **options)
         api_request "#{base_url(:media)}/playable-class/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'playable-class'
-        @namespace = :static
-        @collection = 'classes'
-        @ttl = CACHE_TRIMESTER
-      end
-
-      def get_class_icon(media_url, **options)
-        return if options.include? :classic
-
-        media_data = request media_url[:key][:href], **options
-        %r{56/([a-z_]+).jpg}.match(media_data[:assets][0][:value].to_s)[1]
-      end
     end
   end
 end

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

@@ -10,14 +10,7 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   race = BlizzardApi::Wow.playable_race
     class PlayableRace < Wow::GenericDataEndpoint
-      protected
-
-      def endpoint_setup
-        @endpoint = 'playable-race'
-        @namespace = :static
-        @collection = 'races'
-        @ttl = CACHE_TRIMESTER
-      end
+      setup 'playable-race', :static, CACHE_TRIMESTER
     end
   end
 end

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

@@ -10,15 +10,7 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   spec = BlizzardApi::Wow.playable_specialization
     class PlayableSpecialization < Wow::GenericDataEndpoint
-      ##
-      # @!macro complete
-      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
+      setup 'playable-specialization', :static, CACHE_TRIMESTER
 
       ##
       # Fetch media for one of the playable specializations listed by the {#index} using its *id*
@@ -32,15 +24,6 @@ module BlizzardApi
         api_request "#{base_url(:media)}/playable-specialization/#{id}", **default_options.merge(options)
       end
 
-      protected
-
-      def endpoint_setup
-        @endpoint = 'playable-specialization'
-        @namespace = :static
-        @collection = 'playable_specialization'
-        @ttl = CACHE_TRIMESTER
-      end
-
       private
 
       def character_data(index_data, options)

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

@@ -10,14 +10,7 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.power_type
     class PowerType < Wow::GenericDataEndpoint
-      protected
-
-      def endpoint_setup
-        @endpoint = 'power-type'
-        @namespace = :static
-        @collection = 'power_types'
-        @ttl = CACHE_TRIMESTER
-      end
+      setup 'power-type', :static, CACHE_TRIMESTER
     end
   end
 end

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # 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*
       #
@@ -58,15 +60,6 @@ module BlizzardApi
       def recipe_media(id, **options)
         api_request "#{base_url(:media)}/recipe/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'profession'
-        @namespace = :static
-        @collection = 'professions'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

data/lib/blizzard_api/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/wow/game_data/pvp_season.rb

@@ -10,9 +10,13 @@ module BlizzardApi
     # 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
       #
@@ -24,6 +28,9 @@ module BlizzardApi
       ##
       # 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
       #
@@ -41,15 +48,6 @@ module BlizzardApi
       def rewards(season_id, **options)
         api_request "#{endpoint_uri}/#{season_id}/pvp-reward/index", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'pvp-season'
-        @namespace = :dynamic
-        @collection = 'power_types'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # 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
       #
@@ -17,16 +19,7 @@ module BlizzardApi
       #
       # @!macro response
       def tier_media(id, **options)
-        api_request "#{base_url(:media)}/#{@endpoint}/#{id}", **default_options.merge(options)
-      end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'pvp-tier'
-        @namespace = :static
-        @collection = 'tiers'
-        @ttl = CACHE_TRIMESTER
+        api_request "#{base_url(:media)}/#{self.class.endpoint}/#{id}", **default_options.merge(options)
       end
     end
   end

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.quest
     class Quest < Wow::GenericDataEndpoint
+      setup 'quest', :static, CACHE_TRIMESTER
+
       ##
       # Return a list of quest categories
       #
@@ -72,15 +74,6 @@ module BlizzardApi
       def type(id, **options)
         api_request "#{endpoint_uri}/type/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'quest'
-        @namespace = :static
-        @collection = 'quests'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

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

@@ -12,14 +12,7 @@ module BlizzardApi
     class Realm < Wow::GenericDataEndpoint
       include BlizzardApi::Wow::Searchable
 
-      protected
-
-      def endpoint_setup
-        @endpoint = 'realm'
-        @namespace = :dynamic
-        @collection = 'realms'
-        @ttl = CACHE_TRIMESTER
-      end
+      setup 'realm', :dynamic, CACHE_TRIMESTER
     end
   end
 end

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

@@ -10,14 +10,7 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.region
     class Region < Wow::GenericDataEndpoint
-      protected
-
-      def endpoint_setup
-        @endpoint = 'region'
-        @namespace = :dynamic
-        @collection = 'regions'
-        @ttl = CACHE_TRIMESTER
-      end
+      setup 'region', :dynamic, CACHE_TRIMESTER
     end
   end
 end

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.reputation
     class Reputation < Wow::GenericDataEndpoint
+      setup 'reputation', :static, CACHE_TRIMESTER
+
       ##
       # This method overrides the inherited default behavior to prevent high server load and fetch time
       #
@@ -67,15 +69,6 @@ module BlizzardApi
       def tier(id, **options)
         api_request "#{endpoint_uri('tiers')}/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'reputation'
-        @namespace = :static
-        @collection = 'reputations'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

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

@@ -12,6 +12,8 @@ module BlizzardApi
     class Spell < Wow::GenericDataEndpoint
       include BlizzardApi::Wow::Searchable
 
+      setup 'spell', :static, CACHE_TRIMESTER
+
       ##
       # This method overrides the inherited default behavior to prevent high server load and fetch time
       #
@@ -20,14 +22,6 @@ module BlizzardApi
         raise BlizzardApi::ApiException, 'This endpoint does not have a index method'
       end
 
-      ##
-      # This method overrides the inherited default behavior to prevent high server load and fetch time
-      #
-      # @!macro response
-      def complete
-        raise BlizzardApi::ApiException, 'This endpoint does not have a complete method'
-      end
-
       ##
       # Fetch media for a spell
       #
@@ -39,15 +33,6 @@ module BlizzardApi
       def display_media(id, **options)
         api_request "#{base_url(:media)}/spell/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'spell'
-        @namespace = :static
-        @collection = 'spells'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.talent
     class Talent < Wow::GenericDataEndpoint
+      setup 'talent', :static, CACHE_TRIMESTER
+
       ##
       # Fetch pvp talents
       #
@@ -31,15 +33,6 @@ module BlizzardApi
       def pvp_talent(id, **options)
         api_request "#{base_url(:game_data)}/pvp-talent/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'talent'
-        @namespace = :static
-        @collection = 'talents'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.talent
     class TechTalent < Wow::GenericDataEndpoint
+      setup 'tech-talent', :static, CACHE_TRIMESTER
+
       ##
       # Fetch tech talent trees
       #
@@ -43,15 +45,6 @@ module BlizzardApi
       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/title.rb

@@ -10,22 +10,7 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.title
     class Title < Wow::GenericDataEndpoint
-      ##
-      # This method overrides the inherited default behavior to prevent high server load and fetch time
-      #
-      # @!macro response
-      def complete
-        raise BlizzardApi::ApiException, 'There are too many achievements to fetch complete data'
-      end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'title'
-        @namespace = :static
-        @collection = 'titles'
-        @ttl = CACHE_TRIMESTER
-      end
+      setup 'title', :static, CACHE_TRIMESTER
     end
   end
 end

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

@@ -7,8 +7,8 @@ module BlizzardApi
     class AccountProfile < Request
       ##
       # @param token [String] A token obtained using the authorization_code flow
-      def initialize(token, region = nil, mode = :regular)
-        super region, mode
+      def initialize(token, **options)
+        super(**options)
         @token = token
       end
 
@@ -68,7 +68,7 @@ module BlizzardApi
         { ttl: CACHE_HOUR, namespace: :profile }
       end
 
-      def api_request(_uri, query_string = {})
+      def api_request(_uri, **query_string)
         query_string.merge! access_token: @token
         super
       end

data/lib/blizzard_api/wow/request.rb

@@ -6,9 +6,9 @@ module BlizzardApi
     # World of Warcraft requests
     class Request < BlizzardApi::Request
       ##
-      # @!macro regions
-      def initialize(region = nil, mode = :regular)
-        super region, mode
+      # @!macro init_options
+      def initialize(**options)
+        super(**options)
         @game = 'wow'
       end
     end