blizzard_api 0.6.0 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7671ab9869534ec9c4c8031eac8e73ac9f389b9199cd9ca61a0e80127de66c53
-  data.tar.gz: 915f7c1ff4b867b4b403dcb55128ab134b5012f380e90a8c589097ba57bf28a8
+  metadata.gz: f331c75e7b30062614bb12c18bfe208742debf32143048dfb51e322baa53fe83
+  data.tar.gz: 8653702786c36a232c7698feb4b8559681dd5418fe9ad5e390578977c2b3525c
 SHA512:
-  metadata.gz: 50ce63d400f8997131913f6b677b3676bf68c5134d0acf5328276a37d861073f57004eb3c922821c261608a17610e25c956a1401633d99d25af68cb05c8729f8
-  data.tar.gz: f57a645a37541c1ab06113439529822b84fe71808447303d04b25ba947e368754169e7cb6532482d584061c5a0708b1c7ecf0fe9392c896e236bc132f8c4885b
+  metadata.gz: ac6789833e98e6f0b1a940999ea59ac96bf1c9676bf58fff869c1a78fb98a5ffffb3e52254f4e261b73407606e6659bff3c904f31c436694d65d1e2bf873d45d
+  data.tar.gz: '088809759e0d6afe7ad9824098f54c1c4d4d66457ef187c3e24b0288bf3f6dfdfbb34e39cb0d5396db8f8360f69fdea55c64e988597115dc6920e98259fd414b'

data/.rubocop.yml

@@ -11,7 +11,7 @@ Metrics/AbcSize:
   Max: 20
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   NewCops: enable
   Exclude:
     - 'vendor/**/*'

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 0.6.4**
+
+Fixed argument propagation in SC2 legacy profile methods.
+
+**Version 0.6.3**
+
+Fixed argument propagation in some profile methods.
+
+**Version 0.6.2**
+
+Fixed an encoding problem on search endpoints.
+
+**Version 0.6.1**
+
+Added support for TBCC and Classice Era endpoints.
+
 **Version 0.6.0**
 
 Upgraded gem dependencies and refactored the code to support Ruby 3.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    blizzard_api (0.6.0)
+    blizzard_api (0.6.3)
       redis (~> 4.1, >= 4.1.0)
       thwait (~> 0.2.0)
 
@@ -13,11 +13,11 @@ GEM
     e2mmap (0.1.0)
     minitest (5.14.4)
     parallel (1.20.1)
