bufu v0.2.0 Bufu

Giant Bomb API client library.

See the Giant Bomb API documentation for more details on the Giant Bomb API, including terms of use, obtaining an API key, and rate limit restrictions.

Summary

Functions

Generates a new Bufu client with an inferred API key, from either the Mix (application) config or the system environment (GIANT_BOMB_API_KEY)

Generates a new Bufu client with the given API key. Generally, you will not need to use this variant, but it is provided in case you need to support multiple clients in the same process (e.g. with a standard API key and a premium API key)

Returns the current Bufu version

Functions

api_key(bufu)
config(bufu)
new()

Generates a new Bufu client with an inferred API key, from either the Mix (application) config or the system environment (GIANT_BOMB_API_KEY).

Raises an error if it cannot infer an API key, as the Giant Bomb API does not allow unauthenticated access.

new(api_key)

Generates a new Bufu client with the given API key. Generally, you will not need to use this variant, but it is provided in case you need to support multiple clients in the same process (e.g. with a standard API key and a premium API key).

start_link(config)
version()

Returns the current Bufu version.