rotten 0.3.0 → 0.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rotten (0.2.0)
+    rotten (0.3.0)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -10,17 +10,35 @@
     movie.reviews
     movie.cast
     
-    # list upcoming movies
+    # List upcoming movies
     Rotten::Movie.upcoming
 
-    # list movies opening this week
+    # List movies in theatres now
+    Rotten::Movie.in_theatres
+
+    # List movies opening this week
     Rotten::Movie.opening
 
+    # List movies coming to dvd this week
+    Rotten::Movie.dvd_release
+
+    # Use a file cache (baked in)
+    Rotten::Movie.enable_cache!
+    Rotten::Movie.search "What about bob?"  # Hits API
+    Rotten::Movie.search "What about bob?"  # Hits on-disk cache
+
+    # Custom cache. Should respond to #read & #write. Recommended over included cache.
+    Rotten::Movie.cache= ActiveSupport::Cache::MemoryStore.new
+    Rotten::Movie.search "Blue Velvet"  # Hits API
+    Rotten::Movie.search "Blue Velvet"  # Hits MemoryStore
+
+
 ### Features
 - Movie search
 - Movies opening this week
 - Movies upcoming
 - Movie reviews
+- Caching
 
 #### TODO
 - Implement all APIs

data/lib/rotten.rb

@@ -8,6 +8,7 @@ module Rotten
   autoload :Cast,   "rotten/cast"
   autoload :Review, "rotten/review"
   autoload :Movie,  "rotten/movie"
+  autoload :Cache,  "rotten/cache"
 
   def api_key=(val)
     @api_key = val

data/lib/rotten/api.rb

@@ -23,16 +23,60 @@ module Rotten
         '1.0'
       end
 
+      def use_cache?
+        @use_cache == true
+      end
+
+      def enable_cache!
+        @use_cache = true
+      end
+
+      def disable_cache!
+        @use_cache = false
+      end
+
+      def cache
+        @cache ||= Cache.new
+        @cache.store
+      end
+     
+      # Use your own cache, such as ActiveSupport::Cache::MemoryStore
+      def cache=(_cache)
+        enable_cache!
+        @cache = Cache.new :store => _cache
+      end
+
+      def get_from_cache url
+        if use_cache?
+          cache.read(url)
+        end
+      end
+
+      def write_to_cache url, data
+        cache.write(url, data) if use_cache?
+      end
+
       def get path, options={}
         if Rotten.api_key.nil?
           raise UndefinedApiKeyError, "Please define your API key with Rotten.api_key=(your_key)"
         end
 
-        url = url_for(path, options)
+        url    = url_for(path, options)
+        cached = get_from_cache(url)
+        if cached
+          puts "Using cache.."
+          if block_given?
+            return yield(cached)
+          else
+            return cached
+          end
+        end
+
         open( url ) do |response|
           data = JSON.parse(response.read)
+          write_to_cache url, data
           if block_given?
-            yield data
+            yield(data)
           else
             data
           end

data/lib/rotten/cache.rb

@@ -0,0 +1,25 @@
+# Capture JSON responses and re-use them
+# Works with any cache store that accepts the "read" and "write" methods
+# TODO method_missing should hit the @store
+
+module Rotten
+  autoload :SimpleCache, "rotten/simple_cache.rb"
+
+  class Cache
+
+    attr_reader :store
+    def initialize options={}
+      @store = options.delete(:store) || SimpleCache.new(options)
+    end
+
+    def read key
+      @store.read key
+    end
+    alias_method :get, :read
+
+    def write key, value
+      @store.write key, value
+    end
+    alias_method :set, :write
+  end
+end

data/lib/rotten/cast.rb

@@ -17,8 +17,6 @@ module Rotten
       @characters[index]
     end
 
-    def first; at[0]; end
-
     def process array
       array.each do |hash|
         actor      =  @actors.detect{|a| a.name == hash["name"] } || a=Actor.new; a.attributes=hash

data/lib/rotten/entity.rb

@@ -0,0 +1,18 @@
+module Rotten
+  require "ostruct"
+  class Entity < OpenStruct
+    class << self
+      def from_json(json)
+        e = new
+        e.attributes = json
+        e
+      end
+    end
+
+    def attributes= hash={}
+      hash.each_pair do |k,v|
+        instance_variable_get("@table")[k.to_sym] = v
+      end
+    end
+  end
+end

