Project

bnet_api

0.0
No commit activity in last 3 years
No release in over 3 years
Ruby wrapper for the Battle.net web API. For more info visit https://dev.battle.net
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

= 0.14.0
 Project Readme

BnetApi

Gem Version Build Status Code Climate Coverage StatusInline docs

A Ruby wrapper for the Battle.net API.

Installation

gem install bnet_api

Requirements

  • Ruby 2.0.0 or higher

Configuration

You need to set at least the Battle.net API key in the configuration, either in the code or in an initializer.

You can also change the region of the API to query and the locale of the returned data.

BnetApi.config.api_key = 'YOUR_API_KEY'
BnetApi.config.api_secret = 'YOUR_API_SECRET'
# config/initializers/bnet_api.rb
require 'bnet_api'

BnetApi.configure do |config|
  config.region = :eu
  config.locale = :en_GB

  config.api_key = 'YOUR_API_KEY'
  config.api_secret = 'YOUR_API_SECRET'
end

Regions

  • us
  • eu
  • kr
  • tw

Locales

Region Locales
us en_US, es_MX, pt_BR
eu en_GB, es_ES, fr_FR, ru_RU, de_DE, pl_PL, pt_PT, it_IT
kr ko_KR
tw zh_TW

Usage

Documentation can be found in the wiki