blizzard_api_rb_rb 3.4.2

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

@@ -0,0 +1,30 @@
+# 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
+      include BlizzardApi::Wow::Searchable
+
+      setup 'azerite-essence', :static, CACHE_TRIMESTER
+
+      ##
+      # Fetch media for one of the azerite essences listed by the {#index} using its *id*
+      #
+      # @param id [Integer] Azerite essence id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, **options)
+        api_request "#{base_url(:media)}/azerite-essence/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/wow/game_data/connected_realm.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft connected realms
+    #
+    # @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.connected_realm
+    class ConnectedRealm < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
+      setup 'connected-realm', :dynamic, CACHE_TRIMESTER
+    end
+  end
+end

data/lib/blizzard_api_rb/wow/game_data/covenant.rb

@@ -0,0 +1,72 @@
+# 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 Covenant < Wow::GenericDataEndpoint
+      setup 'covenant', :static, CACHE_TRIMESTER
+
+      ##
+      # Fetch media for one of the covenants listed by the {#index} using its *id*
+      #
+      # @param id [Integer] Covenant id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, **options)
+        api_request "#{base_url(:media)}/covenant/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch all soulbinds
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def soulbinds(**options)
+        api_request "#{base_url(:game_data)}/covenant/soulbind/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch a soulbind by its id
+      #
+      # @param id Soulbind id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def soulbind(id, **options)
+        api_request "#{base_url(:game_data)}/covenant/soulbind/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch all conduits
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def conduits(**options)
+        api_request "#{base_url(:game_data)}/covenant/conduit/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch a conduit by its id
+      #
+      # @param id Conduit id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def conduit(id, **options)
+        api_request "#{base_url(:game_data)}/covenant/conduit/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft creatures
+    #
+    # @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.creature
+    class Creature < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
+      setup 'creature', :static, CACHE_TRIMESTER
+
+      def index
+        raise BlizzardApi::ApiException, 'Creatures endpoint does not have an index method'
+      end
+
+      ##
+      # Fetch all creature families
+      #
+      # @!macro request_options
+      # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      def families(**options)
+        api_request "#{endpoint_uri('family')}/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch all possible data for one of the items listed by the {#families} using its *id*
+      #
+      # @param id [Integer] Creature family id
+      #
+      # @!macro request_options
+      # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      def family(id, **options)
+        api_request "#{endpoint_uri('family')}/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch media for one of the items listed by the {#families} using its *id*
+      #
+      # @param id [Integer] Creature family id
+      #
+      # @!macro request_options
+      # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      def family_media(id, **options)
+        api_request "#{base_url(:media)}/creature-family/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch all creature types
+      #
+      # @!macro request_options
+      # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      def types(**options)
+        api_request "#{endpoint_uri('type')}/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch all possible data for one of the items listed by the {#types} using its *id*
+      #
+      # @param id [Integer] Creature type id
+      #
+      # @!macro request_options
+      # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      def type(id, **options)
+        api_request "#{endpoint_uri('type')}/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch media for one of the items listed by the {#types} using its *id*
+      #
+      # @param id [Integer] Creature type id
+      #
+      # @!macro request_options
+      # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      def display_media(id, **options)
+        api_request "#{base_url(:media)}/creature-display/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/wow/game_data/generic_data_endpoint.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # Generic endpoint to support most data requests with minor configurations
+    class GenericDataEndpoint < Wow::Request
+      class << self
+        attr_accessor :endpoint, :namespace, :ttl
+
+        def setup(endpoint, namespace, ttl)
+          self.endpoint = endpoint
+          self.namespace = namespace
+          self.ttl = ttl
+        end
+      end
+
+      ##
+      # Fetch a list of all resources available for this endpoint
+      #
+      # @!macro request_options
+      # @!macro response
+      def index(**options)
+        api_request "#{endpoint_uri}/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch all possible data for one of the items listed by the {#index} using its *id*
+      #
+      # @param id [Integer] One of the IDs returned by the {#index}
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(id, **options)
+        api_request "#{endpoint_uri}/#{id}", **default_options.merge(options)
+      end
+
+      protected
+
+      def endpoint_uri(variant = nil, scope = :game_data)
+        endpoint = variant ? "#{self.class.endpoint}-#{variant}" : self.class.endpoint
+        "#{base_url(scope)}/#{endpoint}"
+      end
+
+      def default_options
+        { namespace: self.class.namespace, ttl: self.class.ttl }
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/wow/game_data/guild_crest.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft guild crest 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.guild_crest
+    class GuildCrest < Wow::GenericDataEndpoint
+      setup 'guild-crest', :static, CACHE_TRIMESTER
+
+      def get
+        raise BlizzardApi::ApiException, 'This endpoint does not have a get method'
+      end
+
+      ##
+      # Return guild border assets by its id
+      #
+      # @param id [Integer] Border id
+      #
+      # @!macro request_options
+      # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      def border_media(id, **options)
+        api_request "#{base_url(:media)}/#{self.class.endpoint}/border/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Return guild embelm assets by its id
+      #
+      # @param id [Integer] Emblem id
+      # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def emblem_media(id, **options)
+        api_request "#{base_url(:media)}/#{self.class.endpoint}/emblem/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/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_rb/wow/game_data/item.rb

