blizzard_api_rb_rb 3.4.2

data/blizzard_api_rb.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blizzard_api_rb/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.7.2'
+  spec.name = 'blizzard_api_rb_rb'
+  spec.version = BlizzardApi::VERSION
+  spec.authors = ['Alexchaos']
+  spec.email = ['contact@astpierre.dev']
+  spec.summary = 'Unofficial Ruby client for Blizzard Entertainment API'
+  spec.description = 'This is a simple interface to obtain data from Blizzard API'
+  spec.homepage = 'https://github.com/alexchaoss/blizzard_api_rb'
+  spec.license = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/alexchaoss/blizzard_api_rb'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/alexchaoss/blizzard_api_rb/issues'
+  spec.metadata['changelog_uri'] = 'https://github.com/alexchaoss/blizzard_api_rb/blob/master/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://rubydoc.info/gems/blizzard_api_rb_rb'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'redis', '~> 4.1', '>= 4.1.0'
+
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 0.61'
+  spec.add_development_dependency 'yard'
+end

data/lib/blizzard_api_rb/api_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  ##
+  # Simple replacement for the http response object for cached data
+  class ApiResponse
+    attr_reader :code, :body
+
+    def initialize(body)
+      @code = 200
+      @body = body
+    end
+
+    def cached?
+      true
+    end
+  end
+end
+
+module Net
+  # Workaround for fake response payloads
+  class HTTPResponse
+    def cached?
+      false
+    end
+  end
+end

data/lib/blizzard_api_rb/api_standards.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  ##
+  # Default constants and helper functions for the API format
+  module ApiStandards
+    # Common endpoints
+    BASE_URLS = {
+      game_data: 'https://%s.api.blizzard.com/data/%s',
+      community: 'https://%s.api.blizzard.com/%s',
+      profile: 'https://%s.api.blizzard.com/profile/%s',
+      media: 'https://%s.api.blizzard.com/data/%s/media',
+      user_profile: 'https://%s.api.blizzard.com/profile/user/%s',
+      search: 'https://%s.api.blizzard.com/data/%s/search'
+    }.freeze
+
+    protected
+
+    def base_url(scope)
+      raise ArgumentError, 'Invalid scope' unless BASE_URLS.include? scope
+
+      format BASE_URLS[scope], region, @game
+    end
+
+    ##
+    # Returns a valid version namespace
+    #
+    # @param [Hash] options A hash containing a valid namespace key
+    def endpoint_version(options)
+      if options.key? :classic
+        'classic-'
+      elsif options.key? :classic1x
+        'classic1x-'
+      else
+        ''
+      end
+    end
+
+    ##
+    # Returns a valid namespace string for consuming the api endpoints
+    #
+    # @param [Hash] options A hash containing the namespace key
+    def endpoint_namespace(options)
+      version = endpoint_version(options)
+
+      return "dynamic-#{version}#{region}" if options[:namespace].eql? :dynamic
+
+      return "static-#{version}#{region}" if options[:namespace].eql? :static
+
+      return "profile-#{version}#{region}" if options[:namespace].eql? :profile
+
+      raise ArgumentError, 'Invalid namespace scope'
+    end
+  end
+end

