blizzard_api 4.0.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79f824ffc1cb26dddb1fc23ae4c029930feaf2c16f2d9bdbed6bbd20b815e47e
-  data.tar.gz: 92271ac4aed4dd441dc9b43f74afae3794035b6fde44dd76651e9f4596868978
+  metadata.gz: 25f4493d9dc72b6f70302dadcfb4679785684a62d29a532ea6cc8e3b0a73ad0e
+  data.tar.gz: '0298ac0da67ef8000f63f9f23d2ce79a6a5d4f853eb9863f720fb82720e238f3'
 SHA512:
-  metadata.gz: 564512eb1d3bb2a0157b33783cf277d3f1f1ec30757972bd5c2a97485567b0f9287ad59f49f9fdc2f3ad042e342e2852d3a811620328853a10245d36a73a112c
-  data.tar.gz: dc87e72420e7be2f16861fb6b5ead8355fd66e7ae52f0151997440d838ca011d707ee2b7abfa2ba46bff8dd7d1d2760611fa6c3914ad014216323072719a9a1b
+  metadata.gz: e5cf53cc39f5e09877da0ff4b86a3c50a624c9d7ccf3accc5ef96851f0d0763f5f188e8c4e80dfb272f1a0c45b16b71f147a9a8664506488005bdb986c169c30
+  data.tar.gz: 29d93824b97b4f606822f6b1f9d7a904090e5ac993269afee2b3073aa135ad1062dbd8a94dd3b08c937af52993474869d27ce715ec9a2158640ce2dee638c346

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 4.2.0**
+
+Added new collections endpoints (https://us.forums.blizzard.com/en/blizzard/t/item-appearance-and-transmog-apis/51532)
+
+**Version 4.1.0**
+
+Removed the discontinued Overwatch League API
+
+Updated all dependencies to latest version
+
+Note: While this introduces a breaking change, I did not bump version to 5.x.x
+since the Overwatch League API was already broken.
+
 **Version 4.0.0**
 
 **Warning**: This version introduces breaking changes to the way the gem handles the Redis connection.

data/Gemfile.lock

@@ -1,25 +1,26 @@
 PATH
   remote: .
   specs:
-    blizzard_api (4.0.0)
+    blizzard_api (4.1.0)
       redis (~> 4.1, >= 4.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    dotenv (3.1.0)
-    minitest (5.22.3)
-    parallel (1.24.0)
-    parser (3.3.1.0)
+    dotenv (3.1.2)
+    minitest (5.24.1)
+    parallel (1.26.1)
+    parser (3.3.4.2)
       ast (~> 2.4.1)
       racc
-    racc (1.7.3)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
     redis (4.8.1)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
+    regexp_parser (2.9.2)
+    rexml (3.3.4)
+      strscan
     rubocop (0.93.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
@@ -29,11 +30,12 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
+    rubocop-ast (1.32.0)
+      parser (>= 3.3.1.0)
     rubocop-minitest (0.27.0)
       rubocop (>= 0.90, < 2.0)
     ruby-progressbar (1.13.0)
+    strscan (3.1.0)
     unicode-display_width (1.8.0)
     yard (0.9.36)
 
@@ -50,4 +52,4 @@ DEPENDENCIES
   yard (~> 0.9.36)
 
 BUNDLED WITH
-   2.5.4
+   2.4.22

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '4.0.0'
+  VERSION = '4.2.0'
 end

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

@@ -19,7 +19,7 @@ module BlizzardApi
       #
       # @!macro response
       def index
-        raise BlizzardApi::ApiException, 'This endpoint does not have a index method'
+        raise BlizzardApi::ApiException, 'This endpoint does not have an index method'
       end
 
       ##

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft item data
+    #
+    # @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.item_appearance
+    class ItemAppearance < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
+      setup 'item-appearance', :static, CACHE_TRIMESTER
+
+      ##
+      # This method overrides the inherited default behavior to prevent high server load and fetch time
+      #
+      # @!macro response
+      def index
+        raise BlizzardApi::ApiException, 'This endpoint does not have an index method'
+      end
+
+      ##
+      # Return a list of item appearance sets
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def sets(**options)
+        api_request "#{endpoint_uri}/set/index", **default_options.merge(options)
+      end
+
+      ##
+      # Return data about an item appearance set
+      #
+      # @param id [Integer] Item appearance set id
+      # @!macro request_options
+      #
+      # @!macro response
+      def set(id, **options)
+        api_request "#{endpoint_uri}/set/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Return a list of item appearance slots
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def slots(**options)
+        api_request "#{endpoint_uri}/slot/index", **default_options.merge(options)
+      end
+
+      ##
+      # Return data about an item appearance slot
+      #
+      # @param type [Integer] Item appearance slot type
+      # @!macro request_options
+      #
+      # @!macro response
+      def slot(type, **options)
+        api_request "#{endpoint_uri}/slot/#{type}", **default_options.merge(options)
+      end
+    end
+  end
+end

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

@@ -38,9 +38,10 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def collection(**options)
+      def collections(**options)
         api_request "#{base_url(:user_profile)}/collections", **default_options.merge(options)
       end
+      alias collection collections
 
       ##
       # Returns the mount collection index for the account
@@ -82,6 +83,16 @@ module BlizzardApi
         api_request "#{base_url(:user_profile)}/collections/pets", **default_options.merge(options)
       end
 
+      ##
+      # Returns the transmogs collection index for the account
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def transmogs(**options)
+        api_request "#{base_url(:user_profile)}/collections/transmogs", **default_options.merge(options)
+      end
+
       protected
 
       def default_options

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

@@ -397,6 +397,20 @@ module BlizzardApi
         character_request realm, character, 'titles', **options
       end
 
+      ##
+      # Return a character's transmogs
+      #
+      # @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 transmogs(realm, character, **options)
+        character_request realm, character, 'transmogs', **options
+      end
+
       private
 
       def default_options(user_token = nil)

data/lib/blizzard_api/wow.rb

@@ -25,6 +25,7 @@ module BlizzardApi
     require_relative 'wow/game_data/guild_crest'
     require_relative 'wow/game_data/heirloom'
     require_relative 'wow/game_data/item'
+    require_relative 'wow/game_data/item_appearance'
     require_relative 'wow/game_data/journal'
     require_relative 'wow/game_data/media'
     require_relative 'wow/game_data/modified_crafting'
@@ -116,6 +117,13 @@ module BlizzardApi
       BlizzardApi::Wow::Item.new(**options)
     end
 
+    ##
+    # @!macro init_options
+    # @return {Item}
+    def self.item_appearance(**options)
+      BlizzardApi::Wow::ItemAppearance.new(**options)
+    end
+
     ##
     # @!macro init_options
     # @return {Journal}

data/lib/blizzard_api.rb

@@ -11,7 +11,6 @@ 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: 4.0.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -154,13 +154,6 @@ 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
@@ -182,6 +175,7 @@ files:
 - 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/item_appearance.rb
 - lib/blizzard_api/wow/game_data/journal.rb
 - lib/blizzard_api/wow/game_data/media.rb
 - lib/blizzard_api/wow/game_data/modified_crafting.rb

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

@@ -1,22 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,15 +0,0 @@
-# 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

@@ -1,50 +0,0 @@
-# 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