blizzard_api 0.6.3 → 3.0.0

data/lib/blizzard_api/request.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+##
+# @!macro [new] init_options
+#   @param [Hash] options
+#   @option options [String] :region API Region
+#   @option options [Symbol] :mode API Mode
+
 ##
 # @!macro [new] request_options
 #   @param {Hash} options You can specify some options
@@ -9,31 +15,18 @@
 #   @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
 #   @option options [DateTime] :since Adds the If-modified-since headers. Will always ignore cache when set.
-#   @option options [Integer] :concurrency How many threads to use for complete sets of data.
-#     BEWARE: Might cause 429 responses, in this case lower the number.
-
-##
-# @!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 [Hash] 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
+    include ApiStandards
+
     # One hour cache
     CACHE_HOUR = 3600
     # One day cache
@@ -41,16 +34,6 @@ module BlizzardApi
     # Three (commercial) months cache
     CACHE_TRIMESTER = CACHE_DAY * 90
 
-    # 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
-
     ##
     # @!attribute region
     #   @return [String] Api region
@@ -62,14 +45,14 @@ module BlizzardApi
     attr_accessor :mode
 
     ##
-    # @!macro regions
-    def initialize(region = nil, mode = :regular)
-      self.region = region || BlizzardApi.region
-      @redis = Redis.new(host: BlizzardApi.redis_host, port: BlizzardApi.redis_port) if BlizzardApi.use_cache
+    # @!macro init_options
+    def initialize(**options)
+      self.region = options[:region] || BlizzardApi.region
       # 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
+      create_access_token if BlizzardApi.access_token_expired?
+
       # Mode
-      @mode = mode
+      @mode = options[:mode] || BlizzardApi.mode
     end
 
     require 'net/http'
@@ -79,45 +62,9 @@ module BlizzardApi
 
     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)
-      case options[:namespace]
-      when :dynamic
-        "dynamic-#{version}#{region}"
-      when :static
-        "static-#{version}#{region}"
-      when :profile
-        "profile-#{region}"
-      else
-        raise ArgumentError, 'Invalid namespace scope'
-      end
-    end
-
     def create_access_token
+      return if BlizzardApi.restore_access_token
+
       uri = URI.parse("https://#{BlizzardApi.region}.battle.net/oauth/token")
 
       http = Net::HTTP.new(uri.host, uri.port)
@@ -129,7 +76,7 @@ module BlizzardApi
       request.set_form_data grant_type: 'client_credentials'
 
       response = http.request(request)
-      BlizzardApi.access_token = JSON.parse(response.body)['access_token']
+      BlizzardApi.save_access_token(JSON.parse(response.body))
     end
 
     def request(url, **options)
@@ -139,16 +86,14 @@ module BlizzardApi
       data = using_cache?(options) ? find_in_cache(parsed_url.to_s) : nil
 
       # If data was found that means cache is enabled and valid
-      return JSON.parse(data, symbolize_names: true) if data
+      return prepare_response data if data
 
       response = consume_api parsed_url, **options
 
+      response_data = response.code.to_i.eql?(304) ? nil : response.body
       save_in_cache parsed_url.to_s, response.body, options[:ttl] || CACHE_DAY if using_cache? options
 
-      response_data = response.code.to_i.eql?(304) ? nil : JSON.parse(response.body, symbolize_names: true)
-      return [response, response_data] if mode.eql? :extended
-
-      response_data
+      prepare_response response_data, response
     end
 
     def api_request(uri, **query_string)
@@ -163,7 +108,7 @@ module BlizzardApi
 
       # 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)
+        query_string = URI.encode_www_form(query_string)
         uri = uri.include?('?') ? "#{uri}&#{query_string}" : "#{uri}?#{query_string}"
       end
 
@@ -172,24 +117,41 @@ module BlizzardApi
 
     private
 
+    ##
+    # Resolves the response based on the mode
+    def prepare_response(data, response = false)
+      parsed_data = data.nil? ? data : JSON.parse(data, symbolize_names: true)
+
+      return parsed_data unless mode.eql? :extended
+
+      response = ApiResponse.new(data) unless response
+
+      [response, parsed_data]
+    end
+
     ##
     # @param options [Hash] Request options
     def using_cache?(options)
-      return false if mode.eql?(:extended) || options.key?(:since)
+      return false if options.key?(:since)
 
       !options.fetch(:ignore_cache, false)
     end
 
