blizzard_api 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c949d92a0d0319778a898e3e42f3d96b4a6e2328735cea5e04be4793411fd7f
-  data.tar.gz: 1878247e2dbe3f00dd97350c8335fb624100fa69d244c897a054812df2e7b295
+  metadata.gz: 8912dbf1d2428d658df1a48f5e24f4eda29a1bf40b6882851d899b35ebecd678
+  data.tar.gz: b97d376156394a7c529ab7ff42ec67227307141e9037ba015aaf9114636228ab
 SHA512:
-  metadata.gz: 9f3d4741c338306be140799708a739b56e907b5f740697db53175a1147ca897cb2457008e41ece15d4173eeba16ebf7aa5c3bb6b0a16c6243c5efb00f0075bc7
-  data.tar.gz: 48c7583dbc4a25200789f7ec4443670a9f0769f34ab035cf058fee3ae3a78b12234e95f2da476925bbd86621a8dde70ed57501a7c71c84969dbdb97de0bda80a
+  metadata.gz: 5592ee0340659d8c20e301b27f48b8f213b0b71df70b8024f5b8177ab89d22c1f1b080f5b55e22bb4ebe63c9c442cfe40c83ad4071b19e28ec92bc8cfedd15bc
+  data.tar.gz: fba6de77e9c6e60ed932dcdb53fecdc3a1003563f71681691b3015ab0af2dc03174ebe97e3f4b51db5f5af31d82a5f1f55d0fc3c1f125f1e89addda3405d2ec1

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 0.2.3**
+* Added new api endpoints listed here: https://us.battle.net/forums/en/bnet/topic/20772337044
+
 **Version 0.2.2**
 * Added new api endpoints listed here: https://us.battle.net/forums/en/bnet/topic/20771546990
 

data/Gemfile.lock

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

data/README.md

@@ -177,7 +177,18 @@ Most **data** endpoints will have always 3 methods available `index`, `get` and
   - index
   - get :id
   - complete
-
+* Blizzard::Wow::Title
+  - index
+  - get :id
+* Blizzard::Wow::Item
+  - get :id
+  - item_set :id
+  - classes
+  - class :id
+  - subclass :class_id, :subclass_id
+* Blizzard::Wow::AzeriteEssence
+  - index
+  - get :id
 
 * Blizzard::Wow::Auction
   - get :realm
@@ -195,9 +206,6 @@ Most **data** endpoints will have always 3 methods available `index`, `get` and
   - get :relam, :name, :fields
   - rewards
   - perks
-* Blizzard::Wow::Item
-  - get :id
-  - item_set :setId
 * Blizzard::Wow::PvP
   - get :bracket
 * Blizzard::Wow::Quest

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/lib/blizzard_api/wow.rb

@@ -27,6 +27,9 @@ module BlizzardApi
     require_relative 'wow/game_data/region'
     require_relative 'wow/game_data/wow_token'
     require_relative 'wow/game_data/race'
+    require_relative 'wow/game_data/title'
+    require_relative 'wow/game_data/item'
+    require_relative 'wow/game_data/azerite_essence'
 
     ##
     # @return {Achievement}
@@ -148,12 +151,29 @@ module BlizzardApi
       BlizzardApi::Wow::Race.new
     end
 
+    ##
+    # @return {Title}
+    def self.title
+      BlizzardApi::Wow::Title.new
+    end
+
+    ##
+    # @return {Item}
+    def self.item
+      BlizzardApi::Wow::Item.new
+    end
+
+    ##
+    # @return {AzeriteEssence}
+    def self.azerite_essence
+      BlizzardApi::Wow::AzeriteEssence.new
+    end
+
     # Wow community api
     require_relative 'wow/community/auction'
     require_relative 'wow/community/boss'
     require_relative 'wow/community/challenge'
     require_relative 'wow/community/character'
-    require_relative 'wow/community/item'
     require_relative 'wow/community/pvp'
     require_relative 'wow/community/quest'
     require_relative 'wow/community/recipe'
@@ -184,12 +204,6 @@ module BlizzardApi
       BlizzardApi::Wow::Character.new
     end
 
