blizzard_api 0.3.1 → 0.3.2

data/lib/blizzard_api/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
+      ##
+      # 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
+
+      ##
+      # This method overrides the inherited default behavior to prevent high server load and fetch time
+      #
+      # @!macro response
+      def get(_id, _options = {})
+        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
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'journal'
+        @namespace = :static
+        @collection = 'journals'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -10,20 +10,6 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.mount
     class Mount < Wow::GenericDataEndpoint
-      ##
-      # Returns a index of mounts
-      #
-      # @!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 index(options = {})
-        return super options unless options.include? :use_community_endpoint
-
-        api_request "#{base_url(:community)}/mount/", { ttl: CACHE_TRIMESTER }.merge(options)
-      end
-
       protected
 
       def endpoint_setup

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

@@ -10,81 +10,6 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.pet
     class Pet < Wow::GenericDataEndpoint
-      # Poor (gray) quality pet
-      PET_QUALITY_POOR = 0
-      # Common (white) quality pet
-      PET_QUALITY_COMMON = 1
-      # Uncommon (green) quality pet
-      PET_QUALITY_UNCOMMON = 2
-      # Rare (blue) quality pet
-      PET_QUALITY_RARE = 3
-      # Epic (purple) quality pet
-      PET_QUALITY_EPIC = 4
-      # Legendary (orange) quality pet
-      PET_QUALITY_LEGENDARY = 5
-
-      ##
-      # Return a list of all available pets
-      #
-      # @!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 index(options = {})
-        return super options unless options.include? :use_community_endpoint
-
-        api_request "#{base_url(:community)}/pet/", { ttl: CACHE_TRIMESTER }.merge(options)
-      end
-
-      ##
-      # Return complete data about a pet ability by its id
-      #
-      # @param id [Integer] Pet ability id
-      # @!macro request_options
-      #
-      # @!macro response
-      def ability(id, options = {})
-        api_request "#{base_url(:community)}/pet/ability/#{id}", { ttl: CACHE_TRIMESTER }.merge(options)
-      end
-
-      ##
-      # Return complete data about a pet species by its id
-      #
-      # @param id [Integer] Pet species id
-      # @!macro request_options
-      #
-      # @!macro response
-      def species(id, options = {})
-        api_request "#{base_url(:community)}/pet/species/#{id}", { ttl: CACHE_TRIMESTER }.merge(options)
-      end
-
-      ##
-      # Return complete data about a pet stats based on its attributes
-      #
-      # @param id [Integer] Pet id (Obtained by the {#index} or {Character#get} with the fields *pets* or *petSlots*)
-      # @param level [Integer] Pet's level (1 - 25)
-      # @param breed_id [Integer]
-      # @param quality_id [Integer] Pets quality ID where 0 = Poor and 5 = legendary. You can use the
-      # constants PET_QUALITY_*
-      # @!macro request_options
-      #
-      # @!macro response
-      def stats(id, level = 25, breed_id = 3, quality_id = 1, options = {})
-        opts = { level: level, breedId: breed_id, qualityId: quality_id, ttl: CACHE_TRIMESTER }.merge(options)
-        api_request "#{base_url(:community)}/pet/stats/#{id}", opts
-      end
-
-      ##
-      # Return a complete list of pet types
-      #
-      # @!macro request_options
-      #
-      # @!macro response
-      def types(options = {})
-        api_request "#{base_url(:community)}/data/pet/types", { ttl: CACHE_TRIMESTER }.merge(options)
-      end
-
       protected
 
       def endpoint_setup

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

@@ -10,21 +10,6 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.playable_class
     class PlayableClass < Wow::GenericDataEndpoint
-      ##
-      # Returns a index of playable 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
-      # @option options [Boolean] :classic If set to true, this method will call the classic version
-      #
-      # @!macro response
-      def index(options = {})
-        return super options unless options.include? :use_community_endpoint
-
-        api_request "#{base_url(:community)}/data/character/classes", { ttl: CACHE_TRIMESTER }.merge(options)
-      end
-
       ##
       # Returns the PvP talent slots data of a specific class
       #

data/lib/blizzard_api/wow/game_data/{reputation_tier.rb → playable_race.rb}

@@ -3,19 +3,19 @@
 module BlizzardApi
   module Wow
     ##
-    # This class allows access to World of Warcraft reputation
+    # This class allows access to World of Warcraft playable races
     #
     # @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 ReputationTier < Wow::GenericDataEndpoint
+    #   race = BlizzardApi::Wow.playable_race
+    class PlayableRace < Wow::GenericDataEndpoint
       protected
 
       def endpoint_setup
-        @endpoint = 'reputation-tiers'
+        @endpoint = 'playable-race'
         @namespace = :static
-        @collection = 'achievements'
+        @collection = 'races'
         @ttl = CACHE_TRIMESTER
       end
     end

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

@@ -8,7 +8,7 @@ module BlizzardApi
     # @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.power_type
+    #   api_instance = BlizzardApi::Wow.pvp_tier
     class PvpTier < Wow::GenericDataEndpoint
       ##
       # Returns media assets for a pvp tier

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

@@ -0,0 +1,86 @@
+# 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
+      ##
+      # 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
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'quest'
+        @namespace = :static
+        @collection = 'quests'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# 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
+      ##
+      # 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
+        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
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'reputation'
+        @namespace = :static
+        @collection = 'reputations'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# 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
+      ##
+      # 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
+
+      ##
+      # 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
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'spell'
+        @namespace = :static
+        @collection = 'spells'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end