blizzard_api 3.2.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba8374332ff5b57727b9b5528294f71c723b617fc863672f2cc1673c8a1f1537
-  data.tar.gz: 29b16eee7787cfc7a5e53d3274a829b49db727ca106e9e1f53a0867a1a81b188
+  metadata.gz: 3a312449c62a1d6f9f0905e1b13009ec8f6f9c0153e843ceccff71ce20572dd2
+  data.tar.gz: 3917df7bb6af320e2ce5cdd41e0f5309b43550a4f032a8d3e09be984f3fd9351
 SHA512:
-  metadata.gz: e2f2dfff1fed002b4ee9ac408a59a675d175c0effbc04fd39d3aac55b29802cc5db9d9d563528b2349724111191f7d0eddd15f696c2c67399a3df05875ffa6d5
-  data.tar.gz: 335ccfcdebdcfc92c345c11a0da1330092fdc55a5cc0a7927a4099ae37f838673a1b2ad6fbd29b9aa0b05f9274049d8e38a653379054cecb29259af2b395290c
+  metadata.gz: 1b5a43dc799bdfcf902da78605b5d3308f651910d1cd01d6819648087235a1f4f4f65def824f192bd0a0d1efc13baad42d6ce20c753edfa0977263b352b937c7
+  data.tar.gz: b7c9a62af171bb7748d8d09325cdb1b38c377b1404dbcbdcda9280cee3c4418c1b1ed1b3aabc25df43d97d0e431322490821e13f101ca75d3a0623a1118f72ff

data/.github/workflows/ruby.yml

@@ -8,9 +8,9 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby
-        uses: ruby/setup-ruby@21351ecc0a7c196081abca5dc55b08f085efe09a
+        uses: ruby/setup-ruby@359bebbc29cbe6c87da6bc9ea3bc930432750108
         with:
-          ruby-version: 3.0.0-preview1
+          ruby-version: 3.1
       - name: Install dependencies
         run: bundle install
       - name: Run tests
@@ -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,22 +1,22 @@
 PATH
   remote: .
   specs:
-    blizzard_api (3.1.0)
+    blizzard_api (3.4.0)
       redis (~> 4.1, >= 4.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    dotenv (2.7.6)
-    minitest (5.15.0)
-    parallel (1.21.0)
-    parser (3.0.3.2)
+    dotenv (2.8.1)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    redis (4.5.1)
-    regexp_parser (2.2.0)
+    redis (4.8.0)
+    regexp_parser (2.6.1)
     rexml (3.2.5)
     rubocop (0.93.1)
       parallel (~> 1.10)
@@ -27,12 +27,12 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     unicode-display_width (1.8.0)
     webrick (1.7.0)
-    yard (0.9.27)
+    yard (0.9.28)
       webrick (~> 1.7.0)
 
 PLATFORMS

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/overwatch_league/community/matches.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module OverwatchLeague
+    ##
+    # This class allows access to OWL2 match data
+    #
+    # @see https://develop.battle.net/documentation/owl/community-apis
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::OverwatchLeague.matches
+    class Matches < OverwatchLeague::Request
+      ##
+      # Returns match information
+      #
+      # @!macro request_options
+      def get(match_id, **options)
+        api_request "#{base_url(:community)}/v1/matches/#{match_id}", **{ ttl: CACHE_DAY }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api/overwatch_league/community/players.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module OverwatchLeague
+    ##
+    # This class allows access to OWL2 player data
+    #
+    # @see https://develop.battle.net/documentation/owl/community-apis
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::OverwatchLeague.players
+    class Players < OverwatchLeague::Request
+      ##
+      # Returns player information
+      #
+      # @!macro request_options
+      def get(player_id, **options)
+        api_request "#{base_url(:community)}/v1/players/#{player_id}", **{ ttl: CACHE_DAY }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api/overwatch_league/community/segments.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module OverwatchLeague
+    ##
+    # This class allows access to OWL2 segment data
+    #
+    # @see https://develop.battle.net/documentation/owl/community-apis
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::OverwatchLeague.segments
+    class Segments < OverwatchLeague::Request
+      ##
+      # Returns segment information
+      #
+      # @!macro request_options
+      def get(segment_id, **options)
+        api_request "#{base_url(:community)}/v1/segments/#{segment_id}", **{ ttl: CACHE_DAY }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api/overwatch_league/community/summary.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module OverwatchLeague
+    ##
+    # This class allows access to OWL2 summary data
+    #
+    # @see https://develop.battle.net/documentation/owl/community-apis
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::OverwatchLeague.summary
+    class Summary < OverwatchLeague::Request
+      ##
+      # Returns summary information
+      #
+      # @!macro request_options
+      def get(**options)
+        api_request "#{base_url(:community)}/v1/owl2", **{ ttl: CACHE_DAY }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api/overwatch_league/community/teams.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module OverwatchLeague
+    ##
+    # This class allows access to OWL2 team data
+    #
+    # @see https://develop.battle.net/documentation/owl/community-apis
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::OverwatchLeague.teams
+    class Teams < OverwatchLeague::Request
+      ##
+      # Returns team information
+      #
+      # @!macro request_options
+      def get(team_id, **options)
+        api_request "#{base_url(:community)}/v1/teams/#{team_id}", **{ ttl: CACHE_DAY }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api/overwatch_league/request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module OverwatchLeague
+    # Overwatch League requests
+    class Request < BlizzardApi::Request
+      ##
+      # @!macro init_options
+      def initialize(**options)
+        super(**options)
+        @game = 'owl'
+      end
+    end
+  end
+end

data/lib/blizzard_api/overwatch_league.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  # Overwatch League related classes
+  module OverwatchLeague
+    require_relative 'overwatch_league/request'
+
+    # Overwatch League community api
+    require_relative 'overwatch_league/community/summary'
+    require_relative 'overwatch_league/community/players'
+    require_relative 'overwatch_league/community/matches'
+    require_relative 'overwatch_league/community/segments'
+    require_relative 'overwatch_league/community/teams'
+
+    ##
+    # @!macro init_options
+    # @return {Summary}
+    def self.summary(**options)
+      BlizzardApi::OverwatchLeague::Summary.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Players}
+    def self.players(**options)
+      BlizzardApi::OverwatchLeague::Players.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Matches}
+    def self.matches(**options)
+      BlizzardApi::OverwatchLeague::Matches.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Segments}
+    def self.segments(**options)
+      BlizzardApi::OverwatchLeague::Segments.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Teams}
+    def self.teams(**options)
+      BlizzardApi::OverwatchLeague::Teams.new(**options)
+    end
+  end
+end

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '3.2.0'
+  VERSION = '3.4.0'
 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

