rotten 0.4.0 → 0.5.0

data/Gemfile.lock

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

data/README.md

@@ -6,7 +6,7 @@
     Rotten.api_key = 'your_key'
 
     # Info about a specific film
-    movies = Rotten::Movies.search("There will be blood").pop
+    movies = Rotten::Movies.search("There will be blood")[0]
     movie.reviews
     movie.cast
     
@@ -32,7 +32,25 @@
     Rotten::Movie.search "Blue Velvet"  # Hits API
     Rotten::Movie.search "Blue Velvet"  # Hits MemoryStore
 
+Most API calls return multiple results. They are encapsulated in a SearchResult class. They are instances of Set with some Array sugar added. Example:
 
+    Rotten::Movie.upcoming
+    => <Rotten::SearchResult total=14 more='false'>
+    Rotten::Movie.upcoming[0]
+    => <Rotten::Movie title='Water for Elephants' id='771204250'>
+    Rotten::Movie.upcoming.to_a
+    => <Rotten::Movie title='Water for Elephants' id='771204250'><Rotten::Movie title (you get the idea)...
+
+    results = Rotten::Movie.search "bob"
+    => <Rotten::SearchResult total=242 more='true'>
+    results.size
+    => 50
+    results.next #grab the next 50
+    results.size
+    => 100
+
+SearchResult works with caching, albeit a little wonky as the URLs are not grouped together.
+   
 ### Features
 - Movie search
 - Movies opening this week
@@ -40,10 +58,6 @@
 - Movie reviews
 - Caching
 
-#### TODO
-- Implement all APIs
-- More tests
-
 #### Copyright
 
 Rotten is licensed under the MIT license.

data/lib/rotten.rb

@@ -2,13 +2,14 @@ lib = File.expand_path('../', __FILE__)
 $:.unshift lib unless $:.include?(lib)
 
 module Rotten
-  autoload :Entity, "rotten/entity"
-  autoload :Api,    "rotten/api"
-  autoload :Actor,  "rotten/actor"
-  autoload :Cast,   "rotten/cast"
-  autoload :Review, "rotten/review"
-  autoload :Movie,  "rotten/movie"
-  autoload :Cache,  "rotten/cache"
+  autoload :Entity,       "rotten/entity"
+  autoload :Api,          "rotten/api"
+  autoload :Actor,        "rotten/actor"
+  autoload :Cast,         "rotten/cast"
+  autoload :Review,       "rotten/review"
+  autoload :Movie,        "rotten/movie"
+  autoload :Cache,        "rotten/cache"
+  autoload :SearchResult, "rotten/search_result"
 
   def api_key=(val)
     @api_key = val

data/lib/rotten/api.rb

@@ -11,6 +11,10 @@ module Rotten
 
     def self.included(base)
       base.send :extend,  ClassMethods
+      base.send :include, InstanceMethods
+    end
+
+    module InstanceMethods
     end
 
     module ClassMethods
@@ -23,6 +27,10 @@ module Rotten
         '1.0'
       end
 
+      def maximum_per_page
+        '50'
+      end
+
       def use_cache?
         @use_cache == true
       end
@@ -64,7 +72,6 @@ module Rotten
         url    = url_for(path, options)
         cached = get_from_cache(url)
         if cached
-          puts "Using cache.."
           if block_given?
             return yield(cached)
           else
@@ -88,12 +95,29 @@ module Rotten
         
         params = ''
         if options.keys.any?
-          options.each_pair{|k,v| params << "#{k}=#{URI.escape(v)}&" }
+          options.each_pair{|k,v| params << "#{k}=#{URI.escape(v.to_s)}&" }
         end
         params.chomp! "&" if params
 
         "#{endpoint}/#{path}.json?apikey=#{Rotten.api_key}&#{params}"
       end
