blizzard_api 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8912dbf1d2428d658df1a48f5e24f4eda29a1bf40b6882851d899b35ebecd678
-  data.tar.gz: b97d376156394a7c529ab7ff42ec67227307141e9037ba015aaf9114636228ab
+  metadata.gz: 770ab293148fe2410f404e46ffb5108121b47dcf9262dfc4e07c4b139dca3fab
+  data.tar.gz: c807938359f746c9a0d0ada0761726e268588f2a359b1c362c3acb24444dfa98
 SHA512:
-  metadata.gz: 5592ee0340659d8c20e301b27f48b8f213b0b71df70b8024f5b8177ab89d22c1f1b080f5b55e22bb4ebe63c9c442cfe40c83ad4071b19e28ec92bc8cfedd15bc
-  data.tar.gz: fba6de77e9c6e60ed932dcdb53fecdc3a1003563f71681691b3015ab0af2dc03174ebe97e3f4b51db5f5af31d82a5f1f55d0fc3c1f125f1e89addda3405d2ec1
+  metadata.gz: 429845f34610b72326cdca9b77b8408d49bb0852297d0282d8ee71ef0a2f0c4dfe4ea6dbf1c3d5ca31e562a343edde968178888d64e29ea7c8ec2d522eb1d6e7
+  data.tar.gz: d06edb2063dd4edd42b7f5ae18018355854884eb482ac94d3589f6abc3a04fa24d93e37f474d690daa225aa392c12baa5a36dc1ea9751c0afb2b2277b96d29a5

data/.gitlab-ci.yml

@@ -10,6 +10,7 @@ stages:
 environment-setup:
   stage: prepare
   script:
+    - gem install bundler -v 1.17.3
     - rvm use 2.5.3 --install
     - bundle install
     - cat /dev/null > .env

data/.travis.yml

@@ -4,4 +4,4 @@ language: ruby
 cache: bundler
 rvm:
   - 2.5.3
-before_install: gem install bundler -v 1.16.6
+before_install: gem install bundler -v 1.17.3

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 0.2.4**
+* Added new WoW profile endpoints: #2 https://us.battle.net/forums/en/bnet/topic/20772457051
+* Added support for HearthStone: !1 (Thanks Bradyn Glines for implementing this)
+
 **Version 0.2.3**
 * Added new api endpoints listed here: https://us.battle.net/forums/en/bnet/topic/20772337044
 

data/Gemfile.lock

@@ -8,33 +8,31 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
-    dotenv (2.5.0)
-    jaro_winkler (1.5.1)
+    dotenv (2.7.4)
+    jaro_winkler (1.5.3)
     minitest (5.11.3)