@@ -12,6 +12,43 @@ module BlizzardApi
     class Talent < Wow::GenericDataEndpoint
       setup 'talent', :static, CACHE_TRIMESTER
 
+      ##
+      # Fetch talent trees
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def talent_trees(**options)
+        api_request "#{base_url(:game_data)}/talent-tree/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch a talent tree
+      #
+      # @param talent_tree_id [Integer] talent tree id
+      #
+      # @param spec_id [Integer] playable specialization id
+      #
+      # @!macro request_options
+      #
+      # @!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)
+      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
+
       ##
       # Fetch pvp talents
       #
@@ -23,7 +60,7 @@ module BlizzardApi
       end
 
       ##
-      # Fetch pvp a talent
+      # Fetch a pvp talent
       #
       # @param id [Integer] Pvp talent id
       #

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.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}

data/lib/blizzard_api.rb

@@ -11,6 +11,7 @@ require_relative 'blizzard_api/wow'
 require_relative 'blizzard_api/diablo'
 require_relative 'blizzard_api/hearthstone'
 require_relative 'blizzard_api/starcraft'
+require_relative 'blizzard_api/overwatch_league'
 
 # Blizzard namespace
 module BlizzardApi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-18 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -144,6 +144,13 @@ files:
 - lib/blizzard_api/hearthstone/game_data/generic_data_endpoint.rb
 - lib/blizzard_api/hearthstone/game_data/metadata.rb
 - lib/blizzard_api/hearthstone/request.rb
+- lib/blizzard_api/overwatch_league.rb
+- lib/blizzard_api/overwatch_league/community/matches.rb
+- lib/blizzard_api/overwatch_league/community/players.rb
+- lib/blizzard_api/overwatch_league/community/segments.rb
+- lib/blizzard_api/overwatch_league/community/summary.rb
+- lib/blizzard_api/overwatch_league/community/teams.rb
+- lib/blizzard_api/overwatch_league/request.rb
 - lib/blizzard_api/request.rb
 - lib/blizzard_api/starcraft.rb
 - lib/blizzard_api/starcraft/community/account.rb
@@ -163,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
@@ -189,6 +197,7 @@ 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/character_profile.rb
 - lib/blizzard_api/wow/profile/guild.rb
@@ -221,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Unofficial Ruby client for Blizzard Entertainment API