data/lib/rotten/movie.rb

@@ -12,6 +12,15 @@ module Rotten
         fetch "lists/movies/upcoming", options
       end
 
+      def dvd_releases options={}
+        fetch "lists/dvds/new_releases", options
+      end
+
+      def in_theaters options={}
+        fetch "lists/movies/in_theaters", options
+      end
+      alias_method :in_theatres, :in_theaters
+
       def search phrase, options={}
         options.delete :q
         options[:q] = phrase
@@ -23,7 +32,7 @@ module Rotten
         if json.is_a?(Array)
           json.map{|m| extract_movie_info(m) }
         else
-          return Movie.new(json)
+          Movie.new(json)
         end
       end
 

data/lib/rotten/review.rb

@@ -0,0 +1,4 @@
+module Rotten
+  class Review < Entity
+  end
+end

data/lib/rotten/simple_cache.rb

@@ -0,0 +1,30 @@
+module Rotten
+  class SimpleCache
+    attr_reader :cache_file
+    def initialize options={}
+      require "yaml"
+      if options[:cache_path] && File.exists?(options[:cache_path])
+        @cache_file = options[:cache_path]
+        @data = YAML.load_file @cache_file || {}
+      else
+        require "tempfile"
+        @cache_file = Tempfile.new "__rotten"
+        @data = YAML.load_file(@cache_file) || {}
+      end
+    end
+
+    def read key
+      @data[key.to_s]
+    end
+
+    def write key, value
+      @data[key.to_s] = value
+      save_to_disk
+    end
+
+    private
+    def save_to_disk
+      File.open(@cache_file, "w"){|f| f.puts(YAML.dump(@data)) }
+    end
+  end
+end

data/lib/rotten/version.rb

@@ -1,3 +1,3 @@
 module Rotten
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/cache_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe Rotten::Cache do
+  context ".new" do
+    context "when :store is not given" do
+      it "should set the store to SimpleCache" do
+        Rotten::Cache.new.store.class.should == Rotten::SimpleCache 
+      end
+    end
+  end
+
+  context "#read" do
+    before :each do
+      @cache = Rotten::SimpleCache.new
+      @cache.write :name, "bob"
+    end
+
+    context "given a key" do
+      it "should read the key from the cache" do
+        @cache.read(:name).should == "bob"
+        YAML.load(@cache.cache_file).should == {"name" => "bob"}
+      end
+    end
+  end
+
+  context "#write" do
+    before :each do
+      @cache = Rotten::SimpleCache.new
+      @cache.write :name, "hank"
+    end
+    context "given a key/value" do
+      it "should write the data to the cache"  do
+        YAML.load(@cache.cache_file).should == {"name" => "hank"}
+      end
+    end
+  end
+
+  context "hooked into Rotten::Movie" do
+    before :each do
+      Rotten::Movie.enable_cache!
+      simulate "movies/search", "search.json", :q => "There Will Be Blood"
+      #TODO figure out how open uri uses Net::HTTP for better tests
+      Net::HTTP.stub(:open){ raise }
+      Net::HTTP.stub(:start){ raise }
+      Net::HTTP.stub(:get){ raise }
+    end
+
+    it "should fetch from the cache" do
+      Rotten::Movie.search("There Will Be Blood").should be_an_instance_of(Array)
+      json = JSON.parse(File.read( File.join(fixture_path, "search.json") ) )
+      YAML.load(Rotten::Movie.cache.cache_file)["http://api.rottentomatoes.com/api/public/v1.0/movies/search.json?apikey=1234567890&q=There%20Will%20Be%20Blood"]["movies"].should ==  json["movies"]
+    end
+  end
+end

data/spec/fixtures/reviews.json

