blizzard_api 0.5.6 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b285d4489642a601b88964d4b1a150edde7e95fef456be3bf2ea03fa0bc2c7e9
-  data.tar.gz: 8856431d0831292b61e54b7a558270bcb8c3288153490a20268057a00a91a505
+  metadata.gz: 7671ab9869534ec9c4c8031eac8e73ac9f389b9199cd9ca61a0e80127de66c53
+  data.tar.gz: 915f7c1ff4b867b4b403dcb55128ab134b5012f380e90a8c589097ba57bf28a8
 SHA512:
-  metadata.gz: 98257842acc25c914dc2f1b3237b52ae52c6d197906c9c42b3a4ddca3fd54a25718bf61a15ed97155c330c9cad1ef0b2938dc266e4537da32d7e880b97b230a8
-  data.tar.gz: a6f85d169c53bf0a9e671b07b73fbd21333bc1eb3457d4be9c5e47fae57be6a99083f575f91c112ca1dea8c89d9a1c7e073f8f7b54569421cf5a5de5e0faf349
+  metadata.gz: 50ce63d400f8997131913f6b677b3676bf68c5134d0acf5328276a37d861073f57004eb3c922821c261608a17610e25c956a1401633d99d25af68cb05c8729f8
+  data.tar.gz: f57a645a37541c1ab06113439529822b84fe71808447303d04b25ba947e368754169e7cb6532482d584061c5a0708b1c7ecf0fe9392c896e236bc132f8c4885b

data/.github/workflows/ruby.yml

@@ -10,7 +10,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@21351ecc0a7c196081abca5dc55b08f085efe09a
         with:
-          ruby-version: 2.6
+          ruby-version: 3.0.0-preview1
       - name: Install dependencies
         run: bundle install
       - name: Run tests

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 0.6.0**
+
+Upgraded gem dependencies and refactored the code to support Ruby 3.0.0
+Required ruby version upgraded to 2.7.2
+Added concurrency to all WoW game data *complete* methods. Default of 4 threads. Should be close to # of threads available.
+
 **Version 0.5.6**
 
 Upgrade gem dependencies to fix a security vulnerability 

data/Gemfile.lock

@@ -1,14 +1,16 @@
 PATH
   remote: .
   specs:
-    blizzard_api (0.5.6)
+    blizzard_api (0.6.0)
       redis (~> 4.1, >= 4.1.0)
