blizzard_api 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d393f54b32beecd52103af873d07cc29fc6602a30cb2af5ede821c2a06a15082
-  data.tar.gz: 18f3bb7b4525010a81d8055f4e15a83d0e7ddf9cce4587874b08561e6fa0ae0e
+  metadata.gz: e053e270f32f8b4b3f5ef31dd081652ac643c2108ec2505a8ccd4684b392b233
+  data.tar.gz: 658b55408c9aff58ba82e9f425d737d577bcbb2eead1080fb8ccc654180be81e
 SHA512:
-  metadata.gz: 9ce54dbc13359589df640b0162c77877c6a9bdc161fb69d968981e8cad47df82326ecccb17fd98eaf1e57dcfee70db740bc23ec3b1b633e94dae03eb171303ac
-  data.tar.gz: f5fc106293d421250af06f785823a93f3bba6657bf078b00f46f77c8c7c25dd5fc50d4427a529e74aed16d927aba13c9ca2c2d0a848cbbfb81a2a49f0812b0e5
+  metadata.gz: 7b003416b1ce96f0312a4c05002940bdac6a8ee5f82c638cde5627a6bff5a3a4ebc616c4a242f2beb0e4004e7a5c5314b94db360673b33dc3e0c35eb1530d3c4
+  data.tar.gz: 67c2413bc2cbf9f3192aa7d8187e9b5ec67eb0699b2ca5f6f0ef6f92ce7589f6008eb4edc78d825c0bf0cdbae64fc8c58f450fd7f45914cdff7ae12b7ff29150

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 0.2.9**
+* Added new character endpoints:
+  * reputations
+  * hunter-pets
+  * collections
+  * pets
+  * mounts
+
+* Added new endpoints:
+  * reputation-tiers
+  * reputation-faction
+
+**Version 0.2.8**
+* Added the new character status endpoint
+
 **Version 0.2.7**
 * Changed CI process to use docker ruby images.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    blizzard_api (0.2.8)
+    blizzard_api (0.2.7)
       redis (~> 4.1, >= 4.1.0)
 
 GEM

data/README.md

@@ -195,6 +195,12 @@ Most **data** endpoints will have always 3 methods available `index`, `get` and
   - index
   - get :id
   - media :id
+* Blizzard::Wow::ReputationTier
+  - index
+  - get :id
+* Blizzard::Wow::ReputationFaction
+  - index
+  - get :id
 
 * Blizzard::Wow::Auction
   - get :realm
@@ -223,6 +229,7 @@ Most **data** endpoints will have always 3 methods available `index`, `get` and
 * BlizzardApi::Wow::CharacterProfile
   - get_user_characters :user_token
   - get :realm, :character, :fields
+  - status :realm, :character
   - pvp_summmary :realm, :character, :user_token
   - pvp_bracket :realm, :character, :bracket, :user_token
   - achievements :realm, :character
@@ -236,7 +243,11 @@ Most **data** endpoints will have always 3 methods available `index`, `get` and
   - titles :realm, :character
   - mythic_keystone_profile :realm, :character
   - mythic_keystone_seasons :realm, :character
-  - collections :realm, :character (Not active yet on Blizzard servers)
+  - collections :realm, :character
+  - pets :realm, :character
+  - mounts :realm, :character
+  - hunter_pets :realm, :character
+  - reputations :realm, :character
   - raid_progression :realm, :character (Not active yet on Blizzard servers)
 
 ### 4.2. Diablo III endpoints

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '0.2.8'
+  VERSION = '0.2.9'
 end

data/lib/blizzard_api/wow.rb

@@ -30,6 +30,8 @@ module BlizzardApi
     require_relative 'wow/game_data/title'
     require_relative 'wow/game_data/item'
     require_relative 'wow/game_data/azerite_essence'
+    require_relative 'wow/game_data/reputation_tier'
+    require_relative 'wow/game_data/reputation_faction'
 
     ##
     # @return {Achievement}
@@ -169,6 +171,18 @@ module BlizzardApi
       BlizzardApi::Wow::AzeriteEssence.new
     end
 
+    ##
+    # @return {ReputationTier}
+    def self.reputation_tier
+      BlizzardApi::Wow::ReputationTier.new
+    end
+
+    ##
+    # @return {ReputationFaction}
+    def self.reputation_faction
+      BlizzardApi::Wow::ReputationFaction.new
+    end
+
     # Wow community api
     require_relative 'wow/community/auction'
     require_relative 'wow/community/boss'

data/lib/blizzard_api/wow/community/auction.rb

@@ -5,6 +5,8 @@ module BlizzardApi
     ##
     # This class allows access to World of Warcraft auctions
     #
+    # @deprecated See https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-community-api-migration/767
+    #
     # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
     #
     # You can get an instance of this class using the default region as follows:

data/lib/blizzard_api/wow/community/boss.rb