@@ -0,0 +1 @@
+{"total":41,"reviews":[{"critic":"Bob Mondello","date":"2008-10-18","publication":"NPR.org","quote":"This sometimes magnificent, decidedly strange film is a portrait of a terrible, rapacious man.","links":{"review":"http://www.npr.org/templates/story/story.php?storyId=17628099"}},{"critic":"Richard Schickel","date":"2008-10-18","publication":"TIME Magazine","quote":"One of the most wholly original American movies ever made.","links":{"review":"http://www.time.com/time/arts/article/0,8599,1698168,00.html"}},{"critic":"Christopher Orr","date":"2008-09-18","publication":"New Republic","quote":"There Will Be Blood establishes itself as a film of Darwinian ferocity, a stark and pitiless parable of American capitalism.","links":{"review":"http://www.tnr.com/booksarts/story.html?id=ba49de78-d44a-4963-9d96-65ef4fef9e21"}},{"critic":"Jonathan F. Richards","date":"2008-02-05","publication":"Film.com","quote":"Daniel Day-Lewis bestrides the narrow world like a colossus as Daniel Plainview, a turn-of-the-last-century prospector for gold and silver who stumbles upon oil in rural California and goes after it with the ferocity, focus, and ethical sensitivity of a f","links":{"review":"http://www.filmfreak.be/index.php?module=filmfreak&func=viewpub&tid=9&pid=420&title=There.Will.Be.Blood"}},{"critic":"Christy Lemire","date":"2008-01-18","publication":"Associated Press","quote":"Someday, we're probably going to look back at There Will Be Blood, Paul Thomas Anderson's epic about greed, lies, manipulation and insanity, and call it his masterpiece.","links":{}},{"critic":"Roger Moore","date":"2008-01-18","original_score":"4/5","publication":"Orlando Sentinel","quote":"It's oil, and a West that was just discovering it, that makes There Will Be Blood intriguing. But it's Day-Lewis who draws us in.","links":{"review":"http://www.orlandosentinel.com/entertainment/movies/orl-db-moviereviews-searchresults,0,3279701,results.formprofile?turbine_cdb_lib__cdb_01_txt=There%20Will%20Be%20Blood&Find+it%21=Submit+Query"}},{"critic":"Amy Biancolli","date":"2008-01-11","original_score":"3.5/4","publication":"Houston Chronicle","quote":"As an incurable romantic, I hold out hope that Anderson's flawed but phenomenal feat here marks the start of a new, mature stage in a long career. He has genius in him. So does the movie -- before its ending.","links":{"review":"http://www.chron.com/disp/story.mpl/ent/movies/reviews/5320054.html"}},{"critic":"Adam Graham","date":"2008-01-11","original_score":"B-","publication":"Detroit News","quote":"A maddening epic with a towering, bravura performance from star Daniel Day-Lewis, There Will Be Blood will rattle your brain for weeks, even months after you see it.","links":{"review":"http://www.detnews.com/apps/pbcs.dll/article?AID=/20080111/ENT02/801110391/1034/ENT02"}},{"critic":"Peter Travers","date":"2008-01-08","original_score":"4/4","publication":"Rolling Stone","quote":"There Will Be Blood hits with hurricane force. Lovers of formula and sugarcoating will hate it. Screw them. In terms of excitement, imagination and rule-busting experimentation, it's a gusher.","links":{}},{"critic":"Richard Roeper","date":"2008-01-07","publication":"Ebert & Roeper","quote":"Filmmaking at the highest level.","links":{}},{"critic":"Michael Phillips","date":"2008-01-04","original_score":"4/4","publication":"Chicago Tribune","quote":"There Will Be Blood reminds us that the greatest screen performances don't settle for capturing one trait, a dominant emotion or an easy way in.","links":{"review":"http://chicago.metromix.com/movies/movie_review/movie-review-there-will/276085/content"}},{"critic":"Peter Howell","date":"2008-01-04","original_score":"3.5/4","publication":"Toronto Star","quote":"There Will Be Blood, the astounding new film by Paul Thomas Anderson, is Horatio Alger by way of Faust.","links":{"review":"http://www.thestar.com/entertainment/Movies/article/290905"}},{"critic":"Mick LaSalle","date":"2008-01-04","original_score":"2.5/4","publication":"San Francisco Chronicle","quote":"Individual scenes and sequences are too strange, haunting and emotionally right for the film to be dismissed. There should be no attempt or temptation to dismiss it.","links":{"review":"http://www.sfgate.com/cgi-bin/article.cgi?file=/c/a/2008/01/04/DDVCU8QKP.DTL&type=movies"}},{"critic":"Liam Lacey","date":"2008-01-04","original_score":"3.5/4","publication":"Globe and Mail","quote":"Conjure up the maddest despot scene you can remember and you might get a sense of the seismic register of Day-Lewis's extravagant performance. Watch and marvel, though you may have to suspend your disbelief from the top of an oil derrick.","links":{"review":"http://www.theglobeandmail.com/servlet/story/RTGAM.20080103.blood04nat/BNStory/Entertainment/home"}},{"critic":"Lisa Kennedy","date":"2008-01-04","original_score":"4/4","publication":"Denver Post","quote":"If [Day-Lewis] does not win the Academy Award for this protean portrayal, it will be because he's won before. Or because his gift, his discipline, is so daunting it can be confounding.","links":{"review":"http://www.denverpost.com/movies/ci_7866021"}},{"critic":"Chris Vognar","date":"2008-01-04","original_score":"A-","publication":"Dallas Morning News","quote":"A haunting enigma that refuses to conform to any recognizable pattern, period or otherwise. I suppose you could see it as a descendent of Citizen Kane. But such comparisons aren't really fair to either film.","links":{"review":"http://www.guidelive.com/portal/page?_pageid=33,97283&_dad=portal&_schema=PORTAL&item_id=62157"}},{"critic":"Wesley Morris","date":"2008-01-04","original_score":"4/4","publication":"Boston Globe","quote":"There Will Be Blood is anti-state of the art. It's the work of an analog filmmaker railing against an increasingly digitized world. In that sense, the movie is idiosyncratic, too: vintage visionary stuff. It's physical and tactile.","links":{"review":"http://www.boston.com/movies/display?display=movie&id=10610"}},{"critic":"Roger Ebert","date":"2008-01-04","original_score":"3.5/4","publication":"Chicago Sun-Times","quote":"A force beyond categories.","links":{"review":"http://rogerebert.suntimes.com/apps/pbcs.dll/article?AID=/20080103/REVIEWS/801030301"}},{"critic":"Ann Hornaday","date":"2008-01-04","publication":"Washington Post","quote":"Paul Thomas Anderson becomes California's certified cinematic poet laureate with There Will Be Blood.","links":{"review":"http://www.washingtonpost.com/wp-dyn/content/article/2008/01/03/AR2008010304142.html"}},{"critic":"Colin Covert","date":"2008-01-04","original_score":"4/4","publication":"Minneapolis Star Tribune","quote":"A work of stunning intelligence and dramatic sweep, a portrait of a young nation struggling to find itself, torn between religious and business values.","links":{"review":"http://www.startribune.http://www.startribune.com/entertainment/movies/13018431.htmlcom/movies/"}}],"links":{"self":"http://api.rottentomatoes.com/api/public/v1.0/movies/770671487/reviews.json?review_type=topCritic&page_limit=20&country=us&page=1","next":"http://api.rottentomatoes.com/api/public/v1.0/movies/770671487/reviews.json?review_type=topCritic&page_limit=20&country=us&page=2","alternate":"http://www.rottentomatoes.com/m/there_will_be_blood/#reviews","rel":"http://api.rottentomatoes.com/api/public/v1.0/movies/770671487.json"},"link_template":"http://api.rottentomatoes.com/api/public/v1.0/movies/{movie-id}/reviews.json?review_type={top_critic|all|dvd}&page_limit={results-per-page}&page={page-number}&country={country-code}"}

