blizzard_api 3.3.0 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20cf33fde29710b0f5c1c24e5e2c7001c42a25997175def8f3e02ed7742a4b62
-  data.tar.gz: f95f37b65054229c5fa4091a53cbbd31c20a4901282c78e4b37e07dd24636b69
+  metadata.gz: 5c512afdd4603e21f9e0f69320bea3ee1217050c7529979453c4e5196ebae26d
+  data.tar.gz: 54bf6ae69b29b36b7522072c5feadfc47255184b1a2e00acae842373d7711917
 SHA512:
-  metadata.gz: d9cea099795510ba35524d15a4a77af940ba8bce410646f23b4ead61ba423b6c5567ad0804c3115fa523dc85da33d2643d87e980e4a4b4b59768c8ea45c91cc2
-  data.tar.gz: 68a150c0d4c39e86654087e6609e20809cb5971b0cdc2f26c9553ddb7089bb61ad30b33ce3661651cb7887e8d44c5445c75a0b0df3e277dc9ed74542d7626b6c
+  metadata.gz: 0e1bf5df8fb0171d4347b35ecf5f40441ddf430f30feb62b9d0f250fc88b14abbc6649ad150e6a2a5f8f49ae71129eeff0f394433a247fa7cb5a281c8ae120a1
+  data.tar.gz: befe1a4fb05362cd1f7cf67aa5d0d59ea14e1eb00d7455c2d7558322fe65a0c51e7339a5d9e9178aefacf654f45915e34034cbba8df53597ed8003df8e72dcd0

data/.github/workflows/ruby.yml

@@ -19,3 +19,4 @@ jobs:
           BNET_APPLICATION_ID: ${{ secrets.BNET_APPLICATION_ID }}
           BNET_APPLICATION_SECRET: ${{ secrets.BNET_APPLICATION_SECRET }}
           USE_CACHE: false
+          IGNORE_CLASSIC_TESTS: true

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 3.4.0**
+
+Added new collections endpoints for toys and heirlooms.
+
+**Version 3.2.0**
+
+Added new WoW Dragonflight talents endpoint.
+Added support for Overwatch League API
+
 **Version 3.2.0**
 
 Added new AH commodities endpoint.
@@ -257,4 +266,4 @@ https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-api-update-collec
 * Lots of improvements to WoW endpoints
 
 **Version 0.1.0**
-* Initial release
+* Initial release

data/Gemfile.lock

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

data/README.md

@@ -129,6 +129,7 @@ end
 * [BlizzardApi::Wow.covenant](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Covenant)
 * [BlizzardApi::Wow.creature](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Creature)
 * [BlizzardApi::Wow.guild_crest](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/GuildCrest)
+* [BlizzardApi::Wow.heirloom](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Heirloom)
 * [BlizzardApi::Wow.item](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Item)
 * [BlizzardApi::Wow.journal](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Journal)
 * [BlizzardApi::Wow.media](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Media)
@@ -154,6 +155,7 @@ end
 * [BlizzardApi::Wow.talent](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Talent)
 * [BlizzardApi::Wow.tech_talent](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/TechTalent)
 * [BlizzardApi::Wow.title](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Title)
