blizzard_api 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a7115f7058b188e0130c206c24aad91ee0ffccfb1b5af117c7df1e1ad057576
-  data.tar.gz: 5673b1e4e632d76244c8315a217b9a4ee6a55555159bc0fbcf134a09d7a191e1
+  metadata.gz: 98dfa44fc3124d09b6f7d748b9177f4fa4db78b75824f9c5643b3b4ec9ebd6b9
+  data.tar.gz: 04fc32625fc155c3b2d187ea0db9d79427d902b67783b79684efc2023a29462c
 SHA512:
-  metadata.gz: f779ae48590fe9fe5ecae0ab0004528a9600390c0f6862da2f52a9fd8f2c31351fa6945adfe5ee67a52df14437dee3d1da1e5a0df8bb5b6b6db1c402521ba2ec
-  data.tar.gz: 307e0b9549d87b2fee99c832854398948a37cf414acc8103b8e733532e1d4faab7f94c870e67959e42bea941d42c3f4a9435d92542becaac8d10b934a81d53e6
+  metadata.gz: 1d601c0591eb90072a937cc860e2fb5e8e42c0fc72d795207188156a7df40f17187e40604d4acc3f187c75d4ae82ce55bfd2cf1212f3311e2205500a8da01ff6
+  data.tar.gz: 768023a73f05b338e6c03c57ba918ede8b3aa16a7f2aefa5ec61e3c4f1025e4f42c2242fdddf08a4e0559f46e86cfe25dde955ccb3c3611b62712e031ad83e2f

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 0.3.6**
+
+Fix Diablo shortcuts.
+Adding SC2 endpoints back.
+ 
+https://us.forums.blizzard.com/en/blizzard/t/starcraft-ii-community-api-update/2652/5
+
 **Version 0.3.5**
 
 Fixed a bug for generating slugs for Korean

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    blizzard_api (0.3.5)
+    blizzard_api (0.3.6)
       redis (~> 4.1, >= 4.1.0)
 
 GEM

data/README.md

@@ -16,6 +16,7 @@ This gem allow you to interface with the new blizzard api (2018) using the OAuth
    - 4.1. [World of Warcraft endpoints](#41-world-of-warcraft-endpoints)
    - 4.2. [Diablo III endpoints](#42-diablo-iii-endpoints)
    - 4.3. [Hearthstone endpoints](#43-hearthstone-endpoints)
+   - 4.4. [Starcraft II endpoints](#43-starcraft-ii-endpoints)
 
 ## 1. Installation
 
@@ -284,6 +285,24 @@ Most **data** endpoints will have always 3 methods available `index`, `get` and
 * BlizzardApi::Hearthstone::Metadata
   - index
   - get :type
+  
+### 4.4. Starcraft II endpoints
+
+Every endpoint requiring a *region_id* parameter will accepts either the integer representation of the region described in the api docs or a symbol: `:US`, `:EU`, `:KO` or `:TW` 
+
+* BlizzardApi::Starcraft::League
+  - get :season_id, :queue_id, :team_type, :league_id
+* BlizzardApi::Starcraft::Profile
+  - static :region_id
+  - metadata :region_id, :realm_id, :profile_id
+  - profile :region_id, :realm_id, :profile_id
+  - ladder_summary :region_id, :realm_id, :profile_id
+  - ladder :region_id, :realm_id, :profile_id, :ladder_id
+* BlizzardApi::Starcraft::Ladder
+  - grandmaster :region_id, :options
+  - season :region_id
+* BlizzardApi::Starcraft::Account
+  - player :account_id
 
 ## Contributing
 

data/lib/blizzard_api.rb

@@ -7,6 +7,7 @@ require_relative 'blizzard_api/version'
 require_relative 'blizzard_api/wow'
 require_relative 'blizzard_api/diablo'
 require_relative 'blizzard_api/hearthstone'
+require_relative 'blizzard_api/starcraft'
 
 # Blizzard namespace
 module BlizzardApi

data/lib/blizzard_api/diablo.rb

@@ -12,13 +12,13 @@ module BlizzardApi
 
     ##
     # @return {Season}
-    def season
+    def self.season
       BlizzardApi::Diablo::Season.new
     end
 
     ##
     # @return {Era}
-    def era
+    def self.era
       BlizzardApi::Diablo::Era.new
     end
 
@@ -33,43 +33,43 @@ module BlizzardApi
 
     ##
     # @return {Act}
-    def act
+    def self.act
       BlizzardApi::Diablo::Act.new
     end
 
     ##
     # @return {Artisan}
-    def artisan
+    def self.artisan
       BlizzardApi::Diablo::Artisan.new
     end
 
     ##
     # @return {Follower}
-    def follower
+    def self.follower
       BlizzardApi::Diablo::Follower.new
     end
 
     ##
     # @return {Character}
-    def character
+    def self.character
       BlizzardApi::Diablo::Character.new
     end
 
     ##
     # @return {ItemType}
-    def item_type
+    def self.item_type
       BlizzardApi::Diablo::ItemType.new
     end
 
     ##
     # @return {Type}
-    def item
+    def self.item
       BlizzardApi::Diablo::Item.new
     end
 
     ##
     # @return {Profile}
-    def profile
+    def self.profile
       BlizzardApi::Diablo::Profile.new
     end
   end

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)}/data/profile/#{battletag}", opts
+        api_request "#{base_url(:community)}/data/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)}/data/profile/#{battletag}/hero/#{hero_id}", opts
+        api_request "#{base_url(:community)}/data/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)}/data/profile/#{battletag}/hero/#{hero_id}/items", opts
+        api_request "#{base_url(:community)}/data/profile/#{parse_battle_tag(battletag)}/hero/#{hero_id}/items", opts
       end
 
       ##
@@ -70,7 +70,13 @@ 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)}/data/profile/#{battletag}/hero/#{hero_id}/follower-items", opts
+        api_request "#{base_url(:community)}/data/profile/#{parse_battle_tag(battletag)}/hero/#{hero_id}/follower-items", opts
+      end
+
+      private
+
+      def parse_battle_tag(battletag)
+        battletag.sub('#', '-')
       end
     end
   end

