vinegar 0.0.1

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

@@ -0,0 +1,29 @@
+# Similar
+module Vinegar
+  class Client
+    # Similar
+    #
+    # @see http://developer.rottentomatoes.com/docs/json/v10/Movie_Similar
+    module Similar
+      # Shows similar movies for a movie.
+      #
+      # @see http://developer.rottentomatoes.com/docs/json/v10/Movie_Similar
+      #
+      # @param [Integer] movie_id The id of the movie from Rotten Tomatoes
+      # @param [Integer] limit Limit the number of similar movies to show
+      #
+      # @return [Hashie::Mash] Similar movies response
+      #
+      # @example Get the similar movies for a movie
+      #   @client.similar_movies(12345)
+      #
+      # @author Jason Truluck
+      def similar_movies(movie_id, limit = 5, options = {})
+        options.merge!(
+          :limit => limit
+        )
+        get("movies/#{movie_id}/similar.json", options)
+      end
+    end
+  end
+end

data/lib/vinegar/client/root.rb

@@ -0,0 +1,23 @@
+# Root
+module Vinegar
+  class Client
+    # Root level tasks for Rotten Tomatoes API
+    #
+    # @see http://developer.rottentomatoes.com/docs/json/v10/
+    module Root
+      # Returns the root of the api
+      #
+      # @see http://developer.rottentomatoes.com/docs/json/v10/
+      #
+      # @return api root
+      #
+      # @example Return the root of the api
+      #   @client.root
+      #
+      # @author Jason Truluck
+      def root(options = {})
+        get("", options)
+      end
+    end
+  end
+end

data/lib/vinegar/configuration.rb

@@ -0,0 +1,29 @@
+#Configuration
+module Vinegar
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :api_key,
+      :api_version,
+      :api_endpoint
+    ]
+
+    DEFAULT_API_VERSION   = 1.0
+    DEFAULT_API_ENDPOINT  = "http://api.rottentomatoes.com/api/public/v#{DEFAULT_API_VERSION}"
+
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+    end
+
+    def reset!
+      self.api_key             = nil
+      self.api_version         = DEFAULT_API_VERSION
+      self.api_endpoint        = DEFAULT_API_ENDPOINT
+    end
+  end
+end

data/lib/vinegar/connection.rb

@@ -0,0 +1,16 @@
+# Connection
+require "faraday_middleware"
+
+module Vinegar
+  module Connection
+    def connection(options = {})
+      connection = Faraday.new(options) do |build|
+        build.use FaradayMiddleware::Mashify
+        build.use FaradayMiddleware::ParseJson
+        build.adapter  Faraday.default_adapter
+      end
+
+      connection
+    end
+  end
+end

data/lib/vinegar/request.rb

@@ -0,0 +1,29 @@
+module Vinegar
+  module Request
+    def get(path, options = {})
+      response = request(:get, path, options)
+      response.body
+    end
+
+    private
+    def request(method, path, options = {})
+      url = options.delete(:api_endpoint) || api_endpoint
+      key = options.delete(:api_key) || api_key
+
+      connection_options = {
+        :url    => url
+      }
+
+      response = connection(connection_options).send(method) do |request|
+        options.merge!(:apikey => key)
+
+        case method
+        when :get
+          request.url(path, options)
+        end
+      end
+
+      response
+    end
+  end
+end

data/lib/vinegar/version.rb

@@ -0,0 +1,3 @@
+module Vinegar
+  VERSION = "0.0.1"
+end

data/spec/fixtures/authentication.yml.sample

