blizzard_api 0.5.2 → 0.6.0

data/lib/blizzard_api/configuration.rb

@@ -45,13 +45,12 @@ module BlizzardApi
     attr_accessor :redis_port
 
     ##
-    # @!attribute format
-    #   Response format:
-    #   * *:raw* plain text (String)
-    #   * *:json* for native ruby json (Array).
-    #   * Any other value *OpenStruct* will be used.
-    #   @return [Symbol] Response format.
-    attr_accessor :format
+    #
+    # @!attribute concurrency
+    #   How many threads to use for WoW game data `complete` payloads. Defaults to 4.
+    #   Should be set to the amount of available cores on the system.
+    #   @return [Integer] Concurrency
+    attr_accessor :concurrency
 
     ##
     # @!attribute access_token
@@ -59,33 +58,6 @@ module BlizzardApi
     #   @return [String] Access token.
     attr_accessor :access_token
 
-    ##
-    # @!attribute icons_directory
-    #   Icons directory.
-    #   This directory stores icons for many World of Warcraft endpoints.
-    #   @return [String] icons_directory
-    attr_accessor :wow_icons_directory
-
-    ##
-    # @!attribute guild_emblem_directory
-    #   Guild crest images directory. Some sub directories will be created.
-    #   @see https://develop.battle.net/access/clients
-    #   @return [String] Guild crest directory
-    attr_accessor :wow_guild_crest_directory
-
-    ##
-    # @!attribute wow_character_profile_directory
-    #   This directory stores images for World of Warcraft character profiles. Sub directories will be created for
-    #   each realm and character.
-    #   @return [String] Character profile media directory
-    attr_accessor :wow_character_profile_directory
-
-    ##
-    # @!attribute wow_npc_directory
-    #   This directory stores images for World of Warcraft NPCs and creatures.
-    #   @return [String] NPCs media directory
-    attr_accessor :wow_npc_directory
-
     ##
     # This method return the singleton instance of the configuration module. Use this to initialize the default values
     # and options.
@@ -110,5 +82,9 @@ module BlizzardApi
     def configure
       yield self
     end
+
+    def concurrency
+      @concurrency ||= 4
+    end
   end
 end

data/lib/blizzard_api/diablo/community/act.rb

@@ -16,8 +16,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def index(options = {})
-        api_request "#{base_url(:community)}/data/act", { ttl: CACHE_TRIMESTER }.merge(options)
+      def index(**options)
+        api_request "#{base_url(:community)}/data/act", **{ ttl: CACHE_TRIMESTER }.merge(options)
       end
 
       ##
@@ -27,8 +27,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(id, options = {})
-        api_request "#{base_url(:community)}/data/act/#{id}", { ttl: CACHE_TRIMESTER }.merge(options)
+      def get(id, **options)
+        api_request "#{base_url(:community)}/data/act/#{id}", **{ ttl: CACHE_TRIMESTER }.merge(options)
       end
     end
   end

data/lib/blizzard_api/diablo/community/artisan.rb

@@ -17,8 +17,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(artisan_slug, options = {})
-        api_request "#{base_url(:community)}/data/artisan/#{artisan_slug}", { ttl: CACHE_TRIMESTER }.merge(options)
+      def get(artisan_slug, **options)
+        api_request "#{base_url(:community)}/data/artisan/#{artisan_slug}", **{ ttl: CACHE_TRIMESTER }.merge(options)
       end
 
       ##
@@ -29,9 +29,9 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def recipe(artisan_slug, recipe_slug, options = {})
+      def recipe(artisan_slug, recipe_slug, **options)
         opts = { ttl: CACHE_TRIMESTER }.merge(options)
-        api_request "#{base_url(:community)}/data/artisan/#{artisan_slug}/recipe/#{recipe_slug}", opts
+        api_request "#{base_url(:community)}/data/artisan/#{artisan_slug}/recipe/#{recipe_slug}", **opts
       end
     end
   end

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

@@ -17,8 +17,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(class_slug, options = {})
-        api_request "#{base_url(:community)}/data/hero/#{class_slug}", { ttl: CACHE_TRIMESTER }.merge(options)
+      def get(class_slug, **options)
+        api_request "#{base_url(:community)}/data/hero/#{class_slug}", **{ ttl: CACHE_TRIMESTER }.merge(options)
       end
 
       ##
