blizzard_api 0.6.4 → 1.0.0

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.4'
+  VERSION = '1.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

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

@@ -12,6 +12,8 @@ module BlizzardApi
     class Item < Wow::GenericDataEndpoint
       include BlizzardApi::Wow::Searchable
 
+      setup 'item', :static, CACHE_TRIMESTER
+
       ##
       # This method overrides the inherited default behavior to prevent high server load and fetch time
       #
@@ -20,14 +22,6 @@ module BlizzardApi
         raise BlizzardApi::ApiException, 'This endpoint does not have a index method'
       end
 
-      ##
-      # This method overrides the inherited default behavior to prevent high server load and fetch time
-      #
-      # @!macro response
-      def complete
-        raise BlizzardApi::ApiException, 'This endpoint does not have a complete method'
-      end
-
       ##
       # Return a list of item classes
       #
@@ -49,7 +43,7 @@ module BlizzardApi
       # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
       #
       # @!macro response
-      def class(id, **options)
+      def item_class(id, **options)
         api_request "#{endpoint_uri('class')}/#{id}", **default_options.merge(options)
       end
 
@@ -101,15 +95,6 @@ module BlizzardApi
       def set(id, **options)
         api_request "#{endpoint_uri('set')}/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'item'
-        @namespace = :static
-        @collection = 'items'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

data/lib/blizzard_api/wow/game_data/journal.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.journal
     class Journal < Wow::GenericDataEndpoint
+      setup 'journal', :static, CACHE_TRIMESTER
+
       ##
       # This method overrides the inherited default behavior to prevent high server load and fetch time
       #
@@ -18,14 +20,6 @@ module BlizzardApi
         raise BlizzardApi::ApiException, 'This endpoint does not have a index method'
       end
 
-      ##
-      # This method overrides the inherited default behavior to prevent high server load and fetch time
-      #
-      # @!macro response
-      def complete
-        raise BlizzardApi::ApiException, 'This endpoint does not have a complete method'
-      end
-
       ##
       # This method overrides the inherited default behavior to prevent high server load and fetch time
       #
@@ -111,15 +105,6 @@ module BlizzardApi
 
         api_request "#{endpoint_uri('encounter', :search)}?#{search_options.to_search_query}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'journal'
-        @namespace = :static
-        @collection = 'journals'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

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

@@ -12,6 +12,8 @@ module BlizzardApi
     class Media < Wow::GenericDataEndpoint
       include BlizzardApi::Wow::Searchable
 
+      setup 'media', :static, CACHE_TRIMESTER
+
       def index(_options = nil)
         raise BlizzardApi::ApiException, 'This endpoint does not have a index method'
       end
@@ -19,19 +21,6 @@ module BlizzardApi
       def get(_options = nil)
         raise BlizzardApi::ApiException, 'This endpoint does not have a get method'
       end
-
-      def complete(_options = nil)
-        raise BlizzardApi::ApiException, 'This endpoint does not have a complete method'
-      end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'media'
-        @namespace = :static
-        @collection = 'medias'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

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

@@ -10,9 +10,7 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.modified_crafting
     class ModifiedCrafting < Wow::GenericDataEndpoint
-      def complete
-        raise BlizzardApi::ApiException, 'This endpoint does not have a complete method.'
-      end
+      setup 'modified-crafting', :static, CACHE_TRIMESTER
 
       ##
       # Fetch modified crafting category index
@@ -53,15 +51,6 @@ module BlizzardApi
       def slot_type(id, **options)
         api_request "#{base_url(:game_data)}/modified-crafting/reagent-slot-type/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'modified-crafting'
-        @namespace = :static
-        @collection = 'professions'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

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

@@ -12,14 +12,7 @@ module BlizzardApi
     class Mount < Wow::GenericDataEndpoint
       include BlizzardApi::Wow::Searchable
 