+    def http_connection(url)
+      Net::HTTP.new(url.host, url.port).tap do |http|
+        http.use_ssl = true
+        http.keep_alive_timeout = 30
+      end
+    end
+
     def consume_api(url, **options)
       # 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)
 
       add_headers request, options
 
       # Executes the request
-      http.request(request).tap do |response|
+      http_connection(url).request(request).tap do |response|
         if mode.eql?(:regular) && ![200, 304].include?(response.code.to_i)
           raise BlizzardApi::ApiException.new "Request failed with code '#{response.code}' details: #{response.to_hash}", response.code.to_i
         end
@@ -198,20 +160,20 @@ module BlizzardApi
 
     def add_headers(request, options)
       # Blizzard API documentation states the preferred way to send the access_token is using Bearer token on header
-      request['Authorization'] = "Bearer #{options.fetch(:access_token, @access_token)}"
+      request['Authorization'] = "Bearer #{options.fetch(:access_token, BlizzardApi.access_token)}"
       # Format If-modified-since option
       request['If-Modified-Since'] = options[:since].httpdate if options.key? :since
       options[:headers]&.each { |header, content| request[header] = content }
     end
 
     def save_in_cache(resource_url, data, ttl)
-      @redis.setex resource_url, ttl, data if BlizzardApi.use_cache
+      BlizzardApi.redis_connection.setex resource_url, ttl, data if BlizzardApi.use_cache
     end
 
     def find_in_cache(resource_url)
       return false unless BlizzardApi.use_cache
 
-      @redis.get resource_url if @redis.exists? resource_url
+      BlizzardApi.redis_connection.get resource_url if BlizzardApi.redis_connection.exists? resource_url
     end
   end
 end

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

@@ -20,7 +20,7 @@ module BlizzardApi
       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)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}", opts
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}", **opts
       end
 
       ##
@@ -33,7 +33,7 @@ module BlizzardApi
       def ladders(region_id, realm_id, profile_id, **options)
         reg = resolve_region(region_id)
         opts = { ttl: CACHE_DAY }.merge(options)
-        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}/ladder ", opts
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}/ladder ", **opts
       end
 
       ##
@@ -46,7 +46,7 @@ module BlizzardApi
       def match(region_id, realm_id, profile_id, **options)
         reg = resolve_region(region_id)
         opts = { ttl: CACHE_DAY }.merge(options)
-        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}/matches", opts
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}/matches", **opts
       end
 
       ##
@@ -58,7 +58,7 @@ module BlizzardApi
       def ladder(region_id, ladder_id, **options)
         reg = resolve_region(region_id)
         opts = { ttl: CACHE_DAY }.merge(options)
-        api_request "#{base_url(:community)}/legacy/ladder/#{reg}/#{ladder_id}", opts
+        api_request "#{base_url(:community)}/legacy/ladder/#{reg}/#{ladder_id}", **opts
       end
 
       ##
@@ -69,7 +69,7 @@ module BlizzardApi
       def achievements(region_id, **options)
         reg = resolve_region(region_id)
         opts = { ttl: CACHE_DAY }.merge(options)
-        api_request "#{base_url(:community)}/legacy/data/achievements/#{reg}", opts
+        api_request "#{base_url(:community)}/legacy/data/achievements/#{reg}", **opts
       end
 
       ##
@@ -80,7 +80,7 @@ module BlizzardApi
       def rewards(region_id, **options)
         reg = resolve_region(region_id)
         opts = { ttl: CACHE_DAY }.merge(options)
-        api_request "#{base_url(:community)}/legacy/data/rewards/#{reg}", opts
+        api_request "#{base_url(:community)}/legacy/data/rewards/#{reg}", **opts
       end
     end
   end

data/lib/blizzard_api/starcraft/request.rb

@@ -14,9 +14,9 @@ module BlizzardApi
       SC_REGION = { US: 1, EU: 2, KO: 3, TW: 3 }.freeze
 
       ##
-      # @!macro regions
-      def initialize(region = nil, mode = :regular)
-        super region, mode
+      # @!macro init_options
+      def initialize(**options)
+        super(**options)
         @game = 'sc2'
       end
 

data/lib/blizzard_api/starcraft.rb

@@ -1,5 +1,11 @@
 # 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
   # Starcraft II related classes
   module Starcraft
@@ -9,10 +15,10 @@ module BlizzardApi
     require_relative 'starcraft/game_data/league'
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {League}
-    def self.league(region = BlizzardApi.region)
-      BlizzardApi::Starcraft::League.new(region)
+    def self.league(**options)
+      BlizzardApi::Starcraft::League.new(**options)
     end
 
     # Starcraft community api
