Project

fanart_api

0.0
No commit activity in last 3 years
No release in over 3 years
Ruby client for fanart.tv API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
~> 0.7
>= 0
~> 3.1.0

Runtime

~> 0.1.0
~> 0.1.0
 Project Readme

Build Status Dependency Status Code Climate Coverage Status Gem Version

FanartApi

fanart_api is a simple ruby client for accessing TV shows information from the fanart.tv API.

Installation

With Bundler:

gem 'thetvdb_api'
$ bundle install

Otherwhise:

$ gem install thetvdb_api

How to use

You have two way for access to api:

client = FanartApi::Client.new(api_key: '...')
client = FanartApi::Client.new(api_key: '...', proxy_url: '...')
client.movie # => #<FanartApi::Movie>
client.music # => #<FanartApi::Music>
client.tv # => #<FanartApi::Tv>
  • 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::Actor.new(api_key: '...', proxy_url: '...')
ThetvdbApi::Banner.new(api_key: '...', proxy_url: '...')
ThetvdbApi::Episode.new(api_key: '...', proxy_url: '...')

Methods

For all methods you can pass hash attributes or multiple attributes specified in method comment.

Movie methods

For method attributes read https://github.com/tvapi/fanart_api/blob/master/lib/fanart_api/movie.rb

  • find
  • find_url
  • latest
  • latest_url

Music methods

For method attributes read https://github.com/tvapi/fanart_api/blob/master/lib/fanart_api/music.rb

  • artist
  • artist_url
  • album
  • album_url
  • label
  • label_url
  • latest
  • latest_url

Tv methods

For method attributes read https://github.com/tvapi/fanart_api/blob/master/lib/fanart_api/tv.rb

  • find
  • find_url
  • latest
  • latest_url

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