blizzard_api 0.2.0

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft guild 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.guild
+    class Guild < Wow::Request
+      # Valid fields for guild profile request
+      VALID_FIELDS = %w[achievements challenge members news].freeze
+
+      ##
+      # Helper method for checking valid fields. Use this to validate an array of fields if you are not sure about their
+      # names.
+      #
+      # @param fields [Array<String>] Array containing desired fields to include
+      #
+      # @raise ArgumentError
+      def validate_fields(fields)
+        fields.each do |field|
+          raise ArgumentError, "Unrecognized field #{field}" unless VALID_FIELDS.include? field
+        end
+      end
+
+      ##
+      # Return a list with all possible rewards.
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def rewards(options = {})
+        api_request "#{base_url(:community)}/data/guild/rewards", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return a list with all possible perks
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def perks(options = {})
+        api_request "#{base_url(:community)}/data/guild/perks", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return data about the specified guild
+      #
+      # @param realm [String] The guild realm's slug
+      # @param guild [String] The guild's name
+      # @param fields [Array<String>] An array containing all the fields you want to be included in the response.
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(realm, guild, fields = [], options = {})
+        validate_fields fields if options.include? :validate_fields
+
+        opts = { ttl: CACHE_DAY, fields: fields.join(',') }.merge(options)
+
+        api_request "#{base_url(:community)}/guild/#{realm}/#{guild}", opts
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# 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

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft mount 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.mount
+    class Mount < Wow::Request
+      ##
+      # Return a list with all available mounts
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def index(options = {})
+        api_request "#{base_url(:community)}/mount/", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft pet 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.pet
+    class Pet < Wow::Request
+      # 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
+      #
+      # @!macro response
+      def index(options = {})
+        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
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft PvP 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.pvp
+    class PvP < Wow::Request
+      # Arena 2v2
+      BRACKET_2V2 = '2v2'
+      # Arena 3x3
+      BRACKET_3V3 = '3v3'
+      # Arena 5x5
+      BRACKET_5V5 = '5v5'
+      # Rated battlegrounds
+      BRACKET_RBG = 'rbg'
+
+      ##
+      # Returns the current pvp leaderboard for the current region
+      #
+      # @param bracket [String] PvP leaderboard category. You can use the constants BRACKET_*
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(bracket, options = {})
+        api_request "#{base_url(:community)}/leaderboard/#{bracket}", { ttl: CACHE_DAY }.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft quest 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.quest
+    class Quest < Wow::Request
+      ##
+      # Return information about a quest by its id
+      #
+      # @param id [Integer] Quest id
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(id, options = {})
+        api_request "#{base_url(:community)}/quest/#{id}", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft recipe 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.recipe
+    class Recipe < Wow::Request
+      ##
+      # Return information about a recipe by its id
+      #
+      # @param id [Integer] Recipe id
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(id, options = {})
+        api_request "#{base_url(:community)}/recipe/#{id}", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft spell 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.spell
+    class Spell < Wow::Request
+      ##
+      # Return information about a spell by its id
+      #
+      # @param id [Integer] Spell id
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(id, options = {})
+        api_request "#{base_url(:community)}/spell/#{id}", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft zone 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.zone
+    class Zone < Wow::Request
+      ##
+      # Return a list of all zones
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def index(options = {})
+        api_request "#{base_url(:community)}/zone/", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return complete information about a zone by its id
+      #
+      # @param id [Integer] Zone id
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(id, options = {})
+        api_request "#{base_url(:community)}/zone/#{id}", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# 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_realms
+    class ConnectedRealm < Wow::GenericDataEndpoint
+      ##
+      # @!macro complete
+      def complete(options = {})
+        [].tap do |data|
+          index_data = index options
+          index_data[:connected_realms].each do |realm|
+            realm_id = %r{connected-realm/([0-9]+)}.match(realm[:href])[1]
+            realm_data = get realm_id, options
+            realm_data.delete :_links
+            data.push realm_data
+          end
+        end
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'connected-realm'
+        @namespace = endpoint_namespace :dynamic
+        @collection = 'connected_realms'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # Generic endpoint to support most data requests with minor configurations
+    class GenericDataEndpoint < Wow::Request
+      ##
+      # @!macro regions
+      def initialize(region = nil)
+        super region
+        endpoint_setup
+        @ttl ||= CACHE_DAY
+      end
+
+      ##
+      # Fetch a list of all resources available for this endpoint
+      #
+      # @!macro request_options
+      # @!macro response
+      def index(options = {})
+        api_request "#{base_url(:game_data)}/#{@endpoint}/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch all possible data for one of 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 "#{base_url(:game_data)}/#{@endpoint}/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # @!macro complete
+      def complete(options = {})
+        index_data = index options
+        index_data[@collection.to_sym].tap do |collection|
+          collection.each do |item|
+            item.delete 'key'
+          end
+        end
+      end
+
+      protected
+
+      def endpoint_setup
+        raise NotImplementedError, 'You must override this method to properly set up the endpoint'
+      end
+
+      def default_options
+        { namespace: @namespace, ttl: @ttl }
+      end
+    end
+  end
+end