blizzard_api 0.2.9 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e053e270f32f8b4b3f5ef31dd081652ac643c2108ec2505a8ccd4684b392b233
-  data.tar.gz: 658b55408c9aff58ba82e9f425d737d577bcbb2eead1080fb8ccc654180be81e
+  metadata.gz: 1d9e981de12146c8fa8c57320363113050ff5415e7b6ae41422ec945f113b560
+  data.tar.gz: 8f262b1cc6376a60f1dc8705a49b6dd0dc2b6ce295e24b563a269ce55a24aaf4
 SHA512:
-  metadata.gz: 7b003416b1ce96f0312a4c05002940bdac6a8ee5f82c638cde5627a6bff5a3a4ebc616c4a242f2beb0e4004e7a5c5314b94db360673b33dc3e0c35eb1530d3c4
-  data.tar.gz: 67c2413bc2cbf9f3192aa7d8187e9b5ec67eb0699b2ca5f6f0ef6f92ce7589f6008eb4edc78d825c0bf0cdbae64fc8c58f450fd7f45914cdff7ae12b7ff29150
+  metadata.gz: 3eb0e63dea5d778a83264ac54b45acfa664e13ce695495e91238b98e169c8e18c9ab69f72cb12a2a25aad5c633c788a66ad8843e721a7a51fec63c013a144cbc
+  data.tar.gz: a952007d42101fedaea6f22cc1ed0e148bec4fc5f890803121e27c178c4563c13414760d8910e627476e2e30c650aa2eb257421ed555a71fa6704946f63f9c6e

data/CHANGELOG.md

@@ -1,7 +1,15 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 0.3.0**
+
+https://us.forums.blizzard.com/en/blizzard/t/starcraft-ii-community-api-update/2652
+
+Removed all Starcraft II related code.
+
 **Version 0.2.9**
-* Added new character endpoints:
+
+https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-api-update-collections-hunter-pets-and-reputations/757
+* Added new character endpoints: 
   * reputations
   * hunter-pets
   * collections
@@ -12,6 +20,8 @@ Please view this file on the master branch, otherwise it may be outdated
   * reputation-tiers
   * reputation-faction
 
+* Marked all WoW community endpoints as deprecated: https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-community-api-migration/767
+
 **Version 0.2.8**
 * Added the new character status endpoint
 

data/Gemfile.lock

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

data/README.md

@@ -15,8 +15,7 @@ This gem allow you to interface with the new blizzard api (2018) using the OAuth
 4. [Available endpoints](#4-available-endpoints)
    - 4.1. [World of Warcraft endpoints](#41-world-of-warcraft-endpoints)
    - 4.2. [Diablo III endpoints](#42-diablo-iii-endpoints)
-   - 4.3. [Starcraft II endpoints](#43-starcraft-ii-endpoints)
-   - 4.4. [Hearthstone endpoints](#44-hearthstone-endpoints)
+   - 4.3. [Hearthstone endpoints](#43-hearthstone-endpoints)
 
 ## 1. Installation
 
@@ -273,26 +272,8 @@ Most **data** endpoints will have always 3 methods available `index`, `get` and
   - hero :battletag, :oauth_token, :hero_id
   - hero_items :battletag, :oauth_token, :hero_id
   - hero_follower_items :battletag, :oauth_token, :hero_id
-  
-### 4.3. 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
-
-### 4.4. Hearthstone endpoints
+
+### 4.3. Hearthstone endpoints
 
 * BlizzardApi::Hearthstone::Card
   - index

data/lib/blizzard_api.rb

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

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '0.2.9'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.0
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-02 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -83,7 +83,6 @@ files:
 - ".gitlab-ci.yml"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -115,12 +114,6 @@ 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/community/auction.rb
@@ -181,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Unofficial Ruby client for Blizzard Entertainment API

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.3
-before_install: gem install bundler -v 1.17.3

data/lib/blizzard_api/starcraft.rb

@@ -1,40 +0,0 @@
-# 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 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 profile
-      BlizzardApi::Starcraft::Profile.new
-    end
-
-    ##
-    # @return {Ladder}
-    def ladder
-      BlizzardApi::Starcraft::Ladder.new
-    end
-
-    ##
-    # @return {Account}
-    def account
-      BlizzardApi::Starcraft::Account.new
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-# 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

@@ -1,34 +0,0 @@
-# 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

@@ -1,76 +0,0 @@
-# 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

@@ -1,27 +0,0 @@
-# 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

@@ -1,36 +0,0 @@
-# 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