ThetvdbApi

thetvdb_api is a simple ruby client for accessing TV shows information from the thetvdb.com API.

Getting started

You can add it to your Gemfile with:

gem 'thetvdb_api'

Run the bundle command to install it.

After you install ThetvdbApi and add it to your Gemfile, you need to run the generator (if you use Ruby on Rails application):

rails generate thetvdb_api:install

The generator will install an initializer where you must past your api_key, and can past: language (2 letters abbrevation), api_url (base url).

How to use

There is one entry point, in initialize you can past hash with api_key, language and api_url values, or leave empty:

client = ThetvdbApi::Client.new(api_url: '...', api_key: '...', language: 'en')

Search series by name

client = ThetvdbApi::Client.new
client.search.get_series('buffy')
client.search.get_series_by_imdb_id('...')
client.search.get_series_by_zap2it_id('...')
client.search.get_episode_by_air_date('123', air_date)

Search series by id

client = ThetvdbApi::Client.new
client.series.find('123')
client.series.find_full('123')

Return series actors

client = ThetvdbApi::Client.new
client.actor.all(series_id)

Return series banners

client = ThetvdbApi::Client.new
client.banner.all(series_id)

Return series episode

client = ThetvdbApi::Client.new
client.episode.find_by_default_order(series_id, season, episode)
client.episode.find_by_dvd_order(series_id, season, episode)
client.episode.find_by_absolute_order(series_id, absolute)
client.episode.find(episode_id)

Get updates

client = ThetvdbApi::Client.new
client.update.day
client.update.week
client.update.month
client.update.all

In each response you get pure hash, without any coerce or key mapping.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request