blizzard_api 0.6.1 → 1.0.0

data/lib/blizzard_api/wow.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
   # World of Warcraft related classes
   module Wow
@@ -32,6 +38,7 @@ module BlizzardApi
     require_relative 'wow/game_data/playable_specialization'
     require_relative 'wow/game_data/power_type'
     require_relative 'wow/game_data/profession'
+    require_relative 'wow/game_data/pvp_region'
     require_relative 'wow/game_data/pvp_season'
     require_relative 'wow/game_data/pvp_tier'
     require_relative 'wow/game_data/quest'
@@ -45,234 +52,241 @@ module BlizzardApi
     require_relative 'wow/game_data/wow_token'
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Achievement}
-    def self.achievement(region = BlizzardApi.region)
-      BlizzardApi::Wow::Achievement.new(region)
+    def self.achievement(**options)
+      BlizzardApi::Wow::Achievement.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Auction}
-    def self.auction(region = BlizzardApi.region)
-      BlizzardApi::Wow::Auction.new(region)
+    def self.auction(**options)
+      BlizzardApi::Wow::Auction.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {AzeriteEssence}
-    def self.azerite_essence(region = BlizzardApi.region)
-      BlizzardApi::Wow::AzeriteEssence.new(region)
+    def self.azerite_essence(**options)
+      BlizzardApi::Wow::AzeriteEssence.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {ConnectedRealm}
-    def self.connected_realm(region = BlizzardApi.region)
-      BlizzardApi::Wow::ConnectedRealm.new(region)
+    def self.connected_realm(**options)
+      BlizzardApi::Wow::ConnectedRealm.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Covenant}
-    def self.covenant(region = BlizzardApi.region)
-      BlizzardApi::Wow::Covenant.new(region)
+    def self.covenant(**options)
+      BlizzardApi::Wow::Covenant.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Creature}
-    def self.creature(region = BlizzardApi.region)
-      BlizzardApi::Wow::Creature.new(region)
+    def self.creature(**options)
+      BlizzardApi::Wow::Creature.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {GuildCrest}
-    def self.guild_crest(region = BlizzardApi.region)
-      BlizzardApi::Wow::GuildCrest.new(region)
+    def self.guild_crest(**options)
+      BlizzardApi::Wow::GuildCrest.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Item}
-    def self.item(region = BlizzardApi.region)
-      BlizzardApi::Wow::Item.new(region)
+    def self.item(**options)
+      BlizzardApi::Wow::Item.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Journal}
-    def self.journal(region = BlizzardApi.region)
-      BlizzardApi::Wow::Journal.new(region)
+    def self.journal(**options)
+      BlizzardApi::Wow::Journal.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Media}
-    def self.media(region = BlizzardApi.region)
-      BlizzardApi::Wow::Media.new(region)
+    def self.media(**options)
+      BlizzardApi::Wow::Media.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {ModifiedCrafting}
-    def self.modified_crafting(region = BlizzardApi.region)
-      BlizzardApi::Wow::ModifiedCrafting.new(region)
+    def self.modified_crafting(**options)
+      BlizzardApi::Wow::ModifiedCrafting.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Mount}
-    def self.mount(region = BlizzardApi.region)
-      BlizzardApi::Wow::Mount.new(region)
+    def self.mount(**options)
+      BlizzardApi::Wow::Mount.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {MythicKeystoneAffix}
-    def self.mythic_keystone_affix(region = BlizzardApi.region)
-      BlizzardApi::Wow::MythicKeystoneAffix.new(region)
+    def self.mythic_keystone_affix(**options)
+      BlizzardApi::Wow::MythicKeystoneAffix.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {MythicKeystone}
-    def self.mythic_keystone(region = BlizzardApi.region)
-      BlizzardApi::Wow::MythicKeystone.new(region)
+    def self.mythic_keystone(**options)
+      BlizzardApi::Wow::MythicKeystone.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {MythicRaidLeaderboard}
-    def self.mythic_raid_leaderboard(region = BlizzardApi.region)
-      BlizzardApi::Wow::MythicRaidLeaderboard.new(region)
+    def self.mythic_raid_leaderboard(**options)
+      BlizzardApi::Wow::MythicRaidLeaderboard.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {MythicKeystoneLeaderboard}
-    def self.mythic_keystone_leaderboard(region = BlizzardApi.region)
-      BlizzardApi::Wow::MythicKeystoneLeaderboard.new(region)
+    def self.mythic_keystone_leaderboard(**options)
+      BlizzardApi::Wow::MythicKeystoneLeaderboard.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Pet}
-    def self.pet(region = BlizzardApi.region)
-      BlizzardApi::Wow::Pet.new(region)
+    def self.pet(**options)
+      BlizzardApi::Wow::Pet.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {PlayableClass}
-    def self.playable_class(region = BlizzardApi.region)
-      BlizzardApi::Wow::PlayableClass.new(region)
+    def self.playable_class(**options)
+      BlizzardApi::Wow::PlayableClass.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Race}
-    def self.playable_race(region = BlizzardApi.region)
-      BlizzardApi::Wow::PlayableRace.new(region)
+    def self.playable_race(**options)
+      BlizzardApi::Wow::PlayableRace.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {PlayableSpecialization}
-    def self.playable_specialization(region = BlizzardApi.region)
-      BlizzardApi::Wow::PlayableSpecialization.new(region)
+    def self.playable_specialization(**options)
+      BlizzardApi::Wow::PlayableSpecialization.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {PowerType}
-    def self.power_type(region = BlizzardApi.region)
-      BlizzardApi::Wow::PowerType.new(region)
+    def self.power_type(**options)
+      BlizzardApi::Wow::PowerType.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Profession}
-    def self.profession(region = BlizzardApi.region)
-      BlizzardApi::Wow::Profession.new(region)
+    def self.profession(**options)
+      BlizzardApi::Wow::Profession.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {PvpRegion}
+    def self.pvp_region(**options)
+      BlizzardApi::Wow::PvpRegion.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {PvpSeason}
-    def self.pvp_season(region = BlizzardApi.region)
-      BlizzardApi::Wow::PvpSeason.new(region)
+    def self.pvp_season(**options)
+      BlizzardApi::Wow::PvpSeason.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {PvpTier}
-    def self.pvp_tier(region = BlizzardApi.region)
-      BlizzardApi::Wow::PvpTier.new(region)
+    def self.pvp_tier(**options)
+      BlizzardApi::Wow::PvpTier.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Quest}
-    def self.quest(region = BlizzardApi.region)
-      BlizzardApi::Wow::Quest.new(region)
+    def self.quest(**options)
+      BlizzardApi::Wow::Quest.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Realm}
-    def self.realm(region = BlizzardApi.region)
-      BlizzardApi::Wow::Realm.new(region)
+    def self.realm(**options)
+      BlizzardApi::Wow::Realm.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Region}
-    def self.region(region = BlizzardApi.region)
-      BlizzardApi::Wow::Region.new(region)
+    def self.region(**options)
+      BlizzardApi::Wow::Region.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Reputation}
-    def self.reputation(region = BlizzardApi.region)
-      BlizzardApi::Wow::Reputation.new(region)
+    def self.reputation(**options)
+      BlizzardApi::Wow::Reputation.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Spell}
-    def self.spell(region = BlizzardApi.region)
-      BlizzardApi::Wow::Spell.new(region)
+    def self.spell(**options)
+      BlizzardApi::Wow::Spell.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Talent}
-    def self.talent(region = BlizzardApi.region)
-      BlizzardApi::Wow::Talent.new(region)
+    def self.talent(**options)
+      BlizzardApi::Wow::Talent.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {TechTalent}
-    def self.tech_talent(region = BlizzardApi.region)
-      BlizzardApi::Wow::TechTalent.new(region)
+    def self.tech_talent(**options)
+      BlizzardApi::Wow::TechTalent.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Title}
-    def self.title(region = BlizzardApi.region)
-      BlizzardApi::Wow::Title.new(region)
+    def self.title(**options)
+      BlizzardApi::Wow::Title.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {WowToken}
-    def self.wow_token(region = BlizzardApi.region)
-      BlizzardApi::Wow::WowToken.new(region)
+    def self.wow_token(**options)
+      BlizzardApi::Wow::WowToken.new(**options)
     end
 
     require_relative 'wow/profile/profile'