data/spec/movie_spec.rb

@@ -3,9 +3,9 @@ require "spec_helper"
 describe Rotten::Movie do
   context "#cast" do
     before :each do
-      simulate_movie_search
+      simulate "movies/search", "search.json", :q => "There Will Be Blood"
       @movie = Rotten::Movie.search("There Will Be Blood").pop
-      simulate_full_cast(@movie)
+      simulate "movies/#{@movie.id}/cast", "cast.json"
     end
 
     context "sent :full" do
@@ -18,9 +18,9 @@ describe Rotten::Movie do
 
   context "#reviews" do
     before :each do
-      simulate_movie_search
+      simulate "movies/search", "search.json", :q => "There Will Be Blood"
       @movie = Rotten::Movie.search("There Will Be Blood").pop
-      simulate_movie_reviews(@movie)
+      simulate "movies/#{@movie.id}/reviews", "reviews.json"
     end
 
     it "should return an array of Review" do
@@ -28,10 +28,30 @@ describe Rotten::Movie do
       @movie.reviews.shift.should be_an_instance_of(Rotten::Review)
     end
   end
+
+  context ".dvd_releases" do
+    before :each do
+      simulate "lists/dvds/new_releases", "movie_openings.json"
+    end
+
+    it "should return an array" do
+      Rotten::Movie.dvd_releases.should be_an_instance_of(Array)
+    end 
+  end
+
+  context ".in_theaters" do
+    before :each do
+      simulate "lists/movies/in_theaters", "movie_openings.json"
+    end
+
+    it "should return an array" do
+      Rotten::Movie.in_theatres.should be_an_instance_of(Array)
+    end 
+  end
   
   context ".opening" do
     before :each do