@@ -7,6 +7,8 @@ module BlizzardApi
     #
     # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
     #
+    # @deprecated See https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-community-api-migration/767
+    #
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.boss
     class Boss < Wow::Request

data/lib/blizzard_api/wow/community/challenge.rb

@@ -7,6 +7,8 @@ module BlizzardApi
     #
     # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
     #
+    # @deprecated See https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-community-api-migration/767
+    #
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.challenge
     class Challenge < Wow::Request

data/lib/blizzard_api/wow/community/pvp.rb

@@ -7,6 +7,8 @@ module BlizzardApi
     #
     # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
     #
+    # @deprecated See https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-community-api-migration/767
+    #
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.pvp
     class PvP < Wow::Request

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

@@ -7,6 +7,8 @@ module BlizzardApi
     #
     # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
     #
+    # @deprecated See https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-community-api-migration/767
+    #
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.quest
     class Quest < Wow::Request

data/lib/blizzard_api/wow/community/recipe.rb

@@ -7,6 +7,8 @@ module BlizzardApi
     #
     # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
     #
+    # @deprecated See https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-community-api-migration/767
+    #
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.recipe
     class Recipe < Wow::Request

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

@@ -7,6 +7,8 @@ module BlizzardApi
     #
     # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
     #
+    # @deprecated See https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-community-api-migration/767
+    #
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.spell
     class Spell < Wow::Request

data/lib/blizzard_api/wow/community/zone.rb

@@ -7,6 +7,8 @@ module BlizzardApi
     #
     # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
     #
+    # @deprecated See https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-community-api-migration/767
+    #
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.zone
     class Zone < Wow::Request

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

@@ -3,7 +3,7 @@
 module BlizzardApi
   module Wow
     ##
-    # This class allows access to World of Warcraft achievements
+    # This class allows access to World of Warcraft creatures
     #
     # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
     #

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft reputation
+    #
+    # @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.creature
+    class ReputationFaction < Wow::GenericDataEndpoint
+      protected
+
+      def endpoint_setup
+        @endpoint = 'reputation-faction'
+        @namespace = :static
+        @collection = 'achievements'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft reputation
+    #
+    # @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.creature
+    class ReputationTier < Wow::GenericDataEndpoint
+      protected
+
+      def endpoint_setup
+        @endpoint = 'reputation-tiers'
+        @namespace = :static
+        @collection = 'achievements'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -12,25 +12,8 @@ module BlizzardApi
     class CharacterProfile < Wow::Request
       # Valid fields for character profile requests
       VALID_FIELDS = %w[
-        achievements
-        appearance
-        feed
-        guild
-        hunterPets
-        items
-        mounts
-        pets
-        petSlots
-        professions
-        progression
-        pvp
-        quests
-        reputation
-        statistics
-        stats
-        talents
-        titles
-        audit
+        achievements appearance feed guild hunterPets items mounts pets petSlots professions progression
+        pvp quests reputation statistics stats talents titles audit
       ].freeze
 
       ##
@@ -83,6 +66,21 @@ module BlizzardApi
         api_request "#{base_url(:community)}/character/#{CGI.escape(realm)}/#{CGI.escape(character)}", opts
       end
 
+      ##
+      # 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 status(realm, character, options = {})
+        character_request realm, character, options, 'status'
+      end
+
       ##
       # Return character achievements
       #
@@ -257,6 +255,62 @@ module BlizzardApi
         character_request realm, character, options, 'collections'
       end
 
+      ##
+      # Return a character's pet collection
+      #
+      # @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 pets(realm, character, options = {})
+        character_request realm, character, options, 'collections/pets'
+      end
+
+      ##
+      # Return a character's mount collection
+      #
+      # @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 mounts(realm, character, options = {})
+        character_request realm, character, options, 'collections/mounts'
+      end
+
+      ##
+      # Return a character's reputations
+      #
+      # @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 reputation(realm, character, options = {})
+        character_request realm, character, options, 'reputations'
+      end
+
+      ##
+      # Return a character's hunter pets
+      #
+      # @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 hunter_pets(realm, character, options = {})
+        character_request realm, character, options, 'hunter-pets'
+      end
+
       ##
       # Return a character's raid progression
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-01 00:00:00.000000000 Z
+date: 2019-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -153,6 +153,8 @@ files:
 - lib/blizzard_api/wow/game_data/race.rb
 - lib/blizzard_api/wow/game_data/realm.rb
 - lib/blizzard_api/wow/game_data/region.rb
+- lib/blizzard_api/wow/game_data/reputation_faction.rb
+- lib/blizzard_api/wow/game_data/reputation_tier.rb
 - lib/blizzard_api/wow/game_data/title.rb
 - lib/blizzard_api/wow/game_data/wow_token.rb
 - lib/blizzard_api/wow/profile/character_profile.rb