+* [BlizzardApi::Wow.toy](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Toy)
 * [BlizzardApi::Wow.wow_token](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/WowToken)
 
 * [BlizzardApi::Wow.profile](https://rubydoc.info/gems/blizzard_api/BlizzardApi/Wow/Profile)

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '3.3.0'
+  VERSION = '3.4.1'
 end

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

@@ -15,7 +15,7 @@ module BlizzardApi
       setup 'creature', :static, CACHE_TRIMESTER
 
       def index
-        raise BlizzardApi::ApiException, 'Creatures endpoint doesn\'t have an index method'
+        raise BlizzardApi::ApiException, 'Creatures endpoint does not have an index method'
       end
 
       ##

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft heirloom 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.heirloom
+    class Heirloom < Wow::GenericDataEndpoint
+      setup 'heirloom', :static, CACHE_TRIMESTER
+    end
+  end
+end

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

@@ -33,6 +33,7 @@ module BlizzardApi
       def classes(**options)
         api_request "#{endpoint_uri('class')}/index", **default_options.merge(options)
       end
+      alias item_classes classes
 
       ##
       # Return data about an item class
@@ -60,6 +61,7 @@ module BlizzardApi
       def subclass(id, subclass_id, **options)
         api_request "#{endpoint_uri('class')}/#{id}/item-subclass/#{subclass_id}", **default_options.merge(options)
       end
+      alias item_subclass subclass
 
       ##
       # Fetch media for an item using its *id*

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

@@ -12,6 +12,10 @@ module BlizzardApi
     class ModifiedCrafting < Wow::GenericDataEndpoint
       setup 'modified-crafting', :static, CACHE_TRIMESTER
 
+      def get(_id, **_options)
+        raise BlizzardApi::ApiException, 'This endpoint does not have a get method'
+      end
+
       ##
       # Fetch modified crafting category index
       #

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

@@ -58,7 +58,7 @@ module BlizzardApi
 
       def resolve_icon(media_url)
         media_data = api_request(media_url)
-        media_data[:assets][0][:value]
+        media_data.dig(:assets, 0, :value)
       end
     end
   end

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

@@ -33,7 +33,20 @@ module BlizzardApi
       #
       # @!macro response
       def talent_tree(talent_tree_id, spec_id, **options)
-        api_request "#{base_url(:game_data)}/talent-tree/#{talent_tree_id}/playable-specialization/#{spec_id}", **default_options.merge(options)
+        api_request "#{base_url(:game_data)}/talent-tree/#{talent_tree_id}/playable-specialization/#{spec_id}",
+                    **default_options.merge(options)
+      end
+
+      ##
+      # Fetch a talent tree node
+      #
+      # @param talent_tree_id [Integer] talent tree id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def talent_tree_nodes(talent_tree_id, **options)
+        api_request "#{base_url(:game_data)}/talent-tree/#{talent_tree_id}", **default_options.merge(options)
       end
 
       ##

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft toys
+    #
+    # @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.toy
+    class Toy < Wow::GenericDataEndpoint
+      setup 'toy', :static, CACHE_TRIMESTER
+    end
+  end
+end

data/lib/blizzard_api/wow/profile/{profile.rb → account_profile.rb}

@@ -52,6 +52,26 @@ module BlizzardApi
         api_request "#{base_url(:user_profile)}/collections/mounts", **default_options.merge(options)
       end
 
+      ##
+      # Returns the toy collection index for the account
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def toys(**options)
+        api_request "#{base_url(:user_profile)}/collections/toys", **default_options.merge(options)
+      end
+
+      ##
+      # Returns the heirloom collection index for the account
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def heirloom(**options)
+        api_request "#{base_url(:user_profile)}/collections/heirloom", **default_options.merge(options)
+      end
+
       ##
       # Returns the pet collection index for the account
       #

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

@@ -110,6 +110,34 @@ module BlizzardApi
         character_request realm, character, 'collections/mounts', **options
       end
 
+      ##
+      # Return a character's toy 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 toys(realm, character, **options)
+        character_request realm, character, 'collections/toys', **options
+      end
+
+      ##
+      # Return a character's heirloom 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 heirlooms(realm, character, **options)
+        character_request realm, character, 'collections/heirlooms', **options
+      end
+
       ##
       # Return a character's encounter summary
       #

data/lib/blizzard_api/wow.rb

@@ -23,6 +23,7 @@ module BlizzardApi
     require_relative 'wow/game_data/covenant'
     require_relative 'wow/game_data/creature'
     require_relative 'wow/game_data/guild_crest'
+    require_relative 'wow/game_data/heirloom'
     require_relative 'wow/game_data/item'
     require_relative 'wow/game_data/journal'
     require_relative 'wow/game_data/media'
@@ -49,6 +50,7 @@ module BlizzardApi
     require_relative 'wow/game_data/talent'
     require_relative 'wow/game_data/tech_talent'
     require_relative 'wow/game_data/title'
+    require_relative 'wow/game_data/toy'
     require_relative 'wow/game_data/wow_token'
 
     ##
@@ -100,6 +102,13 @@ module BlizzardApi
       BlizzardApi::Wow::GuildCrest.new(**options)
     end
 
+    ##
+    # @!macro init_options
+    # @return {Heirloom}
+    def self.heirloom(**options)
+      BlizzardApi::Wow::Heirloom.new(**options)
+    end
+
     ##
     # @!macro init_options
     # @return {Item}
@@ -282,6 +291,13 @@ module BlizzardApi
       BlizzardApi::Wow::Title.new(**options)
     end
 
+    ##
+    # @!macro init_options
+    # @return {Toy}
+    def self.toy(**options)
+      BlizzardApi::Wow::Toy.new(**options)
+    end
+
     ##
     # @!macro init_options
     # @return {WowToken}
@@ -289,7 +305,7 @@ module BlizzardApi
       BlizzardApi::Wow::WowToken.new(**options)
     end
 
-    require_relative 'wow/profile/profile'
+    require_relative 'wow/profile/account_profile'
     require_relative 'wow/profile/guild'
     require_relative 'wow/profile/character_profile'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.1
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-29 00:00:00.000000000 Z
+date: 2023-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -170,6 +170,7 @@ files:
 - lib/blizzard_api/wow/game_data/creature.rb
 - lib/blizzard_api/wow/game_data/generic_data_endpoint.rb
 - lib/blizzard_api/wow/game_data/guild_crest.rb
+- lib/blizzard_api/wow/game_data/heirloom.rb
 - lib/blizzard_api/wow/game_data/item.rb
 - lib/blizzard_api/wow/game_data/journal.rb
 - lib/blizzard_api/wow/game_data/media.rb
@@ -196,10 +197,11 @@ files:
 - lib/blizzard_api/wow/game_data/talent.rb
 - lib/blizzard_api/wow/game_data/tech_talent.rb
 - lib/blizzard_api/wow/game_data/title.rb
+- lib/blizzard_api/wow/game_data/toy.rb
 - lib/blizzard_api/wow/game_data/wow_token.rb
+- lib/blizzard_api/wow/profile/account_profile.rb
 - lib/blizzard_api/wow/profile/character_profile.rb
 - lib/blizzard_api/wow/profile/guild.rb
-- lib/blizzard_api/wow/profile/profile.rb
 - lib/blizzard_api/wow/request.rb
 - lib/blizzard_api/wow/search/search_composer.rb
 - lib/blizzard_api/wow/search/search_request.rb