A Ruby gem that wraps Blizzard's Game Data and Profile APIs.
Add this line to your application's Gemfile:
gem 'rbattlenet'
Your private Battle.net API key must be present in order to get a valid Battle.net API response. Before any requests are made, your API key must be set like so:
client_id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
client_secret = "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
RBattlenet.authenticate(client_id: client_id, client_secret: client_secret)
Your region and locale defaults to EU and en_GB respectively. However, these can be changed like so:
RBattlenet.set_options(region: "us", locale: "en_US")
Singular requests will be returned as a RBattlenet::Result object. Requests with an array passed in will
be returned as a RBattlenet::ResultCollection object by default. If you want to simply receive the raw HTTP response
or the response as a Hash you can set that like so:
RBattlenet.set_options(response_type: :struct) # Default
RBattlenet.set_options(response_type: :hash)
RBattlenet.set_options(response_type: :raw)
item = RBattlenet::Wow::Item.find(18803)
item.name # => "Finkle's Lava Dredger"
You can pass in an Array to every endpoint. Requests will be made in parallel automatically:
collection = RBattlenet::Wow::Item.find([18803, 18804])
collection.results.map(&:name) # => ["Finkle's Lava Dredger", "Lord Grayson's Satchel"]
For some endpoints you can pass in fields to automatically (in parallel) retrieve resources that belong to them:
character = RBattlenet::Wow::Character.find(realm: "stormrage", name: "sheday", fields: [:mounts, :titles])
character.name # => "Sheday"
character.titles.active_title.name # => "Famed Slayer of the Harbinger"
character.mounts.first.name # => "Black War Bear"
Each RBattlenet::Result object has a status_code property. When the code is not 200, the raw HTTP response is
included (response property) and it'll be a RBattlenet::EmptyResult object instead. RBattlenet::ResultCollection
objects can contain both Result and EmptyResult objects simultaneously. Exceptions are not raised for non-200 responses.
Client side exceptions will be raised if there are issues, for example:
characters = RBattlenet::Wow::Character.all
# => RBattlenet::Errors::IndexNotSupported (Retrieving all entities of this endpoint is not supported)
The Account Profile API needs an access token acquired via the Authorization Code Flow.
It concerns the following requests:
RBattlenet::Wow::Profile::UserRBattlenet::Wow::Profile::ProtectedSummaryRBattlenet::Wow::Profile::MountsCollectionRBattlenet::Wow::Profile::PetsCollectionTest against the stored VCR cassettes
bundle exec rspec spec/ # Execute all the tests
bundle exec rspec spec/lib/wow/character_spec.rb # Execute only the character_spec tests
If there is no VCR cassette for the test
RECORD_CASSETTE=1 CLIENT_ID=<your_id> CLIENT_SECRET=<your_secret> bundle exec rspec
If you wish to test against the real API and bypass the :
REAL_CONNECTIONS=1 CLIENT_ID=<your_id> CLIENT_SECRET=<your_secret> bundle exec rspec
Some of the most commonly used endpoints are listed here; you can find examples for every single endpoint in the spec files.
https://develop.battle.net/documentation/api-reference/hearthstone-game-data-api
RBattlenet::Hearthstone::Card.find("52119-arch-villain-rafaam")
Battlenet::Hearthstone::Card.find(manaCost: 1, attack: 1, health: 1)
RBattlenet::Hearthstone::Deck.find("AAECAQcG+wyd8AKS+AKggAOblAPanQMMS6IE/web8wLR9QKD+wKe+wKz/AL1gAOXlAOalAOSnwMA")
RBattlenet::Hearthstone::Metadata.all
RBattlenet::Hearthstone::Metadata.find(:sets)
achievement = RBattlenet::Wow::Achievement.find(2144)
RBattlenet::Wow::Character.find(realm: "stormrage", name: "sheday")
RBattlenet::Wow::Character.find(realm: "stormrage", name: "sheday", fields: [:achievements, :mounts])
Supported fields:
achievements, appearance, equipment, hunter_pets, keystones, media, mounts, pets, pvp_summary, reputations, specializations, statistics, status, titles
RBattlenet::Wow::Guild.find(realm: "stormrage", name: "avalerion")
RBattlenet::Wow::Guild.find(realm: "stormrage", name: "avalerion", fields: [:roster])
Supported fields:
roster, achievements
RBattlenet::Wow::Item.find(11081)
RBattlenet::Wow::Mount.find(304)
RBattlenet::Wow::Mount.all
RBattlenet::Wow::Pet.find(405)
RBattlenet::Wow::Pet.all
RBattlenet::Wow::MythicKeystoneLeaderboard.find(connected_realm_id: 509, dungeon_id: 244, period: 682)
RBattlenet::Wow::Classic::Creature.find(30)
RBattlenet::Wow::Classic::Item.find(19019)
RBattlenet::Sc2::Profile.find(region_id: 2, realm_id: 1, id: 2137104)
RBattlenet::Sc2::Legacy::Profile.find(region_id: 2, realm_id: 1, id: 2137104)
RBattlenet::Sc2::Legacy::ProfileLadders.find(region_id: 2, realm_id: 1, id: 2137104)
RBattlenet::Sc2::Legacy::ProfileMatchHistory.find(region_id: 2, realm_id: 1, id: 2137104)
RBattlenet::Sc2::Legacy::Ladder.find(region_id: 2, id: 2200)
RBattlenet::D3::Hero.find(battletag: "Battle#tag", id: 104729462)
RBattlenet::D3::Item.find("corrupted-ashbringer-Unique_Sword_2H_104_x1")
git checkout -b my-new-feature)git commit -am 'Add some feature')git push origin my-new-feature)FAQs
Unknown package
We found that rbattlenet demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Following last week’s supply chain attack, Nx published findings on the GitHub Actions exploit and moved npm publishing to Trusted Publishers.
Security News
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.