@@ -29,9 +29,9 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def skill(class_slug, skill_slug, options = {})
+      def skill(class_slug, skill_slug, **options)
         opts = { ttl: CACHE_TRIMESTER }.merge(options)
-        api_request "#{base_url(:community)}/data/hero/#{class_slug}/skill/#{skill_slug}", opts
+        api_request "#{base_url(:community)}/data/hero/#{class_slug}/skill/#{skill_slug}", **opts
       end
     end
   end

data/lib/blizzard_api/diablo/community/follower.rb

@@ -17,8 +17,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(follower_slug, options = {})
-        api_request "#{base_url(:community)}/data/follower/#{follower_slug}", { ttl: CACHE_TRIMESTER }.merge(options)
+      def get(follower_slug, **options)
+        api_request "#{base_url(:community)}/data/follower/#{follower_slug}", **{ ttl: CACHE_TRIMESTER }.merge(options)
       end
     end
   end

data/lib/blizzard_api/diablo/community/item.rb

@@ -17,8 +17,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(item_slug_and_id, options = {})
-        api_request "#{base_url(:community)}/data/item/#{item_slug_and_id}", { ttl: CACHE_TRIMESTER }.merge(options)
+      def get(item_slug_and_id, **options)
+        api_request "#{base_url(:community)}/data/item/#{item_slug_and_id}", **{ ttl: CACHE_TRIMESTER }.merge(options)
       end
     end
   end

data/lib/blizzard_api/diablo/community/item_type.rb

@@ -16,8 +16,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def index(options = {})
-        api_request "#{base_url(:community)}/data/item-type", { ttl: CACHE_TRIMESTER }.merge(options)
+      def index(**options)
+        api_request "#{base_url(:community)}/data/item-type", **{ ttl: CACHE_TRIMESTER }.merge(options)
       end
 
       ##
@@ -27,8 +27,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(item_type_slug, options = {})
-        api_request "#{base_url(:community)}/data/item-type/#{item_type_slug}", { ttl: CACHE_TRIMESTER }.merge(options)
+      def get(item_type_slug, **options)
+        api_request "#{base_url(:community)}/data/item-type/#{item_type_slug}", **{ ttl: CACHE_TRIMESTER }.merge(options)
       end
     end
   end

data/lib/blizzard_api/diablo/community/profile.rb

@@ -20,7 +20,7 @@ module BlizzardApi
       # @!macro response
       #
       # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
-      def index(battletag, oauth_token, options = {})
+      def index(battletag, oauth_token, **options)
         opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
         api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/", opts
       end
@@ -36,7 +36,7 @@ module BlizzardApi
       # @!macro response
       #
       # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
-      def hero(battletag, oauth_token, hero_id, options = {})
+      def hero(battletag, oauth_token, hero_id, **options)
         opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
         api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/hero/#{hero_id}", opts
       end
@@ -52,7 +52,7 @@ module BlizzardApi
       # @!macro response
       #
       # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
-      def hero_items(battletag, oauth_token, hero_id, options = {})
+      def hero_items(battletag, oauth_token, hero_id, **options)
         opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
         api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/hero/#{hero_id}/items", opts
       end
@@ -68,7 +68,7 @@ module BlizzardApi
       # @!macro response
       #
       # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
-      def hero_follower_items(battletag, oauth_token, hero_id, options = {})
+      def hero_follower_items(battletag, oauth_token, hero_id, **options)
         opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
         api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/hero/#{hero_id}/follower-items", opts
       end

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

@@ -16,8 +16,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def index(options = {})
-        api_request "#{base_url(:game_data)}/#{@endpoint}/", default_options.merge(options)
+      def index(**options)
+        api_request "#{base_url(:game_data)}/#{@endpoint}/", **default_options.merge(options)
       end
 
       ##
@@ -27,8 +27,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(id, options = {})
-        api_request "#{base_url(:game_data)}/#{@endpoint}/#{id}", default_options.merge(options)
+      def get(id, **options)
+        api_request "#{base_url(:game_data)}/#{@endpoint}/#{id}", **default_options.merge(options)
       end
 
       ##
@@ -39,9 +39,9 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def leaderboard(id, leaderboard_id, options = {})
+      def leaderboard(id, leaderboard_id, **options)
         opts = default_options.merge(options)