@@ -22,30 +28,30 @@ module BlizzardApi
     require_relative 'starcraft/community/legacy'
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Profile}
-    def self.profile(region = BlizzardApi.region)
-      BlizzardApi::Starcraft::Profile.new(region)
+    def self.profile(**options)
+      BlizzardApi::Starcraft::Profile.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Ladder}
-    def self.ladder(region = BlizzardApi.region)
-      BlizzardApi::Starcraft::Ladder.new(region)
+    def self.ladder(**options)
+      BlizzardApi::Starcraft::Ladder.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Account}
-    def self.account(region = BlizzardApi.region)
-      BlizzardApi::Starcraft::Account.new(region)
+    def self.account(**options)
+      BlizzardApi::Starcraft::Account.new(**options)
     end
 
     ##
     # @return {Legacy}
-    def self.legacy(region = BlizzardApi.region)
-      BlizzardApi::Starcraft::Legacy.new(region)
+    def self.legacy(**options)
+      BlizzardApi::Starcraft::Legacy.new(**options)
     end
   end
 end

data/lib/blizzard_api/token_manager.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  ##
+  # Manages the current token and expiration date
+  module TokenManager
+    REDIS_TOKEN_KEY = 'access_token'
+
+    ##
+    # @!attribute access_token
+    #   Current access token.
+    #   @return [String] access_token
+    attr_accessor :access_token
+
+    ##
+    # @!attribute expires_at
+    #   Current access token expiration date.
+    #   @return [String] expires_at
+    attr_accessor :expires_at
+
+    ##
+    # Returns if the current token has expired
+    #
+    # @return [Boolean]
+    def access_token_expired?
+      return true if access_token.nil?
+
+      expires_at < Time.now
+    end
+
+    def restore_access_token
+      return false unless use_cache && cache_access_token
+
+      return false unless redis_connection.exists? REDIS_TOKEN_KEY
+
+      self.access_token = redis_connection.get REDIS_TOKEN_KEY
+      self.expires_at = Time.now + redis_connection.ttl(REDIS_TOKEN_KEY)
+      true
+    end
+
+    def save_access_token(token_data)
+      ttl = token_data['expires_in'].to_i
+      self.expires_at = Time.now + ttl
+      self.access_token = token_data['access_token']
+
+      redis_connection.setex REDIS_TOKEN_KEY, ttl, access_token if use_cache && cache_access_token
+    end
+  end
+end

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '0.6.3'
+  VERSION = '3.0.0'
 end

data/lib/blizzard_api/wow/game_data/achievement.rb

@@ -10,13 +10,7 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.achievement
     class Achievement < Wow::GenericDataEndpoint
-      ##
-      # This method overrides the inherited default behavior to prevent high server load and fetch time
-      #
-      # @!macro response
-      def complete
-        raise BlizzardApi::ApiException, 'There are too many achievements to fetch complete data'
-      end
+      setup 'achievement', :static, CACHE_TRIMESTER
 
       ##
       # Return a list of possible achievement categories.
@@ -47,15 +41,6 @@ module BlizzardApi
       def media(id, **options)
         api_request "#{base_url(:media)}/achievement/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'achievement'
-        @namespace = :static
-        @collection = 'achievements'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

data/lib/blizzard_api/wow/game_data/azerite_essence.rb

@@ -12,6 +12,8 @@ module BlizzardApi
     class AzeriteEssence < Wow::GenericDataEndpoint
       include BlizzardApi::Wow::Searchable
 
+      setup 'azerite-essence', :static, CACHE_TRIMESTER
+
       ##
       # Fetch media for one of the azerite essences listed by the {#index} using its *id*
       #
@@ -23,15 +25,6 @@ module BlizzardApi
       def media(id, **options)
         api_request "#{base_url(:media)}/azerite-essence/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'azerite-essence'
-        @namespace = :static
-        @collection = 'azerite_essences'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

data/lib/blizzard_api/wow/game_data/connected_realm.rb

@@ -12,14 +12,7 @@ module BlizzardApi
     class ConnectedRealm < Wow::GenericDataEndpoint
       include BlizzardApi::Wow::Searchable
 
-      protected
-
-      def endpoint_setup
-        @endpoint = 'connected-realm'
-        @namespace = :dynamic
-        @collection = 'connected_realms'
-        @ttl = CACHE_TRIMESTER
-      end
+      setup 'connected-realm', :dynamic, CACHE_TRIMESTER
     end
   end
 end

data/lib/blizzard_api/wow/game_data/covenant.rb

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.azerite_essence
     class Covenant < Wow::GenericDataEndpoint
