bgg gem

An object-oriented API for interacting with the boardgamegeek XML Version 2 API.

This is based on a fork of earlier work I had done on bgg-api, along with Brett and a few other contributors.

Versions supported

Please note that this code uses Ruby 1.9 hash syntax and thus does not support versions earlier than that.

Installing the Gem

Do the following to install the bgg gem Ruby Gem.

Add the following to your Gemfile:

gem "bgg"

Then run bundle install from the command line:

bundle install

Using the Gem

Require the gem at the top of any file you want to use.

require 'bgg'

You can either use the low level basic api and then parse the XML document in a way that suits your needs, or you can use the specialized methods

There are object types and subtypes for many of the APIs documented at BGG_XML_API2, but not all of them are implemented. Everything around a user and their game collection should work, as well as generalized searching for board games.

Example

Most of the documentation right now is in the specs. I will work on beefing this section up shortly.

texasjdl = Bgg::User.find_by_id(39488)
texasjdl.collection.played.each do |item|
  puts "#{item.name} is #{item.owned? ? '' : 'not'} owned."
end

Contributing to bgg