blizzard_api 0.3.1 → 0.3.2

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft talent 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.talent
+    class Talent < Wow::GenericDataEndpoint
+      ##
+      # Fetch pvp talents
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def pvp_talents(options = {})
+        api_request "#{base_url(:game_data)}/pvp-talent/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch pvp a talent
+      #
+      # @param id [Integer] Pvp talent id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def pvp_talent(id, options = {})
+        api_request "#{base_url(:game_data)}/pvp-talent/#{id}", default_options.merge(options)
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'talent'
+        @namespace = :static
+        @collection = 'talents'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -10,25 +10,6 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.achievement
     class CharacterProfile < 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 a list containing all WoW characters of a BNet account
       #
@@ -51,19 +32,11 @@ module BlizzardApi
       #
       # @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. Only
-      #   used for community endpoint.
       # @!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, character, fields = [], options = {})
-        return character_request realm, character, 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)}/character/#{CGI.escape(realm)}/#{CGI.escape(character)}", opts
+      def get(realm, character, options = {})
+        character_request realm, character, options
       end
 
       ##
@@ -89,14 +62,24 @@ module BlizzardApi
       # @param realm [String] The character realm's slug
       # @param character [String] The character name
       # @!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 achievements(realm, character, options = {})
-        return character_request realm, character, options, 'achievements' unless options.include? :use_community_endpoint
+        character_request realm, character, options, 'achievements'
+      end
 
-        api_request "#{base_url(:community)}/data/guild/achievements", { ttl: CACHE_TRIMESTER }.merge(options)
+      ##
+      # 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, options, 'achievements/statistics'
       end
 
       ##
@@ -170,6 +153,22 @@ module BlizzardApi
         character_request realm, character, options, 'pvp-summary'
       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
+      #
+      # @!macro response
+      def quests(realm, character, completed = false, options = {})
+        return character_request realm, character, options, 'quests/completed' if completed
+
+        character_request realm, character, options, 'quests'
+      end
+
       ##
       # Return a character's specialization
       #

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

@@ -5,29 +5,11 @@ 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
     class Guild < Wow::Request