@@ -281,25 +295,25 @@ module BlizzardApi
 
     ##
     # @param token [String] A token obtained using the authorization_code flow
-    # @param region [String] API Region
+    # @!macro init_options
     #
     # @return {Profile}
-    def self.profile(token, region = BlizzardApi.region)
-      BlizzardApi::Wow::AccountProfile.new(token, region)
+    def self.profile(token, **options)
+      BlizzardApi::Wow::AccountProfile.new(token, **options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Guild}
-    def self.guild(region = BlizzardApi.region)
-      BlizzardApi::Wow::Guild.new(region)
+    def self.guild(**options)
+      BlizzardApi::Wow::Guild.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {CharacterProfile}
-    def self.character_profile(region = BlizzardApi.region)
-      BlizzardApi::Wow::CharacterProfile.new(region)
+    def self.character_profile(**options)
+      BlizzardApi::Wow::CharacterProfile.new(**options)
     end
   end
 end

data/lib/blizzard_api.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative 'blizzard_api/configuration'
+require_relative 'blizzard_api/token_manager'
+require_relative 'blizzard_api/api_standards'
 require_relative 'blizzard_api/request'
 require_relative 'blizzard_api/exception'
 require_relative 'blizzard_api/version'
@@ -11,5 +13,12 @@ require_relative 'blizzard_api/starcraft'
 
 # Blizzard namespace
 module BlizzardApi
+  extend TokenManager
   extend Configuration
+
+  def self.redis_connection
+    return nil unless use_cache
+
+    @redis_connection ||= Redis.new(host: redis_host, port: redis_port, db: redis_database)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-03 00:00:00.000000000 Z
+date: 2022-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -30,20 +30,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
-- !ruby/object:Gem::Dependency
-  name: thwait
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -135,6 +121,7 @@ files:
 - bin/setup
 - blizzard_api.gemspec
 - lib/blizzard_api.rb
+- lib/blizzard_api/api_standards.rb
 - lib/blizzard_api/configuration.rb
 - lib/blizzard_api/diablo.rb
 - lib/blizzard_api/diablo/community/act.rb
@@ -164,6 +151,7 @@ files:
 - lib/blizzard_api/starcraft/community/profile.rb
 - lib/blizzard_api/starcraft/game_data/league.rb
 - lib/blizzard_api/starcraft/request.rb
+- lib/blizzard_api/token_manager.rb
 - lib/blizzard_api/version.rb
 - lib/blizzard_api/wow.rb
 - lib/blizzard_api/wow/game_data/achievement.rb
@@ -189,6 +177,7 @@ files:
 - lib/blizzard_api/wow/game_data/playable_specialization.rb
 - lib/blizzard_api/wow/game_data/power_type.rb
 - lib/blizzard_api/wow/game_data/profession.rb
+- lib/blizzard_api/wow/game_data/pvp_region.rb
 - lib/blizzard_api/wow/game_data/pvp_season.rb
 - lib/blizzard_api/wow/game_data/pvp_tier.rb
 - lib/blizzard_api/wow/game_data/quest.rb