blizzard_api 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7001dfa4c7c5712eaf8b8e4cf4785006d000150148e6ba3757095b1ebac9a23
-  data.tar.gz: 300638e6cd003a6af590e0a9eeba272f2e2d3094417826ac494ec6fbef2ef1e0
+  metadata.gz: 25f4493d9dc72b6f70302dadcfb4679785684a62d29a532ea6cc8e3b0a73ad0e
+  data.tar.gz: '0298ac0da67ef8000f63f9f23d2ce79a6a5d4f853eb9863f720fb82720e238f3'
 SHA512:
-  metadata.gz: dee9b6a3b3de00e4bf077245393bf7bf9308e17806c4237ad7a9088ebcd560db229dff31b60ac31424aad1aaa6dca6a64ec865e9079c0c90cbe181f89cb61db7
-  data.tar.gz: 4c635e72548d627edcf101cd06451476ddd4e8fd988ce4685dbf8668e1d8c9db34801783236bdce4c3172f0e31acfe2710c550074f65d156367980100090fd19
+  metadata.gz: e5cf53cc39f5e09877da0ff4b86a3c50a624c9d7ccf3accc5ef96851f0d0763f5f188e8c4e80dfb272f1a0c45b16b71f147a9a8664506488005bdb986c169c30
+  data.tar.gz: 29d93824b97b4f606822f6b1f9d7a904090e5ac993269afee2b3073aa135ad1062dbd8a94dd3b08c937af52993474869d27ce715ec9a2158640ce2dee638c346

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 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

data/Gemfile.lock

@@ -10,16 +10,16 @@ GEM
     ast (2.4.2)
     dotenv (3.1.2)
     minitest (5.24.1)
-    parallel (1.25.1)
-    parser (3.3.4.0)
+    parallel (1.26.1)
+    parser (3.3.4.2)
       ast (~> 2.4.1)
       racc
-    racc (1.8.0)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
     redis (4.8.1)
     regexp_parser (2.9.2)
-    rexml (3.3.2)
+    rexml (3.3.4)
       strscan
     rubocop (0.93.1)
       parallel (~> 1.10)
@@ -30,7 +30,7 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.31.3)
+    rubocop-ast (1.32.0)
       parser (>= 3.3.1.0)
     rubocop-minitest (0.27.0)
       rubocop (>= 0.90, < 2.0)

data/lib/blizzard_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-24 00:00:00.000000000 Z
+date: 2024-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -175,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
@@ -232,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Unofficial Ruby client for Blizzard Entertainment API