blizzard_api 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d9e981de12146c8fa8c57320363113050ff5415e7b6ae41422ec945f113b560
-  data.tar.gz: 8f262b1cc6376a60f1dc8705a49b6dd0dc2b6ce295e24b563a269ce55a24aaf4
+  metadata.gz: 45f2875f44a7d4af854565cd63f33286da88a5d0be8ef48bdda7ad3afa967787
+  data.tar.gz: 561caa05b1ce6d7d4ffcd041e63ffa865b136fc6c556c32b6423eff08c48440d
 SHA512:
-  metadata.gz: 3eb0e63dea5d778a83264ac54b45acfa664e13ce695495e91238b98e169c8e18c9ab69f72cb12a2a25aad5c633c788a66ad8843e721a7a51fec63c013a144cbc
-  data.tar.gz: a952007d42101fedaea6f22cc1ed0e148bec4fc5f890803121e27c178c4563c13414760d8910e627476e2e30c650aa2eb257421ed555a71fa6704946f63f9c6e
+  metadata.gz: 25c9fdc5b2263f7e556c494db66d15b56574ddd9a05694236d90ff25ed6edcf9702cdd8f83dd5977d3f6e4c67e2f0288e0eeb80e6c0f944e8a09fef51ae55662
+  data.tar.gz: b80581204677d04b6cde838f9b9ca348787ffa2fb2d15706a4f43c86911eaf06e67d3b6c7a2806aa266dda71a9405c09db197239f10ece171e8c47e0da923b21

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 0.3.1**
+
+https://us.forums.blizzard.com/en/blizzard/t/hearthstone-api-updates/2978
+
+Hearthstone updates:
+
+* Added the new Cardback endpoint
+* Card endpoint now supports the new `gameMode` search option
+
 **Version 0.3.0**
 
 https://us.forums.blizzard.com/en/blizzard/t/starcraft-ii-community-api-update/2652

data/Gemfile.lock

@@ -36,4 +36,4 @@ DEPENDENCIES
   rubocop (~> 0.61)
 
 BUNDLED WITH
-   1.17.3
+   2.1.2

data/lib/blizzard_api/hearthstone.rb

@@ -8,6 +8,7 @@ module BlizzardApi
 
     # Hearthstone data api
     require_relative 'hearthstone/game_data/card'
+    require_relative 'hearthstone/game_data/back'
     require_relative 'hearthstone/game_data/deck'
     require_relative 'hearthstone/game_data/metadata'
 
@@ -17,6 +18,12 @@ module BlizzardApi
       BlizzardApi::Hearthstone::Card.new
     end
 
+    ##
+    # @return {Back}
+    def self.back
+      BlizzardApi::Hearthstone::Back.new
+    end
+
     ##
     # @return {Deck}
     def self.deck

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Hearthstone
+    ##
+    # This class allows access to Hearthstone card data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/hearthstone-game-data-api
+    # @see https://develop.battle.net/documentation/hearthstone/guides/card-backs
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Hearthstone.card
+    class Back < Hearthstone::GenericDataEndpoint
+      # Valid options for card search
+      VALID_SEARCH_OPTIONS = %i[
+        cardBackCategory
+        textFilter
+        sort
+        order
+      ].freeze
+
+      ##
+      # Returns an up-to-date list of all card backs matching the search criteria. For more information about the
+      #   search parameters, see the Card Backs Guide.
+      #
+      # @param search_options [Hash] Search options accepted by the endpoint
+      #   @option search_options [String] :cardBackCategory A category of the card back. The category must match a valid category.
+      #   @option search_options [String] :textFilter A text string used to filter cards.
+      #     You must include a locale along with the textFilter parameter.
+      #   @option search_options [String] :sort The field used to sort the results. Valid value include name.
+      #     Results are sorted by date (desc) by default.
+      #   @option search_options [String] :order The order in which to sort the results.
+      #     Valid values are asc or desc. The default value is asc.
+      # @!macro request_options
+      # @option options [Boolean] :validate_fields If set to true, this method will throw an exception if nay search
+      #   option is invalid
+      #
+      # @!macro response
+      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)
+      end
+
+      protected
+
+      def validate_search_options(search_options)
+        search_options.each do |field|
+          raise ArgumentError, "Unrecognized search option #{field}" unless VALID_SEARCH_OPTIONS.include? field
+        end
+      end
+
+      def endpoint_setup
+        @endpoint = 'cardbacks'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -6,6 +6,7 @@ module BlizzardApi
     # This class allows access to Hearthstone card data
     #
     # @see https://develop.battle.net/documentation/api-reference/hearthstone-game-data-api
