vinegar 0.0.1

data/.gitignore

@@ -0,0 +1,32 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+spec/cassettes
+spec/.DS_Store
+
+spec/fixtures/authentications.yml
+
+spec/vinegar/.DS_Store
+
+lib/vinegar/.DS_Store
+
+lib/vinegar/client/movies/.DS_Store
+
+lib/vinegar/client/movie/.DS_Store
+
+spec/vinegar/client/movies/.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vinegar.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jason Truluck
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# Vinegar
+
+Rotten Tomatoes API Wrapper in Ruby. Currently the wrapper supports the movies api and lists api is comming shortly.
+
+## Installation
+
+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
+
+```ruby
+client = Vinegar::Client.new(:api_key => 1234567890)
+```
+
+### [Search for movies](http://rdoc.info/github/jasontruluck/vinegar/Vinegar/Client/Movie#movies_search-instance_method)
+
+```ruby
+client.movies_search("Star Wars")
+```
+
+### [View a single movie](http://rdoc.info/github/jasontruluck/vinegar/Vinegar/Client/Movie#movie-instance_method)
+
+```ruby
+client.movie(12345) #12345 is the movies Rotten Tomatoes ID
+```
+
+### [Get the cast for a movie](http://rdoc.info/github/jasontruluck/vinegar/Vinegar/Client/Cast)
+
+```ruby
+client.full_movie_cast(12345) #12345 is the movies Rotten Tomatoes ID
+```
+
+### [Get reviews for a movie](http://rdoc.info/github/jasontruluck/vinegar/Vinegar/Client/Review)
+
+```ruby
+client.all_movie_reviews(12345) #12345 is the movies Rotten Tomatoes ID
+```
+
+### [Get similar movies for a movie](http://rdoc.info/github/jasontruluck/vinegar/Vinegar/Client/Similar)
+
+```ruby 
+client.similar_movies(12345) #12345 is the movies Rotten Tomatoes ID
+```
+
+### [Get clips for a movie](http://rdoc.info/github/jasontruluck/vinegar/Vinegar/Client/Clip)
+
+```ruby 
+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:
+    
+```ruby
+#spec/fixtures/authentications.yml
+api_key:        1234567890 # Your API key
+movies_search: "Star Wars" # Movie title you would like to use for search tests
+movie_id:       9          # ID of a movie you would like to use for movie tests
+```
+
+A sample is included in the [directory](https://github.com/jasontruluck/vinegar/blob/master/spec/fixtures/authentication.yml.sample).
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/vinegar.rb

@@ -0,0 +1,19 @@
+require "vinegar/version"
+require "vinegar/configuration"
+require "vinegar/client"
+
+module Vinegar
+  extend Configuration
+
+  class << self
+    # Alias for Vinegar::Client.new
+    # @return [Vinegar::Client]
+    def new(options = {})
+      Vinegar::Client.new(options)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/lib/vinegar/authentication.rb

@@ -0,0 +1,21 @@
+# Authentication Module
+module Vinegar
+  module Authentication
+    def authentication
+      if api_key
+        { :api_key => api_key}
+      else
+        {}
+      end
+    end
+
+    def authenticated?
+      !authentication.empty?
+    end
+
+    def login_token(api_key = "")
+      return if api_key.nil?
+      self.api_key  = api_key
+    end
+  end
+end

data/lib/vinegar/client.rb

@@ -0,0 +1,40 @@
+# Client Module
+require "vinegar/authentication"
+require "vinegar/connection"
+require "vinegar/request"
+
+require "vinegar/client/root"
+require "vinegar/client/movie"
+require "vinegar/client/movie/review"
+require "vinegar/client/movie/cast"
+require "vinegar/client/movie/similar"
+require "vinegar/client/movie/clip"
+
+module Vinegar
+  class Client
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    def initialize(options = {})
+      Vinegar.reset!
+      options = Vinegar.options.merge(options)
+
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+
+      login_token(options[:api_key])
+    end
+
+
+    include Vinegar::Authentication
+    include Vinegar::Connection
+    include Vinegar::Request
+
+    include Vinegar::Client::Root
+    include Vinegar::Client::Movie
+    include Vinegar::Client::Review
+    include Vinegar::Client::Cast
+    include Vinegar::Client::Similar
+    include Vinegar::Client::Clip
+  end
+end

data/lib/vinegar/client/movie.rb

@@ -0,0 +1,55 @@
+# Movies
+module Vinegar
+  class Client
+    # Movies Search
+    #
+    # @see http://developer.rottentomatoes.com/docs/json/v10/Movies_Search
+    module Movie
+      # Returns the response from querying the movies search endpoint
+      #
+      # @see http://developer.rottentomatoes.com/docs/json/v10/Movies_Search
+      #
+      # @param [String] query The query you want to search on
+      # @param [Integer] page_limit The amount of movie search results to show per page
+      # @param [Integer] page The selected page of movie search results
+      #
+      # @return [Hashie::Mash] Movies serach Response
+      #
+      # @example Get the search results for a query
+      #   @client.movies_search("Movie Title")
+      #
+      # @example Get the search results for a query with a page limit
+      #   @client.movies_search("Movie Title", 10)
+      #
+      # @example Get the search results for a query with a page limit and a page
+      #   @client.movies_search("Movie Title", 10, 1)
+      #
+      # @author Jason Truluck
+      def movies_search(query, per_page = "", page = "", options = {})
+        options.merge!(
+          :q          => query,
+          :page_limit => per_page,
+          :page       => page
+        )
+        get("movies.json", options)
+      end
+
+      # Detailed information on a specific movie specified by Id. You can use the movies search endpoint
+      # or peruse the lists of movies/dvds to get the urls to movies.
+      #
+      # @see http://developer.rottentomatoes.com/docs/json/v10/Movie_Info
+      #
+      # @param [Integer] Movie ID from Rotten Tomatoes
+      #
+      # @return [Hashie::Mash] Movie Response
+      #
+      # @example Get the results for a specific movie id
+      #   @client.movie(12345)
+      #
+      # @author Jason Truluck
+      def movie(movie_id, options = {})
+        get("movies/#{movie_id}.json", options)
+      end
+    end
+  end
+end

data/lib/vinegar/client/movie/cast.rb

@@ -0,0 +1,25 @@
+# Cast
+module Vinegar
+  class Client
+    # Cast
+    #
+    # @see http://developer.rottentomatoes.com/docs/json/v10/Movie_Cast
+    module Cast
+      # Pulls the complete movie cast for a movie
+      #
+      # @see http://developer.rottentomatoes.com/docs/json/v10/Movie_Cast
+      #
+      # @param [Integer] movie_id The id of the movie from Rotten Tomatoes
+      #
+      # @return [Hashie::Mash] Movie cast response
+      #
+      # @example Get the cast results for a movie
+      #   @client.full_movie_cast(12345)
+      #
+      # @author Jason Truluck
+      def full_movie_cast(movie_id, options = {})
+        get("movies/#{movie_id}/cast.json", options)
+      end
+    end
+  end
+end

data/lib/vinegar/client/movie/clip.rb

@@ -0,0 +1,25 @@
+# Clip
+module Vinegar
+  class Client
+    # Clip
+    #
+    # @see http://developer.rottentomatoes.com/docs/json/v10/Movie_Clips
+    module Clip
+      # Related movie clips and trailers for a movie
+      #
+      # @see http://developer.rottentomatoes.com/docs/json/v10/Movie_Clips
+      #
+      # @param [Integer] movie_id The id of the movie from Rotten Tomatoes
+      #
+      # @return [Hashie::Mash] Clips movies response
+      #
+      # @example Get the similar movies for a movie
+      #   @client.clips_for_movie(12345)
+      #
+      # @author Jason Truluck
+      def clips_for_movie(movie_id, options = {})
+        get("movies/#{movie_id}/clips.json", options)
+      end
+    end
+  end
+end

data/lib/vinegar/client/movie/review.rb

@@ -0,0 +1,98 @@
+# Reviews
+module Vinegar
+  class Client
+    # Reviews
+    #
+    # @see http://developer.rottentomatoes.com/docs/json/v10/Movie_Reviews
+    module Review
+      # Retrieves all reviews for a movie. Results are paginated if they go past the specified page limit
+      #
+      # @see http://developer.rottentomatoes.com/docs/json/v10/Movie_Reviews
+      #
+      # @param [Integer] movie_id The id of the movie from Rotten Tomatoes
+      # @param [String] country Provides localized data for the selected country if available. Otherwise, returns US data.
+      # @param [Integer] page_limit The amount of movie search results to show per page
+      # @param [Integer] page The selected page of movie search results
+      #
+      # @return [Hashie::Mash] Movies reviews Response
+      #
+      # @example Get the search results for a query
+      #   @client.all_movie_reviews("12345")
+      #
+      # @author Jason Truluck
+      def all_movie_reviews(movie_id, country = "us", per_page = "", page = "", options = {})
+        options.merge!(
+          :review_type  => :all,
+          :country      => country,
+          :page_limit   => per_page,
+          :page         => page
+        )
+        reviews(movie_id, options)
+      end
+
+      # Retrieves top_critic reviews for a movie. Results are paginated if they go past the specified page limit
+      #
+      # @see http://developer.rottentomatoes.com/docs/json/v10/Movie_Reviews
+      #
+      # @param [Integer] movie_id The id of the movie from Rotten Tomatoes
+      # @param [String] country Provides localized data for the selected country if available. Otherwise, returns US data.
+      # @param [Integer] page_limit The amount of movie search results to show per page
+      # @param [Integer] page The selected page of movie search results
+      #
+      # @return [Hashie::Mash] Movies reviews Response
+      #
+      # @example Get the search results for a query
+      #   @client.top_critic_movie_reviews("12345")
+      #
+      # @author Jason Truluck
+      def top_critic_movie_reviews(movie_id, country = "us", per_page = "", page = "", options = {})
+        options.merge!(
+          :review_type  => :top_critic,
+          :country      => country,
+          :page_limit   => per_page,
+          :page         => page
+        )
+        reviews(movie_id, options)
+      end
+
+      # Retrieves dvd reviews for a movie. Results are paginated if they go past the specified page limit
+      #
+      # @see http://developer.rottentomatoes.com/docs/json/v10/Movie_Reviews
+      #
+      # @param [Integer] movie_id The id of the movie from Rotten Tomatoes
+      # @param [String] country Provides localized data for the selected country if available. Otherwise, returns US data.
+      # @param [Integer] page_limit The amount of movie search results to show per page
+      # @param [Integer] page The selected page of movie search results
+      #
+      # @return [Hashie::Mash] Movies reviews Response
+      #
+      # @example Get the search results for a query
+      #   @client.dvd_movie_reviews("12345")
+      #
+      # @author Jason Truluck
+      def dvd_movie_reviews(movie_id, country = "us", per_page = "", page = "", options = {})
+        options.merge!(
+          :review_type  => :dvd,
+          :country      => country,
+          :page_limit   => per_page,
+          :page         => page
+        )
+        reviews(movie_id, options)
+      end
+
+      private
+      # @private
+      #
+      # General method to handle endpoints for grabing reviews
+      #
+      # @param [Integer] movie_id The id of the movie from Rotten Tomatoes
+      #
+      # @return [Hashie::Mash] Movies reviews Response
+      #
+      # @author Jason Truluck
+      def reviews(movie_id, options)
+        get("movies/#{movie_id}/reviews.json", options)
+      end
+    end
+  end
+end