+      setup 'covenant', :static, CACHE_TRIMESTER
+
       ##
       # Fetch media for one of the covenants listed by the {#index} using its *id*
       #
@@ -65,15 +67,6 @@ module BlizzardApi
       def conduit(id, **options)
         api_request "#{base_url(:game_data)}/covenant/conduit/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'covenant'
-        @namespace = :static
-        @collection = 'covenants'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

data/lib/blizzard_api/wow/game_data/creature.rb

@@ -12,14 +12,12 @@ module BlizzardApi
     class Creature < Wow::GenericDataEndpoint
       include BlizzardApi::Wow::Searchable
 
+      setup 'creature', :static, CACHE_TRIMESTER
+
       def index
         raise BlizzardApi::ApiException, 'Creatures endpoint doesn\'t have an index method'
       end
 
-      def complete
-        raise BlizzardApi::ApiException, 'There are too many creatures to fetch complete data'
-      end
-
       ##
       # Fetch all creature families
       #
@@ -99,15 +97,6 @@ module BlizzardApi
       def display_media(id, **options)
         api_request "#{base_url(:media)}/creature-display/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'creature'
-        @namespace = :static
-        @collection = 'achievements'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

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

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require 'thwait'
-
 module BlizzardApi
   module Wow
     ##
     # Generic endpoint to support most data requests with minor configurations
     class GenericDataEndpoint < Wow::Request
-      ##
-      # @!macro regions
-      def initialize(region = nil, mode = :regular)
-        super region, mode
-        endpoint_setup
-        @ttl ||= CACHE_DAY
+      class << self
+        attr_accessor :endpoint, :namespace, :ttl
+
+        def setup(endpoint, namespace, ttl)
+          self.endpoint = endpoint
+          self.namespace = namespace
+          self.ttl = ttl
+        end
       end
 
       ##
@@ -35,42 +35,15 @@ module BlizzardApi
         api_request "#{endpoint_uri}/#{id}", **default_options.merge(options)
       end
 
-      ##
-      # @!macro complete
-      def complete(**options)
-        payload = [].tap do |complete_data|
-          index_data = index(**options)
-          threads = []
-
-          concurrency = options.key?(:concurrency) ? options[:concurrency].to_i : BlizzardApi.concurrency
-          concurrency.times do
-            threads << Thread.new do
-              while index_data[@collection.to_sym].size.positive?
-                item = index_data[@collection.to_sym].pop
-                link = item.key?(:key) ? item[:key][:href] : item[:href]
-                item_data = request link
-                complete_data.push item_data
-              end
-            end
-          end
-          ThreadsWait.all_waits threads
-        end
-        payload.sort { |a, b| a[:id] <=> b[:id] }
-      end
-
       protected
 
       def endpoint_uri(variant = nil, scope = :game_data)
-        endpoint = variant ? "#{@endpoint}-#{variant}" : @endpoint
+        endpoint = variant ? "#{self.class.endpoint}-#{variant}" : self.class.endpoint
         "#{base_url(scope)}/#{endpoint}"
       end
 
-      def endpoint_setup
-        raise NotImplementedError, 'You must override this method to properly set up the endpoint'
-      end
-
       def default_options
-        { namespace: @namespace, ttl: @ttl }
+        { namespace: self.class.namespace, ttl: self.class.ttl }
       end
     end
   end

data/lib/blizzard_api/wow/game_data/guild_crest.rb

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.guild_crest
     class GuildCrest < Wow::GenericDataEndpoint
+      setup 'guild-crest', :static, CACHE_TRIMESTER
+
       def get
         raise BlizzardApi::ApiException, 'This endpoint doens\'t have a get method'
       end
@@ -25,7 +27,7 @@ module BlizzardApi
       #
       # @!macro response
       def border_media(id, **options)
-        api_request "#{base_url(:media)}/#{@endpoint}/border/#{id}", **default_options.merge(options)
+        api_request "#{base_url(:media)}/#{self.class.endpoint}/border/#{id}", **default_options.merge(options)
       end
 
       ##
@@ -39,15 +41,7 @@ module BlizzardApi
       #
       # @!macro response
       def emblem_media(id, **options)
-        api_request "#{base_url(:media)}/#{@endpoint}/emblem/#{id}", **default_options.merge(options)
-      end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'guild-crest'
-        @namespace = :static
-        @ttl = CACHE_TRIMESTER
+        api_request "#{base_url(:media)}/#{self.class.endpoint}/emblem/#{id}", **default_options.merge(options)
       end
     end
   end