blizzard_api_rb_rb 3.4.2

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

@@ -0,0 +1,415 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft character profile 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.achievement
+    class CharacterProfile < Wow::Request
+      include BlizzardApi::Wow::Slug
+
+      ##
+      # Return character basic data
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(realm, character, **options)
+        character_request realm, character, **options
+      end
+
+      ##
+      # Return character achievements
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def achievements(realm, character, **options)
+        character_request realm, character, 'achievements', **options
+      end
+
+      ##
+      # Return character achievements statistics
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def achievement_statistics(realm, character, **options)
+        character_request realm, character, 'achievements/statistics', **options
+      end
+
+      ##
+      # Return character appearance
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def appearance(realm, character, **options)
+        character_request realm, character, 'appearance', **options
+      end
+
+      ##
+      # Return a character's collections
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def collections(realm, character, **options)
+        character_request realm, character, 'collections', **options
+      end
+
+      ##
+      # Return a character's pet collection
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def pets(realm, character, **options)
+        character_request realm, character, 'collections/pets', **options
+      end
+
+      ##
+      # Return a character's mount collection
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def mounts(realm, character, **options)
+        character_request realm, character, 'collections/mounts', **options
+      end
+
+      ##
+      # Return a character's toy collection
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def toys(realm, character, **options)
+        character_request realm, character, 'collections/toys', **options
+      end
+
+      ##
+      # Return a character's heirloom collection
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def heirlooms(realm, character, **options)
+        character_request realm, character, 'collections/heirlooms', **options
+      end
+
+      ##
+      # Return a character's encounter summary
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def encounters(realm, character, **options)
+        character_request realm, character, 'encounters', **options
+      end
+
+      ##
+      # Return a character's dungeon progress
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def dungeons(realm, character, **options)
+        character_request realm, character, 'encounters/dungeons', **options
+      end
+
+      ##
+      # Return a character's raid progress
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def raids(realm, character, **options)
+        character_request realm, character, 'encounters/raids', **options
+      end
+
+      ##
+      # Return character equipment
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def equipment(realm, character, **options)
+        character_request realm, character, 'equipment', **options
+      end
+
+      ##
+      # Return a character's hunter pets
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def hunter_pets(realm, character, **options)
+        character_request realm, character, 'hunter-pets', **options
+      end
+
+      ##
+      # Return character media
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(realm, character, **options)
+        character_request realm, character, 'character-media', **options
+      end
+
+      ##
+      # Return the mythic keystone profile of a character
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def mythic_keystone_profile(realm, character, **options)
+        character_request realm, character, 'mythic-keystone-profile', **options
+      end
+
+      ##
+      # Return the mythic keystone profile of a character
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @param season [Integer] Season ID if you want only a specific season or nil to include all.
+      # @!macro request_options
+      #
+      # @!macro response
+      def mythic_keystone_seasons(realm, character, season = nil, **options)
+        character_request realm, character, "mythic-keystone-profile/season/#{season}", **options
+      end
+
+      ##
+      # Return professions from a character
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def professions(realm, character, **options)
+        character_request realm, character, 'professions', **options
+      end
+
+      ##
+      # Return character status
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      # @see https://us.forums.blizzard.com/en/blizzard/t/data-protection-notice-and-faq/609
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def status(realm, character, **options)
+        character_request realm, character, 'status', **options
+      end
+
+      ##
+      # Return the pvp bracket of a character
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @param bracket [String] Pvp bracket
+      # @!macro request_options
+      #
+      # @!macro response
+      def pvp_bracket(realm, character, bracket, **options)
+        character_request realm, character, "pvp-bracket/#{bracket}", **options
+      end
+
+      ##
+      # Return the pvp summary of a character
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def pvp_summary(realm, character, **options)
+        character_request realm, character, 'pvp-summary', **options
+      end
+
+      ##
+      # Return a character's quests
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #   @option options [Boolean] :completed Should return completed quests
+      #
+      # @!macro response
+      def quests(realm, character, **options)
+        completed = options.delete(:completed) || false
+        return character_request realm, character, 'quests/completed', **options if completed
+
+        character_request realm, character, 'quests', **options
+      end
+
+      ##
+      # Return a character's reputations
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def reputation(realm, character, **options)
+        character_request realm, character, 'reputations', **options
+      end
+
+      ##
+      # Return a character's soulbinds
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def soulbinds(realm, character, **options)
+        character_request realm, character, 'soulbinds', **options
+      end
+
+      ##
+      # Return a character's specialization
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def specializations(realm, character, **options)
+        character_request realm, character, 'specializations', **options
+      end
+
+      ##
+      # Return a character's statistics
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def statistics(realm, character, **options)
+        character_request realm, character, 'statistics', **options
+      end
+
+      ##
+      # Return a character's titles
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def titles(realm, character, **options)
+        character_request realm, character, 'titles', **options
+      end
+
+      private
+
+      def default_options(user_token = nil)
+        opts = { ttl: CACHE_HOUR, namespace: :profile }
+        opts.merge access_token: user_token if user_token
+        opts
+      end
+
+      def character_request(realm, character, variant = nil, **options)
+        uri = "#{base_url(:profile)}/character/#{string_to_slug(realm)}/#{string_to_slug(character)}"
+        uri += "/#{variant}" if variant
+        api_request uri, **default_options.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# 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-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.guild
+    class Guild < Wow::Request
+      include BlizzardApi::Wow::Slug
+
+      ##
+      # Return data about the specified guild
+      #
+      # @param realm [String] The guild realm's slug
+      # @param guild [String] The guild's name
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(realm, guild, **options)
+        guild_request(realm, guild, **options)
+      end
+
+      ##
+      # Return all guild members for a specified guild
+      #
+      # @param realm [String] The guild realm's slug
+      # @param guild [String] The guild's name
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def roster(realm, guild, **options)
+        guild_request realm, guild, 'roster', **options
+      end
+
+      ##
+      # Return all guild achievements for a specified guild
+      #
+      # @param realm [String] The guild realm's slug
+      # @param guild [String] The guild's name
+      # @!macro request_options
+      #
+      # @!macro response
+      def achievements(realm, guild, **options)
+        guild_request realm, guild, 'achievements', **options
+      end
+
+      ##
+      # Return guild activity
+      #
+      # @param realm [String] The guild realm's slug
+      # @param guild [String] The guild's name
+      # @!macro request_options
+      #
+      # @!macro response
+      def activity(realm, guild, **options)
+        guild_request realm, guild, 'activity', **options
+      end
+
+      private
+
+      def guild_request(realm, guild, variant = nil, **options)
+        realm = string_to_slug(realm)
+        guild = string_to_slug(guild)
+        url = "#{base_url(:game_data)}/guild/#{realm}/#{guild}"
+        url += "/#{variant}" if variant
+        api_request url, **{ ttl: CACHE_DAY, namespace: :profile }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/wow/request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # World of Warcraft requests
+    class Request < BlizzardApi::Request
+      ##
+      # @!macro init_options
+      def initialize(**options)
+        super(**options)
+        @game = 'wow'
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/wow/search/search_composer.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # Composer for search endpoint arguments
+    class SearchComposer
+      attr_accessor :fields, :order, :page, :page_size
+
+      def initialize(page, page_size)
+        self.page = page
+        self.page_size = page_size
+        self.fields = []
+        self.order = []
+      end
+
+      ##
+      # Add a search field
+      #
+      # The second argument takes a simple value, an array of values or a hash for range searches.
+      #
+      # @param field [String] Field name
+      # @param value [String|Integer|Hash|Array<Integer>|Array<String>]
+      # @option value [Integer] :min Range start
+      # @option value [Integer] :max Range end
+      # @option value [Integer] :mode Range mode (:inclusive|:exclusive)
+      #
+      # @return {SearchComposer}
+      def where(field, value)
+        fields.push "#{field}=#{URI.encode_www_form_component(resolve_value(value))}"
+        self
+      end
+
+      ##
+      # Add a search field
+      #
+      # The second argument takes a simple value, an array of values or a hash for range searches.
+      #
+      # @param field [String] Field name
+      # @param value [String|Integer|Hash|Array<Integer>|Array<String>]
+      # @option value [Integer] :min Range start
+      # @option value [Integer] :max Range end
+      # @option value [Integer] :mode Range mode (:inclusive|:exclusive)
+      #
+      # @return {SearchComposer}
+      def where_not(field, value)
+        fields.push "#{field}!=#{URI.encode_www_form_component(resolve_value(value))}"
+        self
+      end
+
+      ##
+      # Add a sort field
+      #
+      # @param field [String] Field name
+      # @param mode [Symbol] :asc or :desc
+      #
+      # @return {SearchComposer}
+      def order_by(field, mode = :asc)
+        raise ArgumentError, 'Invalid order mode.' unless %i[asc desc].include? mode
+
+        order.push "#{field}:#{mode}"
+        self
+      end
+
+      ##
+      # Returns a valid queryString based on the options
+      #
+      # @return {String}
+      def to_search_query
+        query_string = "_page=#{page}&_pageSize=#{page_size}"
+        query_string += "&#{fields.join('&')}" unless fields.size.zero?
+        query_string += "&orderby=#{order.join(',')}" unless order.size.zero?
+        query_string
+      end
+
+      protected
+
+      def resolve_value(value)
+        return value.join '||' if value.is_a? Array
+
+        return value.to_s unless value.is_a? Hash
+
+        resolve_hash value
+      end
+
+      def resolve_hash(value)
+        min = value.key?(:min) ? value[:min] : ''
+        max = value.key?(:max) ? value[:max] : ''
+        mode = value.key?(:mode) ? value[:mode] : :inclusive
+
+        return "[#{min},#{max}]" if mode.eql? :inclusive
+
+        "(#{min},#{max})"
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/wow/search/search_request.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # Added search support to an endpoint
+    module Searchable
+      ##
+      # Fetch data based on search criteria
+      #
+      # @param page [Integer] Page o return
+      # @param page_size [Integer] Amount of items per page
+      #
+      # @!macro request_options
+      # @!macro response
+      def search(page = 1, page_size = 100, **options)
+        search_options = SearchComposer.new(page, page_size)
+        yield search_options if block_given?
+
+        api_request "#{endpoint_uri(nil, :search)}?#{search_options.to_search_query}", **default_options.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/wow/slug.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    # Support for slugs
+    module Slug
+      def string_to_slug(string)
+        CGI.escape(string.downcase.tr(' ', '-'))
+      end
+    end
+  end
+end