@@ -0,0 +1,3 @@
+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

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+
+if ENV['RAILS_ENV'] == 'test'
+  require 'simplecov'
+  SimpleCov.start 'rails'
+  class SimpleCov::Formatter::QualityFormatter
+    def format(result)
+      SimpleCov::Formatter::HTMLFormatter.new.format(result)
+      File.open("coverage/covered_percent", "w") do |f|
+        f.puts result.source_files.covered_percent.to_f
+      end
+    end
+  end
+  SimpleCov.formatter = SimpleCov::Formatter::QualityFormatter
+end
+
+require 'vinegar'
+require 'vcr'
+require "webmock/rspec"
+require "mocha/api"
+
+# Load Authentications
+auth = YAML::load(File.open(File.expand_path("../fixtures/authentications.yml", __FILE__)))
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :faraday
+  c.ignore_localhost = true
+  # Uncomment if you need to log VCR
+  # c.debug_logger = File.open(Rails.root.join("log","vcr_debugger.log"), 'w')
+  c.configure_rspec_metadata!
+  c.allow_http_connections_when_no_cassette = true
+end
+
+WebMock.allow_net_connect!
+
+Dir[File.expand_path("spec/support/**/*.rb", __FILE__)].each {|f| require f}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.order                                           = "random"
+end

data/spec/vinegar/client/movies/cast_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+auth = YAML::load(File.open(File.expand_path("../../../../fixtures/authentications.yml", __FILE__)))
+
+# Movie Search Spec
+describe Vinegar::Client do
+  before do
+    Vinegar.reset!
+    Vinegar.configure do |c|
+      c.api_key = auth["api_key"]
+    end
+  end
+
+  let(:vinegar) { Vinegar::Client.new(:api_key => auth["api_key"]) }
+
+  describe "#full_movie_cast", :vcr do
+    let(:current_response) { vinegar.full_movie_cast(auth["movie_id"]) }
+
+    it "returns the full_movie_cast response" do
+      current_response.should_not be_nil
+    end
+
+    describe "methods" do
+      it "responds to .cast" do
+        current_response.should respond_to(:cast)
+      end
+
+      it "responds to .links" do
+        current_response.should respond_to(:links)
+      end
+
+      describe "within .links" do
+        it "responds to .rel" do
+          current_response.links.should respond_to(:rel)
+        end
+      end
+
+      describe "within .cast" do
+        it "responds to .id" do
+          current_response.cast.first.should respond_to(:id)
+        end
+
+        it "responds to .name" do
+          current_response.cast.first.should respond_to(:name)
+        end
+
+        it "responds to .characters" do
+          current_response.cast.first.should respond_to(:characters)
+        end
+      end
+    end
+  end
+end

data/spec/vinegar/client/movies/clip_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+
+auth = YAML::load(File.open(File.expand_path("../../../../fixtures/authentications.yml", __FILE__)))
+
+# Movie Search Spec
+describe Vinegar::Client do
+  before do
+    Vinegar.reset!
+    Vinegar.configure do |c|
+      c.api_key = auth["api_key"]
+    end
+  end
+
+  let(:vinegar) { Vinegar::Client.new(:api_key => auth["api_key"]) }
+
+  describe "#clips_for_movie", :vcr do
+    let(:current_response) { vinegar.clips_for_movie(auth["movie_id"]) }
+
+    it "should return the clips_for_movie response" do
+      current_response.should_not be_nil
+    end
+
+    describe "methods" do
+      it "responds to .clips" do
+        current_response.should respond_to(:clips)
+      end
+
+      it "responds to .links" do
+        current_response.should respond_to(:links)
+      end
+
+      describe "within each .clips item" do
+        it "responds to .title" do
+          current_response.clips.first.should respond_to(:title)
+        end
+
+        it "responds to .duration" do
+          current_response.clips.first.should respond_to(:duration)
+        end
+
+        it "responds to .thumbnail" do
+          current_response.clips.first.should respond_to(:thumbnail)
+        end
+
+        it "responds to .links" do
+          current_response.clips.first.should respond_to(:links)
+        end
+      end
+
+      describe "within .links" do
+        it "responds to .self" do
+          current_response.links.should respond_to(:self)
+        end
+
+        it "responds to .alternate" do
+          current_response.links.should respond_to(:alternate)
+        end
+
+        it "responds to .rel" do
+          current_response.links.should respond_to(:rel)
+        end
+      end
+    end
+  end
+end

data/spec/vinegar/client/movies/review_spec.rb