-    parallel (1.12.1)
-    parser (2.5.3.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
       ast (~> 2.4.0)
-    powerpack (0.1.2)
     rainbow (3.0.0)
     rake (10.5.0)
-    redis (4.1.1)
-    rubocop (0.61.1)
+    redis (4.1.2)
+    rubocop (0.72.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    unicode-display_width (1.4.0)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   blizzard_api!
-  bundler (~> 1.16)
+  bundler (~> 1.17.3)
   dotenv (~> 2.5)
   minitest (~> 5.0)
   rake (~> 10.0)

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. [Starcraft II endpoints](#43-starcraft-ii-endpoints)
+   - 4.4. [Hearthstone endpoints](#44-hearthstone-endpoints)
 
 ## 1. Installation
 
@@ -266,6 +267,18 @@ Every endpoint requiring a *region_id* parameter will accepts either the integer
 * BlizzardApi::Starcraft::Account
   - player :account_id
 
+### 4.4. Hearthstone endpoints
+
+* BlizzardApi::Hearthstone::Card
+  - index
+  - get :id_or_slug
+  - search :search_options
+* BlizzardApi::Hearthstone::Deck
+  - get :deck_code
+* BlizzardApi::Hearthstone::Metadata
+  - index
+  - get :type
+
 ## Contributing
 
 Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/francisschiavo/blizzard_api/issues

data/blizzard_api.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'redis', '~> 4.1', '>= 4.1.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '~> 1.17.3'
   spec.add_development_dependency 'dotenv', '~> 2.5'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'

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/starcraft'
+require_relative 'blizzard_api/hearthstone'
 
 # Blizzard namespace
 module BlizzardApi

data/lib/blizzard_api/configuration.rb

@@ -68,7 +68,7 @@ module BlizzardApi
 
     ##
     # @!attribute guild_emblem_directory
-    #   Guild crest images directory. Some sub directories will be crated.
+    #   Guild crest images directory. Some sub directories will be created.
     #   @see https://develop.battle.net/access/clients
     #   @return [String] Guild crest directory
     attr_accessor :wow_guild_crest_directory
@@ -93,7 +93,7 @@ module BlizzardApi
     # @yield self
     #
     # @example
-    #   Blizzard.configure do |config|
+    #   BlizzardApi.configure do |config|
     #     config.app_id = ENV['BNET_APPLICATION_ID']
     #     config.app_secret = ENV['BNET_APPLICATION_SECRET']
     #     config.region = 'us'

data/lib/blizzard_api/diablo/request.rb

@@ -2,7 +2,7 @@
 
 module BlizzardApi
   module Diablo
-    # World of Warcraft requests
+    # Diablo III requests
     class Request < BlizzardApi::Request
       ##
       # @!macro regions

data/lib/blizzard_api/hearthstone.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+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/deck'
+    require_relative 'hearthstone/game_data/metadata'
+
+    ##
+    # @return {Card}
+    def self.card
+      BlizzardApi::Hearthstone::Card.new
+    end
+
+    ##
+    # @return {Deck}
+    def self.deck
+      BlizzardApi::Hearthstone::Deck.new
+    end
+
+    ##
+    # @return {Metadata}
+    def self.metadata
+      BlizzardApi::Hearthstone::Metadata.new
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# 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
+    #
+    # 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
+        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 [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
+
+      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/hearthstone/game_data/deck.rb

@@ -0,0 +1,29 @@
+# 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
+    #
+    # 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/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(region = nil)
+        super region
+        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 index(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] 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/hearthstone/game_data/metadata.rb

@@ -0,0 +1,21 @@
+# 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
+    #
+    # 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/hearthstone/request.rb

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

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

data/lib/blizzard_api/wow/profile/character_profile.rb

@@ -11,62 +11,168 @@ module BlizzardApi
     #   api_instance = BlizzardApi::Wow.achievement
     class CharacterProfile < Wow::Request
       ##
-      # Return the mythic keystone profile of a character
+      # Return character achievements
       #
-      # @note This endpoint requires a user token obtained through the user authorization flow
-      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
       # @param realm [String] The character realm's slug
       # @param character [String] The character name
-      # @param user_token [String] A token obtained by the authorization flow. See link below.
-      # @param season [Integer] Season ID if you want only a specific season or nil to include all.
       # @!macro request_options
       #
       # @!macro response
-      def get_keystone_profile(realm, character, user_token, season = nil, options = {})
-        url = "#{endpoint_uri(realm, character)}/mythic-keystone-profile"
-        url += "/season/#{season}" unless season.nil?
-        api_request url, default_options(user_token).merge(options)
+      def achievements(realm, character, options = {})
+        api_request "#{endpoint_uri(realm, character)}/achievements", default_options.merge(options)
       end
 
       ##
-      # Return the pvp summary of a character
+      # Return character appearance
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def appearance(realm, character, options = {})
+        api_request "#{endpoint_uri(realm, character)}/appearance", default_options.merge(options)
+      end
+
+      ##
+      # Return character equipment
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def equipment(realm, character, options = {})
+        api_request "#{endpoint_uri(realm, character)}/equipment", default_options.merge(options)
+      end
+
+      ##
+      # Return character media
       #
-      # @note This endpoint requires a user token obtained through the user authorization flow
-      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
       # @param realm [String] The character realm's slug
       # @param character [String] The character name
-      # @param user_token [String] A token obtained by the authorization flow. See link below.
       # @!macro request_options
       #
       # @!macro response
-      def pvp_summmary(realm, character, user_token, options = {})
-        api_request "#{endpoint_uri(realm, character)}/pvp-summary", default_options(user_token).merge(options)
+      def media(realm, character, options = {})
+        api_request "#{endpoint_uri(realm, character)}/character-media", default_options.merge(options)
       end
 
       ##
       # Return the pvp bracket of a character
       #
-      # @note This endpoint requires a user token obtained through the user authorization flow
-      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #
       # @param realm [String] The character realm's slug
       # @param character [String] The character name
       # @param bracket [String] Pvp bracket
-      # @param user_token [String] A token obtained by the authorization flow. See link below.
       # @!macro request_options
       #
       # @!macro response
-      def pvp_bracket(realm, character, bracket, user_token, options = {})
-        api_request "#{endpoint_uri(realm, character)}/pvp-bracket/#{bracket}",
-                    default_options(user_token).merge(options)
+      def pvp_bracket(realm, character, bracket, options = {})
+        api_request "#{endpoint_uri(realm, character)}/pvp-bracket/#{bracket}", default_options.merge(options)
+      end
+
+      ##
+      # Return the pvp summary of a character
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def pvp_summary(realm, character, options = {})
+        api_request "#{endpoint_uri(realm, character)}/pvp-summary", default_options.merge(options)
+      end
+
+      ##
+      # Return a character's specialization
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def specializations(realm, character, options = {})
+        api_request "#{endpoint_uri(realm, character)}/specializations", default_options.merge(options)
+      end
+
+      ##
+      # Return a character's statistics
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def statistics(realm, character, options = {})
+        api_request "#{endpoint_uri(realm, character)}/statistics", default_options.merge(options)
+      end
+
+      ##
+      # Return a character's titles
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def titles(realm, character, options = {})
+        api_request "#{endpoint_uri(realm, character)}/titles", default_options.merge(options)
+      end
+
+      ##
+      # Return the mythic keystone profile of a character
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def keystone_profile(realm, character, options = {})
+        api_request "#{endpoint_uri(realm, character)}/mythic-keystone-profile", default_options.merge(options)
+      end
+
+      ##
+      # Return the mythic keystone profile of a character
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @param season [Integer] Season ID if you want only a specific season or nil to include all.
+      # @!macro request_options
+      #
+      # @!macro response
+      def keystone_season_details(realm, character, season = nil, options = {})
+        api_request api_request "#{endpoint_uri(realm, character)}/mythic-keystone-profile/season/#{season}",
+                                default_options.merge(options)
       end
 
       private
 
-      def default_options(user_token)
-        { ttl: CACHE_HOUR, namespace: endpoint_namespace(:profile), access_token: user_token }
+      def default_options(user_token = nil)
+        opts = { ttl: CACHE_HOUR, namespace: endpoint_namespace(:profile) }
+        opts.merge access_token: user_token if user_token
+        opts
       end
 
       def endpoint_uri(realm, character)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2019-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 1.17.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 1.17.3
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,12 @@ files:
 - lib/blizzard_api/diablo/game_data/season.rb
 - lib/blizzard_api/diablo/request.rb
 - lib/blizzard_api/exception.rb
+- lib/blizzard_api/hearthstone.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
+- 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