Rotten Tomatoes API Wrapper in Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
vinegar.gemspec

README.md

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)

Search for movies

client.movies_search("Star Wars")

View a single movie

client.movie(12345) #12345 is the movies Rotten Tomatoes ID

Get the cast for a movie

client.full_movie_cast(12345) #12345 is the movies Rotten Tomatoes ID

Get reviews for a movie

client.all_movie_reviews(12345) #12345 is the movies Rotten Tomatoes ID

Get similar movies for a movie

client.similar_movies(12345) #12345 is the movies Rotten Tomatoes ID

Get clips for a movie

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