-    parser (3.0.1.1)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.3)
-    redis (4.2.5)
+    rake (13.0.6)
+    redis (4.3.1)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rubocop (0.93.1)
@@ -29,7 +29,7 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.5.0)
+    rubocop-ast (1.8.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     thwait (0.2.0)

data/lib/blizzard_api/configuration.rb

@@ -50,7 +50,7 @@ module BlizzardApi
     #   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
+    attr_writer :concurrency
 
     ##
     # @!attribute access_token

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

@@ -22,7 +22,7 @@ module BlizzardApi
       # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
       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
+        api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/", **opts
       end
 
       ##
@@ -38,7 +38,7 @@ module BlizzardApi
       # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
       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
+        api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/hero/#{hero_id}", **opts
       end
 
       ##
@@ -54,7 +54,7 @@ module BlizzardApi
       # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
       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
+        api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/hero/#{hero_id}/items", **opts
       end
 
       ##
@@ -70,7 +70,7 @@ module BlizzardApi
       # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
       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
+        api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/hero/#{hero_id}/follower-items", **opts
       end
 
       private

data/lib/blizzard_api/request.rb

@@ -9,7 +9,8 @@
 #   @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.
+#   @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
@@ -84,16 +85,31 @@ module BlizzardApi
       format BASE_URLS[scope], region, @game
     end
 
+    ##
+    # Returns a valid version namespace
+    #
+    # @param [Hash] options A hash containing a valid namespace key
+    def endpoint_version(options)
+      if options.key? :classic
+        'classic-'
+      elsif options.key? :classic1x
+        'classic1x-'
+      else
+        ''
+      end
+    end
+
     ##
     # Returns a valid namespace string for consuming the api endpoints
     #
     # @param [Hash] options A hash containing the namespace key
     def endpoint_namespace(options)
+      version = endpoint_version(options)
       case options[:namespace]
       when :dynamic
-        options.include?(:classic) ? "dynamic-classic-#{region}" : "dynamic-#{region}"
+        "dynamic-#{version}#{region}"
       when :static
-        options.include?(:classic) ? "static-classic-#{region}" : "static-#{region}"
+        "static-#{version}#{region}"
       when :profile
         "profile-#{region}"
       else
@@ -137,7 +153,7 @@ module BlizzardApi
 
     def api_request(uri, **query_string)
       # List of request options
-      options_key = %i[ignore_cache ttl format access_token namespace classic headers since]
+      options_key = %i[ignore_cache ttl format access_token namespace classic classic1x headers since]
 
       # Separates request options from api fields and options. Any user-defined option will be treated as api field.
       options = query_string.select { |k, _v| query_string.delete(k) || true if options_key.include? k }

data/lib/blizzard_api/starcraft.rb

@@ -41,7 +41,7 @@ module BlizzardApi
     def self.account(region = BlizzardApi.region)
       BlizzardApi::Starcraft::Account.new(region)
     end
-    
+
     ##
     # @return {Legacy}
     def self.legacy(region = BlizzardApi.region)

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

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

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

@@ -10,7 +10,6 @@ module BlizzardApi
     # 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
       #
@@ -21,7 +20,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)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}", opts
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}", **opts
       end
 
       ##
@@ -34,7 +33,7 @@ module BlizzardApi
       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
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}/ladder ", **opts
       end
 
       ##
@@ -47,9 +46,9 @@ module BlizzardApi
       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
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}/matches", **opts
       end
-      
+
       ##
       # Ladder
       #
@@ -59,9 +58,9 @@ module BlizzardApi
       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
+        api_request "#{base_url(:community)}/legacy/ladder/#{reg}/#{ladder_id}", **opts
       end
-      
+
       ##
       # Achievement data
       #
@@ -70,9 +69,9 @@ module BlizzardApi
       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
+        api_request "#{base_url(:community)}/legacy/data/achievements/#{reg}", **opts
       end
-      
+
       ##
       # Rewards data
       #
@@ -81,7 +80,7 @@ module BlizzardApi
       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
+        api_request "#{base_url(:community)}/legacy/data/rewards/#{reg}", **opts
       end
     end
   end

data/lib/blizzard_api/version.rb

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

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

@@ -10,15 +10,33 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.auction
     class Auction < Wow::Request
+      ##
+      # Return all auction houses for the specified connected realm. Classic only.
+      #
+      # @param connected_realm_id [Integer] A valid connected realm id
+      # @!macro request_options
+      #
+      # @!macro response
+      def index(connected_realm_id, **options)
+        opts = { ttl: CACHE_HOUR, namespace: :dynamic }.merge(options)
+        api_request "#{base_url(:game_data)}/connected-realm/#{connected_realm_id}/auctions/index", **opts
+      end
+
       ##
       # Return all active auctions for the specified connected realm
       #
       # @param connected_realm_id [Integer] A valid connected realm id
       # @!macro request_options
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
-      def get(connected_realm_id, **options)
+      def get(connected_realm_id, auction_house_id = nil, **options)
         opts = { ttl: CACHE_HOUR, namespace: :dynamic }.merge(options)
+
+        unless auction_house_id.nil?
+          return api_request "#{base_url(:game_data)}/connected-realm/#{connected_realm_id}/auctions/#{auction_house_id}", **opts
+        end
+
         api_request "#{base_url(:game_data)}/connected-realm/#{connected_realm_id}/auctions", **opts
       end
     end

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