-    ##
-    # @return {Item}
-    def self.item
-      BlizzardApi::Wow::Item.new
-    end
-
     ##
     # @return {PvP}
     def self.pvp

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft azerite essences
+    #
+    # @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.azerite_essence
+    class AzeriteEssence < Wow::GenericDataEndpoint
+      protected
+
+      def endpoint_setup
+        @endpoint = 'azerite-essence'
+        @namespace = endpoint_namespace :static
+        @collection = 'azerite_essences'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft item data
+    #
+    # @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:
+    #   api_instance = BlizzardApi::Wow.item
+    class Item < Wow::GenericDataEndpoint
+      ##
+      # 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 a index method'
+      end
+
+      ##
+      # This method overrides the inherited default behavior to prevent high server load and fetch time
+      #
+      # @!macro response
+      def complete
+        raise BlizzardApi::ApiException, 'This endpoint does not have a complete method'
+      end
+
+      ##
+      # Return complete data of an item by id
+      #
+      # @param id [Integer] Item id
+      # @!macro request_options
+      # @option options [Boolean] :use_community_endpoint If set to true, this method will call the community endpoint
+      #   instead of the data endpoint https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
+      #
+      # @!macro response
+      def get(id, options = {})
+        return super id, options unless options.include? :use_community_endpoint
+
+        api_request "#{base_url(:community)}/item/#{id}", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return complete data of an item set by id
+      #
+      # @param set_id [Integer] Item set id
+      # @!macro request_options
+      #
+      # @!macro response
+      def item_set(set_id, options = {})
+        api_request "#{base_url(:community)}/item/set/#{set_id}", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return a list of item classes
+      #
+      # @!macro request_options
+      # @option options [Boolean] :use_community_endpoint If set to true, this method will call the community endpoint
+      #   instead of the data endpoint https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
+      #
+      # @!macro response
+      def classes(options = {})
+        if options.include? :use_community_endpoint
+          return api_request "#{base_url(:community)}/data/item/classes", { ttl: CACHE_TRIMESTER }.merge(options)
+        end
+
+        api_request "#{endpoint_uri('class')}/index", default_options.merge(options)
+      end
+
+      ##
+      # Return data about an item class
+      #
+      # @param id [Integer] Item class id
+      # @!macro request_options
+      #
+      # @!macro response
+      def class(id, options = {})
+        api_request "#{endpoint_uri('class')}/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Return all subclasses of a given class
+      #
+      # @param id [Integer] Item class id
+      # @param subclass_id [Integer] Item subclass id
+      # @!macro request_options
+      #
+      # @!macro response
+      def subclass(id, subclass_id, options = {})
+        api_request "#{endpoint_uri('class')}/#{id}/item-subclass/#{subclass_id}", default_options.merge(options)
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'item'
+        @namespace = endpoint_namespace :static
+        @collection = 'items'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft titles
+    #
+    # @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.title
+    class Title < Wow::GenericDataEndpoint
+      ##
+      # This method overrides the inherited default behavior to prevent high server load and fetch time
+      #
+      # @!macro response
+      def complete
+        raise BlizzardApi::ApiException, 'There are too many achievements to fetch complete data'
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'title'
+        @namespace = endpoint_namespace :static
+        @collection = 'titles'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Francis Schiavo
@@ -149,18 +149,19 @@ files:
 - lib/blizzard_api/wow/community/boss.rb
 - lib/blizzard_api/wow/community/challenge.rb
 - lib/blizzard_api/wow/community/character.rb
-- lib/blizzard_api/wow/community/item.rb
 - lib/blizzard_api/wow/community/pvp.rb
 - lib/blizzard_api/wow/community/quest.rb
 - lib/blizzard_api/wow/community/recipe.rb
 - lib/blizzard_api/wow/community/spell.rb
 - lib/blizzard_api/wow/community/zone.rb
 - lib/blizzard_api/wow/game_data/achievement.rb
+- lib/blizzard_api/wow/game_data/azerite_essence.rb
 - lib/blizzard_api/wow/game_data/connected_realm.rb
 - 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.rb
 - lib/blizzard_api/wow/game_data/guild_crest.rb
+- lib/blizzard_api/wow/game_data/item.rb
 - lib/blizzard_api/wow/game_data/mount.rb
 - lib/blizzard_api/wow/game_data/mythic_keystone.rb
 - lib/blizzard_api/wow/game_data/mythic_keystone_affix.rb
@@ -175,6 +176,7 @@ 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/title.rb
 - lib/blizzard_api/wow/game_data/wow_token.rb
 - lib/blizzard_api/wow/profile/character_profile.rb
 - lib/blizzard_api/wow/request.rb

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

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module BlizzardApi
-  module Wow
-    ##
-    # This class allows access to World of Warcraft item data
-    #
-    # @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:
-    #   api_instance = BlizzardApi::Wow.item
-    class Item < Wow::Request
-      ##
-      # Return complete data of an item by id
-      #
-      # @param id [Integer] Item id
-      # @!macro request_options
-      #
-      # @!macro response
-      def get(id, options = {})
-        api_request "#{base_url(:community)}/item/#{id}", { ttl: CACHE_TRIMESTER }.merge(options)
-      end
-
-      ##
-      # Return complete data of an item set by id
-      #
-      # @param set_id [Integer] Item set id
-      # @!macro request_options
-      #
-      # @!macro response
-      def item_set(set_id, options = {})
-        api_request "#{base_url(:community)}/item/set/#{set_id}", { ttl: CACHE_TRIMESTER }.merge(options)
-      end
-
-      ##
-      # Return a list of item classes
-      #
-      # @!macro request_options
-      #
-      # @!macro response
-      def classes(options = {})
-        api_request "#{base_url(:community)}/data/item/classes", { ttl: CACHE_TRIMESTER }.merge(options)
-      end
-    end
-  end
-end