Project

tvdb-api

0.0
No commit activity in last 3 years
No release in over 3 years
Clean Ruby API interface to The TVDB
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

~> 0.10.0
 Project Readme

TVDB API

Yet another Ruby client for the TVDB ( http://thetvdb.com ).

  • Clean and fully featured API client that streamlines usage but gets out of your way when you need it to.
  • Supports all non-deprecated aspects of the TVDB Api.
  • Uses compression for all calls making the API very quick.
  • All XML responses parsed into simple Ruby Hash structure.

See http://thetvdb.com/wiki/index.php?title=Programmers_API for documentation of API.

This library does not do caching. Please use some form of caching when interacting with TVDB

Usage

client = TVDBApi.new API_KEY
# or
client = TVDBApi.new API_KEY, 'en'

# Dynamic Interfaces
client.get_series 'Futurama'
client.get_series_by_remote_id :imdb, 'tt0149460'
# etc...

## Files Interface

client['updates/updates_day.xml']

# Adds .xml for you
client['languages'] # => languages.xml

# Automatically gets the default language if not specified
client['series/73871'] => series/73871/en.xml

# Allows array input for more structured calls
client[:series, 73871, :default, 1, 1] => 'series/73871/default/1/1/en.xml'

# Adds 'updates_' prefix to updates calls
client[:updates, :day] => 'updates/updates_day.xml'