+    # @see https://develop.battle.net/documentation/hearthstone/guides/card-search
     #
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Hearthstone.card
@@ -23,6 +24,7 @@ module BlizzardApi
         minionType
         keyword
         textFilter
+        gameMode
         page
         pageSize
         sort
@@ -55,6 +57,8 @@ module BlizzardApi
       #     and so on). This value must match the keyword slugs found in metadata.
       #   @option search_options [String] :textFilter A text string used to filter cards.
       #     You must include a locale along with the textFilter parameter.
+      #   @option search_options [String] :gameMode A recognized game mode (for example, battlegrounds or constructed).
+      #     The default value is constructed. See the Game Modes Guide for more information.
       #   @option search_options [Integer] :page A page number.
       #   @option search_options [Integer] :pageSize The number of results to choose per page.
       #     A value will be selected automatically if you do not supply a pageSize or if the pageSize is higher than the
@@ -74,6 +78,22 @@ module BlizzardApi
         api_request "#{base_url(:community)}/cards", default_options.merge(options).merge(search_options)
       end
 
+      ##
+      # Returns the card with an ID or slug that matches the one you specify. For more information, see the Card Search Guide.
+      #
+      # @see https://develop.battle.net/documentation/hearthstone/guides/card-search
+      # @see https://develop.battle.net/documentation/hearthstone/guides/game-modes
+      #
+      # @param id_or_slug [String] Card ID or slug
+      # @param game_mode [String] A recognized game mode (for example, battlegrounds or constructed).
+      #   The default value is constructed. See the Game Modes Guide for more information.
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(id_or_slug, game_mode = 'constructed', options = {})
+        super id_or_slug, { gameMode: game_mode }.merge(options)
+      end
+
       protected
 
       def validate_search_options(search_options)

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

@@ -6,6 +6,7 @@ module BlizzardApi
     # This class allows access to Hearthstone deck data
     #
     # @see https://develop.battle.net/documentation/api-reference/hearthstone-game-data-api
+    # @see https://develop.battle.net/documentation/hearthstone/guides/decks
     #
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Hearthstone.deck

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

@@ -27,7 +27,7 @@ module BlizzardApi
       ##
       # Fetch all possible data for one of items listed by the {#index} using its *id*
       #
-      # @param [Integer] id One of the IDs returned by the {#index}
+      # @param [Integer|String] id One of the IDs returned by the {#index}
       # @!macro request_options
       #
       # @!macro response

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

@@ -6,6 +6,7 @@ module BlizzardApi
     # This class allows access to Hearthstone metadata data
     #
     # @see https://develop.battle.net/documentation/api-reference/hearthstone-game-data-api
+    # https://develop.battle.net/documentation/hearthstone/guides/metadata
     #
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Hearthstone.metadata

data/lib/blizzard_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-07 00:00:00.000000000 Z
+date: 2020-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -108,6 +108,7 @@ files:
 - lib/blizzard_api/diablo/request.rb
 - lib/blizzard_api/exception.rb
 - lib/blizzard_api/hearthstone.rb
+- lib/blizzard_api/hearthstone/game_data/back.rb
 - lib/blizzard_api/hearthstone/game_data/card.rb
 - lib/blizzard_api/hearthstone/game_data/deck.rb
 - lib/blizzard_api/hearthstone/game_data/generic_data_endpoint.rb