blizzard_api 0.2.0

data/lib/blizzard_api/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/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(region = nil)
+        super region
+        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 [Integer] 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/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/diablo/request.rb

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

data/lib/blizzard_api/exception.rb

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

data/lib/blizzard_api/request.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+##
+# @!macro [new] request_options
+#   @param {Hash} options You can specify some options
+#   @option options [String] :region Overrides the default region for a single call
+#   @option options [String] :locale Overrides the default locale for a single call
+#   @option options [String] :namespace Overrides the default namespace for a single call
+#   @option options [String] :access_token Overrides the access_token for a single call
+#   @option options [Boolean] :ignore_cache If set to true the request will not use the cache
+#   @option options [Integer] :ttl Override the default time (in seconds) a request should be cached
+
+##
+# @!macro [new] regions
+#   @param {Symbol} region One of the valid API regions *:us*, *:eu*, *:ko*, and *:tw*
+#   @note This gem do not support nor will support China endpoints
+
+##
+# @!macro [new] response
+#   @return [OpenStruct,Array] API Response. The actual type of the returned object depends on the *format* option
+#   in the configuration module
+
+##
+# @!macro [new] complete
+#   Iterates through the {index} response data and fetch additional information using {get}, it results in a more
+#   complete set of data
+#   @note IT MAY PERFORM MANY REQUESTS TO FETCH ALL DATA
+#   @!macro request_options
+#   @!macro response
+
+module BlizzardApi
+  ##
+  # Simplifies the requests to Blizzard APIS
+  class Request
+    # One minute cache
+    CACHE_MINUTE = 60
+    # One hour cache
+    CACHE_HOUR = 60 * CACHE_MINUTE
+    # One day cache
+    CACHE_DAY = 24 * CACHE_HOUR
+    # One week cache
+    CACHE_WEEK = CACHE_DAY * 7
+    # One (commercial) month cache
+    CACHE_MONTH = CACHE_DAY * 30
+    # Three (commercial) months cache
+    CACHE_TRIMESTER = CACHE_MONTH * 3
+
+    ##
+    # @!attribute region
+    #   @return [String] Api region
+    attr_accessor :region
+
+    ##
+    # @!macro regions
+    def initialize(region = nil)
+      self.region = region || BlizzardApi.region
+      @redis = Redis.new(host: BlizzardApi.redis_host, port: BlizzardApi.redis_port) if BlizzardApi.use_cache
+      # Use the shared access_token, or create one if it doesn't exists. This avoids unnecessary calls to create tokens.
+      @access_token = BlizzardApi.access_token || create_access_token
+    end
+
+    require 'net/http'
+    require 'uri'
+    require 'json'
+    require 'redis'
+
+    protected
+
+    def base_url(scope)
+      case scope
+      when :game_data
+        "https://#{region}.api.blizzard.com/data/#{@game}"
+      when :community
+        "https://#{region}.api.blizzard.com/#{@game}"
+      when :profile
+        "https://#{region}.api.blizzard.com/profile/#{@game}"
+      else
+        raise ArgumentError
+      end
+    end
+
+    ##
+    # Returns a valid namespace string for consuming the api endpoints
+    #
+    # @param [Symbol] scope Scope of the namespace to be used. *:dynamic* or *:static*
+    def endpoint_namespace(scope)
+      case scope
+      when :dynamic
+        "dynamic-#{region}"
+      when :static
+        "static-#{region}"
+      else
+        raise ArgumentError, 'Invalid namespace scope'
+      end
+    end
+
+    def create_access_token
+      uri = URI.parse("https://#{BlizzardApi.region}.battle.net/oauth/token")
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      request = Net::HTTP::Post.new(uri.path)
+      request.basic_auth(BlizzardApi.app_id, BlizzardApi.app_secret)
+      request['Content-Type'] = 'application/x-www-form-urlencoded'
+      request.set_form_data grant_type: 'client_credentials'
+
+      response = http.request(request)
+      BlizzardApi.access_token = JSON.parse(response.body)['access_token']
+    end
+
+    def request(url, options = {})
+      # Creates the whole url for request
+      parsed_url = URI.parse(url)
+
+      data = options[:ignore_cache] ? nil : find_in_cache(parsed_url.to_s)
+      # If data was found that means cache is enabled and valid
+      return format_response data if data
+
+      # Override access_token
+      @access_token = options[:access_token] if options.include? :access_token
+
+      response = consume_api parsed_url
+
+      unless options[:ignore_cache]
+        ttl = options[:ttl] || CACHE_DAY
+        save_in_cache parsed_url.to_s, response.body, ttl
+      end
+
+      format_response response.body
+    end
+
+    def api_request(uri, query_string = {})
+      # List of request options
+      options_key = %i[ignore_cache ttl format access_token]
+
+      # Separates request options from api fields and options. Any user-defined option will be treated as api field.
+      options = query_string.select { |k, _v| query_string.delete(k) || true if options_key.include? k }
+
+      # In case uri already have query string parameters joins them with &
+      if query_string.size.positive?
+        query_string = URI.encode_www_form(query_string, false)
+        uri = uri.include?('?') ? "#{uri}&#{query_string}" : "#{uri}?#{query_string}"
+      end
+
+      request uri, options
+    end
+
+    private
+
+    def consume_api(url)
+      # Creates a HTTP connection and request to ensure thread safety
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      request = Net::HTTP::Get.new(url)
+
+      # Blizzard API documentation states the preferred way to send the access_token is using Bearer token on header
+      request['Authorization'] = "Bearer #{@access_token}"
+
+      # Executes the request
+      http.request(request).tap do |response|
+        raise ApiException.new 'Request failed', response.code unless response.code.to_i == 200
+      end
+    end
+
+    def save_in_cache(resource_url, data, ttl)
+      return nil unless BlizzardApi.use_cache
+
+      @redis.setex resource_url, ttl, data
+    end
+
+    def find_in_cache(resource_url)
+      return false unless BlizzardApi.use_cache
+
+      @redis.get resource_url if @redis.exists resource_url
+    end
+
+    def format_response(data)
+      JSON.parse(data, symbolize_names: true)
+    end
+  end
+end

