blizzard_api 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 680ed6a0b92283da14b06fd82d2b68d907f54ae43286dcdadce49c59d5d2f006
-  data.tar.gz: 55533dafd67060eaa7c5100da709d9477941cbc3e1d110d01feb7384857bb791
+  metadata.gz: 20cf33fde29710b0f5c1c24e5e2c7001c42a25997175def8f3e02ed7742a4b62
+  data.tar.gz: f95f37b65054229c5fa4091a53cbbd31c20a4901282c78e4b37e07dd24636b69
 SHA512:
-  metadata.gz: 9f389ae7148b0e0527cbae0f00153e9db2d400496223c4c69a86149720115d39959e69365004914128a53072dc838bcec5161d9a436e880a7e96bd8ac39d5669
-  data.tar.gz: cbcfceaeab33b4a85e6c0fe6d408c2762e4cd0ba14fadb471eec2ff00e246e0982bcc7e3820d56c87788e0a011d2055e0b27fb0e4effbb795c0435b93bd0f1d1
+  metadata.gz: d9cea099795510ba35524d15a4a77af940ba8bce410646f23b4ead61ba423b6c5567ad0804c3115fa523dc85da33d2643d87e980e4a4b4b59768c8ea45c91cc2
+  data.tar.gz: 68a150c0d4c39e86654087e6609e20809cb5971b0cdc2f26c9553ddb7089bb61ad30b33ce3661651cb7887e8d44c5445c75a0b0df3e277dc9ed74542d7626b6c

data/.github/workflows/ruby.yml

@@ -8,9 +8,9 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby
-        uses: ruby/setup-ruby@21351ecc0a7c196081abca5dc55b08f085efe09a
+        uses: ruby/setup-ruby@359bebbc29cbe6c87da6bc9ea3bc930432750108
         with:
-          ruby-version: 3.0.0-preview1
+          ruby-version: 3.1
       - name: Install dependencies
         run: bundle install
       - name: Run tests

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 3.2.0**
+
+Added new AH commodities endpoint.
+
 **Version 3.1.0**
 
 Fixed the latest build to exclude non 200 responses from caching.

data/Gemfile.lock

@@ -1,22 +1,22 @@
 PATH
   remote: .
   specs:
-    blizzard_api (3.1.0)
+    blizzard_api (3.3.0)
       redis (~> 4.1, >= 4.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    dotenv (2.7.6)
-    minitest (5.15.0)
-    parallel (1.21.0)
-    parser (3.0.3.2)
+    dotenv (2.8.1)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    redis (4.5.1)
-    regexp_parser (2.2.0)
+    redis (4.8.0)
+    regexp_parser (2.6.1)
     rexml (3.2.5)
     rubocop (0.93.1)
       parallel (~> 1.10)
@@ -27,12 +27,12 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     unicode-display_width (1.8.0)
     webrick (1.7.0)
-    yard (0.9.27)
+    yard (0.9.28)
       webrick (~> 1.7.0)
 
 PLATFORMS

data/lib/blizzard_api/overwatch_league/community/matches.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module OverwatchLeague
+    ##
+    # This class allows access to OWL2 match data
+    #
+    # @see https://develop.battle.net/documentation/owl/community-apis
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::OverwatchLeague.matches
+    class Matches < OverwatchLeague::Request
+      ##
+      # Returns match information
+      #
+      # @!macro request_options
+      def get(match_id, **options)
+        api_request "#{base_url(:community)}/v1/matches/#{match_id}", **{ ttl: CACHE_DAY }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api/overwatch_league/community/players.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module OverwatchLeague
+    ##
+    # This class allows access to OWL2 player data
+    #
+    # @see https://develop.battle.net/documentation/owl/community-apis
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::OverwatchLeague.players
+    class Players < OverwatchLeague::Request
+      ##
+      # Returns player information
+      #
+      # @!macro request_options
+      def get(player_id, **options)
+        api_request "#{base_url(:community)}/v1/players/#{player_id}", **{ ttl: CACHE_DAY }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api/overwatch_league/community/segments.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module OverwatchLeague
+    ##
+    # This class allows access to OWL2 segment data
+    #
+    # @see https://develop.battle.net/documentation/owl/community-apis
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::OverwatchLeague.segments
+    class Segments < OverwatchLeague::Request
+      ##
+      # Returns segment information
+      #
+      # @!macro request_options
+      def get(segment_id, **options)
+        api_request "#{base_url(:community)}/v1/segments/#{segment_id}", **{ ttl: CACHE_DAY }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api/overwatch_league/community/summary.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module OverwatchLeague
+    ##
+    # This class allows access to OWL2 summary data
+    #
+    # @see https://develop.battle.net/documentation/owl/community-apis
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::OverwatchLeague.summary
+    class Summary < OverwatchLeague::Request
+      ##
+      # Returns summary information
+      #
+      # @!macro request_options
+      def get(**options)
+        api_request "#{base_url(:community)}/v1/owl2", **{ ttl: CACHE_DAY }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api/overwatch_league/community/teams.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module OverwatchLeague
+    ##
+    # This class allows access to OWL2 team data
+    #
+    # @see https://develop.battle.net/documentation/owl/community-apis
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::OverwatchLeague.teams
+    class Teams < OverwatchLeague::Request
+      ##
+      # Returns team information
+      #
+      # @!macro request_options
+      def get(team_id, **options)
+        api_request "#{base_url(:community)}/v1/teams/#{team_id}", **{ ttl: CACHE_DAY }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api/overwatch_league/request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module OverwatchLeague
+    # Overwatch League requests
+    class Request < BlizzardApi::Request
+      ##
+      # @!macro init_options
+      def initialize(**options)
+        super(**options)
+        @game = 'owl'
+      end
+    end
+  end
+end

data/lib/blizzard_api/overwatch_league.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  # Overwatch League related classes
+  module OverwatchLeague
+    require_relative 'overwatch_league/request'
+
+    # Overwatch League community api
+    require_relative 'overwatch_league/community/summary'
+    require_relative 'overwatch_league/community/players'
+    require_relative 'overwatch_league/community/matches'
+    require_relative 'overwatch_league/community/segments'
+    require_relative 'overwatch_league/community/teams'
+
+    ##
+    # @!macro init_options
+    # @return {Summary}
+    def self.summary(**options)
+      BlizzardApi::OverwatchLeague::Summary.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Players}
+    def self.players(**options)
+      BlizzardApi::OverwatchLeague::Players.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Matches}
+    def self.matches(**options)
+      BlizzardApi::OverwatchLeague::Matches.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Segments}
+    def self.segments(**options)
+      BlizzardApi::OverwatchLeague::Segments.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Teams}
+    def self.teams(**options)
+      BlizzardApi::OverwatchLeague::Teams.new(**options)
+    end
+  end
+end

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '3.1.0'
+  VERSION = '3.3.0'
 end

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

