Project

tvrage_api

0.0
No commit activity in last 3 years
No release in over 3 years
Ruby client for accessing TV shows information from the tvrage.com 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

>= 1.1.0
~> 0.1.0
~> 0.1.0
 Project Readme

Build Status Dependency Status Code Climate Coverage Status Gem Version

TvrageApi

tvrage_api is a simple ruby client for accessing TV shows information from the tvrage.com API.

Getting started

You can add it to your Gemfile with:

gem 'tvrage_api'

Run the bundle command to install it.

How to use

You have two way for access to api:

  • I way (create client class, one entry point)
client = TvrageApi::Client.new
client.info # => #<TvrageApi::Info>
client.recap # => #<TvrageApi::Recap>
client.schedule # => #<TvrageApi::Schedule>
client.search # => #<TvrageApi::Search>
client.show # => #<TvrageApi::Show>
client.update # => #<TvrageApi::Update>
  • II way (direct access to api class, many entry points)
TvrageApi::Info.new
TvrageApi::Recap.new
TvrageApi::Schedule.new
TvrageApi::Search.new
TvrageApi::Show.new
TvrageApi::Update.new

Methods

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

Info (QuickInfo) methods

For method attributes read https://github.com/tvapi/tvrage_api/blob/master/lib/tvrage_api/info.rb

  • find
  • find_url

Recap methods

For method attributes read https://github.com/tvapi/tvrage_api/blob/master/lib/tvrage_api/recap.rb

  • all
  • all_url
  • show
  • show_url
  • last
  • last_url

Schedule methods

For method attributes read https://github.com/tvapi/tvrage_api/blob/master/lib/tvrage_api/schedule.rb

  • quick
  • quick_url
  • full
  • full_url

Search methods

For method attributes read https://github.com/tvapi/tvrage_api/blob/master/lib/tvrage_api/search.rb

  • by_name
  • by_name_url
  • full_by_name
  • full_by_name_url

Show (search show) methods

For method attributes read https://github.com/tvapi/tvrage_api/blob/master/lib/tvrage_api/show.rb

  • find
  • find_url
  • find_full
  • find_full_url
  • episodes
  • episodes_url
  • episode
  • episode_url
  • all
  • all_url

Update methods

For method attributes read https://github.com/tvapi/tvrage_api/blob/master/lib/tvrage_api/update.rb

  • last
  • last_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