-        api_request "#{base_url(:game_data)}/#{@endpoint}/#{id}/leaderboard/#{leaderboard_id}", opts
+        api_request "#{base_url(:game_data)}/#{@endpoint}/#{id}/leaderboard/#{leaderboard_id}", **opts
       end
 
       protected

data/lib/blizzard_api/hearthstone/game_data/back.rb

@@ -36,10 +36,10 @@ module BlizzardApi
       #   option is invalid
       #
       # @!macro response
-      def search(search_options = {}, options = {})
+      def search(search_options = {}, **options)
         validate_search_options search_options if options.include? :validate_fields
 
-        api_request "#{base_url(:community)}/cardbacks", default_options.merge(options).merge(search_options)
+        api_request "#{base_url(:community)}/cardbacks", **default_options.merge(options).merge(search_options)
       end
 
       protected

data/lib/blizzard_api/hearthstone/game_data/card.rb

@@ -72,10 +72,10 @@ module BlizzardApi
       #   option is invalid
       #
       # @!macro response
-      def search(search_options = {}, options = {})
+      def search(search_options = {}, **options)
         validate_search_options search_options if options.include? :validate_fields
 
-        api_request "#{base_url(:community)}/cards", default_options.merge(options).merge(search_options)
+        api_request "#{base_url(:community)}/cards", **default_options.merge(options).merge(search_options)
       end
 
       ##
@@ -90,8 +90,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(id_or_slug, game_mode = 'constructed', options = {})
-        super id_or_slug, { gameMode: game_mode }.merge(options)
+      def get(id_or_slug, game_mode = 'constructed', **options)
+        super id_or_slug, **{ gameMode: game_mode }.merge(options)
       end
 
       protected

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

@@ -20,8 +20,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def index(options = {})
-        api_request "#{base_url(:community)}/#{@endpoint}/", default_options.merge(options)
+      def index(**options)
+        api_request "#{base_url(:community)}/#{@endpoint}/", **default_options.merge(options)
       end
 
       ##
@@ -31,8 +31,8 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def get(id, options = {})
-        api_request "#{base_url(:community)}/#{@endpoint}/#{id}", default_options.merge(options)
+      def get(id, **options)
+        api_request "#{base_url(:community)}/#{@endpoint}/#{id}", **default_options.merge(options)
       end
 
       protected

data/lib/blizzard_api/request.rb

@@ -9,6 +9,7 @@
 #   @option options [Boolean] :ignore_cache If set to true the request will not use the cache
 #   @option options [Integer] :ttl Override the default time (in seconds) a request should be cached
 #   @option options [DateTime] :since Adds the If-modified-since headers. Will always ignore cache when set.
+#   @option options [Integer] :concurrency How many threads to use for complete sets of data. BEWARE: Might cause 429 responses, in this case lower the number.
 
 ##
 # @!macro [new] regions
@@ -17,7 +18,7 @@
 
 ##
 # @!macro [new] response
-#   @return [OpenStruct,Array] API Response. The actual type of the returned object depends on the *format* option
+#   @return [Hash] API Response. The actual type of the returned object depends on the *format* option
 #   in the configuration module
 
 ##
@@ -115,7 +116,7 @@ module BlizzardApi
       BlizzardApi.access_token = JSON.parse(response.body)['access_token']
     end
 
-    def request(url, options = {})
+    def request(url, **options)
       # Creates the whole url for request
       parsed_url = URI.parse(url)
 
@@ -124,7 +125,7 @@ module BlizzardApi
       # If data was found that means cache is enabled and valid
       return JSON.parse(data, symbolize_names: true) if data
 
-      response = consume_api parsed_url, options
+      response = consume_api parsed_url, **options
 
       save_in_cache parsed_url.to_s, response.body, options[:ttl] || CACHE_DAY if using_cache? options
 
@@ -134,7 +135,7 @@ module BlizzardApi
       response_data
     end
 
-    def api_request(uri, query_string = {})
+    def api_request(uri, **query_string)
       # List of request options
       options_key = %i[ignore_cache ttl format access_token namespace classic headers since]
 
@@ -150,7 +151,7 @@ module BlizzardApi
         uri = uri.include?('?') ? "#{uri}&#{query_string}" : "#{uri}?#{query_string}"
       end
 
