tomato_power 0.0.5

data/.gitignore

@@ -0,0 +1,18 @@
+*.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/config/tomato_power_config.yaml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format Fuubar

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sean Kay
+
+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,57 @@
+# TomatoPower
+
+TomatoPower is a wrapper for the
+[Rotten Tomatoes API](http://developer.rottentomatoes.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tomato_power'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tomato_power
+
+## Usage
+
+1. Create an instance of the `TomatoPower` client.
+  
+    client = TomatoPower.new <your_rotten_tomatoes_api_key>
+
+2. Start using the gem!
+
+## Examples
+Searching for a movie returns an array of `TomatoPower::Movie` objects.
+
+    >> movies = client.search_by_title("The Dark Knight")
+    >> movies[0].title
+    => "The Dark Knight"
+
+Easily access information from movies and cast members. 
+
+    >> actors = movie.full_cast
+    >> actor = actors[0]
+    >> actor.name
+    => "Christian Bale"
+    >> actor.characters
+    => ["Batman/Bruce Wayne"]
+
+Search for similar movies
+
+    >> movies = client.search_by_title("The Dark Knight")
+    >> similar_movies = movies[0].similar
+    >> similar_movies[0].title 
+    => "Batman Begins"
+
+## 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/tomato_power/api/api.rb

@@ -0,0 +1,97 @@
+require 'active_support/core_ext/hash'
+require 'open-uri'
+require 'json'
+
+module TomatoPower
+  class API
+    API_VERSION = 'v1.0'
+    MAX_PAGE_LIMIT = 50
+    BASE_URL = "http://api.rottentomatoes.com/api/public/#{API_VERSION}"
+    MOVIE_URL = "#{ BASE_URL }/movies/"
+
+    def initialize api_key
+      @api_key = api_key
+    end
+
+    #Defines methods in `TOMATO_METHODS`
+    # ==Parameters:
+    # options:
+    #   Hash of options allowed (#see tomato_methods.rb).
+    # 
+    def method_missing method, options={}
+      if TOMATO_METHODS.keys.include?(method)
+        self.class.send(:define_method, method) do |options={}|
+          if options_valid? method, options
+            fetch api_url TOMATO_METHODS[method][:url], options
+          end
+        end
+      else
+        super
+      end
+      self.send method, options
+    end
+
+    def respond_to? method
+      if TOMATO_METHODS.keys.include? method
+        true
+      else
+        super
+      end
+    end
+
+    private
+
+    def fetch url
+      tomato = get url
+      payload = TomatoPower::Parser::parse JSON.parse(tomato) 
+    end
+
+    def get url
+      open(url) do |f|
+        f.read
+      end
+    end
+
+    def options_valid? method, options={}
+      options.keys.each do |option|
+        if option == :page_limit && options[:page_limit] > MAX_PAGE_LIMIT
+          options[:pagelimit] = MAX_PAGE_LIMIT 
+        end
+        unless TOMATO_METHODS[method][:whitelist].include?(option)
+          raise ArgumentError.new(
+            "Invalid key: #{option} for #{method}.
+            Valid keys are #{TOMATO_METHODS[method][:whitelist]}."
+          )
+          false
+        end
+      end
+      true
+    end
+
+    def api_url endpoint, options={}
+      if movie_id = options[:movie_id]
+        options.delete :movie_id
+        movie_url endpoint, movie_id, options 
+      else
+        list_url endpoint, options
+      end
+    end
+
+    def movie_url endpoint, movie_id,  options={}
+      url = "#{MOVIE_URL}#{movie_id}#{endpoint}apikey=#{@api_key}#{request_params(options)}"
+    end
+
+    def list_url endpoint, options={}
+      url = "#{BASE_URL}#{endpoint}apikey=#{@api_key}#{request_params(options)}"
+    end
+
+    def request_params options ={}
+      params = ""
+      options.each_key do |key|
+        options[key] = URI.escape(options[key]) if options[key].is_a?(String)
+        params << "&#{key}=#{options[key]}" 
+      end
+      params
+    end
+  end
+end

data/lib/tomato_power/api/tomato_methods.rb

@@ -0,0 +1,82 @@
+# List of methods and whitelist of allowed options for the corresponding
+# RottenTomatoes API call.
+# ==
+#    rotten_tomatoes_api_method => 
+#    { 
+#       :url => "resource_url", 
+#       :whitelist => [allowed options] 
+#    }
+module TomatoPower
+  TOMATO_METHODS = {
+    :movies_search => 
+    {
+      :url       => "/movies.json?",
+      :whitelist => [:q, :page, :page_limit],
+    },
+    :box_office_movies => 
+    {
+      :url       => "/lists/movies/box_office.json?",
+      :whitelist => [:limit, :country]
+    },
+      :in_theaters_movies => 
+    {
+      :url       => "/lists/movies/in_theaters.json?",
+      :whitelist => [:page, :page_limit, :country]
+    },
+      :opening_movies => 
+    {
+      :url       => "/lists/movies/opening.json?",
+      :whitelist => [:limit, :country]
+    },
+      :upcoming_movies => 
+    {
+      :url       => "/lists/movies/upcoming.json?",
+      :whitelist => [:page, :page_limit, :country]
+    },
+      :top_rentals => 
+    { 
+      :url       => "/lists/dvds/top_rentals.json?",
+      :whitelist => [:limit, :country]
+    },
+      :current_release_dvds => 
+    {
+      :url       => "/lists/dvds/current_releases.json?",
+      :whitelist => [:page, :page_limit,:country]
+    }, 
+      :new_release_dvds => 
+    {
+      :url       => "/lists/dvds/new_releases.json?",
+      :whitelist => [:page, :page_limit, :country]
+    },
+      :upcoming_dvds => 
+    {
+      :url       => "/lists/dvds/upcoming.json?",
+      :whitelist => [:page, :page_limit, :country]
+    },
+      :movie_cast => 
+    {
+      :url       => "/cast.json?",
+      :whitelist => [:movie_id]
+    },
+      :movie_clips => 
+    {
+      :url       => "/clips.json?",
+      :whitelist => [:movie_id]
+    },
+      :movie_reviews => 
+    {
+      :url       => "/reviews.json?",
+      :whitelist => [:movie_id, :review_type, :page_limit, :page, :country]
+    },
+      :movie_similar => 
+    {
+      :url       => "/similar.json?",
+      :whitelist => [:movie_id]
+    },
+      :movie_alias => 
+    {
+      :url       => "/movie_alias.json?",
+      :whitelist => [:type, :id]
+    },
+  }
+end

data/lib/tomato_power/client.rb

@@ -0,0 +1,35 @@
+require 'forwardable'
+
+module TomatoPower
+  class Client
+
+    extend Forwardable
+
+    def initialize 
+      @api = TomatoPower::api
+    end
+
+    def_delegators :@api, 
+      :box_office_movies,
+      :opening_movies,
+      :upcoming_movies,
+      :top_rentals,
+      :current_release_dvds,
+      :new_release_dvds,
+      :upcoming_dvds
+    def_delegator :@api, :in_theaters_movies, :movies_in_theaters
+
+    def search_by_title(movie_title, options={})
+      options[:q] = movie_title
+      @api.movies_search(options)
+    end
+
+    def search_by_id(movie_id)
+      options = {}
+      options[:type] = 'imdb' #current only supports 'imdb' type
+      options[:id] = movie_id
+      @api.movie_alias(options)
+    end
+
+  end
+end

data/lib/tomato_power/helpers/helpers.rb

@@ -0,0 +1,12 @@
+require 'yaml'
+
+module Helpers
+  String.class_eval do
+    def is_valid_url?
+      uri = URI.parse self
+      uri.kind_of? URI::HTTP
+    rescue URI::InvalidURIError
+      false
+    end
+  end
+end

data/lib/tomato_power/helpers/parsers.rb

@@ -0,0 +1,28 @@
+module TomatoPower
+  module Parser
+    def self.parse json={}
+      payload =[]
+      if json["movies"]
+        json["movies"].each do |movie|
+          payload << Movie.new(movie)
+        end 
+      elsif json["cast"]
+        json["cast"].each do |actor|
+          payload << Actor.new(actor)
+        end
+      elsif json["clips"]
+        json["clips"].each do |clip|
+          payload << Clip.new(clip)
+        end
+      elsif json["reviews"]
+        json["reviews"].each do |review|
+          payload << Review.new(review)
+        end
+      else
+        payload << Movie.new(json) 
+      end
+      payload << "No Results" if payload.length < 1
+      payload
+    end
+  end
+end

data/lib/tomato_power/movie/actor.rb

@@ -0,0 +1,12 @@
+module TomatoPower
+  class Actor
+
+    attr_reader :id, :name, :characters
+
+    def initialize actor={}
+      @id = actor["id"]
+      @name = actor["name"]
+      @characters = actor["characters"]
+    end
+  end
+end

data/lib/tomato_power/movie/clip.rb

@@ -0,0 +1,10 @@
+module TomatoPower
+  class Clip
+    attr_reader :title, :duration, :thumbnail
+    def initialize clip={}
+      @title = clip["title"]
+      @duration = clip["duration"]
+      @thumbnail = clip["thumbnail"]
+    end
+  end
+end

data/lib/tomato_power/movie/movie.rb

@@ -0,0 +1,56 @@
+module TomatoPower
+  class Movie
+
+    attr_reader :id, :info, :abridged_cast, :title, :ratings, :mpaa_rating,
+      :runtime,:release_dates, :synopsis, :posters, :alternate_ids, :links, 
+      :studio, :abridged_directors
+
+    def initialize movie={}
+      @api = TomatoPower::api
+
+      @info = movie 
+      @id = movie["id"] 
+      @title = movie["title"]
+      @mpaa_rating = movie["mpaa_rating"]
+      @runtime = movie["runtime"]
+      @release_dates = movie["release_dates"]
+      @ratings = movie["ratings"]
+      @synopsis = movie["synopsis"]
+      @posters = movie["posters"]
+      @abridged_cast = movie["abridged_cast"]
+      @alternate_ids = movie["alternate_ids"]
+      @links = movie["links"]
+      @abridged_directors = movie["abridged_directors"]
+      @studio = movie["studio"]
+    end
+
+    MOVIE_METHOD_ALIAS = {
+      :full_cast => :movie_cast,
+      :clips => :movie_clips,
+      :reviews => :movie_reviews,
+      :similar => :movie_similar,
+      :alias => :movie_alias
+    }
+
+    def method_missing method, options={}
+      if MOVIE_METHOD_ALIAS.keys.include?(method)
+        method = MOVIE_METHOD_ALIAS[method]
+        self.class.send(:define_method, method) do |options={}|
+          options[:movie_id] = @id 
+          @api.send(method, options )
+        end
+      else
+        super
+      end
+      self.send method
+    end
+
+    def respond_to? method
+      if MOVIE_METHOD_ALIAS.keys.include? method
+        true
+      else
+        super
+      end
+    end
+  end
+end

data/lib/tomato_power/movie/review.rb

@@ -0,0 +1,15 @@
+module TomatoPower
+  class Review
+
+    attr_reader :critic, :date, :freshness, :publication, :quote, :links
+    def initialize review={}
+      @critic = review["critic"]
+      @date = review["date"]
+      @freshness = review["freshness"]
+      @publication = review["publication"]
+      @quote = review["quote"]
+      @links = review["links"]
+    end
+
+  end
+end

data/lib/tomato_power/version.rb

@@ -0,0 +1,3 @@
+module TomatoPower
+  VERSION = "0.0.5"
+end

data/lib/tomato_power.rb

@@ -0,0 +1,22 @@
+require "tomato_power/version"
+
+module TomatoPower
+  require File.join(File.expand_path(File.dirname(__FILE__)), 'tomato_power', 'client')
+  require File.join(File.expand_path(File.dirname(__FILE__)), 'tomato_power','api', 'api')
+  require File.join(File.expand_path(File.dirname(__FILE__)), 'tomato_power','api', 'tomato_methods')
+  require File.join(File.expand_path(File.dirname(__FILE__)), 'tomato_power','movie', 'actor')
+  require File.join(File.expand_path(File.dirname(__FILE__)), 'tomato_power', 'movie','clip')
+  require File.join(File.expand_path(File.dirname(__FILE__)), 'tomato_power', 'movie','movie')
+  require File.join(File.expand_path(File.dirname(__FILE__)), 'tomato_power', 'movie','review')
+  require File.join(File.expand_path(File.dirname(__FILE__)), 'tomato_power','helpers', 'helpers')
+  require File.join(File.expand_path(File.dirname(__FILE__)), 'tomato_power', 'helpers','parsers')
+
+  def self.new api_key=ENV.fetch("ROTTEN_TOMATOES_API_KEY")
+    self.api = API.new api_key
+    Client.new 
+  end
+
+  class << self
+    attr_accessor :api
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$: << File.join(File.dirname(__FILE__), "/../lib") 
+require 'rubygems'
+require 'support/vcr'
+require 'tomato_power'
+require 'unit_specs/helpers'

data/spec/support/sample_data/no_results

@@ -0,0 +1 @@
+{"total":0,"movies":[]}

data/spec/support/sample_data/sample_actor

@@ -0,0 +1,5 @@
+{
+  "id": "162655641",
+    "name": "Tom Hanks",
+    "characters": ["Woody"]
+}