blizzard_api 0.2.1 → 0.2.2

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

@@ -0,0 +1,97 @@
+# 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
+      def get
+        raise BlizzardApi::ApiException, 'Mythic keystone endpoint does not have a get method'
+      end
+
+      def complete
+        raise BlizzardApi::ApiException, 'There are too many creatures to fetch complete data'
+      end
+
+      ##
+      # Fetch all mythic keystone dungeons
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def dungeons(options = {})
+        api_request "#{endpoint_uri}/period/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
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'mythic-keystone'
+        @namespace = endpoint_namespace :dynamic
+        @collection = 'mythic-keystones'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

data/lib/blizzard_api/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: endpoint_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/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: endpoint_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/wow/{community/pets.rb → game_data/pet.rb}

@@ -9,7 +9,7 @@ module BlizzardApi
     #
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.pet
-    class Pet < Wow::Request
+    class Pet < Wow::GenericDataEndpoint
       # Poor (gray) quality pet
       PET_QUALITY_POOR = 0
       # Common (white) quality pet
@@ -27,9 +27,13 @@ module BlizzardApi
       # Return a list of all available pets
       #
       # @!macro request_options
+      # @option options [Boolean] :use_community_endpoint If set to true, this method will call the community endpoint
+      #   instead of the data endpoint https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
       #
       # @!macro response
       def index(options = {})
+        return super options unless options.include? :use_community_endpoint
+
         api_request "#{base_url(:community)}/pet/", { ttl: CACHE_TRIMESTER }.merge(options)
       end
 
@@ -80,6 +84,15 @@ module BlizzardApi
       def types(options = {})
         api_request "#{base_url(:community)}/data/pet/types", { ttl: CACHE_TRIMESTER }.merge(options)
       end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'pet'
+        @namespace = endpoint_namespace :static
+        @collection = 'pets'
+        @ttl = CACHE_TRIMESTER
+      end
     end
   end
 end

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

@@ -32,7 +32,7 @@ module BlizzardApi
       #
       # @!macro response
       def talent_slots(id, options = {})
-        api_request "#{base_url(:game_data)}/#{@endpoint}/#{id}/pvp-talent-slots", default_options.merge(options)
+        api_request "#{endpoint_uri}/#{id}/pvp-talent-slots", default_options.merge(options)
       end
 
       ##
@@ -48,11 +48,17 @@ module BlizzardApi
         end
       end
 
+      ##
+      # Return playable class data by its id
+      #
+      # @param id [Integer] Playable class id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
       def get(id, options = {})
-        data = api_request "#{base_url(:game_data)}/#{@endpoint}/#{id}", default_options.merge(options)
+        data = api_request "#{endpoint_uri}/#{id}", default_options.merge(options)
         data[:icon] = get_class_icon data[:media], options
-        data.delete :_links
-        data.delete :media
         data
       end
 

data/lib/blizzard_api/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
+      ##
+      # Returns a index of pvp leaderboard for a season
+      #
+      # @!macro request_options
+      #
+      # @!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
+      #
+      # @!macro request_options
+      #
+      # @!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
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'pvp-season'
+        @namespace = endpoint_namespace :dynamic
+        @collection = 'power_types'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# 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 PvpTier < Wow::GenericDataEndpoint
+      ##
+      # Returns media assets for a pvp tier
+      #
+      # @!macro request_options
+      #
+      # @!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 = endpoint_namespace :static
+        @collection = 'tiers'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -24,24 +24,10 @@ module BlizzardApi
         api_request "#{base_url(:community)}/data/character/races", { ttl: CACHE_TRIMESTER }.merge(options)
       end
 
-      ##
-      # @!macro complete
-      def complete(options = {})
-        index_data = index options
-        [].tap do |races|
-          index_data[:races].each do |race|
-            race_id = %r{race/([0-9]+)}.match(race[:key].to_s)[1]
-            race_data = get race_id, options
-            race_data.delete :name
-            races.push race_data
-          end
-        end
-      end
-
       protected
 
       def endpoint_setup
-        @endpoint = 'race'
+        @endpoint = 'playable-race'
         @namespace = endpoint_namespace :static
         @collection = 'races'
         @ttl = CACHE_TRIMESTER

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

@@ -21,20 +21,6 @@ module BlizzardApi
         api_request "#{base_url(:community)}/realm/status", { ttl: CACHE_MINUTE }.merge(options)
       end
 
-      ##
-      # @!macro complete
-      def complete(options = {})
-        index_data = index options
-        [].tap do |realms|
-          index_data[:realms].each do |realm|
-            realm_data = get realm[:id], options
-            realm_data.delete :_links
-            realm_data[:region].delete :key
-            realms.push realm_data
-          end
-        end
-      end
-
       protected
 
       def endpoint_setup

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

@@ -10,19 +10,6 @@ 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
-      ##
-      # @!macro complete
-      def complete(options = {})
-        [].tap do |data|
-          index_data = index options
-          index_data[:regions].each do |region|
-            region_data = request region[:href], options
-            region_data.delete :_links
-            data.push region_data
-          end
-        end
-      end
-
       ##
       # Returns data about region battlegroups
       #

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft tokens
+    #
+    # @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.wow_token
+    class WowToken < Wow::Request
+      ##
+      # Returns wow token data
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(options = {})
+        opts = { namespace: endpoint_namespace(:dynamic), ttl: CACHE_HOUR }.merge(options)
+        api_request "#{base_url(:game_data)}/token/index", opts
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft character profile data
+    #
+    # @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.achievement
+    class CharacterProfile < Wow::Request
+      ##
+      # Return the mythic keystone profile of a character
+      #
+      # @note This endpoint requires a user token obtained through the user authorization flow
+      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @param user_token [String] A token obtained by the authorization flow. See link below.
+      # @param season [Integer] Season ID if you want only a specific season or nil to include all.
+      # @!macro request_options
+      #
+      # @!macro response
+      def get_keystone_profile(realm, character, user_token, season = nil, options = {})
+        url = "#{endpoint_uri(realm, character)}/mythic-keystone-profile"
+        url += "/season/#{season}" unless season.nil?
+        api_request url, default_options(user_token).merge(options)
+      end
+
+      ##
+      # Return the pvp summary of a character
+      #
+      # @note This endpoint requires a user token obtained through the user authorization flow
+      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @param user_token [String] A token obtained by the authorization flow. See link below.
+      # @!macro request_options
+      #
+      # @!macro response
+      def pvp_summmary(realm, character, user_token, options = {})
+        api_request "#{endpoint_uri(realm, character)}/pvp-summary", default_options(user_token).merge(options)
+      end
+
+      ##
+      # Return the pvp bracket of a character
+      #
+      # @note This endpoint requires a user token obtained through the user authorization flow
+      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @param bracket [String] Pvp bracket
+      # @param user_token [String] A token obtained by the authorization flow. See link below.
+      # @!macro request_options
+      #
+      # @!macro response
+      def pvp_bracket(realm, character, bracket, user_token, options = {})
+        api_request "#{endpoint_uri(realm, character)}/pvp-bracket/#{bracket}",
+                    default_options(user_token).merge(options)
+      end
+
+      private
+
+      def default_options(user_token)
+        { ttl: CACHE_HOUR, namespace: endpoint_namespace(:profile), access_token: user_token }
+      end
+
+      def endpoint_uri(realm, character)
+        "#{base_url(:profile)}/character/#{CGI.escape(realm)}/#{CGI.escape(character)}"
+      end
+    end
+  end
+end