blizzard_api 0.2.0

data/lib/blizzard_api/starcraft/game_data/league.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Starcraft
+    ##
+    # This class allows access to Starcraft II league data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/starcraft-2-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Starcraft.league
+    class League < Starcraft::Request
+      ##
+      # Return information about league
+      #
+      # @param [Integer] season_id Season id
+      # @param [Integer] queue_id Queue id
+      # @param [Integer] team_type Team type
+      # @param [Integer] league_id League id
+      # @!macro request_options
+      def get(season_id, queue_id, team_type, league_id, options = {})
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:game_data)}/league/#{season_id}/#{queue_id}/#{team_type}/#{league_id}", opts
+      end
+    end
+  end
+end

data/lib/blizzard_api/starcraft/request.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+##
+# @!macro [new] sc2_regions
+#   @param {Symbol} region_id One of the valid Starcraft II regions *:US*, *:EU*, *:KO*, and *:TW*
+#   @note This gem do not support nor will support China endpoints
+
+module BlizzardApi
+  module Starcraft
+    ##
+    # Starcraft requests
+    class Request < BlizzardApi::Request
+      # Possible regions for the SC II API (Except China)
+      SC_REGION = { US: 1, EU: 2, KO: 3, TW: 3 }.freeze
+
+      ##
+      # @!macro regions
+      def initialize(region = nil)
+        super region
+        @game = 'sc2'
+      end
+
+      private
+
+      ##
+      # Helper method to find a region_id by its symbol
+      def resolve_region(region_arg)
+        return region_arg if region_arg.is_a? Integer
+
+        return SC_REGION[region_arg] if region_arg.is_a? Symbol
+
+        raise ArgumentError, 'Invalid region, please read the documentation'
+      end
+    end
+  end
+end

data/lib/blizzard_api/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  # Gem version
+  VERSION = '0.2.0'
+end

