Project

giantbomb

0.01
No commit activity in last 3 years
No release in over 3 years
Provides a simple, easy to use interface for the Giant Bomb video game wiki API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

A Ruby wrapper for the GiantBomb API

Configuration

GiantBomb::Api.key(API_KEY_HERE)

Resources

Current available resources:

  • Game
  • Company
  • Character

All resources have access to Resource#list, Resource#detail, and Resource#search.

Example

@game = Game.detail(1)
@games = Game.find("Duke Nukem")
@games = Game.list

Search

GiantBomb::Search defaults to using the GiantBomb search resource and is the basis for all other resource requests. The implementation is inspired by jnunemaker’s Twitter library.

All of the “filter” methods in GiantBomb::Search are chainable.

Usage

@search = GiantBomb::Search.new
@search.limit(10) # limits number of returned resources
@search.resources('game') # determines type(s) of resources
@search.fields('name,deck') # limits fields returned
@search.offset(100) # sets the offset
@search.query('duke nukem') # the query to search against
@search.fetch # makes request