+
+      def extract_info klass, json={}
+        if json.is_a?(Array)
+          json.map{|m| extract_info(klass, m) }
+        else
+          klass.new(json)
+        end
+      end
+
+      protected
+      def warn_about_unknown_options hash
+        known   = [:page_limit, :page, :q, :country, :review_type, :apikey]
+        unknown = hash.keys.map{|k| k.to_sym} - known
+        if unknown.any?
+          puts "[rotten] Unknown API options: #{unknown.join(',')}."
+        end
+      end
     end
   end
 end

data/lib/rotten/cache.rb

@@ -1,6 +1,5 @@
 # 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"
@@ -21,5 +20,9 @@ module Rotten
       @store.write key, value
     end
     alias_method :set, :write
+
+    def method_missing sym, *args, &block
+      @store.send sym, *args, &block
+    end
   end
 end

data/lib/rotten/movie.rb

@@ -28,18 +28,22 @@ module Rotten
         fetch "movies/search", options
       end
 
-      def extract_movie_info json={}
-        if json.is_a?(Array)
-          json.map{|m| extract_movie_info(m) }
-        else
-          Movie.new(json)
-        end
+      def find_first phrase, options={}
+        (search phrase, options.merge(:page_limit => 1))[0]
       end
 
       protected
       def fetch path, options, json_start="movies"
+        warn_about_unknown_options(options)
+        options.merge!(:page_limit => maximum_per_page) unless options.key?(:page_limit)
+
+        if options.key?(:page_limit) && options[:page_limit].to_i > 50
+          puts "[rotten] Page limits higher than 50 may not work."
+        end
+
         result = get(path, options) do |json|
-          extract_movie_info(json[json_start])
+          #extract_info(Movie, json[json_start])
+          SearchResult.new( :path => path, :api_options => options, :class => Movie, :json => json )
         end
       end
     end
@@ -62,8 +66,9 @@ module Rotten
     # Moview reviews
     # @return [Array]
     def reviews options={}
-      Movie.get "movies/#{id}/reviews", options do |json|
-        json["reviews"].map{|review| Review.from_json(review) }
+      path = "movies/#{id}/reviews"
+      Movie.get path, options.merge(:page_limit => Movie.maximum_per_page) do |json|
+        SearchResult.new( :path => path, :api_options => options, :class => Review, :json => json, :start => "reviews" )
       end
     end
 

data/lib/rotten/review.rb

@@ -1,4 +1,5 @@
 module Rotten
   class Review < Entity
+    include Api
   end
 end

data/lib/rotten/search_result.rb

@@ -0,0 +1,59 @@
+# Encapsulates APIs that return a 'total'
+module Rotten
+  require "set"
+  class SearchResult < Set
+    include Api
+
+    #def initialize url, json={}, start='movies'
+    def initialize options={}
+      @path   = options[:path]
+      @api_options  = options[:api_options] || {}
+      @start  = options[:start] || 'movies'
+      @json   = options[:json]
+      @klass  = options[:class]
+      @proper = @klass.extract_info(@klass, @json[@start])
+
+      super([@proper].flatten)
+    end
+
+    def inspect
+      "<Rotten::SearchResult total=#{total} more='#{more?}'>"
+    end 
+
+    def total
+      @total ||= @json['total'].nil? ? size : @json['total'].to_i
+    end
+
+    def more?
+      total > size
+    end
+
+    # Make the Set more array-like and allow index-based access
+    def [](index)
+      to_a[index]
+    end
+    
+    # Cache Set#to_a and return it. Calling #next resets it.
+    def to_a
+      @to_a ||= super.to_a
+    end
+
+    def current_page
+      @api_options.delete(:page) || 1
+    end
+
+    # Fetch additional results, while more exist.
+    def next
+      if more?
+        @api_options.merge! :page => current_page + 1
+        @api_options.merge! :page_limit => Movie.maximum_per_page
+        @klass.get @path, @api_options do |json|
+           [@klass.extract_info(@klass, json[@start])].flatten.each do |x|
+             add x
+           end
+           @to_a = nil
+        end
+      end
+    end
+  end
+end

