Nimbomb

Introduction

Nimbomb is a Giantbomb-wiki API wrapper for Nim.

Requirements

Nim

Nim can be found at https://nim-lang.org/.

Giantbomb API Key

To use this module, you need to sign-up for an account on Giant Bomb. Then, go to the API page to sign up for an API Key.

Installation

This module is not ready to be on nimble yet, so just unzip or clone it into your .nimble directory.

Usage

Before you start

An api key is required to use this module, it searches for a file called giantbomb.api in the current working directory. The giantbomb.api file is just a .txt file with the api written on the first line. If the file doesn't exist, you can still call the setAPIKey(nimbomb: NimBombClient, key: string) proc after creating your client.

Example 1: Simple How-to

import nimbomb

var cli = newNimbombClient()

let results: seq[Resource] = cli.search("zelda")

for res in results:
    echo $res

let game: Resource = cli.get(results[0])

echo "\n"
echo $game
echo game.getField(genres)

Make sure to compile with -d:ssl.

This outputs:

Zelda's Adventure
The Legend of Zelda
The Legend of Zelda: The Wind Waker
The Legend of Zelda: Tetra's Trackers
The Legend of Zelda: Link's Awakening
The Legend of Zelda: Oracle of Ages
BS Zelda no Densetsu
Zelda II: The Adventure of Link
The Legend of Zelda: Ocarina of Time
The Legend of Zelda: A Link to the Past

Zelda's Adventure
genres:
        Action-Adventure

Example 2: More Stuff

import nimbomb

var cli = newNimbombClient()

let results: seq[Resource] = cli.search("master chief", "character")

assert(results[0].apiName == "character")

let theChief = cli.get(results[0], people, name, realName, birthday)

theChief.printNonEmpty()

assert($theChief.getField(people).getArr()[0].getField(name) == "Bill Gates")

let gates = cli.get(theChief.getField(people).getArr()[0], concepts, locations, name, objects)

gates.printNonEmpty(labels=true)

Output:

Jan 1, 2511
Master Chief
people:
        Bill Gates
        Bonnie Ross
        Brian Jarrard
        Brian Reed
        Eric Nylund
        Jason Jones
        Joseph Staten
        Josh Holmes
        Michael Salvatori
        Philip O'Duffy
        Shi Kai Wang
        Steve Downes
        Tessho Genda
John
concepts:
        Microtransaction
        Genius-Level Intellect
locations:
        Seattle
        Earth
        The United States of America
name: Bill Gates
objects:
        Glasses
        Computer
        Xbox 360
        Xbox
        Blue Screen of Death
        Microphone

Check this page for what resources and fields there are. Almost all resources can be read.

To do

• Better documentation
• Support all resource types
• More convenient procs