Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

GameOfThronesApi

Something for Game of Thrones & A Song of Ice and Fire fans.

A Ruby API Wrapper using An API Of Ice And Fire. All credit goes to Joakim Skoog the creator of the API.

Still In developement. Basic Functionality. Find Books, Characters and Houses.

TODO: Implement better filtering, complete API functionality and of course tests.

Installation

Add this line to your application's Gemfile:

gem 'game_of_thrones_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install game_of_thrones_api

Usage

An API Of Ice And Fire is public, no authentication required

Retrieve all Books

GameOfThronesApi.get_books

Find a Book by Title or Partial Title.

GameOfThronesApi.find_book('A Dance with Dragons')

or

GameOfThronesApi.find_book('dragon')

Retrieve all Characters

GameOfThronesApi.get_characters

Find a Character by Name or Partial Name

GameOfThronesApi.find_character('Jon Snow')

or

GameOfThronesApi.find_character('baratheon')

Retrieve all Houses

GameOfThronesApi.get_houses

Find a House by Name

GameOfThronesApi.find_house('targaryen')

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jzntam/game_of_thrones_api. Contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

About

An API of Ice and Fire for Ruby

Resources

License

Packages

No packages published