Project

vinegar

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

Development

Runtime

 Project Readme

Vinegar

Code Climate Build Status Coverage Status

Rotten Tomatoes API Wrapper in Ruby. Currently the wrapper supports the movies api and lists api is comming shortly.

Installation

Sign up for a Rotten Tomatoes API key:

http://developer.rottentomatoes.com/member/register

Add this line to your application's Gemfile:

gem 'vinegar'

And then execute:

$ bundle

Or install it yourself as:

$ gem install vinegar

Documentation

http://rdoc.info/github/jasontruluck/vinegar

Usage

Setup a new client

client = Vinegar::Client.new(:api_key => 1234567890)
client.movies_search("Star Wars")
client.movie(12345) #12345 is the movies Rotten Tomatoes ID
client.full_movie_cast(12345) #12345 is the movies Rotten Tomatoes ID
client.all_movie_reviews(12345) #12345 is the movies Rotten Tomatoes ID
client.similar_movies(12345) #12345 is the movies Rotten Tomatoes ID
client.clips_for_movie(12345) #12345 is the movies Rotten Tomatoes ID

Testing

This gem uses VCR to record requests to the api so you must test using a valid API key from Rotten Tomatoes.

Add a sample authentications file to your spec/fixtures directory:

#spec/fixtures/authentications.yml
api_key:       "1234567890" # Your API key
movies_search: "Star Wars"  # Movie title you would like to use for tests
movie_id:      "9"          # ID of a movie you would like to use for tests

A sample is included in the directory.

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