-      simulate_movie_openings
+      simulate "lists/movies/opening", "movie_openings.json"
     end
 
     it "should return an array" do
@@ -53,7 +73,7 @@ describe Rotten::Movie do
 
   context ".search" do
     before :each do
-      simulate_movie_search
+      simulate "movies/search", "search.json", :q => "There Will Be Blood"
     end
 
     it "should return an array" do
@@ -67,7 +87,7 @@ describe Rotten::Movie do
 
   context "when api_key is undefined" do
     it "should raise error" do
-      simulate_movie_openings
+      simulate "lists/movies/opening", "movie_openings.json"
       Rotten.api_key = nil
       lambda{ Rotten::Movie.opening }.should raise_error(Rotten::Api::UndefinedApiKeyError)
     end 

data/spec/spec_helper.rb

@@ -9,27 +9,11 @@ RSpec.configure do |config|
     File.join( File.dirname(__FILE__), "fixtures" )
   end
 
-  def simulate_movie_openings
-    FakeWeb.register_uri(:get, Rotten::Movie.url_for("lists/movies/opening"),
-                         :body => File.read( File.join(fixture_path, "movie_openings.json") ))
+  def simulate(path, fixture, options={})
+    FakeWeb.register_uri(:get, Rotten::Movie.url_for(path, options),
+                         :body => File.read( File.join(fixture_path, fixture)) )
   end
 
-  def simulate_movie_search
-    FakeWeb.register_uri(:get, Rotten::Movie.url_for("movies/search", :q => "There Will Be Blood"), 
-                         :body => File.read( File.join(fixture_path, "search.json") ))
-  end
-
-  def simulate_movie_reviews(movie)
-    FakeWeb.register_uri(:get, Rotten::Movie.url_for("movies/#{movie.id}/reviews"), 
-                         :body => File.read( File.join(fixture_path, "reviews.json") ))
-  end
-
-  def simulate_full_cast(movie)
-    FakeWeb.register_uri(:get, Rotten::Movie.url_for("movies/#{movie.id}/cast"),
-                         :body => File.read( File.join(fixture_path, "cast.json") ))
-  end
-
-
   config.before(:each) do
     Rotten.api_key = "1234567890"
   end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - James Cook
@@ -61,12 +61,18 @@ files:
 - lib/rotten.rb
 - lib/rotten/actor.rb
 - lib/rotten/api.rb
+- lib/rotten/cache.rb
 - lib/rotten/cast.rb
+- lib/rotten/entity.rb
 - lib/rotten/movie.rb
+- lib/rotten/review.rb
+- lib/rotten/simple_cache.rb
 - lib/rotten/version.rb
 - rotten.gemspec
+- spec/cache_spec.rb
 - spec/fixtures/cast.json
 - spec/fixtures/movie_openings.json
+- spec/fixtures/reviews.json
 - spec/fixtures/search.json
 - spec/movie_spec.rb
 - spec/spec_helper.rb
@@ -105,8 +111,10 @@ signing_key:
 specification_version: 3
 summary: Wrapper for Rotten Tomatoes API
 test_files: 
+- spec/cache_spec.rb
 - spec/fixtures/cast.json
 - spec/fixtures/movie_openings.json
+- spec/fixtures/reviews.json
 - spec/fixtures/search.json
 - spec/movie_spec.rb
 - spec/spec_helper.rb