blizzard_api_rb_rb 3.4.2

data/lib/blizzard_api_rb/diablo.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+##
+# @!macro [new] init_options
+#   @param options [Hash] Initialization options
+#     @option options [String] :region API region
+#     @option options [Symbol] :model API mode (:regular, :extended)
+
+module BlizzardApi
+  # Diablo III related classes
+  module Diablo
+    require_relative 'diablo/request'
+    require_relative 'diablo/game_data/generic_data_endpoint'
+
+    # Diablo data api
+    require_relative 'diablo/game_data/season'
+    require_relative 'diablo/game_data/era'
+
+    ##
+    # @!macro init_options
+    # @return {Season}
+    def self.season(**options)
+      BlizzardApi::Diablo::Season.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Era}
+    def self.era(**options)
+      BlizzardApi::Diablo::Era.new(**options)
+    end
+
+    # Diablo community api
+    require_relative 'diablo/community/act'
+    require_relative 'diablo/community/artisan'
+    require_relative 'diablo/community/follower'
+    require_relative 'diablo/community/character_class'
+    require_relative 'diablo/community/item_type'
+    require_relative 'diablo/community/item'
+    require_relative 'diablo/community/profile'
+
+    ##
+    # @!macro init_options
+    # @return {Act}
+    def self.act(**options)
+      BlizzardApi::Diablo::Act.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Artisan}
+    def self.artisan(**options)
+      BlizzardApi::Diablo::Artisan.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Follower}
+    def self.follower(**options)
+      BlizzardApi::Diablo::Follower.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Character}
+    def self.character(**options)
+      BlizzardApi::Diablo::CharacterClass.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {ItemType}
+    def self.item_type(**options)
+      BlizzardApi::Diablo::ItemType.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Type}
+    def self.item(**options)
+      BlizzardApi::Diablo::Item.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Profile}
+    def self.profile(**options)
+      BlizzardApi::Diablo::Profile.new(**options)
+    end
+  end
+end

data/lib/blizzard_api_rb/exception.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  ##
+  # API Exception
+  class ApiException < RuntimeError
+    attr_reader :code
+
+    def initialize(msg = '', code = nil)
+      @code = code
+      super msg
+    end
+  end
+end

data/lib/blizzard_api_rb/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_rb/hearthstone/game_data/card.rb

@@ -0,0 +1,111 @@
+# 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-search
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Hearthstone.card
+    class Card < Hearthstone::GenericDataEndpoint
+      # Valid options for card search
+      VALID_SEARCH_OPTIONS = %i[
+        set
+        class
+        manaCost
+        attack
+        health
+        collectible
+        rarity
+        type
+        minionType
+        keyword
+        textFilter
+        gameMode
+        page
+        pageSize
+        sort
+        order
+      ].freeze
+
+      ##
+      # Fetch all possible data for one of the items listed by the {#index} using its *id*
+      #
+      # @param search_options [Hash] Search options accepted by the endpoint
+      #   @option search_options [String] :set The slug of the set the card belongs to.
+      #     If you do not supply a value cards from all sets will be returned.
+      #   @option search_options [String] :class The slug of the card's class.
+      #   @option search_options [Integer] :manaCost The mana cost required to play the card.
+      #     You can include multiple values in a comma-separated list of numeric values.
+      #   @option search_options [Integer] :attack The attack power of the minion or weapon.
+      #     You can include multiple values in a comma-separated list of numeric values.
+      #   @option search_options [Integer] :health The health of a minion.
+      #     You can include multiple values in a comma-separated list of numeric values.
+      #   @option search_options [Float] :collectible Whether a card is collectible.
+      #     A value of 1 indicates that collectible cards should be returned; 0 indicates uncollectible cards.
+      #     To return all cards, use a value of '0,1'.
+      #   @option search_options [String] :rarity The rarity of a card.
+      #     This value must match the rarity slugs found in metadata.
+      #   @option search_options [String] :type The type of card (for example, minion, spell, and so on).
+      #     This value must match the type slugs found in metadata.
+      #   @option search_options [String] :minionType The type of minion card (for example, beast, murloc, dragon, and
+      #     so on). This value must match the minion type slugs found in metadata.
+      #   @option search_options [String] :keyword A required keyword on the card (for example, battlecry, deathrattle,
+      #     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
+      #     maximum allowed. @option search_options [String] :sort The field used to sort the results.
+      #     Valid values include manaCost, attack, health, and name. Results are sorted by manaCost by default.
+      #     Cards will also be sorted by class automatically in most cases.
+      #   @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)}/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)
+        search_options.each do |field|
+          raise ArgumentError, "Unrecognized search option #{field}" unless VALID_SEARCH_OPTIONS.include? field
+        end
+      end
+
+      def endpoint_setup
+        @endpoint = 'cards'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Hearthstone
+    ##
+    # 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
+    class Deck < Hearthstone::GenericDataEndpoint
+      def index
+        raise ApiException, 'This endpoint does not have a index method'
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'deck'
+        @ttl = CACHE_TRIMESTER
+      end
+
+      def default_options
+        { ttl: @ttl }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Hearthstone
+    # Generic endpoint to support most data requests with minor configurations
+    class GenericDataEndpoint < Hearthstone::Request
+      def initialize(**options)
+        super(**options)
+        endpoint_setup
+        @ttl ||= CACHE_DAY
+      end
+
+      ##
+      # Using :community base_url as that's where Blizzard's endpoint resides
+      # Also in the game_data folder as they have labeled it "Hearthstone Game Data APIs"
+
+      ##
+      # Get information about the resource
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def search(**options)
+        api_request "#{base_url(:community)}/#{@endpoint}/", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch all possible data for one of items listed by the {#index} using its *id*
+      #
+      # @param [Integer|String] id One of the IDs returned by the {#index}
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(id, **options)
+        api_request "#{base_url(:community)}/#{@endpoint}/#{id}", **default_options.merge(options)
+      end
+
+      protected
+
+      def endpoint_setup
+        raise NotImplementedError
+      end
+
+      def default_options
+        { ttl: @ttl }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Hearthstone
+    ##
+    # 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
+    class Metadata < Hearthstone::GenericDataEndpoint
+      protected
+
+      def endpoint_setup
+        @endpoint = 'metadata'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/hearthstone/request.rb

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

data/lib/blizzard_api_rb/hearthstone.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+##
+# @!macro [new] init_options
+#   @param options [Hash] Initialization options
+#     @option options [String] :region API region
+#     @option options [Symbol] :model API mode (:regular, :extended)
+
+module BlizzardApi
+  # Hearthstone related classes
+  module Hearthstone
+    require_relative 'hearthstone/request'
+    require_relative 'hearthstone/game_data/generic_data_endpoint'
+
+    # 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'
+
+    ##
+    # @!macro init_options
+    # @return {Card}
+    def self.card(**options)
+      BlizzardApi::Hearthstone::Card.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Back}
+    def self.back(**options)
+      BlizzardApi::Hearthstone::Back.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Deck}
+    def self.deck(**options)
+      BlizzardApi::Hearthstone::Deck.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Metadata}
+    def self.metadata(**options)
+      BlizzardApi::Hearthstone::Metadata.new(**options)
+    end
+  end
+end

data/lib/blizzard_api_rb/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_rb/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_rb/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_rb/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_rb/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_rb/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_rb/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