@@ -39,6 +39,12 @@ module BlizzardApi
 
         api_request "#{base_url(:game_data)}/connected-realm/#{connected_realm_id}/auctions", **opts
       end
+
+      def commodities(**options)
+        opts = { ttl: CACHE_HOUR, namespace: :dynamic }.merge(options)
+
+        api_request "#{base_url(:game_data)}/auctions/commodities", **opts
+      end
     end
   end
 end

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

@@ -12,6 +12,30 @@ module BlizzardApi
     class Talent < Wow::GenericDataEndpoint
       setup 'talent', :static, CACHE_TRIMESTER
 
+      ##
+      # Fetch talent trees
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def talent_trees(**options)
+        api_request "#{base_url(:game_data)}/talent-tree/index", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch a talent tree
+      #
+      # @param talent_tree_id [Integer] talent tree id
+      #
+      # @param spec_id [Integer] playable specialization id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def talent_tree(talent_tree_id, spec_id, **options)
+        api_request "#{base_url(:game_data)}/talent-tree/#{talent_tree_id}/playable-specialization/#{spec_id}", **default_options.merge(options)
+      end
+
       ##
       # Fetch pvp talents
       #
@@ -23,7 +47,7 @@ module BlizzardApi
       end
 
       ##
-      # Fetch pvp a talent
+      # Fetch a pvp talent
       #
       # @param id [Integer] Pvp talent id
       #

data/lib/blizzard_api.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-09 00:00:00.000000000 Z
+date: 2022-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -144,6 +144,13 @@ files:
 - lib/blizzard_api/hearthstone/game_data/generic_data_endpoint.rb
 - lib/blizzard_api/hearthstone/game_data/metadata.rb
 - lib/blizzard_api/hearthstone/request.rb
+- lib/blizzard_api/overwatch_league.rb
+- lib/blizzard_api/overwatch_league/community/matches.rb
+- lib/blizzard_api/overwatch_league/community/players.rb
+- lib/blizzard_api/overwatch_league/community/segments.rb
+- lib/blizzard_api/overwatch_league/community/summary.rb
+- lib/blizzard_api/overwatch_league/community/teams.rb
+- lib/blizzard_api/overwatch_league/request.rb
 - lib/blizzard_api/request.rb
 - lib/blizzard_api/starcraft.rb
 - lib/blizzard_api/starcraft/community/account.rb
@@ -221,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Unofficial Ruby client for Blizzard Entertainment API