data/lib/blizzard_api_rb/configuration.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  # Global configurations
+  module Configuration
+    ##
+    # @!attribute app_id
+    #   Application ID.
+    #   @see https://develop.battle.net/access/clients
+    #   @return [String] Application ID
+    attr_accessor :app_id
+
+    ##
+    # @!attribute app_secret
+    #   Application secret.
+    #   @see https://develop.battle.net/access/clients
+    #   @return [String] Application secret
+    attr_accessor :app_secret
+
+    ##
+    # @!attribute region
+    #   Default region.
+    #   @return [String] Default region
+    attr_accessor :region
+
+    ##
+    # @!attribute mode
+    #   Api response mode :regular or :extended.
+    #   @return [Symbol] Default API response mode
+    attr_accessor :mode
+
+    ##
+    # @!attribute use_cache
+    #   If true requests will be cached using a Redis server.
+    #   @see https://redis.io/
+    #   @return [Boolean] Application ID
+    attr_accessor :use_cache
+
+    ##
+    # @!attribute redis_host
+    #   Redis host.
+    #   @see https://redis.io/
+    #   @return [String] Redis host
+    attr_accessor :redis_host
+
+    ##
+    # @!attribute redis_port
+    #   Redis port.
+    #   @see https://redis.io/
+    #   @return [Integer] Redis port
+    attr_accessor :redis_port
+
+    ##
+    # @!attribute redis_database
+    #   Redis databse.
+    #   @see https://redis.io/
+    #   @return [Integer] Redis database
+    attr_accessor :redis_database
+
+    ##
+    # @!attribute cache_access_token
+    #   If set to true and cache is enabled the current access token will be cached and recovered from Redis
+    #   @return [Boolean] Access token.
+    attr_accessor :cache_access_token
+
+    ##
+    # This method return the singleton instance of the configuration module. Use this to initialize the default values
+    # and options.
+    #
+    # @yield self
+    #
+    # @example
+    #   BlizzardApi.configure do |config|
+    #     config.app_id = ENV['BNET_APPLICATION_ID']
+    #     config.app_secret = ENV['BNET_APPLICATION_SECRET']
+    #     config.region = 'us'
+    #
+    #     config.use_cache = true
+    #     config.redis_host = ENV['REDIS_HOST']
+    #     config.redis_port = ENV['REDIS_PORT']
+    #   end
+    def configure
+      yield self
+    end
+
+    ##
+    # Initializes some default values for the main module
+    def self.extended(base)
+      base.redis_port = 1
+      base.mode = :regular
+    end
+  end
+end

