ThetvdbApi
thetvdb_api is a simple ruby client for accessing TV shows information from the thetvdb.com API.
Installation
With Bundler:
gem 'thetvdb_api'
$ bundle install
Otherwhise:
gem install thetvdb_api
How to use
- I case (create client class, one entry point)
Language attribute is optional with default value 'en'
client = ThetvdbApi::Client.new(api_key: '...')
client.actor # => #<ThetvdbApi::Actor>
client.banner # => #<ThetvdbApi::Banner>
client.episode # => #<ThetvdbApi::Episode>
client.search # => #<ThetvdbApi::Search>
client.series # => #<ThetvdbApi::Series>
client.update # => #<ThetvdbApi::Update>
client.server # => #<ThetvdbApi::Server>
- II case (direct access to api class, many entry points)
Language attribute is required
ThetvdbApi::Actor.new(api_key: '...')
ThetvdbApi::Banner.new(api_key: '...')
ThetvdbApi::Episode.new(api_key: '...')
ThetvdbApi::Search.new(api_key: '...')
ThetvdbApi::Series.new(api_key: '...')
ThetvdbApi::Update.new(api_key: '...')
ThetvdbApi::Server.new(api_key: '...')
- III case (run request with pass url and params)
client = ThetvdbApi::Client.new(api_key: '...')
client.get("GetSeries.php", seriesname: "buffy")
Methods
For almost all method you can pass attributes as hash
Actor methods
For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib/thetvdb_api/actor.rb
- all
- all_url
Banner methods
For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib/thetvdb_api/banner.rb
- all
- all_url
Episode methods
For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib/thetvdb_api/episode.rb
- find
- find_url
- find_by_absolute_order
- find_by_absolute_order_url
- find_by_default_order
- find_by_default_order_url
- find_by_dvd_order
- find_by_dvd_order_url
Search methods
For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib/thetvdb_api/search.rb
- get_series
- get_series_url
- get_series_by_remote
- get_series_by_remote_url
- get_series_by_imdb_id
- get_series_by_imdb_id_url
- get_series_by_zap2it_id
- get_series_by_zap2it_id_url
- get_episode
- get_episode_url
Series methods
For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib/thetvdb_api/series.rb
- find
- find_url
- find_full
- find_full_url
Server Time method
For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib/thetvdb_api/server.rb
- time
- time_url
Update methods
For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib/thetvdb_api/update.rb
- day
- day_url
- week
- week_url
- month
- month_url
- all
- all_url
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request