data/lib/blizzard_api/starcraft.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  # Starcraft II related classes
+  module Starcraft
+    require_relative 'starcraft/request'
+
+    # Starcraft II data api
+    require_relative 'starcraft/game_data/league'
+
+    ##
+    # @return {League}
+    def self.league
+      BlizzardApi::Starcraft::League.new
+    end
+
+    # Starcraft community api
+    require_relative 'starcraft/community/profile'
+    require_relative 'starcraft/community/ladder'
+    require_relative 'starcraft/community/account'
+
+    ##
+    # @return {Profile}
+    def self.profile
+      BlizzardApi::Starcraft::Profile.new
+    end
+
+    ##
+    # @return {Ladder}
+    def self.ladder
+      BlizzardApi::Starcraft::Ladder.new
+    end
+
+    ##
+    # @return {Account}
+    def self.account
+      BlizzardApi::Starcraft::Account.new
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Starcraft
+    ##
+    # This class allows access to Starcraft II league 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.account
+    class Account < Starcraft::Request
+      ##
+      # Returns information about a player account
+      #
+      # @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)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Starcraft
+    ##
+    # This class allows access to Starcraft II ladder 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.ladder
+    class Ladder < Starcraft::Request
+      ##
+      # Grandmaster endpoint
+      #
+      # @!macro sc2_regions
+      # @!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)
+      end
+
+      ##
+      # Season endpoint
+      #
+      # @!macro sc2_regions
+      # @!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)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Starcraft
+    ##
+    # This class allows access to Starcraft II profile 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.profile
+    class Profile < Starcraft::Request
+      ##
+      # Static profile data
+      #
+      # @!macro sc2_regions
+      # @!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)
+      end
+
+      ##
+      # Metadata
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      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
+      end
+
+      ##
+      # 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)}/profile/#{reg}/#{realm_id}/#{profile_id}", opts
+      end
+
+      ##
+      # Ladder summary
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      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
+      end
+
+      ##
+      # Ladder data
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Starcraft
+    ##
+    # This class allows access to Starcraft II league 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.league
+    class League < Starcraft::Request
+      ##
+      # Return information about league
+      #
+      # @param [Integer] season_id Season id
+      # @param [Integer] queue_id Queue id
+      # @param [Integer] team_type Team type
+      # @param [Integer] league_id League id
+      # @!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
+      end
+    end
+  end
+end

data/lib/blizzard_api/starcraft/request.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+##
+# @!macro [new] sc2_regions
+#   @param {Symbol} region_id One of the valid Starcraft II regions *:US*, *:EU*, *:KO*, and *:TW*
+#   @note This gem do not support nor will support China endpoints
+
+module BlizzardApi
+  module Starcraft
+    ##
+    # Starcraft requests
+    class Request < BlizzardApi::Request
+      # Possible regions for the SC II API (Except China)
+      SC_REGION = { US: 1, EU: 2, KO: 3, TW: 3 }.freeze
+
+      ##
+      # @!macro regions
+      def initialize(region = nil)
+        super region
+        @game = 'sc2'
+      end
+
+      private
+
+      ##
+      # Helper method to find a region_id by its symbol
+      def resolve_region(region_arg)
+        return region_arg if region_arg.is_a? Integer
+
+        return SC_REGION[region_arg] if region_arg.is_a? Symbol
+
+        raise ArgumentError, 'Invalid region, please read the documentation'
+      end
+    end
+  end
+end

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '0.3.5'
+  VERSION = '0.3.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -115,6 +115,12 @@ files:
 - lib/blizzard_api/hearthstone/game_data/metadata.rb
 - lib/blizzard_api/hearthstone/request.rb
 - lib/blizzard_api/request.rb
+- lib/blizzard_api/starcraft.rb
+- lib/blizzard_api/starcraft/community/account.rb
+- lib/blizzard_api/starcraft/community/ladder.rb
+- lib/blizzard_api/starcraft/community/profile.rb
+- lib/blizzard_api/starcraft/game_data/league.rb
+- lib/blizzard_api/starcraft/request.rb
 - lib/blizzard_api/version.rb
 - lib/blizzard_api/wow.rb
 - lib/blizzard_api/wow/game_data/achievement.rb