data/lib/blizzard_api_rb/diablo/community/act.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III act data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-community-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.act
+    class Act < BlizzardApi::Diablo::Request
+      ##
+      # Return a list with all acts
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def index(**options)
+        api_request "#{base_url(:community)}/data/act", **{ ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return complete information about an act
+      #
+      # @param id [Integer] Act id
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(id, **options)
+        api_request "#{base_url(:community)}/data/act/#{id}", **{ ttl: CACHE_TRIMESTER }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/diablo/community/artisan.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III artisan data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-community-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.artisan
+    class Artisan < BlizzardApi::Diablo::Request
+      ##
+      # Return data about an artisan by its slug
+      #
+      # @param artisan_slug [String] Artisan slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(artisan_slug, **options)
+        api_request "#{base_url(:community)}/data/artisan/#{artisan_slug}", **{ ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return data about an artisan recipe
+      #
+      # @param artisan_slug [String] Artisan slug
+      # @param recipe_slug [String] Recipe slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def recipe(artisan_slug, recipe_slug, **options)
+        opts = { ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/data/artisan/#{artisan_slug}/recipe/#{recipe_slug}", **opts
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/diablo/community/character_class.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III character data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-community-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.character
+    class CharacterClass < BlizzardApi::Diablo::Request
+      ##
+      # Return information about a class
+      #
+      # @param class_slug [String] Class slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(class_slug, **options)
+        api_request "#{base_url(:community)}/data/hero/#{class_slug}", **{ ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return information about a class' skill
+      #
+      # @param class_slug [String] Class slug
+      # @param skill_slug [String] Skill slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def skill(class_slug, skill_slug, **options)
+        opts = { ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/data/hero/#{class_slug}/skill/#{skill_slug}", **opts
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/diablo/community/follower.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III follower data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-community-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.follower
+    class Follower < BlizzardApi::Diablo::Request
+      ##
+      # Return information about a follower
+      #
+      # @param follower_slug [String] Follower slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(follower_slug, **options)
+        api_request "#{base_url(:community)}/data/follower/#{follower_slug}", **{ ttl: CACHE_TRIMESTER }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/diablo/community/item.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III item data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-community-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.item
+    class Item < BlizzardApi::Diablo::Request
+      ##
+      # Return information about an item
+      #
+      # @param item_slug_and_id [String] Item slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(item_slug_and_id, **options)
+        api_request "#{base_url(:community)}/data/item/#{item_slug_and_id}", **{ ttl: CACHE_TRIMESTER }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/diablo/community/item_type.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III item type data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-community-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.item_type
+    class ItemType < BlizzardApi::Diablo::Request
+      ##
+      # Return a list of item types
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def index(**options)
+        api_request "#{base_url(:community)}/data/item-type", **{ ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return more information about an item type
+      #
+      # @param item_type_slug [String] Item type slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(item_type_slug, **options)
+        api_request "#{base_url(:community)}/data/item-type/#{item_type_slug}", **{ ttl: CACHE_TRIMESTER }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/diablo/community/profile.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III profile data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-community-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.profile
+    class Profile < BlizzardApi::Diablo::Request
+      ##
+      # Return an user's profile data with a list of heroes
+      #
+      # @param battletag [String] User's battletag
+      # @param oauth_token [String] A token generated by the OAuth authorization flow. See the link below for more info.
+      # @!macro request_options
+      #
+      # @!macro response
+      #
+      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      def index(battletag, oauth_token, **options)
+        opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/", **opts
+      end
+
+      ##
+      # Return more data about a hero
+      #
+      # @param battletag [String] User's battletag
+      # @param oauth_token [String] A token generated by the OAuth authorization flow. See the link below for more info.
+      # @param hero_id [Integer] Hero id
+      # @!macro request_options
+      #
+      # @!macro response
+      #
+      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      def hero(battletag, oauth_token, hero_id, **options)
+        opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/hero/#{hero_id}", **opts
+      end
+
+      ##
+      # Return more data about a hero's items
+      #
+      # @param battletag [String] User's battletag
+      # @param oauth_token [String] A token generated by the OAuth authorization flow. See the link below for more info.
+      # @param hero_id [Integer] Hero id
+      # @!macro request_options
+      #
+      # @!macro response
+      #
+      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      def hero_items(battletag, oauth_token, hero_id, **options)
+        opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/hero/#{hero_id}/items", **opts
+      end
+
+      ##
+      # Return more data about a hero's followers
+      #
+      # @param battletag [String] User's battletag
+      # @param oauth_token [String] A token generated by the OAuth authorization flow. See the link below for more info.
+      # @param hero_id [Integer] Hero id
+      # @!macro request_options
+      #
+      # @!macro response
+      #
+      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      def hero_follower_items(battletag, oauth_token, hero_id, **options)
+        opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/profile/#{parse_battle_tag(battletag)}/hero/#{hero_id}/follower-items", **opts
+      end
+
+      private
+
+      def parse_battle_tag(battletag)
+        battletag.sub('#', '-')
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/diablo/game_data/era.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III era data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.era
+    class Era < Diablo::GenericDataEndpoint
+      protected
+
+      def endpoint_setup
+        @endpoint = 'era'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    # Generic endpoint to support most data requests with minor configurations
+    class GenericDataEndpoint < Diablo::Request
+      def initialize(**options)
+        super(**options)
+        endpoint_setup
+        @ttl ||= CACHE_DAY
+      end
+
+      ##
+      # Get information about the resource
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def index(**options)
+        api_request "#{base_url(:game_data)}/#{@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(:game_data)}/#{@endpoint}/#{id}", **default_options.merge(options)
+      end
+
+      ##
+      # Fetch leaderboard data for the current endpoint
+      #
+      # @param [Integer] id One of the IDs returned by the {index}
+      # @param [String] leaderboard_id Leaderboard id
+      # @!macro request_options
+      #
+      # @!macro response
+      def leaderboard(id, leaderboard_id, **options)
+        opts = default_options.merge(options)
+        api_request "#{base_url(:game_data)}/#{@endpoint}/#{id}/leaderboard/#{leaderboard_id}", **opts
+      end
+
+      protected
+
+      def endpoint_setup
+        raise NotImplementedError
+      end
+
+      def default_options
+        { ttl: @ttl }
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/diablo/game_data/season.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III season data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.season
+    class Season < Diablo::GenericDataEndpoint
+      protected
+
+      def endpoint_setup
+        @endpoint = 'season'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

data/lib/blizzard_api_rb/diablo/request.rb

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