@@ -0,0 +1,109 @@
+require "spec_helper"
+
+auth = YAML::load(File.open(File.expand_path("../../../../fixtures/authentications.yml", __FILE__)))
+
+# Movie Search Spec
+describe Vinegar::Client do
+  before do
+    Vinegar.reset!
+    Vinegar.configure do |c|
+      c.api_key = auth["api_key"]
+    end
+  end
+
+  let(:vinegar) { Vinegar::Client.new(:api_key => auth["api_key"]) }
+
+  describe "#reviews", :vcr do
+    let(:current_response) { vinegar.all_movie_reviews(auth["movie_id"]) }
+
+    it "returns the all_movie_review response" do
+      current_response.should_not be_nil
+    end
+
+    describe "methods" do
+      it "responds to .total" do
+        current_response.should respond_to(:total)
+      end
+
+      it "responds to .reviews" do
+        current_response.should respond_to(:reviews)
+      end
+
+      it "responds to .links" do
+        current_response.should respond_to(:links)
+      end
+
+      it "responds to .link_template" do
+        current_response.should respond_to(:link_template)
+      end
+
+      describe "within .reviews" do
+        it "responds to .critic" do
+          current_response.reviews.first.should respond_to(:critic)
+        end
+
+        it "responds to .date" do
+          current_response.reviews.first.should respond_to(:date)
+        end
+
+        it "responds to .freshness" do
+          current_response.reviews.first.should respond_to(:freshness)
+        end
+
+        it "responds to .publication" do
+          current_response.reviews.first.should respond_to(:publication)
+        end
+
+        it "responds to .quote" do
+          current_response.reviews.first.should respond_to(:quote)
+        end
+
+        it "responds to .links" do
+          current_response.reviews.first.should respond_to(:links)
+        end
+      end
+
+      describe "within .links" do
+        it "responds to .self" do
+          current_response.links.should respond_to(:self)
+        end
+
+        it "responds to .next" do
+          current_response.links.should respond_to(:next)
+        end
+
+        it "responds to .alternate" do
+          current_response.links.should respond_to(:alternate)
+        end
+
+        it "responds to .rel" do
+          current_response.links.should respond_to(:rel)
+        end
+      end
+    end
+
+    context "#all_movie_reviews" do
+      let(:current_response) { vinegar.all_movie_reviews(auth["movie_id"]) }
+
+      it "returns the all_movie_review response" do
+        current_response.should_not be_nil
+      end
+    end
+
+    context "#top_critic_movie_reviews" do
+      let(:current_response) { vinegar.top_critic_movie_reviews(auth["movie_id"]) }
+
+      it "returns the top_critic_movie_review response" do
+        current_response.should_not be_nil
+      end
+    end
+
+    context "#dvd_movie_reviews" do
+      let(:current_response) { vinegar.dvd_movie_reviews(auth["movie_id"]) }
+
+      it "returns the dvd_movie_review response" do
+        current_response.should_not be_nil
+      end
+    end
+  end
+end

data/spec/vinegar/client/movies/similar_spec.rb

@@ -0,0 +1,183 @@
+require "spec_helper"
+
+auth = YAML::load(File.open(File.expand_path("../../../../fixtures/authentications.yml", __FILE__)))
+
+# Movie Search Spec
+describe Vinegar::Client do
+  before do
+    Vinegar.reset!
+    Vinegar.configure do |c|
+      c.api_key = auth["api_key"]
+    end
+  end
+
+  let(:vinegar) { Vinegar::Client.new(:api_key => auth["api_key"]) }
+
+  describe "#similar_movies", :vcr do
+    let(:current_response) { vinegar.similar_movies(auth["movie_id"]) }
+
+    it "returns the similar_movies response" do
+      current_response.should_not be_nil
+    end
+
+    describe "methods" do
+      it "responds to .movies" do
+        current_response.should respond_to(:movies)
+      end
+
+      it "responds to .links" do
+        current_response.should respond_to(:links)
+      end
+
+      it "responds to .link_template" do
+        current_response.should respond_to(:link_template)
+      end
+
+      describe "within each .movies item" do
+        it "responds to .id" do
+          current_response.movies.first.should respond_to(:id)
+        end
+
+        it "responds to .title" do
+          current_response.movies.first.should respond_to(:title)
+        end
+
+        it "responds to .year" do
+          current_response.movies.first.should respond_to(:year)
+        end
+
+        it "responds to .mpaa_rating" do
+          current_response.movies.first.should respond_to(:mpaa_rating)
+        end
+
+        it "responds to .runtime" do
+          current_response.movies.first.should respond_to(:runtime)
+        end
+
+        it "responds to .critics_consensus" do
+          current_response.movies.first.should respond_to(:critics_consensus)
+        end
+
+        it "responds to .release_dates" do
+          current_response.movies.first.should respond_to(:release_dates)
+        end
+
+        it "responds to .ratings" do
+          current_response.movies.first.should respond_to(:ratings)
+        end
+
+        it "responds to .synopsis" do
+          current_response.movies.first.should respond_to(:synopsis)
+        end
+
+        it "responds to .posters" do
+          current_response.movies.first.should respond_to(:posters)
+        end
+
+        it "responds to .abridged_cast" do
+          current_response.movies.first.should respond_to(:abridged_cast)
+        end
+
+        it "responds to .alternate_ids" do
+          current_response.movies.first.should respond_to(:alternate_ids)
+        end
+
+        it "responds to .links" do
+          current_response.should respond_to(:links)
+        end
+
+        describe "within .release_dates" do
+          it "responds to .theater" do
+            current_response.movies.first.release_dates.should respond_to(:theater)
+          end
+
+          it "responds to .dvd" do
+            current_response.movies.first.release_dates.should respond_to(:dvd)
+          end
+        end
+
+        describe "within .ratings" do
+          it "responds to .critics_rating" do
+            current_response.movies.first.ratings.should respond_to(:critics_rating)
+          end
+
+          it "responds to .critics_score" do
+            current_response.movies.first.ratings.should respond_to(:critics_score)
+          end
+
+          it "responds to .audience_rating" do
+            current_response.movies.first.ratings.should respond_to(:audience_rating)
+          end
+
+          it "responds to .audience_score" do
+            current_response.movies.first.ratings.should respond_to(:audience_score)
+          end
+        end
+
+        describe "within .posters" do
+          it "responds to .thumbnail" do
+            current_response.movies.first.posters.should respond_to(:thumbnail)
+          end
+
+          it "responds to .profile" do
+            current_response.movies.first.posters.should respond_to(:profile)
+          end
+
+          it "responds to .detailed" do
+            current_response.movies.first.posters.should respond_to(:detailed)
+          end
+
+          it "responds to .original" do
+            current_response.movies.first.posters.should respond_to(:original)
+          end
+        end
+
+        describe "within each .abridged_cast item" do
+          it "responds to .name" do
+            current_response.movies.first.abridged_cast.first.should respond_to(:name)
+          end
+
+          it "responds to .characters" do
+            current_response.movies.first.abridged_cast.first.should respond_to(:characters)
+          end
+        end
+
+        describe "within .links" do
+          it "responds to .self" do
+            current_response.movies.first.links.should respond_to(:self)
+          end
+
+          it "responds to .alternate" do
+            current_response.movies.first.links.should respond_to(:alternate)
+          end
+
+          it "responds to .cast" do
+            current_response.movies.first.links.should respond_to(:cast)
+          end
+
+          it "responds to .clips" do
+            current_response.movies.first.links.should respond_to(:clips)
+          end
+
+          it "responds to .reviews" do
+            current_response.movies.first.links.should respond_to(:reviews)
+          end
+
+          it "responds to .similar" do
+            current_response.movies.first.links.should respond_to(:similar)
+          end
+        end
+      end
+
+      describe "within .links" do
+        it "responds to .rel" do
+          current_response.links.should respond_to(:rel)
+        end
+
+        it "responds to .self" do
+          current_response.links.should respond_to(:self)
+        end
+      end
+    end
+  end
+end