-      # Valid fields for guild profile request
-      VALID_FIELDS = %w[achievements achievementsCompleted achievementsCompletedTimestamp criteria criteriaCreated
-                        criteriaQuantity criteriaTimestamp 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.
       #
@@ -53,18 +35,11 @@ module BlizzardApi
       #
       # @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
-      # @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, 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
+      def get(realm, guild, options = {})
+        guild_request(realm, guild, options)
       end
 
       ##
@@ -86,18 +61,24 @@ module BlizzardApi
       # @param realm [String] The guild realm's slug
       # @param guild [String] The guild's name
       # @!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 achievements(realm, guild, options = {})
-        if options.include? :use_community_endpoint
-          return api_request "#{base_url(:community)}/data/guild/achievements", { ttl: CACHE_TRIMESTER }.merge(options)
-        end
-
         guild_request realm, guild, options, 'achievements'
       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, options, 'activity'
+      end
+
       private
 
       def guild_request(realm, guild, options = {}, variant = nil)

data/lib/blizzard_api/wow/profile/profile.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # Simplifies the requests to Blizzard APIS
+    class AccountProfile < Request
+      ##
+      # @param token [String] A token obtained using the authorization_code flow
+      def initialize(token)
+        @token = token
+      end
+
+      ##
+      # Returns the account summary for WoW
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(_options = {})
+        api_request base_url(:user_profile).to_s
+      end
+
+      ##
+      # Returns data for protected characters
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def protected_character(realm_id, character_id, options = {})
+        api_request "#{base_url(:user_profile)}/protected-character/#{realm_id}-#{character_id}", default_options.merge(options)
+      end
+
+      ##
+      # Returns the collection index for the account
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def collection(options = {})
+        api_request "#{base_url(:user_profile)}/collections", default_options.merge(options)
+      end
+
+      ##
+      # Returns the mount collection index for the account
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def mounts(options = {})
+        api_request "#{base_url(:user_profile)}/collections/mounts", default_options.merge(options)
+      end
+
+      ##
+      # Returns the pet collection index for the account
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def pets(options = {})
+        api_request "#{base_url(:user_profile)}/collections/pets", default_options.merge(options)
+      end
+
+      protected
+
+      def default_options
+        { ttl: CACHE_HOUR, namespace: :profile }
+      end
+
+      def api_request(_uri, query_string = nil)
+        query_string[:access_token] = @token
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-17 00:00:00.000000000 Z
+date: 2020-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -117,22 +117,20 @@ files:
 - lib/blizzard_api/request.rb
 - lib/blizzard_api/version.rb
 - lib/blizzard_api/wow.rb
-- lib/blizzard_api/wow/community/auction.rb
 - lib/blizzard_api/wow/community/boss.rb
 - lib/blizzard_api/wow/community/challenge.rb
 - lib/blizzard_api/wow/community/pvp.rb
-- lib/blizzard_api/wow/community/quest.rb
 - lib/blizzard_api/wow/community/recipe.rb
-- lib/blizzard_api/wow/community/spell.rb
 - lib/blizzard_api/wow/community/zone.rb
 - lib/blizzard_api/wow/game_data/achievement.rb
+- lib/blizzard_api/wow/game_data/auction.rb
 - lib/blizzard_api/wow/game_data/azerite_essence.rb
 - lib/blizzard_api/wow/game_data/connected_realm.rb
 - lib/blizzard_api/wow/game_data/creature.rb
 - lib/blizzard_api/wow/game_data/generic_data_endpoint.rb
-- lib/blizzard_api/wow/game_data/guild.rb
 - lib/blizzard_api/wow/game_data/guild_crest.rb
 - lib/blizzard_api/wow/game_data/item.rb
+- lib/blizzard_api/wow/game_data/journal.rb
 - lib/blizzard_api/wow/game_data/mount.rb
 - lib/blizzard_api/wow/game_data/mythic_keystone.rb
 - lib/blizzard_api/wow/game_data/mythic_keystone_affix.rb
@@ -140,18 +138,22 @@ files:
 - lib/blizzard_api/wow/game_data/mythic_raid_leaderboard.rb
 - lib/blizzard_api/wow/game_data/pet.rb
 - lib/blizzard_api/wow/game_data/playable_class.rb
+- lib/blizzard_api/wow/game_data/playable_race.rb
 - lib/blizzard_api/wow/game_data/playable_specialization.rb
 - lib/blizzard_api/wow/game_data/power_type.rb
 - lib/blizzard_api/wow/game_data/pvp_season.rb
 - lib/blizzard_api/wow/game_data/pvp_tier.rb
-- lib/blizzard_api/wow/game_data/race.rb
+- lib/blizzard_api/wow/game_data/quest.rb
 - lib/blizzard_api/wow/game_data/realm.rb
 - lib/blizzard_api/wow/game_data/region.rb
-- lib/blizzard_api/wow/game_data/reputation_faction.rb
-- lib/blizzard_api/wow/game_data/reputation_tier.rb
+- lib/blizzard_api/wow/game_data/reputation.rb
+- lib/blizzard_api/wow/game_data/spell.rb
+- lib/blizzard_api/wow/game_data/talent.rb
 - lib/blizzard_api/wow/game_data/title.rb
 - lib/blizzard_api/wow/game_data/wow_token.rb
 - lib/blizzard_api/wow/profile/character_profile.rb
+- lib/blizzard_api/wow/profile/guild.rb
+- lib/blizzard_api/wow/profile/profile.rb
 - lib/blizzard_api/wow/request.rb
 homepage: https://gitlab.com/francisschiavo/blizzard_api
 licenses:

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module BlizzardApi
-  module Wow
-    ##
-    # This class allows access to World of Warcraft auctions
-    #
-    # @deprecated See https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-community-api-migration/767
-    #
-    # @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/quest.rb

@@ -1,27 +0,0 @@
-# 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
-    #
-    # @deprecated See https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-community-api-migration/767
-    #
-    # 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/spell.rb

@@ -1,27 +0,0 @@
-# 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
-    #
-    # @deprecated See https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-community-api-migration/767
-    #
-    # 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