blizzard_api_rb_rb 3.4.2

data/lib/blizzard_api_rb/wow.rb

@@ -0,0 +1,335 @@
+# 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
+    require_relative 'wow/request'
+    require_relative 'wow/game_data/generic_data_endpoint'
+    require_relative 'wow/search/search_composer'
+    require_relative 'wow/search/search_request'
+    require_relative 'wow/slug'
+
+    # WoW data api
+    require_relative 'wow/game_data/achievement'
+    require_relative 'wow/game_data/auction'
+    require_relative 'wow/game_data/azerite_essence'
+    require_relative 'wow/game_data/connected_realm'
+    require_relative 'wow/game_data/covenant'
+    require_relative 'wow/game_data/creature'
+    require_relative 'wow/game_data/guild_crest'
+    require_relative 'wow/game_data/heirloom'
+    require_relative 'wow/game_data/item'
+    require_relative 'wow/game_data/journal'
+    require_relative 'wow/game_data/media'
+    require_relative 'wow/game_data/modified_crafting'
+    require_relative 'wow/game_data/mount'
+    require_relative 'wow/game_data/mythic_keystone_affix'
+    require_relative 'wow/game_data/mythic_keystone'
+    require_relative 'wow/game_data/mythic_raid_leaderboard'
+    require_relative 'wow/game_data/mythic_keystone_leaderboard'
+    require_relative 'wow/game_data/pet'
+    require_relative 'wow/game_data/playable_class'
+    require_relative 'wow/game_data/playable_race'
+    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'
+    require_relative 'wow/game_data/realm'
+    require_relative 'wow/game_data/region'
+    require_relative 'wow/game_data/reputation'
+    require_relative 'wow/game_data/spell'
+    require_relative 'wow/game_data/talent'
+    require_relative 'wow/game_data/tech_talent'
+    require_relative 'wow/game_data/title'
+    require_relative 'wow/game_data/toy'
+    require_relative 'wow/game_data/wow_token'
+
+    ##
+    # @!macro init_options
+    # @return {Achievement}
+    def self.achievement(**options)
+      BlizzardApi::Wow::Achievement.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Auction}
+    def self.auction(**options)
+      BlizzardApi::Wow::Auction.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {AzeriteEssence}
+    def self.azerite_essence(**options)
+      BlizzardApi::Wow::AzeriteEssence.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {ConnectedRealm}
+    def self.connected_realm(**options)
+      BlizzardApi::Wow::ConnectedRealm.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Covenant}
+    def self.covenant(**options)
+      BlizzardApi::Wow::Covenant.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Creature}
+    def self.creature(**options)
+      BlizzardApi::Wow::Creature.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {GuildCrest}
+    def self.guild_crest(**options)
+      BlizzardApi::Wow::GuildCrest.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Heirloom}
+    def self.heirloom(**options)
+      BlizzardApi::Wow::Heirloom.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Item}
+    def self.item(**options)
+      BlizzardApi::Wow::Item.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Journal}
+    def self.journal(**options)
+      BlizzardApi::Wow::Journal.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Media}
+    def self.media(**options)
+      BlizzardApi::Wow::Media.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {ModifiedCrafting}
+    def self.modified_crafting(**options)
+      BlizzardApi::Wow::ModifiedCrafting.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Mount}
+    def self.mount(**options)
+      BlizzardApi::Wow::Mount.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {MythicKeystoneAffix}
+    def self.mythic_keystone_affix(**options)
+      BlizzardApi::Wow::MythicKeystoneAffix.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {MythicKeystone}
+    def self.mythic_keystone(**options)
+      BlizzardApi::Wow::MythicKeystone.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {MythicRaidLeaderboard}
+    def self.mythic_raid_leaderboard(**options)
+      BlizzardApi::Wow::MythicRaidLeaderboard.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {MythicKeystoneLeaderboard}
+    def self.mythic_keystone_leaderboard(**options)
+      BlizzardApi::Wow::MythicKeystoneLeaderboard.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Pet}
+    def self.pet(**options)
+      BlizzardApi::Wow::Pet.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {PlayableClass}
+    def self.playable_class(**options)
+      BlizzardApi::Wow::PlayableClass.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Race}
+    def self.playable_race(**options)
+      BlizzardApi::Wow::PlayableRace.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {PlayableSpecialization}
+    def self.playable_specialization(**options)
+      BlizzardApi::Wow::PlayableSpecialization.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {PowerType}
+    def self.power_type(**options)
+      BlizzardApi::Wow::PowerType.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Profession}
+    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
+
+    ##
+    # @!macro init_options
+    # @return {PvpSeason}
+    def self.pvp_season(**options)
+      BlizzardApi::Wow::PvpSeason.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {PvpTier}
+    def self.pvp_tier(**options)
+      BlizzardApi::Wow::PvpTier.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Quest}
+    def self.quest(**options)
+      BlizzardApi::Wow::Quest.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Realm}
+    def self.realm(**options)
+      BlizzardApi::Wow::Realm.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Region}
+    def self.region(**options)
+      BlizzardApi::Wow::Region.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Reputation}
+    def self.reputation(**options)
+      BlizzardApi::Wow::Reputation.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Spell}
+    def self.spell(**options)
+      BlizzardApi::Wow::Spell.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Talent}
+    def self.talent(**options)
+      BlizzardApi::Wow::Talent.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {TechTalent}
+    def self.tech_talent(**options)
+      BlizzardApi::Wow::TechTalent.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Title}
+    def self.title(**options)
+      BlizzardApi::Wow::Title.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Toy}
+    def self.toy(**options)
+      BlizzardApi::Wow::Toy.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {WowToken}
+    def self.wow_token(**options)
+      BlizzardApi::Wow::WowToken.new(**options)
+    end
+
+    require_relative 'wow/profile/account_profile'
+    require_relative 'wow/profile/guild'
+    require_relative 'wow/profile/character_profile'
+
+    ##
+    # @param token [String] A token obtained using the authorization_code flow
+    # @!macro init_options
+    #
+    # @return {Profile}
+    def self.profile(token, **options)
+      BlizzardApi::Wow::AccountProfile.new(token, **options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {Guild}
+    def self.guild(**options)
+      BlizzardApi::Wow::Guild.new(**options)
+    end
+
+    ##
+    # @!macro init_options
+    # @return {CharacterProfile}
+    def self.character_profile(**options)
+      BlizzardApi::Wow::CharacterProfile.new(**options)
+    end
+  end
+end

data/lib/blizzard_api_rb.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'blizzard_api_rb/configuration'
+require_relative 'blizzard_api_rb/token_manager'
+require_relative 'blizzard_api_rb/api_standards'
+require_relative 'blizzard_api_rb/api_response'
+require_relative 'blizzard_api_rb/request'
+require_relative 'blizzard_api_rb/exception'
+require_relative 'blizzard_api_rb/version'
+require_relative 'blizzard_api_rb/wow'
+require_relative 'blizzard_api_rb/diablo'
+require_relative 'blizzard_api_rb/hearthstone'
+require_relative 'blizzard_api_rb/starcraft'
+require_relative 'blizzard_api_rb/overwatch_league'
+
+# 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

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: blizzard_api_rb_rb
+version: !ruby/object:Gem::Version
+  version: 3.4.2
+platform: ruby
+authors:
+- Alexchaos
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.61'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.61'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a simple interface to obtain data from Blizzard API
+email:
+- contact@astpierre.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blizzard_api_rb.gemspec
+- lib/blizzard_api_rb.rb
+- lib/blizzard_api_rb/api_response.rb
+- lib/blizzard_api_rb/api_standards.rb
+- lib/blizzard_api_rb/configuration.rb
+- lib/blizzard_api_rb/diablo.rb
+- lib/blizzard_api_rb/diablo/community/act.rb
+- lib/blizzard_api_rb/diablo/community/artisan.rb
+- lib/blizzard_api_rb/diablo/community/character_class.rb
+- lib/blizzard_api_rb/diablo/community/follower.rb
+- lib/blizzard_api_rb/diablo/community/item.rb
+- lib/blizzard_api_rb/diablo/community/item_type.rb
+- lib/blizzard_api_rb/diablo/community/profile.rb
+- lib/blizzard_api_rb/diablo/game_data/era.rb
+- lib/blizzard_api_rb/diablo/game_data/generic_data_endpoint.rb
+- lib/blizzard_api_rb/diablo/game_data/season.rb
+- lib/blizzard_api_rb/diablo/request.rb
+- lib/blizzard_api_rb/exception.rb
+- lib/blizzard_api_rb/hearthstone.rb
+- lib/blizzard_api_rb/hearthstone/game_data/back.rb
+- lib/blizzard_api_rb/hearthstone/game_data/card.rb
+- lib/blizzard_api_rb/hearthstone/game_data/deck.rb
+- lib/blizzard_api_rb/hearthstone/game_data/generic_data_endpoint.rb
+- lib/blizzard_api_rb/hearthstone/game_data/metadata.rb
+- lib/blizzard_api_rb/hearthstone/request.rb
+- lib/blizzard_api_rb/overwatch_league.rb
+- lib/blizzard_api_rb/overwatch_league/community/matches.rb
+- lib/blizzard_api_rb/overwatch_league/community/players.rb
+- lib/blizzard_api_rb/overwatch_league/community/segments.rb
+- lib/blizzard_api_rb/overwatch_league/community/summary.rb
+- lib/blizzard_api_rb/overwatch_league/community/teams.rb
+- lib/blizzard_api_rb/overwatch_league/request.rb
+- lib/blizzard_api_rb/request.rb
+- lib/blizzard_api_rb/starcraft.rb
+- lib/blizzard_api_rb/starcraft/community/account.rb
+- lib/blizzard_api_rb/starcraft/community/ladder.rb
+- lib/blizzard_api_rb/starcraft/community/legacy.rb
+- lib/blizzard_api_rb/starcraft/community/profile.rb
+- lib/blizzard_api_rb/starcraft/game_data/league.rb
+- lib/blizzard_api_rb/starcraft/request.rb
+- lib/blizzard_api_rb/token_manager.rb
+- lib/blizzard_api_rb/version.rb
+- lib/blizzard_api_rb/wow.rb
+- lib/blizzard_api_rb/wow/game_data/achievement.rb
+- lib/blizzard_api_rb/wow/game_data/auction.rb
+- lib/blizzard_api_rb/wow/game_data/azerite_essence.rb
+- lib/blizzard_api_rb/wow/game_data/connected_realm.rb
+- lib/blizzard_api_rb/wow/game_data/covenant.rb
+- lib/blizzard_api_rb/wow/game_data/creature.rb
+- lib/blizzard_api_rb/wow/game_data/generic_data_endpoint.rb
+- lib/blizzard_api_rb/wow/game_data/guild_crest.rb
+- lib/blizzard_api_rb/wow/game_data/heirloom.rb
+- lib/blizzard_api_rb/wow/game_data/item.rb
+- lib/blizzard_api_rb/wow/game_data/journal.rb
+- lib/blizzard_api_rb/wow/game_data/media.rb
+- lib/blizzard_api_rb/wow/game_data/modified_crafting.rb
+- lib/blizzard_api_rb/wow/game_data/mount.rb
+- lib/blizzard_api_rb/wow/game_data/mythic_keystone.rb
+- lib/blizzard_api_rb/wow/game_data/mythic_keystone_affix.rb
+- lib/blizzard_api_rb/wow/game_data/mythic_keystone_leaderboard.rb
+- lib/blizzard_api_rb/wow/game_data/mythic_raid_leaderboard.rb
+- lib/blizzard_api_rb/wow/game_data/pet.rb
+- lib/blizzard_api_rb/wow/game_data/playable_class.rb
+- lib/blizzard_api_rb/wow/game_data/playable_race.rb
+- lib/blizzard_api_rb/wow/game_data/playable_specialization.rb
+- lib/blizzard_api_rb/wow/game_data/power_type.rb
+- lib/blizzard_api_rb/wow/game_data/profession.rb
+- lib/blizzard_api_rb/wow/game_data/pvp_region.rb
+- lib/blizzard_api_rb/wow/game_data/pvp_season.rb
+- lib/blizzard_api_rb/wow/game_data/pvp_tier.rb
+- lib/blizzard_api_rb/wow/game_data/quest.rb
+- lib/blizzard_api_rb/wow/game_data/realm.rb
+- lib/blizzard_api_rb/wow/game_data/region.rb
+- lib/blizzard_api_rb/wow/game_data/reputation.rb
+- lib/blizzard_api_rb/wow/game_data/spell.rb
+- lib/blizzard_api_rb/wow/game_data/talent.rb
+- lib/blizzard_api_rb/wow/game_data/tech_talent.rb
+- lib/blizzard_api_rb/wow/game_data/title.rb
+- lib/blizzard_api_rb/wow/game_data/toy.rb
+- lib/blizzard_api_rb/wow/game_data/wow_token.rb
+- lib/blizzard_api_rb/wow/profile/account_profile.rb
+- lib/blizzard_api_rb/wow/profile/character_profile.rb
+- lib/blizzard_api_rb/wow/profile/guild.rb
+- lib/blizzard_api_rb/wow/request.rb
+- lib/blizzard_api_rb/wow/search/search_composer.rb
+- lib/blizzard_api_rb/wow/search/search_request.rb
+- lib/blizzard_api_rb/wow/slug.rb
+homepage: https://github.com/alexchaoss/blizzard_api_rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alexchaoss/blizzard_api_rb
+  source_code_uri: https://github.com/alexchaoss/blizzard_api_rb
+  bug_tracker_uri: https://github.com/alexchaoss/blizzard_api_rb/issues
+  changelog_uri: https://github.com/alexchaoss/blizzard_api_rb/blob/master/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/blizzard_api_rb_rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Unofficial Ruby client for Blizzard Entertainment API
+test_files: []