@@ -0,0 +1,102 @@
+# 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
+    class Item < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
+      setup 'item', :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 a index method'
+      end
+
+      ##
+      # Return a list of item classes
+      #
+      # @!macro request_options
+      # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      def classes(**options)
+        api_request "#{endpoint_uri('class')}/index", **default_options.merge(options)
+      end
+      alias item_classes classes
+
+      ##
+      # Return data about an item class
+      #
+      # @param id [Integer] Item class id
+      # @!macro request_options
+      # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      def item_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
+      # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      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*
+      #
+      # @param id [Integer] Item id
+      #
+      # @!macro request_options
+      # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
+      #
+      # @!macro response
+      def media(id, **options)
+        api_request "#{base_url(:media)}/item/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Return a list of item 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 set
+      #
+      # @param id [Integer] Item set id
+      # @!macro request_options
+      #
+      # @!macro response
+      def set(id, **options)
+        api_request "#{endpoint_uri('set')}/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/wow/game_data/journal.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft journal 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.journal
+    class Journal < Wow::GenericDataEndpoint
+      setup 'journal', :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 a index method'
+      end
+
+      ##
+      # This method overrides the inherited default behavior to prevent high server load and fetch time
+      #
+      # @!macro response
+      def get(_id)
+        raise BlizzardApi::ApiException, 'This endpoint does not have a get method'
+      end
+
+      ##
+      # Return a list of expansion journal entries
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def expansions(**options)
+        api_request "#{endpoint_uri('expansion')}/index", **default_options.merge(options)
+      end
+
+      ##
+      # Return data about an expansion journal entry
+      #
+      # @param id [Integer] Journal entry id
+      # @!macro request_options
+      #
+      # @!macro response
+      def expansion(id, **options)
+        api_request "#{endpoint_uri('expansion')}/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Return a list of instance journal entries
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def instances(**options)
+        api_request "#{endpoint_uri('instance')}/index", **default_options.merge(options)
+      end
+
+      ##
+      # Return data about an instance journal entry
+      #
+      # @param id [Integer] Journal entry id
+      # @!macro request_options
+      #
+      # @!macro response
+      def instance(id, **options)
+        api_request "#{endpoint_uri('instance')}/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Return a list of encounter journal entries
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def encounters(**options)
+        api_request "#{endpoint_uri('encounter')}/index", **default_options.merge(options)
+      end
+
+      ##
+      # Return data about an encounter journal entry
+      #
+      # @param id [Integer] Journal entry id
+      # @!macro request_options
+      #
+      # @!macro response
+      def encounter(id, **options)
+        api_request "#{endpoint_uri('encounter')}/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch data base on search criteria
+      #
+      # @param page [Integer] Page o return
+      # @param page_size [Integer] Amount of items per page
+      #
+      # @!macro request_options
+      # @!macro response
+      def encounter_search(page = 1, page_size = 100, **options)
+        search_options = SearchComposer.new(page, page_size)
+        yield search_options if block_given?
+
+        api_request "#{endpoint_uri('encounter', :search)}?#{search_options.to_search_query}", **default_options.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/wow/game_data/media.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft mounts
+    #
+    # @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.mount
+    class Media < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
+      setup 'media', :static, CACHE_TRIMESTER
+
+      def index(_options = nil)
+        raise BlizzardApi::ApiException, 'This endpoint does not have a index method'
+      end
+
+      def get(_options = nil)
+        raise BlizzardApi::ApiException, 'This endpoint does not have a get method'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft professions
+    #
+    # @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.modified_crafting
+    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
+      #
+      # @!macro request_options
+      def categories(**options)
+        api_request "#{base_url(:game_data)}/modified-crafting/category/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch a modified crafting category
+      #
+      # @param id [Integer] Modified crafting category id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def category(id, **options)
+        api_request "#{base_url(:game_data)}/modified-crafting/category/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch modified crafting slot type index
+      #
+      # @!macro request_options
+      def slot_types(**options)
+        api_request "#{base_url(:game_data)}/modified-crafting/reagent-slot-type/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch a modified crafting slot type
+      #
+      # @param id [Integer] Modified crafting slot type id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def slot_type(id, **options)
+        api_request "#{base_url(:game_data)}/modified-crafting/reagent-slot-type/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/wow/game_data/mount.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft mounts
+    #
+    # @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.mount
+    class Mount < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
+      setup 'mount', :static, CACHE_TRIMESTER
+    end
+  end
+end