data/lib/rotten/version.rb

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

data/spec/cache_spec.rb

@@ -46,9 +46,9 @@ describe Rotten::Cache do
     end
 
     it "should fetch from the cache" do
-      Rotten::Movie.search("There Will Be Blood").should be_an_instance_of(Array)
+      Rotten::Movie.search("There Will Be Blood").should be_an_instance_of(Rotten::SearchResult)
       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"]
+      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&page_limit=50"]["movies"].should ==  json["movies"]
     end
   end
 end

data/spec/movie_spec.rb

@@ -4,8 +4,8 @@ describe Rotten::Movie do
   context "#cast" do
     before :each do
       simulate "movies/search", "search.json", :q => "There Will Be Blood"
-      @movie = Rotten::Movie.search("There Will Be Blood").pop
-      simulate "movies/#{@movie.id}/cast", "cast.json"
+      @movie = Rotten::Movie.search("There Will Be Blood")[-1]
+      simulate "movies/#{@movie.id}/cast", "cast.json", :page_limit => nil
     end
 
     context "sent :full" do
@@ -19,13 +19,13 @@ describe Rotten::Movie do
   context "#reviews" do
     before :each do
       simulate "movies/search", "search.json", :q => "There Will Be Blood"
-      @movie = Rotten::Movie.search("There Will Be Blood").pop
+      @movie = Rotten::Movie.search("There Will Be Blood")[-1]
       simulate "movies/#{@movie.id}/reviews", "reviews.json"
     end
 
     it "should return an array of Review" do
-      @movie.reviews.should be_an_instance_of(Array)
-      @movie.reviews.shift.should be_an_instance_of(Rotten::Review)
+      @movie.reviews.should be_an_instance_of(Rotten::SearchResult)
+      @movie.reviews[0].should be_an_instance_of(Rotten::Review)
     end
   end
 
@@ -35,7 +35,7 @@ describe Rotten::Movie do
     end
 
     it "should return an array" do
-      Rotten::Movie.dvd_releases.should be_an_instance_of(Array)
+      Rotten::Movie.dvd_releases.should be_an_instance_of(Rotten::SearchResult)
     end 
   end
 
@@ -45,7 +45,7 @@ describe Rotten::Movie do
     end
 
     it "should return an array" do
-      Rotten::Movie.in_theatres.should be_an_instance_of(Array)
+      Rotten::Movie.in_theatres.should be_an_instance_of(Rotten::SearchResult)
     end 
   end
   
@@ -55,7 +55,7 @@ describe Rotten::Movie do
     end
 
     it "should return an array" do
-      Rotten::Movie.opening.should be_an_instance_of(Array)
+      Rotten::Movie.opening.should be_an_instance_of(Rotten::SearchResult)
     end 
 
     it "should contain a movie" do
@@ -77,7 +77,7 @@ describe Rotten::Movie do
     end
 
     it "should return an array" do
-      Rotten::Movie.search("There Will Be Blood").should be_an_instance_of(Array)
+      Rotten::Movie.search("There Will Be Blood").should be_an_instance_of(Rotten::SearchResult)
     end 
 
     it "should contain a movie" do

data/spec/spec_helper.rb

@@ -10,6 +10,13 @@ RSpec.configure do |config|
   end
 
   def simulate(path, fixture, options={})
+    if options.member?(:page_limit)
+      if options[:page_limit].nil?
+        options.delete :page_limit
+      end
+    else
+      options.merge!(:page_limit => 50)
+    end
     FakeWeb.register_uri(:get, Rotten::Movie.url_for(path, options),
                          :body => File.read( File.join(fixture_path, fixture)) )
   end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - James Cook
@@ -66,6 +66,7 @@ files:
 - lib/rotten/entity.rb
 - lib/rotten/movie.rb
 - lib/rotten/review.rb
+- lib/rotten/search_result.rb
 - lib/rotten/simple_cache.rb
 - lib/rotten/version.rb
 - rotten.gemspec