blizzard_api 0.3.11 → 0.5.2

data/lib/blizzard_api/starcraft/request.rb

@@ -15,8 +15,8 @@ module BlizzardApi
 
       ##
       # @!macro regions
-      def initialize(region = nil)
-        super region
+      def initialize(region = nil, mode = :regular)
+        super region, mode
         @game = 'sc2'
       end
 

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '0.3.11'
+  VERSION = '0.5.2'
 end

data/lib/blizzard_api/wow.rb

@@ -5,16 +5,22 @@ module BlizzardApi
   module Wow
     require_relative 'wow/request'
     require_relative 'wow/game_data/generic_data_endpoint'
+    require_relative 'wow/search/search_composer'
+    require_relative 'wow/search/search_request'
+    require_relative 'wow/slug'
 
     # WoW data api
     require_relative 'wow/game_data/achievement'
     require_relative 'wow/game_data/auction'
     require_relative 'wow/game_data/azerite_essence'
     require_relative 'wow/game_data/connected_realm'
+    require_relative 'wow/game_data/covenant'
     require_relative 'wow/game_data/creature'
     require_relative 'wow/game_data/guild_crest'
     require_relative 'wow/game_data/item'
     require_relative 'wow/game_data/journal'
+    require_relative 'wow/game_data/media'
+    require_relative 'wow/game_data/modified_crafting'
     require_relative 'wow/game_data/mount'
     require_relative 'wow/game_data/mythic_keystone_affix'
     require_relative 'wow/game_data/mythic_keystone'
@@ -34,6 +40,7 @@ module BlizzardApi
     require_relative 'wow/game_data/reputation'
     require_relative 'wow/game_data/spell'
     require_relative 'wow/game_data/talent'
+    require_relative 'wow/game_data/tech_talent'
     require_relative 'wow/game_data/title'
     require_relative 'wow/game_data/wow_token'
 
@@ -65,6 +72,13 @@ module BlizzardApi
       BlizzardApi::Wow::ConnectedRealm.new(region)
     end
 
+    ##
+    # @param region [String] API Region
+    # @return {Covenant}
+    def self.covenant(region = BlizzardApi.region)
+      BlizzardApi::Wow::Covenant.new(region)
+    end
+
     ##
     # @param region [String] API Region
     # @return {Creature}
@@ -93,6 +107,20 @@ module BlizzardApi
       BlizzardApi::Wow::Journal.new(region)
     end
 
+    ##
+    # @param region [String] API Region
+    # @return {Media}
+    def self.media(region = BlizzardApi.region)
+      BlizzardApi::Wow::Media.new(region)
+    end
+
+    ##
+    # @param region [String] API Region
+    # @return {ModifiedCrafting}
+    def self.modified_crafting(region = BlizzardApi.region)
+      BlizzardApi::Wow::ModifiedCrafting.new(region)
+    end
+
     ##
     # @param region [String] API Region
     # @return {Mount}
@@ -226,6 +254,13 @@ module BlizzardApi
       BlizzardApi::Wow::Talent.new(region)
     end
 
+    ##
+    # @param region [String] API Region
+    # @return {TechTalent}
+    def self.tech_talent(region = BlizzardApi.region)
+      BlizzardApi::Wow::TechTalent.new(region)
+    end
+
     ##
     # @param region [String] API Region
     # @return {Title}

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.azerite_essence
     class AzeriteEssence < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
       ##
       # Fetch media for one of the azerite essences listed by the {#index} using its *id*
       #

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.connected_realm
     class ConnectedRealm < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
       protected
 
       def endpoint_setup

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft azerite essences
+    #
+    # @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.azerite_essence
+    class Covenant < Wow::GenericDataEndpoint
+      ##
+      # Fetch media for one of the covenants listed by the {#index} using its *id*
+      #
+      # @param id [Integer] Covenant id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, options = {})
+        api_request "#{base_url(:media)}/covenant/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch all soulbinds
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def soulbinds(options = {})
+        api_request "#{base_url(:game_data)}/covenant/soulbind/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch a soulbind by its id
+      #
+      # @param id Soulbind id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def soulbind(id, options = {})
+        api_request "#{base_url(:game_data)}/covenant/soulbind/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch all conduits
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def conduits(options = {})
+        api_request "#{base_url(:game_data)}/covenant/conduit/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch a conduit by its id
+      #
+      # @param id Conduit id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def conduit(id, options = {})
+        api_request "#{base_url(:game_data)}/covenant/conduit/#{id}", default_options.merge(options)
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'covenant'
+        @namespace = :static
+        @collection = 'covenants'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.creature
     class Creature < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
       def index
         raise BlizzardApi::ApiException, 'Creatures endpoint doesn\'t have a index method'
       end

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

@@ -7,8 +7,8 @@ module BlizzardApi
     class GenericDataEndpoint < Wow::Request
       ##
       # @!macro regions
-      def initialize(region = nil)
-        super region
+      def initialize(region = nil, mode = :regular)
+        super region, mode
         endpoint_setup
         @ttl ||= CACHE_DAY
       end
@@ -48,9 +48,9 @@ module BlizzardApi
 
       protected
 
-      def endpoint_uri(variant = nil)
+      def endpoint_uri(variant = nil, scope = :game_data)
         endpoint = variant ? "#{@endpoint}-#{variant}" : @endpoint
-        "#{base_url(:game_data)}/#{endpoint}"
+        "#{base_url(scope)}/#{endpoint}"
       end
 
       def endpoint_setup

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.item
     class Item < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
       ##
       # This method overrides the inherited default behavior to prevent high server load and fetch time
       #

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

@@ -97,6 +97,21 @@ module BlizzardApi
         api_request "#{endpoint_uri('encounter')}/#{id}", default_options.merge(options)
       end
 
+      ##
+      # Fetch data base on search criteria
+      #
+      # @param page [Integer] Page o return
+      # @param page_size [Integer] Amount of items per page
+      #
+      # @!macro request_options
+      # @!macro response
+      def encounter_search(page = 1, page_size = 100, options = {})
+        search_options = SearchComposer.new(page, page_size)
+        yield search_options if block_given?
+
+        api_request "#{endpoint_uri('encounter', :search)}?#{search_options.to_search_query}", default_options.merge(options)
+      end
+
       protected
 
       def endpoint_setup

data/lib/blizzard_api/wow/game_data/media.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 Media < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
+      def index(_options = nil)
+        raise BlizzardApi::ApiException, 'This endpoint does not have a index method'
+      end
+
+      def get(_options = nil)
+        raise BlizzardApi::ApiException, 'This endpoint does not have a get method'
+      end
+
+      def complete(_options = nil)
+        raise BlizzardApi::ApiException, 'This endpoint does not have a complete method'
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'media'
+        @namespace = :static
+        @collection = 'medias'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft professions
+    #
+    # @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.modified_crafting
+    class ModifiedCrafting < Wow::GenericDataEndpoint
+      def complete
+        raise BlizzardApi::ApiException, 'This endpoint does not have a complete method.'
+      end
+
+      ##
+      # Fetch modified crafting category index
+      #
+      # @!macro request_options
+      def categories(options = {})
+        api_request "#{base_url(:game_data)}/modified-crafting/category/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch a modified crafting category
+      #
+      # @param id [Integer] Modified crafting category id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def category(id, options = {})
+        api_request "#{base_url(:game_data)}/modified-crafting/category/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch modified crafting slot type index
+      #
+      # @!macro request_options
+      def slot_types(options = {})
+        api_request "#{base_url(:game_data)}/modified-crafting/reagent-slot-type/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch a modified crafting slot type
+      #
+      # @param id [Integer] Modified crafting slot type id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def slot_type(id, options = {})
+        api_request "#{base_url(:game_data)}/modified-crafting/reagent-slot-type/#{id}", default_options.merge(options)
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'modified-crafting'
+        @namespace = :static
+        @collection = 'professions'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.mount
     class Mount < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
       protected
 
       def endpoint_setup

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

@@ -10,6 +10,52 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.pet
     class Pet < Wow::GenericDataEndpoint
+      ##
+      # Fetch media for one of the pets listed by the {#index} using its *id*
+      #
+      # @param id [Integer] Pet id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, options = {})
+        api_request "#{base_url(:media)}/pet/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch all pet abilities
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def abilities(options = {})
+        api_request "#{endpoint_uri('ability')}/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch a pet ability
+      #
+      # @param id [Integer] Pet id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def ability(id, options = {})
+        api_request "#{endpoint_uri('ability')}/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch media for one of the pet abilities listed by the {#abilities} using its *id*
+      #
+      # @param id [Integer] Pet ability id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def ability_media(id, options = {})
+        api_request "#{base_url(:media)}/pet-ability/#{id}", default_options.merge(options)
+      end
+
       protected
 
       def endpoint_setup

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.realm
     class Realm < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
       protected
 
       def endpoint_setup

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.spell
     class Spell < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
       ##
       # This method overrides the inherited default behavior to prevent high server load and fetch time
       #