-      protected
-
-      def endpoint_setup
-        @endpoint = 'mount'
-        @namespace = :static
-        @collection = 'mounts'
-        @ttl = CACHE_TRIMESTER
-      end
+      setup 'mount', :static, CACHE_TRIMESTER
     end
   end
 end

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

@@ -10,14 +10,12 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.mythic_keystone
     class MythicKeystone < Wow::GenericDataEndpoint
+      setup 'mythic-keystone', :dynamic, CACHE_TRIMESTER
+
       def get
         raise BlizzardApi::ApiException, 'Mythic keystone endpoint does not have a get method'
       end
 
-      def complete
-        raise BlizzardApi::ApiException, 'There are too many creatures to fetch complete data'
-      end
-
       ##
       # Fetch all mythic keystone dungeons
       #
@@ -83,15 +81,6 @@ module BlizzardApi
       def season(id, **options)
         api_request "#{endpoint_uri}/season/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'mythic-keystone'
-        @namespace = :dynamic
-        @collection = 'mythic-keystones'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

data/lib/blizzard_api/wow/game_data/mythic_keystone_affix.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.mythic_keystone_affix
     class MythicKeystoneAffix < Wow::GenericDataEndpoint
+      setup 'keystone-affix', :static, CACHE_TRIMESTER
+
       ##
       # Fetch media for one of the affixes listed by the {#index} using its *id*
       #
@@ -21,15 +23,6 @@ module BlizzardApi
       def media(id, **options)
         api_request "#{base_url(:media)}/keystone-affix/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'keystone-affix'
-        @namespace = :static
-        @collection = 'affixes'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

data/lib/blizzard_api/wow/game_data/pet.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.pet
     class Pet < Wow::GenericDataEndpoint
+      setup 'pet', :static, CACHE_TRIMESTER
+
       ##
       # Fetch media for one of the pets listed by the {#index} using its *id*
       #
@@ -55,15 +57,6 @@ module BlizzardApi
       def ability_media(id, **options)
         api_request "#{base_url(:media)}/pet-ability/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def endpoint_setup
-        @endpoint = 'pet'
-        @namespace = :static
-        @collection = 'pets'
-        @ttl = CACHE_TRIMESTER
-      end
     end
   end
 end

data/lib/blizzard_api/wow/game_data/playable_class.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.playable_class
     class PlayableClass < Wow::GenericDataEndpoint
+      setup 'playable-class', :static, CACHE_TRIMESTER
+
       ##
       # Returns the PvP talent slots data of a specific class
       #
@@ -21,22 +23,6 @@ module BlizzardApi
         api_request "#{endpoint_uri}/#{id}/pvp-talent-slots", **default_options.merge(options)
       end
 
-      ##
-      # @!macro complete
-      #
-      # @option options [Boolean] :classic If set to true, this method will call the classic version
-      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
-      def complete(**options)
-        index_data = index(**options)
-        [].tap do |classes|
-          index_data[:classes].each do |pclass|
-            class_id = %r{playable-class/([0-9]+)}.match(pclass[:key].to_s)[1]
-            class_data = get class_id, **options
-            classes.push class_data
-          end
-        end
-      end
-
       ##
       # Return playable class data by its id
       #
@@ -67,13 +53,6 @@ module BlizzardApi
 
       protected
 
-      def endpoint_setup
-        @endpoint = 'playable-class'
-        @namespace = :static
-        @collection = 'classes'
-        @ttl = CACHE_TRIMESTER
-      end
-
       def get_class_icon(media_url, **options)
         return if options.include? :classic
 

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

@@ -10,14 +10,7 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   race = BlizzardApi::Wow.playable_race
     class PlayableRace < Wow::GenericDataEndpoint
-      protected
-
-      def endpoint_setup
-        @endpoint = 'playable-race'
-        @namespace = :static
-        @collection = 'races'
-        @ttl = CACHE_TRIMESTER
-      end
+      setup 'playable-race', :static, CACHE_TRIMESTER
     end
   end
 end