-      request uri, options
+      request uri, **options
     end
 
     private
@@ -163,7 +164,7 @@ module BlizzardApi
       !options.fetch(:ignore_cache, false)
     end
 
-    def consume_api(url, options = {})
+    def consume_api(url, **options)
       # Creates a HTTP connection and request to ensure thread safety
       http = Net::HTTP.new(url.host, url.port)
       http.use_ssl = true
@@ -174,7 +175,7 @@ module BlizzardApi
       # Executes the request
       http.request(request).tap do |response|
         if mode.eql?(:regular) && ![200, 304].include?(response.code.to_i)
-          raise BlizzardApi::ApiException.new 'Request failed', response.code.to_i
+          raise BlizzardApi::ApiException.new "Request failed with code '#{response.code}' details: #{response.to_hash}", response.code.to_i
         end
       end
     end

data/lib/blizzard_api/starcraft.rb

@@ -19,6 +19,7 @@ module BlizzardApi
     require_relative 'starcraft/community/profile'
     require_relative 'starcraft/community/ladder'
     require_relative 'starcraft/community/account'
+    require_relative 'starcraft/community/legacy'
 
     ##
     # @param region [String] API Region
@@ -40,5 +41,11 @@ module BlizzardApi
     def self.account(region = BlizzardApi.region)
       BlizzardApi::Starcraft::Account.new(region)
     end
+    
+    ##
+    # @return {Legacy}
+    def self.legacy(region = BlizzardApi.region)
+      BlizzardApi::Starcraft::Legacy.new(region)
+    end
   end
 end

data/lib/blizzard_api/starcraft/community/account.rb

@@ -15,7 +15,7 @@ module BlizzardApi
       #
       # @param [Integer] account_id Account ID
       # @!macro request_options
-      def player(account_id, options = {})
+      def player(account_id, **options)
         api_request "#{base_url(:community)}/player/#{account_id}", { ttl: CACHE_DAY }.merge(options)
       end
     end

data/lib/blizzard_api/starcraft/community/ladder.rb

@@ -15,9 +15,9 @@ module BlizzardApi
       #
       # @!macro sc2_regions
       # @!macro request_options
-      def grandmaster(region_id, options = {})
+      def grandmaster(region_id, **options)
         reg = resolve_region(region_id)
-        api_request "#{base_url(:community)}/ladder/grandmaster/#{reg}", { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/ladder/grandmaster/#{reg}", **{ ttl: CACHE_DAY }.merge(options)
       end
 
       ##
@@ -25,9 +25,9 @@ module BlizzardApi
       #
       # @!macro sc2_regions
       # @!macro request_options
-      def season(region_id, options = {})
+      def season(region_id, **options)
         reg = resolve_region(region_id)
-        api_request "#{base_url(:community)}/ladder/season/#{reg}", { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/ladder/season/#{reg}", **{ ttl: CACHE_DAY }.merge(options)
       end
     end
   end

data/lib/blizzard_api/starcraft/community/legacy.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Starcraft
+    ##
+    # This class allows access to Starcraft II legacy data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/starcraft-2-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Starcraft.legacy
+    class Legacy < Starcraft::Request
+      
+      ##
+      # Profile data
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      def profile(region_id, realm_id, profile_id, **options)
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}", opts
+      end
+
+      ##
+      # Ladders
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      def ladders(region_id, realm_id, profile_id, **options)
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}/ladder ", opts
+      end
+
+      ##
+      # Match History
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      def match(region_id, realm_id, profile_id, **options)
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}/matches", opts
+      end
+      
+      ##
+      # Ladder
+      #
+      # @!macro sc2_regions
+      # @param [Integer] ladder_id Ladder ID
+      # @!macro request_options
+      def ladder(region_id, ladder_id, **options)
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/ladder/#{reg}/#{ladder_id}", opts
+      end
+      
+      ##
+      # Achievement data
+      #
+      # @!macro sc2_regions
+      # @!macro request_options
+      def achievements(region_id, **options)
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/data/achievements/#{reg}", opts
+      end
+      
+      ##
+      # Rewards data
+      #
+      # @!macro sc2_regions
+      # @!macro request_options
+      def rewards(region_id, **options)
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/data/rewards/#{reg}", opts
+      end
+    end
+  end
+end