Wowr

Introduction

Wowr is a Ruby library for accessing data in the World of Warcraft Armory. It provides an object-oriented interface to the XML data provided by the armory, giving access to items, characters, guilds and arena teams. It is designed for both single users and larger guild or portal sites for many users.

Installation

Install Wowr using RubyGems:

gem install wowr

Alternatively, check out the latest version from GIT:

git clone git://github.com/pwood/wowr.git

Documentation

RubyDoc documentation contains further details of functions available.

Example Sites

The following sites use Wowr.

Hoax Guild

Features

Characters: Retrieve full character details including stats, equipped items, skills, reputation, buffs
Items: With complete stats, reagent details, related quests
Guilds & Arena teams: List of members, win/loss statistics
NEW!Guild Banks: Access bank contents and transaction history securely
Searching: Search the armory for characters, items, guilds and arena teams
Caching: Caches results of requests to improve performance
Localisation: Results returned in the armory's supported languages from localised servers

Usage

require 'wowr'

api = Wowr::API.new(:character_name => 'Hesperus',
                    :guild_name => 'Rawr',
                    :realm => 'Trollbane',
                    :locale => 'eu', # defaults to US

                    :lang => 'fr_fr', # remove for locale default language
                    :caching => false) # defaults to true

# For all requests it's possible to specify the parameters similar to the
# api constructor. By default it'll use whatever is specified in the API.

# gets character with API default values
default_char = api.get_character
jim = api.get_character("Jim", :realm => "Balnazzar", :lang => 'de_de', :caching => false)
chars = api.search_characters(:search => 'Cake')

# Guild requests
my_guild = api.get_guild
guilds = api.search_guilds("Cake")

# Items
items = api.search_items("Cake")
item = api.get_item(33924)

if item.reagents
  item.reagents.each do |reagent|
    puts reagent # Human-readable name aliased to to_s to simplify printing
  end
end

# Arena Teams
arena_teams = api.search_arena_teams("Lemon")
arena_team = api.get_arena_team("Lemon", 2, :realm => "Darksorrow")

# Guild Bank
cookie = api.login('myuser', 'mypass')
api.get_guild_bank_contents(cookie)
api.get_guild_bank_log(cookie)

Contact

Contact me with feedback or requests for features/changes to.

If you use Wowr in a project of yours, I would love to hear about it. It'd also be great if you could provide a link to this site. Feel free to use any of these icons.

16px
32px

License

Wowr is licensed under the CC-GNU GPL.

Version History

0.4.0 [Changelog]

Added Guild Bank functionality.
Buy and sell prices, as well as transactions in the guild bank now use Wowr::Classes::Money.

0.3.0 [Changelog]

Shorter method calls using single parameters instead of hashes.
Compound get_character and get_item methods.
Stricter API now throws more exceptions if correct parameters are not supplied

0.2.2 [Changelog]

Added language support - It's now possible to specify the language in which you wish your results to be returned, in the API constructor :lang => 'en_gb'.
Optional :debug => true parameter when creating the API will output interesting stuff to the standard out.
Cache files are no longer created in subdirectories based on locale, but on language.

See the Wowr Rubyforge Page for the full version history.

A Ruby library for the World of Warcraft Armory