+      thwait (~> 0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     dotenv (2.7.6)
+    e2mmap (0.1.0)
     minitest (5.14.4)
     parallel (1.20.1)
     parser (3.0.1.1)
@@ -30,6 +32,8 @@ GEM
     rubocop-ast (1.5.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
+    thwait (0.2.0)
+      e2mmap
     unicode-display_width (1.7.0)
     yard (0.9.26)
 
@@ -45,4 +49,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.1.4
+   2.2.17

data/blizzard_api.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'blizzard_api/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = '>= 2.7.2'
   spec.name = 'blizzard_api'
   spec.version = BlizzardApi::VERSION
   spec.authors = ['Francis Schiavo']
@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'redis', '~> 4.1', '>= 4.1.0'
+  spec.add_runtime_dependency 'thwait', '~> 0.2.0'
 
   spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'minitest', '~> 5.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

@@ -17,7 +17,7 @@ module BlizzardApi
       #
       # @!macro response
       def index(**options)
-        api_request "#{base_url(:community)}/data/act", { ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/data/act", **{ ttl: CACHE_TRIMESTER }.merge(options)
       end
 
       ##
@@ -28,7 +28,7 @@ module BlizzardApi
       #
       # @!macro response
       def get(id, **options)
-        api_request "#{base_url(:community)}/data/act/#{id}", { ttl: CACHE_TRIMESTER }.merge(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

@@ -18,7 +18,7 @@ module BlizzardApi
       #
       # @!macro response
       def get(artisan_slug, **options)
-        api_request "#{base_url(:community)}/data/artisan/#{artisan_slug}", { ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/data/artisan/#{artisan_slug}", **{ ttl: CACHE_TRIMESTER }.merge(options)
       end
 
       ##
@@ -31,7 +31,7 @@ module BlizzardApi
       # @!macro response
       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

@@ -18,7 +18,7 @@ module BlizzardApi
       #
       # @!macro response
       def get(class_slug, **options)
-        api_request "#{base_url(:community)}/data/hero/#{class_slug}", { ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/data/hero/#{class_slug}", **{ ttl: CACHE_TRIMESTER }.merge(options)
       end
 
       ##
@@ -31,7 +31,7 @@ module BlizzardApi
       # @!macro response
       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

@@ -18,7 +18,7 @@ module BlizzardApi
       #
       # @!macro response
       def get(follower_slug, **options)
-        api_request "#{base_url(:community)}/data/follower/#{follower_slug}", { ttl: CACHE_TRIMESTER }.merge(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

@@ -18,7 +18,7 @@ module BlizzardApi
       #
       # @!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)
+        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

@@ -17,7 +17,7 @@ module BlizzardApi
       #
       # @!macro response
       def index(**options)
-        api_request "#{base_url(:community)}/data/item-type", { ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/data/item-type", **{ ttl: CACHE_TRIMESTER }.merge(options)
       end
 
       ##
@@ -28,7 +28,7 @@ module BlizzardApi
       #
       # @!macro response
       def get(item_type_slug, **options)
-        api_request "#{base_url(:community)}/data/item-type/#{item_type_slug}", { ttl: CACHE_TRIMESTER }.merge(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/game_data/generic_data_endpoint.rb

@@ -17,7 +17,7 @@ module BlizzardApi
       #
       # @!macro response
       def index(**options)
-        api_request "#{base_url(:game_data)}/#{@endpoint}/", default_options.merge(options)
+        api_request "#{base_url(:game_data)}/#{@endpoint}/", **default_options.merge(options)
       end
 
       ##
@@ -28,7 +28,7 @@ module BlizzardApi
       #
       # @!macro response
       def get(id, **options)
-        api_request "#{base_url(:game_data)}/#{@endpoint}/#{id}", default_options.merge(options)
+        api_request "#{base_url(:game_data)}/#{@endpoint}/#{id}", **default_options.merge(options)
       end
 
       ##
@@ -41,7 +41,7 @@ module BlizzardApi
       # @!macro response
       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

@@ -39,7 +39,7 @@ module BlizzardApi
       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

@@ -75,7 +75,7 @@ module BlizzardApi
       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
 
       ##
@@ -91,7 +91,7 @@ module BlizzardApi
       #
       # @!macro response
       def get(id_or_slug, game_mode = 'constructed', **options)
-        super id_or_slug, { gameMode: game_mode }.merge(options)
+        super id_or_slug, **{ gameMode: game_mode }.merge(options)
       end
 
       protected

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

@@ -21,7 +21,7 @@ module BlizzardApi
       #
       # @!macro response
       def index(**options)
-        api_request "#{base_url(:community)}/#{@endpoint}/", default_options.merge(options)
+        api_request "#{base_url(:community)}/#{@endpoint}/", **default_options.merge(options)
       end
 
       ##
@@ -32,7 +32,7 @@ module BlizzardApi
       #
       # @!macro response
       def get(id, **options)
-        api_request "#{base_url(:community)}/#{@endpoint}/#{id}", default_options.merge(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
@@ -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
@@ -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/community/ladder.rb

@@ -17,7 +17,7 @@ module BlizzardApi
       # @!macro request_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
 
       ##
@@ -27,7 +27,7 @@ module BlizzardApi
       # @!macro request_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/profile.rb

@@ -17,7 +17,7 @@ module BlizzardApi
       # @!macro request_options
       def static(region_id, **options)
         reg = resolve_region(region_id)
-        api_request "#{base_url(:community)}/static/profile/#{reg}", { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/static/profile/#{reg}", **{ ttl: CACHE_DAY }.merge(options)
       end
 
       ##
@@ -30,7 +30,7 @@ module BlizzardApi
       def metadata(region_id, realm_id, profile_id, **options)
         reg = resolve_region(region_id)
         opts = { ttl: CACHE_DAY }.merge(options)
-        api_request "#{base_url(:community)}/metadata/profile/#{reg}/#{realm_id}/#{profile_id}", opts
+        api_request "#{base_url(:community)}/metadata/profile/#{reg}/#{realm_id}/#{profile_id}", **opts
       end
 
       ##
@@ -43,7 +43,7 @@ module BlizzardApi
       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)}/profile/#{reg}/#{realm_id}/#{profile_id}", opts
+        api_request "#{base_url(:community)}/profile/#{reg}/#{realm_id}/#{profile_id}", **opts
       end
 
       ##
@@ -56,7 +56,7 @@ module BlizzardApi
       def ladder_summary(region_id, realm_id, profile_id, **options)
         reg = resolve_region(region_id)
         opts = { ttl: CACHE_DAY }.merge(options)
-        api_request "#{base_url(:community)}profile/#{reg}/#{realm_id}/#{profile_id}/ladder/summary ", opts
+        api_request "#{base_url(:community)}profile/#{reg}/#{realm_id}/#{profile_id}/ladder/summary ", **opts
       end
 
       ##
@@ -69,7 +69,7 @@ module BlizzardApi
       def ladder(region_id, realm_id, profile_id, ladder_id, **options)
         reg = resolve_region(region_id)
         opts = { ttl: CACHE_DAY }.merge(options)
-        api_request "#{base_url(:community)}/profile/#{reg}/#{realm_id}/#{profile_id}/ladder/#{ladder_id}", opts
+        api_request "#{base_url(:community)}/profile/#{reg}/#{realm_id}/#{profile_id}/ladder/#{ladder_id}", **opts
       end
     end
   end

data/lib/blizzard_api/starcraft/game_data/league.rb

@@ -20,7 +20,7 @@ module BlizzardApi
       # @!macro request_options
       def get(season_id, queue_id, team_type, league_id, **options)
         opts = { ttl: CACHE_DAY }.merge(options)
-        api_request "#{base_url(:game_data)}/league/#{season_id}/#{queue_id}/#{team_type}/#{league_id}", opts
+        api_request "#{base_url(:game_data)}/league/#{season_id}/#{queue_id}/#{team_type}/#{league_id}", **opts
       end
     end
   end

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '0.5.6'
+  VERSION = '0.6.0'
 end

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

@@ -25,7 +25,7 @@ module BlizzardApi
       #
       # @!macro response
       def categories(**options)
-        api_request "#{endpoint_uri('category')}/index", default_options.merge(options)
+        api_request "#{endpoint_uri('category')}/index", **default_options.merge(options)
       end
 
       ##
@@ -35,7 +35,7 @@ module BlizzardApi
       #
       # @!macro response
       def category(id, **options)
-        api_request "#{endpoint_uri('category')}/#{id}", default_options.merge(options)
+        api_request "#{endpoint_uri('category')}/#{id}", **default_options.merge(options)
       end
 
       ##
@@ -45,7 +45,7 @@ module BlizzardApi
       #
       # @!macro response
       def media(id, **options)
-        api_request "#{base_url(:media)}/achievement/#{id}", default_options.merge(options)
+        api_request "#{base_url(:media)}/achievement/#{id}", **default_options.merge(options)
       end
 
       protected