@@ -13,7 +13,7 @@ module BlizzardApi
       include BlizzardApi::Wow::Searchable
 
       def index
-        raise BlizzardApi::ApiException, 'Creatures endpoint doesn\'t have a index method'
+        raise BlizzardApi::ApiException, 'Creatures endpoint doesn\'t have an index method'
       end
 
       def complete
@@ -25,6 +25,7 @@ module BlizzardApi
       #
       # @!macro request_options
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
       def families(**options)
@@ -38,6 +39,7 @@ module BlizzardApi
       #
       # @!macro request_options
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
       def family(id, **options)
@@ -51,6 +53,7 @@ module BlizzardApi
       #
       # @!macro request_options
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
       def family_media(id, **options)
@@ -62,6 +65,7 @@ module BlizzardApi
       #
       # @!macro request_options
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
       def types(**options)
@@ -75,6 +79,7 @@ module BlizzardApi
       #
       # @!macro request_options
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
       def type(id, **options)
@@ -88,6 +93,7 @@ module BlizzardApi
       #
       # @!macro request_options
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
       def display_media(id, **options)

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

@@ -21,6 +21,7 @@ module BlizzardApi
       #
       # @!macro request_options
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
       def border_media(id, **options)
@@ -32,6 +33,7 @@ module BlizzardApi
       #
       # @param id [Integer] Emblem id
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro request_options
       #

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

@@ -33,6 +33,7 @@ module BlizzardApi
       #
       # @!macro request_options
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
       def classes(**options)
@@ -45,6 +46,7 @@ module BlizzardApi
       # @param id [Integer] Item class id
       # @!macro request_options
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
       def class(id, **options)
@@ -58,6 +60,7 @@ module BlizzardApi
       # @param subclass_id [Integer] Item subclass id
       # @!macro request_options
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
       def subclass(id, subclass_id, **options)
@@ -71,6 +74,7 @@ module BlizzardApi
       #
       # @!macro request_options
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
       def media(id, **options)

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)
         raise BlizzardApi::ApiException, 'This endpoint does not have a get method'
       end
 

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

@@ -25,6 +25,7 @@ module BlizzardApi
       # @!macro complete
       #
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       def complete(**options)
         index_data = index(**options)
         [].tap do |classes|
@@ -43,6 +44,7 @@ module BlizzardApi
       #
       # @!macro request_options
       # @option options [Boolean] :classic If set to true, this method will call the classic version
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
       def get(id, **options)

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

@@ -14,6 +14,7 @@ module BlizzardApi
       # Returns a index of pvp leaderboard for a season
       #
       # @!macro request_options
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
       def leaderboards(season_id, **options)
@@ -24,6 +25,7 @@ module BlizzardApi
       # Returns the leaderboard for a given season and bracket
       #
       # @!macro request_options
+      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
       def leaderboard(season_id, brackets, **options)

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

@@ -68,7 +68,7 @@ module BlizzardApi
         { ttl: CACHE_HOUR, namespace: :profile }
       end
 
-      def api_request(_uri, query_string = {})
+      def api_request(_uri, **query_string)
         query_string.merge! access_token: @token
         super
       end

data/lib/blizzard_api/wow/search/search_composer.rb

@@ -27,7 +27,7 @@ module BlizzardApi
       #
       # @return {SearchComposer}
       def where(field, value)
-        fields.push "#{field}=#{resolve_value(value)}"
+        fields.push "#{field}=#{URI.encode_www_form_component(resolve_value(value))}"
         self
       end
 
@@ -44,7 +44,7 @@ module BlizzardApi
       #
       # @return {SearchComposer}
       def where_not(field, value)
-        fields.push "#{field}!=#{resolve_value(value)}"
+        fields.push "#{field}!=#{URI.encode_www_form_component(resolve_value(value))}"
         self
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.4
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2021-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis