blizzard_api 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b9d57b5dea588a84d7b4d4a66f9885e42b66f3fc6e0be13eebca4b90fab564c
-  data.tar.gz: 9b97294d3acaeb1525cd5844519ba2a77e088975bf542184d6933d48123730c6
+  metadata.gz: d5c188bb1adcbec831c3a8873ab78c3eca668047fb2dd299211c6b2d07d6cea3
+  data.tar.gz: 125c0e5fcc66e7650d3b7c9f888d89944310f06744ef91da3e01cbd09fce9a03
 SHA512:
-  metadata.gz: db17c607f96ae46eebda6cfc550f297bd371898768a1b50da531818855d591baf7e5f0f76a63a2786d95f2010d9e3cc41977f7e8e35ef4b86db30ee2ecd1c26b
-  data.tar.gz: eaba5b7b425e781608a36cc9258085fc98f2da4268710ffa2b4c8c324ec129ac087327d94c33749840e6bac67fa81d24af58ad2d4ac8d504c8997ad4cad8dbf4
+  metadata.gz: 1957b2cec5bd8be947f733945ea95732e07d8e4c9e6d97efec979f9998c09eb997322c33b64f6fd0a9b30ba1e84ce68419886b9f28c03fbcdee4373af05eb092
+  data.tar.gz: 4f34f1c74ffcab76aa80e8bf63e537c093c7a457ce5ca9ea0749b9e4665163ff2c3da50b2fb7b48ed87511f4fe2e00661cddc6152d85515c7d0f38e1b7a0465b

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 0.3.3**
+
+Added character profile encounter endpoints:
+https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-api-patch-notes-20200226/3713
+
+Added missing media endpoints for `playable_class`, `playable_specialization` and `mythic_keystone_affix`
+
 **Version 0.3.2**
 
 Added new WoW endpoints: https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-api-update-visions-of-nzoth/3461

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

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

@@ -10,6 +10,19 @@ module BlizzardApi
     # 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
+
+      ##
+      # 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
+
       protected
 
       def endpoint_setup

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

@@ -51,6 +51,18 @@ module BlizzardApi
         data
       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
+
       protected
 
       def endpoint_setup

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

@@ -20,6 +20,18 @@ module BlizzardApi
         response_data
       end
 
+      ##
+      # 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
+
       protected
 
       def endpoint_setup

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

@@ -40,22 +40,21 @@ module BlizzardApi
       end
 
       ##
-      # Return character status
+      # Return character achievements
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
-      # @see https://us.forums.blizzard.com/en/blizzard/t/data-protection-notice-and-faq/609
       #
       # @param realm [String] The character realm's slug
       # @param character [String] The character name
       # @!macro request_options
       #
       # @!macro response
-      def status(realm, character, options = {})
-        character_request realm, character, options, 'status'
+      def achievements(realm, character, options = {})
+        character_request realm, character, options, 'achievements'
       end
 
       ##
-      # Return character achievements
+      # Return character achievements statistics
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
@@ -64,12 +63,12 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def achievements(realm, character, options = {})
-        character_request realm, character, options, 'achievements'
+      def achievement_statistics(realm, character, options = {})
+        character_request realm, character, options, 'achievements/statistics'
       end
 
       ##
-      # Return character achievements statistics
+      # Return character appearance
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
@@ -78,12 +77,12 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def achievement_statistics(realm, character, options = {})
-        character_request realm, character, options, 'achievements/statistics'
+      def appearance(realm, character, options = {})
+        character_request realm, character, options, 'appearance'
       end
 
       ##
-      # Return character appearance
+      # Return a character's collections
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
@@ -92,12 +91,12 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def appearance(realm, character, options = {})
-        character_request realm, character, options, 'appearance'
+      def collections(realm, character, options = {})
+        character_request realm, character, options, 'collections'
       end
 
       ##
-      # Return character equipment
+      # Return a character's pet collection
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
@@ -106,12 +105,12 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def equipment(realm, character, options = {})
-        character_request realm, character, options, 'equipment'
+      def pets(realm, character, options = {})
+        character_request realm, character, options, 'collections/pets'
       end
 
       ##
-      # Return character media
+      # Return a character's mount collection
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
@@ -120,27 +119,26 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def media(realm, character, options = {})
-        character_request realm, character, options, 'character-media'
+      def mounts(realm, character, options = {})
+        character_request realm, character, options, 'collections/mounts'
       end
 
       ##
-      # Return the pvp bracket of a character
+      # Return a character's encounter summary
       #
       # @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
-      # @param bracket [String] Pvp bracket
       # @!macro request_options
       #
       # @!macro response
-      def pvp_bracket(realm, character, bracket, options = {})
-        character_request realm, character, options, "pvp-bracket/#{bracket}"
+      def encounters(realm, character, options = {})
+        character_request realm, character, options, 'encounters'
       end
 
       ##
-      # Return the pvp summary of a character
+      # Return a character's dungeon progress
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
@@ -149,12 +147,12 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def pvp_summary(realm, character, options = {})
-        character_request realm, character, options, 'pvp-summary'
+      def dungeons(realm, character, options = {})
+        character_request realm, character, options, 'encounters/dungeons'
       end
 
       ##
-      # Return a character's quests
+      # Return a character's raid progress
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
@@ -163,14 +161,12 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def quests(realm, character, completed = false, options = {})
-        return character_request realm, character, options, 'quests/completed' if completed
-
-        character_request realm, character, options, 'quests'
+      def raids(realm, character, options = {})
+        character_request realm, character, options, 'encounters/raids'
       end
 
       ##
-      # Return a character's specialization
+      # Return character equipment
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
@@ -179,12 +175,12 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def specializations(realm, character, options = {})
-        character_request realm, character, options, 'specializations'
+      def equipment(realm, character, options = {})
+        character_request realm, character, options, 'equipment'
       end
 
       ##
-      # Return a character's statistics
+      # Return a character's hunter pets
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
@@ -193,12 +189,12 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def statistics(realm, character, options = {})
-        character_request realm, character, options, 'statistics'
+      def hunter_pets(realm, character, options = {})
+        character_request realm, character, options, 'hunter-pets'
       end
 
       ##
-      # Return a character's titles
+      # Return character media
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
@@ -207,8 +203,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def titles(realm, character, options = {})
-        character_request realm, character, options, 'titles'
+      def media(realm, character, options = {})
+        character_request realm, character, options, 'character-media'
       end
 
       ##
@@ -241,35 +237,37 @@ module BlizzardApi
       end
 
       ##
-      # Return a character's collections
+      # Return character status
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      # @see https://us.forums.blizzard.com/en/blizzard/t/data-protection-notice-and-faq/609
       #
       # @param realm [String] The character realm's slug
       # @param character [String] The character name
       # @!macro request_options
       #
       # @!macro response
-      def collections(realm, character, options = {})
-        character_request realm, character, options, 'collections'
+      def status(realm, character, options = {})
+        character_request realm, character, options, 'status'
       end
 
       ##
-      # Return a character's pet collection
+      # Return the pvp bracket of a character
       #
       # @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
+      # @param bracket [String] Pvp bracket
       # @!macro request_options
       #
       # @!macro response
-      def pets(realm, character, options = {})
-        character_request realm, character, options, 'collections/pets'
+      def pvp_bracket(realm, character, bracket, options = {})
+        character_request realm, character, options, "pvp-bracket/#{bracket}"
       end
 
       ##
-      # Return a character's mount collection
+      # Return the pvp summary of a character
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
@@ -278,8 +276,24 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def mounts(realm, character, options = {})
-        character_request realm, character, options, 'collections/mounts'
+      def pvp_summary(realm, character, options = {})
+        character_request realm, character, options, 'pvp-summary'
+      end
+
+      ##
+      # Return a character's quests
+      #
+      # @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 quests(realm, character, completed = false, options = {})
+        return character_request realm, character, options, 'quests/completed' if completed
+
+        character_request realm, character, options, 'quests'
       end
 
       ##
@@ -297,7 +311,7 @@ module BlizzardApi
       end
 
       ##
-      # Return a character's hunter pets
+      # Return a character's specialization
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
@@ -306,12 +320,12 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def hunter_pets(realm, character, options = {})
-        character_request realm, character, options, 'hunter-pets'
+      def specializations(realm, character, options = {})
+        character_request realm, character, options, 'specializations'
       end
 
       ##
-      # Return a character's raid progression
+      # Return a character's statistics
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
@@ -320,8 +334,22 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def raid_progression(realm, character, options = {})
-        character_request realm, character, options, 'raid-progression'
+      def statistics(realm, character, options = {})
+        character_request realm, character, options, 'statistics'
+      end
+
+      ##
+      # Return a character's titles
+      #
+      # @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 titles(realm, character, options = {})
+        character_request realm, character, options, 'titles'
       end
 
       private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-29 00:00:00.000000000 Z
+date: 2020-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis