blizzard_api 0.5.1 → 0.5.6

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

@@ -24,7 +24,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def categories(options = {})
+      def categories(**options)
         api_request "#{endpoint_uri('category')}/index", default_options.merge(options)
       end
 
@@ -34,7 +34,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def category(id, options = {})
+      def category(id, **options)
         api_request "#{endpoint_uri('category')}/#{id}", default_options.merge(options)
       end
 
@@ -44,7 +44,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def media(id, options = {})
+      def media(id, **options)
         api_request "#{base_url(:media)}/achievement/#{id}", default_options.merge(options)
       end
 

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

@@ -17,7 +17,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(connected_realm_id, options = {})
+      def get(connected_realm_id, **options)
         opts = { ttl: CACHE_HOUR, namespace: :dynamic }.merge(options)
         api_request "#{base_url(:game_data)}/connected-realm/#{connected_realm_id}/auctions", opts
       end

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

@@ -20,7 +20,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def media(id, options = {})
+      def media(id, **options)
         api_request "#{base_url(:media)}/azerite-essence/#{id}", default_options.merge(options)
       end
 

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

@@ -27,7 +27,7 @@ module BlizzardApi
       # @option options [Boolean] :classic If set to true, this method will call the classic version
       #
       # @!macro response
-      def families(options = {})
+      def families(**options)
         api_request "#{endpoint_uri('family')}/index", default_options.merge(options)
       end
 
@@ -40,7 +40,7 @@ module BlizzardApi
       # @option options [Boolean] :classic If set to true, this method will call the classic version
       #
       # @!macro response
-      def family(id, options = {})
+      def family(id, **options)
         api_request "#{endpoint_uri('family')}/#{id}", default_options.merge(options)
       end
 
@@ -53,7 +53,7 @@ module BlizzardApi
       # @option options [Boolean] :classic If set to true, this method will call the classic version
       #
       # @!macro response
-      def family_media(id, options = {})
+      def family_media(id, **options)
         api_request "#{base_url(:media)}/creature-family/#{id}", default_options.merge(options)
       end
 
@@ -64,7 +64,7 @@ module BlizzardApi
       # @option options [Boolean] :classic If set to true, this method will call the classic version
       #
       # @!macro response
-      def types(options = {})
+      def types(**options)
         api_request "#{endpoint_uri('type')}/index", default_options.merge(options)
       end
 
@@ -77,7 +77,7 @@ module BlizzardApi
       # @option options [Boolean] :classic If set to true, this method will call the classic version
       #
       # @!macro response
-      def type(id, options = {})
+      def type(id, **options)
         api_request "#{endpoint_uri('type')}/#{id}", default_options.merge(options)
       end
 
@@ -90,7 +90,7 @@ module BlizzardApi
       # @option options [Boolean] :classic If set to true, this method will call the classic version
       #
       # @!macro response
-      def display_media(id, options = {})
+      def display_media(id, **options)
         api_request "#{base_url(:media)}/creature-display/#{id}", default_options.merge(options)
       end
 

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

@@ -18,7 +18,7 @@ module BlizzardApi
       #
       # @!macro request_options
       # @!macro response
-      def index(options = {})
+      def index(**options)
         api_request "#{endpoint_uri}/index", default_options.merge(options)
       end
 
@@ -29,13 +29,13 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(id, options = {})
+      def get(id, **options)
         api_request "#{endpoint_uri}/#{id}", default_options.merge(options)
       end
 
       ##
       # @!macro complete
-      def complete(options = {})
+      def complete(**options)
         [].tap do |complete_data|
           index_data = index options
           index_data[@collection.to_sym].each do |item|

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

@@ -23,7 +23,7 @@ module BlizzardApi
       # @option options [Boolean] :classic If set to true, this method will call the classic version
       #
       # @!macro response
-      def border_media(id, options = {})
+      def border_media(id, **options)
         api_request "#{base_url(:media)}/#{@endpoint}/border/#{id}", default_options.merge(options)
       end
 
@@ -36,7 +36,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def emblem_media(id, options = {})
+      def emblem_media(id, **options)
         api_request "#{base_url(:media)}/#{@endpoint}/emblem/#{id}", default_options.merge(options)
       end
 

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

@@ -35,7 +35,7 @@ module BlizzardApi
       # @option options [Boolean] :classic If set to true, this method will call the classic version
       #
       # @!macro response
-      def classes(options = {})
+      def classes(**options)
         api_request "#{endpoint_uri('class')}/index", default_options.merge(options)
       end
 
@@ -47,7 +47,7 @@ module BlizzardApi
       # @option options [Boolean] :classic If set to true, this method will call the classic version
       #
       # @!macro response
-      def class(id, options = {})
+      def class(id, **options)
         api_request "#{endpoint_uri('class')}/#{id}", default_options.merge(options)
       end
 
@@ -60,7 +60,7 @@ module BlizzardApi
       # @option options [Boolean] :classic If set to true, this method will call the classic version
       #
       # @!macro response
-      def subclass(id, subclass_id, options = {})
+      def subclass(id, subclass_id, **options)
         api_request "#{endpoint_uri('class')}/#{id}/item-subclass/#{subclass_id}", default_options.merge(options)
       end
 
@@ -73,7 +73,7 @@ module BlizzardApi
       # @option options [Boolean] :classic If set to true, this method will call the classic version
       #
       # @!macro response
-      def media(id, options = {})
+      def media(id, **options)
         api_request "#{base_url(:media)}/item/#{id}", default_options.merge(options)
       end
 
@@ -83,7 +83,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def sets(options = {})
+      def sets(**options)
         api_request "#{endpoint_uri('set')}/index", default_options.merge(options)
       end
 
@@ -94,7 +94,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def set(id, options = {})
+      def set(id, **options)
         api_request "#{endpoint_uri('set')}/#{id}", default_options.merge(options)
       end
 

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

@@ -30,7 +30,7 @@ module BlizzardApi
       # This method overrides the inherited default behavior to prevent high server load and fetch time
       #
       # @!macro response
-      def get(_id, _options = {})
+      def get(_id, **options)
         raise BlizzardApi::ApiException, 'This endpoint does not have a get method'
       end
 
@@ -40,7 +40,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def expansions(options = {})
+      def expansions(**options)
         api_request "#{endpoint_uri('expansion')}/index", default_options.merge(options)
       end
 
@@ -51,7 +51,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def expansion(id, options = {})
+      def expansion(id, **options)
         api_request "#{endpoint_uri('expansion')}/#{id}", default_options.merge(options)
       end
 
@@ -61,7 +61,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def instances(options = {})
+      def instances(**options)
         api_request "#{endpoint_uri('instance')}/index", default_options.merge(options)
       end
 
@@ -72,7 +72,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def instance(id, options = {})
+      def instance(id, **options)
         api_request "#{endpoint_uri('instance')}/#{id}", default_options.merge(options)
       end
 
@@ -82,7 +82,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def encounters(options = {})
+      def encounters(**options)
         api_request "#{endpoint_uri('encounter')}/index", default_options.merge(options)
       end
 
@@ -93,7 +93,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def encounter(id, options = {})
+      def encounter(id, **options)
         api_request "#{endpoint_uri('encounter')}/#{id}", default_options.merge(options)
       end
 
@@ -105,7 +105,7 @@ module BlizzardApi
       #
       # @!macro request_options
       # @!macro response
-      def encounter_search(page = 1, page_size = 100, options = {})
+      def encounter_search(page = 1, page_size = 100, **options)
         search_options = SearchComposer.new(page, page_size)
         yield search_options if block_given?
 

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

@@ -18,7 +18,7 @@ module BlizzardApi
       # Fetch modified crafting category index
       #
       # @!macro request_options
-      def categories(options = {})
+      def categories(**options)
         api_request "#{base_url(:game_data)}/modified-crafting/category/index", default_options.merge(options)
       end
 
@@ -30,7 +30,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def category(id, options = {})
+      def category(id, **options)
         api_request "#{base_url(:game_data)}/modified-crafting/category/#{id}", default_options.merge(options)
       end
 
@@ -38,7 +38,7 @@ module BlizzardApi
       # Fetch modified crafting slot type index
       #
       # @!macro request_options
-      def slot_types(options = {})
+      def slot_types(**options)
         api_request "#{base_url(:game_data)}/modified-crafting/reagent-slot-type/index", default_options.merge(options)
       end
 
@@ -50,7 +50,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def slot_type(id, options = {})
+      def slot_type(id, **options)
         api_request "#{base_url(:game_data)}/modified-crafting/reagent-slot-type/#{id}", default_options.merge(options)
       end
 

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

@@ -24,7 +24,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def dungeons(options = {})
+      def dungeons(**options)
         api_request "#{endpoint_uri}/dungeon/index", default_options.merge(options)
       end
 
@@ -36,7 +36,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def dungeon(id, options = {})
+      def dungeon(id, **options)
         api_request "#{endpoint_uri}/dungeon/#{id}", default_options.merge(options)
       end
 
@@ -46,7 +46,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def periods(options = {})
+      def periods(**options)
         api_request "#{endpoint_uri}/period/index", default_options.merge(options)
       end
 
@@ -58,7 +58,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def period(id, options = {})
+      def period(id, **options)
         api_request "#{endpoint_uri}/period/#{id}", default_options.merge(options)
       end
 
@@ -68,7 +68,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def seasons(options = {})
+      def seasons(**options)
         api_request "#{endpoint_uri}/season/index", default_options.merge(options)
       end
 
@@ -80,7 +80,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def season(id, options = {})
+      def season(id, **options)
         api_request "#{endpoint_uri}/season/#{id}", default_options.merge(options)
       end
 

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

@@ -18,7 +18,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def media(id, options = {})
+      def media(id, **options)
         api_request "#{base_url(:media)}/keystone-affix/#{id}", default_options.merge(options)
       end
 

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

@@ -18,7 +18,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def index(connected_realm_id, options = {})
+      def index(connected_realm_id, **options)
         api_request "#{endpoint_uri(connected_realm_id)}/index", default_options(options)
       end
 
@@ -30,7 +30,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(connected_realm_id, dungeon_id, period, options = {})
+      def get(connected_realm_id, dungeon_id, period, **options)
         api_request "#{endpoint_uri(connected_realm_id)}/#{dungeon_id}/period/#{period}", default_options(options)
       end