Project

tunefind

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

Development

~> 1.10
~> 10.0
~> 3.4

Runtime

~> 3.4
 Project Readme

Tunefind

A simple ruby wrapper for TuneFind REST API V1

Installation

Add this line to your application's Gemfile:

gem 'tunefind'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tunefind

Usage

Set you API username and password as ENV vars:

ENV['TUNEFIND_USERNAME'] = 'your-api-username'
ENV['TUNEFIND_PASSWORD'] = 'your-api-password'

Show:

All shows

Tunefind::Show.search

A single show

Tunefind::Show.find('alias')

Season:

Tunefind::Season.find('alias', 1)

Episode:

Tunefind::Episode.find('alias', 1, 286)

Movie:

All movies

Tunefind::Movie.search

A single movie

Tunefind::Movie.find('zombieland-2009')

Artist:

All artists

Tunefind::Artist.search

A single artist

Tunefind::Artist.find('amazing-baby')

Pagination

Search methods return a maximum of 1000 resources at a time. To page through results, specify a positive zero-indexed integer offset:

Tunefind::Artist.search(offset: 1000)

Filtering

Search methods support an optional "updated" parameter. When provided, only results updated after this date will be listed. The date format is ISO 8601.

Tunefind::Artist.search(updated: '2010-01-01T00%3A00%3A00%2B00%3A00')

Disclaimer: By the time of this implementation, filtering was not working.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tunefind.

License

The gem is available as open source under the terms of the MIT License.