data/lib/blizzard_api/starcraft.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  # Starcraft II related classes
+  module Starcraft
+    require_relative 'starcraft/request'
+
+    # Starcraft II data api
+    require_relative 'starcraft/game_data/league'
+
+    ##
+    # @return {League}
+    def league
+      BlizzardApi::Starcraft::League.new
+    end
+
+    # Starcraft community api
+    require_relative 'starcraft/community/profile'
+    require_relative 'starcraft/community/ladder'
+    require_relative 'starcraft/community/account'
+
+    ##
+    # @return {Profile}
+    def profile
+      BlizzardApi::Starcraft::Profile.new
+    end
+
+    ##
+    # @return {Ladder}
+    def ladder
+      BlizzardApi::Starcraft::Ladder.new
+    end
+
+    ##
+    # @return {Account}
+    def account
+      BlizzardApi::Starcraft::Account.new
+    end
+  end
+end

data/lib/blizzard_api/starcraft/community/account.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Starcraft
+    ##
+    # This class allows access to Starcraft II league data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/starcraft-2-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Starcraft.account
+    class Account < Starcraft::Request
+      ##
+      # Returns information about a player account
+      #
+      # @param [Integer] account_id Account ID
+      # @!macro request_options
+      def player(account_id, options = {})
+        api_request "#{base_url(:community)}/player/#{account_id}", { ttl: CACHE_DAY }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api/starcraft/community/ladder.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Starcraft
+    ##
+    # This class allows access to Starcraft II ladder data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/starcraft-2-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Starcraft.ladder
+    class Ladder < Starcraft::Request
+      ##
+      # Grandmaster endpoint
+      #
+      # @!macro sc2_regions
+      # @!macro request_options
+      def grandmaster(region_id, options = {})
+        reg = resolve_region(region_id)
+        api_request "#{base_url(:community)}/ladder/grandmaster/#{reg}", { ttl: CACHE_DAY }.merge(options)
+      end
+
+      ##
+      # Season endpoint
+      #
+      # @!macro sc2_regions
+      # @!macro request_options
+      def season(region_id, options = {})
+        reg = resolve_region(region_id)
+        api_request "#{base_url(:community)}/ladder/season/#{reg}", { ttl: CACHE_DAY }.merge(options)
+      end
+    end
+  end
+end

data/lib/blizzard_api/starcraft/community/profile.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Starcraft
+    ##
+    # This class allows access to Starcraft II profile data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/starcraft-2-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Starcraft.profile
+    class Profile < Starcraft::Request
+      ##
+      # Static profile data
+      #
+      # @!macro sc2_regions
+      # @!macro request_options
+      def static(region_id, options = {})
+        reg = resolve_region(region_id)
+        api_request "#{base_url(:community)}/static/profile/#{reg}", { ttl: CACHE_DAY }.merge(options)
+      end
+
+      ##
+      # Metadata
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      def metadata(region_id, realm_id, profile_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/metadata/profile/#{reg}/#{realm_id}/#{profile_id}", opts
+      end
+
+      ##
+      # Profile data
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      def profile(region_id, realm_id, profile_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/profile/#{reg}/#{realm_id}/#{profile_id}", opts
+      end
+
+      ##
+      # Ladder summary
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      def ladder_summary(region_id, realm_id, profile_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}profile/#{reg}/#{realm_id}/#{profile_id}/ladder/summary ", opts
+      end
+
+      ##
+      # Ladder data
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      def ladder(region_id, realm_id, profile_id, ladder_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/profile/#{reg}/#{realm_id}/#{profile_id}/ladder/#{ladder_id}", opts
+      end
+    end
+  end
+end