blizzard_api 0.2.1 → 0.2.2

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

@@ -60,28 +60,7 @@ module BlizzardApi
 
         opts = { ttl: CACHE_DAY, fields: fields.join(',') }.merge(options)
 
-        api_request "#{base_url(:community)}/character/#{realm}/#{URI.encode(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}/#{URI.encode(character)}/mythic-keystone-profile"
-        url += "/season/#{season}" unless season.nil?
-        api_request url, opts
+        api_request "#{base_url(:community)}/character/#{CGI.escape(realm)}/#{CGI.escape(character)}", opts
       end
 
       ##

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

@@ -0,0 +1,101 @@
+# 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-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.achievement
+    class Achievement < Wow::GenericDataEndpoint
+      ##
+      # Fetch all possible data for one of the items listed by the {#index} using its *id*
+      #
+      # @param id [Integer] One of the IDs returned by the {#index}
+      #
+      # @!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 get(id, options = {})
+        return super id, options unless options.include? :use_community_endpoint
+
+        api_request "#{base_url(:community)}/achievement/#{id}", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # This method overrides the inherited default behavior to prevent high server load and fetch time
+      #
+      # @!macro response
+      def complete
+        raise BlizzardApi::ApiException, 'There are too many achievements to fetch complete data'
+      end
+
+      ##
+      # Return a list of possible achievement categories.
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def categories(options = {})
+        api_request "#{endpoint_uri('category')}/index", default_options.merge(options)
+      end
+
+      ##
+      # Return a achievement category.
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def category(id, options = {})
+        api_request "#{endpoint_uri('category')}/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Return a list of possible character achievements.
+      # This endpoint uses a community endpoint. It is recommended to use the new data endpoint using {#index}.
+      # @see https://us.battle.net/forums/en/bnet/topic/20771546990
+      #
+      # @!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
+      # This endpoint uses a community endpoint. It is recommended to use the new data endpoint using {#index}.
+      # @see https://us.battle.net/forums/en/bnet/topic/20771546990
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def guild_achievement_index(options = {})
+        api_request "#{base_url(:community)}/data/guild/achievements", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Fetch media assets for the specified achievement
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, options = {})
+        api_request "#{base_url(:media)}/achievement/#{id}", default_options.merge(options)
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'achievement'
+        @namespace = endpoint_namespace :static
+        @collection = 'achievements'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -8,22 +8,8 @@ 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.connected_realms
+    #   api_instance = BlizzardApi::Wow.connected_realm
     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

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

@@ -0,0 +1,99 @@
+# 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-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.creature
+    class Creature < Wow::GenericDataEndpoint
+      def index
+        raise BlizzardApi::ApiException, 'Creatures endpoint doesn\'t have a index method'
+      end
+
+      def complete
+        raise BlizzardApi::ApiException, 'There are too many creatures to fetch complete data'
+      end
+
+      ##
+      # Fetch all creature families
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def families(options = {})
+        api_request "#{endpoint_uri('family')}/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch all possible data for one of the items listed by the {#families} using its *id*
+      #
+      # @param id [Integer] Creature family id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def family(id, options = {})
+        api_request "#{endpoint_uri('family')}/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch media for one of the items listed by the {#families} using its *id*
+      #
+      # @param id [Integer] Creature family id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def family_media(id, options = {})
+        api_request "#{base_url(:media)}/creature-family/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch all creature types
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def types(options = {})
+        api_request "#{endpoint_uri('type')}/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch all possible data for one of the items listed by the {#types} using its *id*
+      #
+      # @param id [Integer] Creature type id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def type(id, options = {})
+        api_request "#{endpoint_uri('type')}/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch media for one of the items listed by the {#types} using its *id*
+      #
+      # @param id [Integer] Creature type id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def display_media(id, options = {})
+        api_request "#{base_url(:media)}/creature-display/#{id}", default_options.merge(options)
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'creature'
+        @namespace = endpoint_namespace :static
+        @collection = 'achievements'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -19,33 +19,40 @@ module BlizzardApi
       # @!macro request_options
       # @!macro response
       def index(options = {})
-        api_request "#{base_url(:game_data)}/#{@endpoint}/index", default_options.merge(options)
+        api_request "#{endpoint_uri}/index", default_options.merge(options)
       end
 
       ##
-      # Fetch all possible data for one of items listed by the {#index} using its *id*
+      # Fetch all possible data for one of the 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)
+        api_request "#{endpoint_uri}/#{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'
+        [].tap do |complete_data|
+          index_data = index options
+          index_data[@collection.to_sym].each do |item|
+            link = item.key?(:key) ? item[:key][:href] : item[:href]
+            item_data = request link
+            complete_data.push item_data
           end
         end
       end
 
       protected
 
+      def endpoint_uri(variant = nil)
+        endpoint = variant ? "#{@endpoint}-#{variant}" : @endpoint
+        "#{base_url(:game_data)}/#{endpoint}"
+      end
+
       def endpoint_setup
         raise NotImplementedError, 'You must override this method to properly set up the endpoint'
       end

data/lib/blizzard_api/wow/{community → game_data}/guild.rb

@@ -6,6 +6,7 @@ module BlizzardApi
     # This class allows access to World of Warcraft guild data
     #
     # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
+    # @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
@@ -53,14 +54,52 @@ module BlizzardApi
       # @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
+      # @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 get(realm, guild, fields = [], options = {})
-        validate_fields fields if options.include? :validate_fields
+      def get(realm, guild, options = {}, fields = [])
+        return guild_request(realm, guild, options) unless options.include? :use_community_endpoint
 
+        validate_fields fields if options.include? :validate_fields
         opts = { ttl: CACHE_DAY, fields: fields.join(',') }.merge(options)
+        api_request "#{base_url(:community)}/guild/#{CGI.escape(realm)}/#{CGI.escape(guild)}", opts
+      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, options, 'roster'
+      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, options, 'achievements'
+      end
+
+      private
 
-        api_request "#{base_url(:community)}/guild/#{realm}/#{URI.encode(guild)}", opts
+      def guild_request(realm, guild, options = {}, variant = nil)
+        realm = CGI.escape string_to_slug(realm)
+        guild = CGI.escape string_to_slug(guild)
+        url = "#{base_url(:game_data)}/guild/#{realm}/#{guild}"
+        url += "/#{variant}" if variant
+        api_request url, { ttl: CACHE_DAY, namespace: endpoint_namespace(:profile) }.merge(options)
       end
     end
   end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft guild crest 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_crest
+    class GuildCrest < Wow::GenericDataEndpoint
+      def get
+        raise BlizzardApi::ApiException, 'This endpoint doens\'t have a get method'
+      end
+
+      ##
+      # Return guild border assets by its id
+      #
+      # @param id [Integer] Border id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def border_media(id, options = {})
+        api_request "#{base_url(:media)}/#{@endpoint}/border/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Return guild embelm assets by its id
+      #
+      # @param id [Integer] Emblem id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def emblem_media(id, options = {})
+        api_request "#{base_url(:media)}/#{@endpoint}/emblem/#{id}", default_options.merge(options)
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'guild-crest'
+        @namespace = endpoint_namespace(:static)
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft mounts
+    #
+    # @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.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
+        @endpoint = 'mount'
+        @namespace = endpoint_namespace :static
+        @collection = 'mounts'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end