blizzard_api_rb_rb 3.4.2

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft quest 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.quest
+    class Quest < Wow::GenericDataEndpoint
+      setup 'quest', :static, CACHE_TRIMESTER
+
+      ##
+      # Return a list of quest categories
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def categories(**options)
+        api_request "#{endpoint_uri}/category/index", **default_options.merge(options)
+      end
+
+      ##
+      # Return data about a quest category
+      #
+      # @param id [Integer] Quest category id
+      # @!macro request_options
+      #
+      # @!macro response
+      def category(id, **options)
+        api_request "#{endpoint_uri}/category/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Return a list of quest areas
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def areas(**options)
+        api_request "#{endpoint_uri}/area/index", **default_options.merge(options)
+      end
+
+      ##
+      # Return data about a quest area
+      #
+      # @param id [Integer] Quest category id
+      # @!macro request_options
+      #
+      # @!macro response
+      def area(id, **options)
+        api_request "#{endpoint_uri}/area/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Return a list of quest types
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def types(**options)
+        api_request "#{endpoint_uri}/type/index", **default_options.merge(options)
+      end
+
+      ##
+      # Return data about a quest type
+      #
+      # @param id [Integer] Quest type
+      # @!macro request_options
+      #
+      # @!macro response
+      def type(id, **options)
+        api_request "#{endpoint_uri}/type/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft regions
+    #
+    # @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.region
+    class Region < Wow::GenericDataEndpoint
+      setup 'region', :dynamic, CACHE_TRIMESTER
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft reputation
+    #
+    # @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.reputation
+    class Reputation < Wow::GenericDataEndpoint
+      setup 'reputation', :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
+
+      ##
+      # This method overrides the inherited default behavior to prevent high server load and fetch time
+      #
+      # @!macro response
+      def get
+        raise BlizzardApi::ApiException, 'This endpoint does not have a get method'
+      end
+
+      ##
+      # Return a list of reputation factions
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def factions(**options)
+        api_request "#{endpoint_uri('faction')}/index", **default_options.merge(options)
+      end
+
+      ##
+      # Return data about a reputation faction
+      #
+      # @param id [Integer] Reputation faction id
+      # @!macro request_options
+      #
+      # @!macro response
+      def faction(id, **options)
+        api_request "#{endpoint_uri('faction')}/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Return a list of reputation tiers
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def tiers(**options)
+        api_request "#{endpoint_uri('tiers')}/index", **default_options.merge(options)
+      end
+
+      ##
+      # Return data about a reputation tier
+      #
+      # @param id [Integer] Reputation tier id
+      # @!macro request_options
+      #
+      # @!macro response
+      def tier(id, **options)
+        api_request "#{endpoint_uri('tiers')}/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft spell 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.spell
+    class Spell < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
+      setup 'spell', :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
+
+      ##
+      # Fetch media for a spell
+      #
+      # @param id [Integer] Spell id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def display_media(id, **options)
+        api_request "#{base_url(:media)}/spell/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft talent 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.talent
+    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
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def pvp_talents(**options)
+        api_request "#{base_url(:game_data)}/pvp-talent/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch a pvp talent
+      #
+      # @param id [Integer] Pvp talent id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def pvp_talent(id, **options)
+        api_request "#{base_url(:game_data)}/pvp-talent/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft talent 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.talent
+    class TechTalent < Wow::GenericDataEndpoint
+      setup 'tech-talent', :static, CACHE_TRIMESTER
+
+      ##
+      # Fetch tech talent trees
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def tech_talent_trees(**options)
+        api_request "#{base_url(:game_data)}/tech-talent-tree/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch a tech talent tree
+      #
+      # @param id [Integer] Tech talent id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def tech_talent_tree(id, **options)
+        api_request "#{base_url(:game_data)}/tech-talent-tree/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch a tech talent media
+      #
+      # @param id [Integer] Tech talent id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, **options)
+        api_request "#{base_url(:media)}/tech-talent/#{id}", **default_options.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# 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
+      setup 'title', :static, CACHE_TRIMESTER
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft tokens
+    #
+    # @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.wow_token
+    class WowToken < GenericDataEndpoint
+      setup 'token', :dynamic, CACHE_HOUR
+
+      def get
+        raise BlizzardApi::ApiException, 'This endpoint does not have a index method'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # Simplifies the requests to Blizzard APIS
+    class AccountProfile < Request
+      ##
+      # @param token [String] A token obtained using the authorization_code flow
+      def initialize(token, **options)
+        super(**options)
+        @token = token
+      end
+
+      ##
+      # Returns the account summary for WoW
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(**options)
+        api_request base_url(:user_profile).to_s, **default_options.merge(options)
+      end
+
+      ##
+      # Returns data for protected characters
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def protected_character(realm_id, character_id, **options)
+        api_request "#{base_url(:user_profile)}/protected-character/#{realm_id}-#{character_id}", **default_options.merge(options)
+      end
+
+      ##
+      # Returns the collection index for the account
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def collection(**options)
+        api_request "#{base_url(:user_profile)}/collections", **default_options.merge(options)
+      end
+
+      ##
+      # Returns the mount collection index for the account
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def mounts(**options)
+        api_request "#{base_url(:user_profile)}/collections/mounts", **default_options.merge(options)
+      end
+
+      ##
+      # Returns the toy collection index for the account
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def toys(**options)
+        api_request "#{base_url(:user_profile)}/collections/toys", **default_options.merge(options)
+      end
+
+      ##
+      # Returns the heirloom collection index for the account
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def heirloom(**options)
+        api_request "#{base_url(:user_profile)}/collections/heirloom", **default_options.merge(options)
+      end
+
+      ##
+      # Returns the pet collection index for the account
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def pets(**options)
+        api_request "#{base_url(:user_profile)}/collections/pets", **default_options.merge(options)
+      end
+
+      protected
+
+      def default_options
+        { ttl: CACHE_HOUR, namespace: :profile }
+      end
+
+      def api_request(_uri, **query_string)
+        query_string.merge! access_token: @token
+        super
+      end
+    end
+  end
+end