data/lib/blizzard_api/wow.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  # World of Warcraft related classes
+  module Wow
+    require_relative 'wow/request'
+    require_relative 'wow/game_data/generic_data_endpoint'
+
+    # WoW data api
+    require_relative 'wow/game_data/region'
+    require_relative 'wow/game_data/realm'
+    require_relative 'wow/game_data/connected_realm'
+    require_relative 'wow/game_data/race'
+    require_relative 'wow/game_data/playable_class'
+    require_relative 'wow/game_data/playable_specialization'
+    require_relative 'wow/game_data/power_type'
+    require_relative 'wow/game_data/mythic_keystone_affix'
+
+    ##
+    # @return {Region}
+    def self.region
+      BlizzardApi::Wow::Region.new
+    end
+
+    ##
+    # @return {Realm}
+    def self.realm
+      BlizzardApi::Wow::Realm.new
+    end
+
+    ##
+    # @return {ConnectedRealm}
+    def self.connected_realm
+      BlizzardApi::Wow::ConnectedRealm.new
+    end
+
+    ##
+    # @return {Race}
+    def self.race
+      BlizzardApi::Wow::Race.new
+    end
+
+    ##
+    # @return {PlayableClass}
+    def self.playable_class
+      BlizzardApi::Wow::PlayableClass.new
+    end
+
+    ##
+    # @return {PlayableSpecialization}
+    def self.playable_specialization
+      BlizzardApi::Wow::PlayableSpecialization.new
+    end
+
+    ##
+    # @return {PowerType}
+    def self.power_type
+      BlizzardApi::Wow::PowerType.new
+    end
+
+    ##
+    # @return {MythicKeystoneAffix}
+    def self.mythic_keystone_affix
+      BlizzardApi::Wow::MythicKeystoneAffix.new
+    end
+
+    # Wow community api
+    require_relative 'wow/community/achievements'
+    require_relative 'wow/community/auction'
+    require_relative 'wow/community/boss'
+    require_relative 'wow/community/challenge'
+    require_relative 'wow/community/character'
+    require_relative 'wow/community/guild'
+    require_relative 'wow/community/item'
+    require_relative 'wow/community/mount'
+    require_relative 'wow/community/pets'
+    require_relative 'wow/community/pvp'
+    require_relative 'wow/community/quest'
+    require_relative 'wow/community/recipe'
+    require_relative 'wow/community/spell'
+    require_relative 'wow/community/zone'
+
+    ##
+    # @return {Achievement}
+    def self.achievement
+      BlizzardApi::Wow::Achievement.new
+    end
+
+    ##
+    # @return {Auction}
+    def self.auction
+      BlizzardApi::Wow::Auction.new
+    end
+
+    ##
+    # @return {Boss}
+    def self.boss
+      BlizzardApi::Wow::Boss.new
+    end
+
+    ##
+    # @return {Challenge}
+    def self.challenge
+      BlizzardApi::Wow::Challenge.new
+    end
+
+    ##
+    # @return {Character}
+    def self.character
+      BlizzardApi::Wow::Character.new
+    end
+
+    ##
+    # @return {Guild}
+    def self.guild
+      BlizzardApi::Wow::Guild.new
+    end
+
+    ##
+    # @return {Item}
+    def self.item
+      BlizzardApi::Wow::Item.new
+    end
+
+    ##
+    # @return {Mount}
+    def self.mount
+      BlizzardApi::Wow::Mount.new
+    end
+
+    ##
+    # @return {Pet}
+    def self.pet
+      BlizzardApi::Wow::Pet.new
+    end
+
+    ##
+    # @return {PvP}
+    def self.pvp
+      BlizzardApi::Wow::PvP.new
+    end
+
+    ##
+    # @return {Quest}
+    def self.quest
+      BlizzardApi::Wow::Quest.new
+    end
+
+    ##
+    # @return {Recipe}
+    def self.recipe
+      BlizzardApi::Wow::Recipe.new
+    end
+
+    ##
+    # @return {Spell}
+    def self.spell
+      BlizzardApi::Wow::Spell.new
+    end
+
+    ##
+    # @return {Zone}
+    def self.zone
+      BlizzardApi::Wow::Zone.new
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft achievements
+    #
+    # @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.achievements
+    class Achievement < Wow::Request
+      ##
+      # Return complete achievement data by achievement id
+      #
+      # @param id [Integer] Achievement id
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(id, options = {})
+        api_request "#{base_url(:community)}/achievement/#{id}", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return a list of possible character achievements
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def character_achievement_index(options = {})
+        api_request "#{base_url(:community)}/data/character/achievements", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return a list of possible guild achievements
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def guild_achievement_index(options = {})
+        api_request "#{base_url(:community)}/data/guild/achievements", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft auctions
+    #
+    # @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.auction
+    class Auction < Wow::Request
+      ##
+      # Return a link to the most recent dump of all active auctions for the desired realm
+      #
+      # @param realm [String] Realm's slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(realm, options = {})
+        api_request "#{base_url(:community)}/auction/data/#{realm}", { ttl: CACHE_HOUR }.merge(options)
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft challenges
+    #
+    # @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.challenge
+    class Challenge < Wow::Request
+      ##
+      # Most recent challenge leaderboard for the specified realm
+      #
+      # @param name [String] Realm's slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def realm_index(name, options = {})
+        api_request "#{base_url(:community)}/challenge/#{name}", { ttl: CACHE_HOUR }.merge(options)
+      end
+
+      ##
+      # Most recent challenge leaderboard for the entire region
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def region_index(options = {})
+        api_request "#{base_url(:community)}/challenge/region", { ttl: CACHE_HOUR }.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft character 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.character
+    class Character < Wow::Request
+      # Valid fields for character profile requests
+      VALID_FIELDS = %w[
+        achievements
+        appearance
+        feed
+        guild
+        hunterPets
+        items
+        mounts
+        pets
+        petSlots
+        professions
+        progression
+        pvp
+        quests
+        reputation
+        statistics
+        stats
+        talents
+        titles
+        audit
+      ].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 data about the specified char
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character 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, character, fields = [], options = {})
+        validate_fields fields if options.include? :validate_fields
+
+        opts = { ttl: CACHE_DAY, fields: fields.join(',') }.merge(options)
+
+        api_request "#{base_url(:community)}/character/#{realm}/#{CGI.escape(character)}", opts
+      end
+
+      ##
+      # Return the mythic keystone profile of a character
+      #
+      # @note This endpoint requires a user token obtained through the user authorization flow
+      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @param user_token [String] A token obtained by the authorization flow. See link below.
+      # @param season [Integer] Season ID if you want only a specific season or nil to include all.
+      # @!macro request_options
+      #
+      # @!macro response
+      def get_keystone_profile(realm, character, user_token, season = nil, options = {})
+        opts = { ttl: CACHE_HOUR, namespace: "profile-#{region}" }.merge(options)
+        opts[:access_token] = user_token
+        url = "#{base_url(:profile)}/character/#{realm}/#{CGI.escape(character)}/mythic-keystone-profile"
+        url += "/season/#{season}" unless season.nil?
+        api_request url, opts
+      end
+
+      ##
+      # Return a list containing all WoW characters of a BNet account
+      #
+      # @note This endpoint requires a user token obtained through the user authorization flow
+      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      #
+      # @param user_token [String] A token obtained by the authorization flow. See link below.
+      # @!macro request_options
+      #
+      # @!macro response
+      def get_user_characters(user_token, options = {})
+        opts = { ttl: CACHE_HOUR, access_token: user_token }.merge(options)
+        api_request "#{base_url(:community)}/user/characters", opts
+      end
+    end
+  end
+end