ruby-tmdb 0.1.4 → 0.2.1

data/.gitignore

@@ -1 +1,2 @@
-*.gem
+*.gem
+test/setup/tmdb_api_key.txt

data/README.rdoc

@@ -1,12 +1,8 @@
 = ruby-tmdb
 
-ruby-tmdb is an ActiveRecord-style API wrapper for {TheMovieDB.org (TMDb)}[http://www.themoviedb.org/]. ruby-tmdb is designed to make common tasks much easier than they would be if dealing directly with the URL based API.
-
-=== Installation
-
-  gem install ruby-tmdb
+ruby-tmdb is an ActiveRecord-style API wrapper for {TheMovieDB.org (TMDb)}[http://www.themoviedb.org/]. ruby-tmdb is designed to streamline common tasks associated with finding information about movies and cast members.
   
-=== Example
+=== Examples
 
   require 'rubygems'
   require 'ruby-tmdb'
@@ -14,6 +10,9 @@ ruby-tmdb is an ActiveRecord-style API wrapper for {TheMovieDB.org (TMDb)}[http:
   # setup your API key
   Tmdb.api_key = "t478f8de5776c799de5a"
   
+  # setup your default language
+  Tmdb.default_language = "en"
+  
   @movie = TmdbMovie.find(:title => "Iron Man", :limit => 1)
   # => <OpenStruct>
   
@@ -26,39 +25,58 @@ ruby-tmdb is an ActiveRecord-style API wrapper for {TheMovieDB.org (TMDb)}[http:
   @movie.posters.first.data
   # => [binary blob representing JPEG]
   
-<<<<<<< HEAD
-  @actor = TmdbCast.find(:name => "Brad Pitt", :limit => 1)
-  # => <TmdbCast>
-=======
-=== Usage
+=== Installation
 
-ruby-tmdb provides 2 main objects that you will use to query the API
-  
-  TmdbMovie
-  TmdbCast
+For ease of use ruby-tmdb is packaged as a Rubygem. Installing it is as simple as:
+
+  gem install ruby-tmdb
   
-These objects provide access to movie and cast listing respectively.
+=== Usage
 
-Each object provides a find() method which accepts a number of options:
+There are 3 main methods you can use to get information about movies and cast members:
 
-  TmdbMovie.find(:id => 123, :title => "fight club", :imdb => 'tt0401792', :limit => 10, :expand_results => true)
+==== TmdbMovie.find([:id, :imdb, :title, :limit, :expand_results, :language])
 
+Find information about an individual movie, or a set of movies that share a similar title, eg:
 
-[:id]              specifies an individual movie via it's TMDb id
-[:title]           specifies a query string to look for in the movie titles
-[:imdb]            specifies an idividual movie via it's IMDB id
-[:limit]           specifies the maximum number of results to be returned
+  TmdbMovie.find(:title => "fight club", :limit => 10, :expand_results => true, :language => "en")
+  
+Parameters:
+
+[:id]              Specifies an individual movie via it's TMDb id
+[:title]           Specifies a query string to look for in the movie titles
+[:imdb]            Specifies an individual movie via it's IMDB id
+[:limit]           Specifies the maximum number of results to be returned
 [:expand_results]  The TMDb API by default returns only partial info for any API method that can return multiple results. When :expand_results is set to true ruby-tmdb automatically makes extra API calls to fetch the full information for each item. This can result in *very* slow requests though. If you only need basic information for a search listing then set this to false. Defaults to 'true'.
+[:language]        Allows you to override the default API language on a per-query basis.
+
+You must supply at least one of :id, :title, or :imdb. All other parameters are optional.
+
+==== TmdbMovie.browse([query_options],[:language, :expand_results])
+
+Find information about a set of movies grouped by one or more defined criteria, eg:
+  
+  TmdbMovie.browse(:order_by => "rating", :order => "desc", :genres => 18, :min_votes => 5, :page => 1, :per_page => 10, :language => "en", :expand_results => true)
   
+Parameters:
 
-  TmdbCast.find( :id => 123, :name => "Brad", :limit => 1, :expand_results => true)
+[query_options]    These are defined by the TMDB.org API, for more info on which options are available please have a look at the {'browse' API documentation}[http://api.themoviedb.org/2.1/methods/Movie.browse]
+[:expand_results]  See TmdbMovie
+[:language]        See TmdbMovie
   
->>>>>>> development
+==== TmdbCast.find([:id, :name, :limit, :expand_results, :language])
+
+Find information about an individual cast member, or a set of cast members sharing similar names, eg:
+
+  TmdbCast.find( :id => 123, :name => "Brad", :limit => 1, :expand_results => true, :language => "fr")
   
-[:id]              specifies an idividual cast member via their TMDb id
-[:name]            specifies a query string to look for in the cast names
-[:limit]           see TmdbMovie
-[:expand_results]  see TmdbMovie
+[:id]              Specifies an individual cast member via their TMDb id
+[:name]            Specifies a query string to look for in the cast names
+[:limit]           See TmdbMovie
+[:expand_results]  See TmdbMovie
+[:language]        See TmdbMovie
+
+You must supply at least one of :id or :name. All other parameters are optional.
 
 
 === Usage Examples
@@ -86,6 +104,10 @@ Find all cast members whose names match a given string:
 Find an individual cast member via their TMDb ID:
 
   @actor = TmdbCast.find(:id => 101)
+  
+Get the info for a movie in French:
+
+  @movie = TmdbMovie.find(:title => 'Sin City', :limit => 1, :language => "fr")
 
 
 === Item information
@@ -95,5 +117,6 @@ To find out more about the information each object offers on retrieved items hav
 === Author & Credits
 
 Author:: {Aaron Gough}[mailto:aaron@aarongough.com]
+Contributors:: {Alex Hayes}[https://github.com/alexhayes], {Alvaro Pereyra Rabanal}[https://github.com/xenda], {Linus Oleander}[https://github.com/oleander], {aristides}[https://github.com/aristides], {Robin Boutros}[https://github.com/niuage]
 
 Copyright (c) 2010 {Aaron Gough}[http://thingsaaronmade.com/] ({thingsaaronmade.com}[http://thingsaaronmade.com/]), released under the MIT license

data/Rakefile

@@ -18,6 +18,7 @@ begin
     gemspec.extra_rdoc_files = ['README.rdoc', 'MIT-LICENSE']
     gemspec.add_dependency( "deepopenstruct", ">= 0.1.2")
     gemspec.add_dependency( "json")
+    gemspec.add_dependency "addressable"
     gemspec.add_development_dependency "webmock"
   end
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.1

data/lib/ruby-tmdb/tmdb.rb

@@ -5,8 +5,10 @@ class Tmdb
   require 'cgi'
   require 'json'
   require 'deepopenstruct'
+  require "addressable/uri"
   
   @@api_key = ""
+  @@default_language = "en"
   @@api_response = {}
   
   def self.api_key
@@ -17,16 +19,44 @@ class Tmdb
     @@api_key = key
   end
   
+  def self.default_language
+    @@default_language
+  end
+  
+  def self.default_language=(language)
+    @@default_language = language
+  end
+  
   def self.base_api_url
     "http://api.themoviedb.org/2.1/"
   end
   
-  def self.api_call(method, data, language = "en")
+  def self.api_call(method, data = nil, language = nil)
     raise ArgumentError, "Tmdb.api_key must be set before using the API" if(Tmdb.api_key.nil? || Tmdb.api_key.empty?)
-    url = Tmdb.base_api_url + method + '/' + language + '/json/' + Tmdb.api_key + '/' + CGI::escape(data.to_s)
+    
+    language = language || @@default_language
+    if data.class == Hash
+      # Addressable can only handle hashes whose values respond to to_str, so lets be nice and convert things.
+      query_values = {}
+      data.each do |key,value|
+        if not value.respond_to?(:to_str) and value.respond_to?(:to_s)
+          query_values[key] = value.to_s
+        else
+          query_values[key] = value
+        end
+      end
+      uri = Addressable::URI.new
+      uri.query_values = query_values
+      params = '?' + uri.query
+    elsif not data.nil?
+      params = '/' + CGI::escape(data.to_s)
+    else
+      params = ''  
+    end
+    url = Tmdb.base_api_url + method + '/' + language + '/json/' + Tmdb.api_key + params 
     response = Tmdb.get_url(url)
     if(response.code.to_i != 200)
-      return nil
+      raise RuntimeError, "Tmdb API returned status code '#{response.code}' for URL: '#{url}'"
     end
     body = JSON(response.body)
     if( body.first.include?("Nothing found"))

data/lib/ruby-tmdb/tmdb_cast.rb

@@ -9,10 +9,10 @@ class TmdbCast
     
     results = []
     unless(options[:id].nil? || options[:id].to_s.empty?)
-      results << Tmdb.api_call('Person.getInfo', options[:id])
+      results << Tmdb.api_call('Person.getInfo', options[:id], options[:language])
     end
     unless(options[:name].nil? || options[:name].to_s.empty?)
-      results << Tmdb.api_call('Person.search', options[:name])
+      results << Tmdb.api_call('Person.search', options[:name], options[:language])
     end
     
     results.flatten!
@@ -23,7 +23,7 @@ class TmdbCast
       results = results.slice(0, options[:limit])
     end
   
-    results.map!{|c| TmdbCast.new(c, options[:expand_results]) }
+    results.map!{|c| TmdbCast.new(c, options[:expand_results], options[:language]) }
   
     if(results.length == 1)
       return results[0]
@@ -32,10 +32,14 @@ class TmdbCast
     end
   end
   
-  def self.new(raw_data, expand_results = false)
+  def self.new(raw_data, expand_results = false, language = nil)
     # expand the result by calling Person.getInfo unless :expand_results is set to false or the data is already complete
     # (as determined by checking for the 'known_movies' property)
-    raw_data = Tmdb.api_call('Person.getInfo', raw_data["id"]).first if(expand_results && !raw_data.has_key?("known_movies"))
+    if(expand_results && !raw_data.has_key?("known_movies"))
+      expanded_data = Tmdb.api_call('Person.getInfo', raw_data["id"], language)
+      raise ArgumentError, "Unable to fetch expanded info for Cast ID: '#{raw_data["id"]}'" if expanded_data.nil?
+      raw_data = expanded_data.first
+    end
     return Tmdb.data_to_object(raw_data)
   end
   

data/lib/ruby-tmdb/tmdb_movie.rb

@@ -9,14 +9,14 @@ class TmdbMovie
     
     results = []
     unless(options[:id].nil? || options[:id].to_s.empty?)
-      results << Tmdb.api_call("Movie.getInfo", options[:id])
+      results << Tmdb.api_call("Movie.getInfo", options[:id], options[:language])
     end
     unless(options[:imdb].nil? || options[:imdb].to_s.empty?)
-      results << Tmdb.api_call("Movie.imdbLookup", options[:imdb])
+      results << Tmdb.api_call("Movie.imdbLookup", options[:imdb], options[:language])
       options[:expand_results] = true
     end
     unless(options[:title].nil? || options[:title].to_s.empty?)
-      results << Tmdb.api_call("Movie.search", options[:title])
+      results << Tmdb.api_call("Movie.search", options[:title], options[:language])
     end
     
     results.flatten!
@@ -27,7 +27,7 @@ class TmdbMovie
       results = results.slice(0, options[:limit])
     end
     
-    results.map!{|m| TmdbMovie.new(m, options[:expand_results]) }
+    results.map!{|m| TmdbMovie.new(m, options[:expand_results], options[:language]) }
     
     if(results.length == 1)
       return results[0]
@@ -36,10 +36,38 @@ class TmdbMovie
     end
   end
   
-  def self.new(raw_data, expand_results = false)
+  def self.browse(options)
+    options = {
+      :expand_results => false
+    }.merge(options)
+    
+    expand_results = options.delete(:expand_results)
+    language = options.delete(:language)
+    
+    results = []
+    results << Tmdb.api_call("Movie.browse", options, language)
+    
+    results.flatten!
+    results.compact!
+    
+    results.map!{|m| TmdbMovie.new(m, expand_results, language) }
+    
+    if(results.length == 1)
+      return results[0]
+    else
+      return results
+    end
+    
+  end
+  
+  def self.new(raw_data, expand_results = false, language = nil)
     # expand the result by calling Movie.getInfo unless :expand_results is false or the data is already complete
     # (as determined by checking for the trailer property in the raw data)
-    raw_data = Tmdb.api_call('Movie.getInfo', raw_data["id"]).first if(expand_results && !raw_data.has_key?("trailer"))
+    if(expand_results && !raw_data.has_key?("trailer"))
+      expanded_data = Tmdb.api_call('Movie.getInfo', raw_data["id"], language)
+      raise ArgumentError, "Unable to fetch expanded info for Movie ID: '#{raw_data["id"]}'" if expanded_data.nil?
+      raw_data = expanded_data.first
+    end
     return Tmdb.data_to_object(raw_data)
   end
   

data/ruby-tmdb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-tmdb}
-  s.version = "0.1.4"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Gough"]
-  s.date = %q{2010-10-06}
+  s.date = %q{2011-04-13}
   s.description = %q{An ActiveRecord-style API wrapper for TheMovieDB.org}
   s.email = %q{aaron@aarongough.com}
   s.extra_rdoc_files = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
      "test/fixtures/example_com.txt",
      "test/fixtures/image.jpg",
      "test/fixtures/incorrect_api_url.txt",
+     "test/fixtures/movie_browse.txt",
      "test/fixtures/movie_get_info.txt",
      "test/fixtures/movie_imdb_lookup.txt",
      "test/fixtures/movie_search.txt",
@@ -69,15 +70,18 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<deepopenstruct>, [">= 0.1.2"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<addressable>, [">= 0"])
       s.add_development_dependency(%q<webmock>, [">= 0"])
     else
       s.add_dependency(%q<deepopenstruct>, [">= 0.1.2"])
       s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<addressable>, [">= 0"])
       s.add_dependency(%q<webmock>, [">= 0"])
     end
   else
     s.add_dependency(%q<deepopenstruct>, [">= 0.1.2"])
     s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<addressable>, [">= 0"])
     s.add_dependency(%q<webmock>, [">= 0"])
   end
 end

data/test/fixtures/movie_browse.txt

@@ -0,0 +1,15 @@
+HTTP/1.1 200 OK
+Server: nginx
+Date: Mon, 23 Aug 2010 16:42:39 GMT
+Content-Type: text/json; charset=utf-8
+Transfer-Encoding: chunked
+Connection: keep-alive
+Keep-Alive: timeout=20
+Status: 200 OK
+Cache-Control: public, max-age=21600
+X-Varnish: 2542116501
+Age: 0
+Via: 1.1 varnish
+X-Cache: MISS
+
+[{"score":null,"popularity":3,"translated":true,"adult":false,"language":"en","original_name":"When The Sun Goes Down","name":"When The Sun Goes Down","alternative_name":null,"movie_type":"movie","id":29734,"imdb_id":"tt1525907","url":"http://www.themoviedb.org/movie/29734","votes":5,"rating":9.8,"certification":"","overview":"No overview found.","released":"2005-01-05","posters":[{"image":{"type":"poster","size":"original","height":1500,"width":1000,"url":"http://hwcdn.themoviedb.org/posters/01e/4bc97392017a3c57fe03501e/when-the-sun-goes-down-original.jpg","id":"4bc97392017a3c57fe03501e"}},{"image":{"type":"poster","size":"mid","height":750,"width":500,"url":"http://hwcdn.themoviedb.org/posters/01e/4bc97392017a3c57fe03501e/when-the-sun-goes-down-mid.jpg","id":"4bc97392017a3c57fe03501e"}},{"image":{"type":"poster","size":"cover","height":278,"width":185,"url":"http://hwcdn.themoviedb.org/posters/01e/4bc97392017a3c57fe03501e/when-the-sun-goes-down-cover.jpg","id":"4bc97392017a3c57fe03501e"}},{"image":{"type":"poster","size":"thumb","height":138,"width":92,"url":"http://hwcdn.themoviedb.org/posters/01e/4bc97392017a3c57fe03501e/when-the-sun-goes-down-thumb.jpg","id":"4bc97392017a3c57fe03501e"}}],"backdrops":[{"image":{"type":"backdrop","size":"original","height":720,"width":1280,"url":"http://hwcdn.themoviedb.org/backdrops/01a/4bc97392017a3c57fe03501a/when-the-sun-goes-down-original.jpg","id":"4bc97392017a3c57fe03501a"}},{"image":{"type":"backdrop","size":"poster","height":439,"width":780,"url":"http://hwcdn.themoviedb.org/backdrops/01a/4bc97392017a3c57fe03501a/when-the-sun-goes-down-poster.jpg","id":"4bc97392017a3c57fe03501a"}},{"image":{"type":"backdrop","size":"thumb","height":169,"width":300,"url":"http://hwcdn.themoviedb.org/backdrops/01a/4bc97392017a3c57fe03501a/when-the-sun-goes-down-thumb.jpg","id":"4bc97392017a3c57fe03501a"}}],"version":9,"last_modified_at":"2010-08-27 08:59:58"},{"score":null,"popularity":3,"translated":true,"adult":false,"language":"en","original_name":"Frankie and Johnny","name":"Frankie and Johnny","alternative_name":"Paura d'amare","movie_type":"movie","id":3784,"imdb_id":"tt0101912","url":"http://www.themoviedb.org/movie/3784","votes":5,"rating":9.6,"certification":"","overview":"Garry Marshall (Pretty Woman) directs the screen adaptation of Terence McNally's play Frankie and Johnny at the Clair de Lune, the story of a short-order cook (Al Pacino) who drives a waitress (Michelle Pfeiffer) crazy with his adamant courtship and mixed messages. The film is okay and not much more than that, the major stumbling block being Marshall's failure to scrub away enough star veneer on Pacino and Pfeiffer to accept them as minimum-wage drones with nowhere to go but toward each other. Fortunately, Marshall's feel for the texture offered by supporting players--Hector Elizondo as a caf\u00e9 owner, Nathan Lane as Pfeiffer's inevitably gay neighbour-buddy, Kate Nelligan as another lonely waitress--keeps things interesting enough.","released":"1991-10-18","posters":[{"image":{"type":"poster","size":"original","height":1450,"width":1021,"url":"http://hwcdn.themoviedb.org/posters/051/4c614eaa5e73d63c86000051/frankie-and-johnny-original.jpg","id":"4c614eaa5e73d63c86000051"}},{"image":{"type":"poster","size":"mid","height":710,"width":500,"url":"http://hwcdn.themoviedb.org/posters/051/4c614eaa5e73d63c86000051/frankie-and-johnny-mid.jpg","id":"4c614eaa5e73d63c86000051"}},{"image":{"type":"poster","size":"cover","height":263,"width":185,"url":"http://hwcdn.themoviedb.org/posters/051/4c614eaa5e73d63c86000051/frankie-and-johnny-cover.jpg","id":"4c614eaa5e73d63c86000051"}},{"image":{"type":"poster","size":"thumb","height":131,"width":92,"url":"http://hwcdn.themoviedb.org/posters/051/4c614eaa5e73d63c86000051/frankie-and-johnny-thumb.jpg","id":"4c614eaa5e73d63c86000051"}}],"backdrops":[{"image":{"type":"backdrop","size":"original","height":720,"width":1280,"url":"http://hwcdn.themoviedb.org/backdrops/c9e/4bc9197b017a3c57fe009c9e/frankie-and-johnny-original.jpg","id":"4bc9197b017a3c57fe009c9e"}},{"image":{"type":"backdrop","size":"poster","height":439,"width":780,"url":"http://hwcdn.themoviedb.org/backdrops/c9e/4bc9197b017a3c57fe009c9e/frankie-and-johnny-poster.jpg","id":"4bc9197b017a3c57fe009c9e"}},{"image":{"type":"backdrop","size":"thumb","height":169,"width":300,"url":"http://hwcdn.themoviedb.org/backdrops/c9e/4bc9197b017a3c57fe009c9e/frankie-and-johnny-thumb.jpg","id":"4bc9197b017a3c57fe009c9e"}}],"version":36,"last_modified_at":"2010-08-18 22:47:39"},{"score":null,"popularity":3,"translated":true,"adult":false,"language":"en","original_name":"The Kite Runner","name":"The Kite Runner","alternative_name":"Les Cerfs-volants de Kaboul","movie_type":"movie","id":7979,"imdb_id":"tt0419887","url":"http://www.themoviedb.org/movie/7979","votes":5,"rating":9.6,"certification":"","overview":"The Kite Runner is the story of strained family relationships between a father and a son, and between two brothers, how they deal with guilt and forgiveness, and how they weather the political and social transformations of Afghanistan from the 1970s to 2001. ","released":"2007-10-14","posters":[{"image":{"type":"poster","size":"original","height":1500,"width":1013,"url":"http://hwcdn.themoviedb.org/posters/f30/4bffc4a2017a3c7031000f30/the-kite-runner-original.jpg","id":"4bffc4a2017a3c7031000f30"}},{"image":{"type":"poster","size":"mid","height":740,"width":500,"url":"http://hwcdn.themoviedb.org/posters/f30/4bffc4a2017a3c7031000f30/the-kite-runner-mid.jpg","id":"4bffc4a2017a3c7031000f30"}},{"image":{"type":"poster","size":"cover","height":274,"width":185,"url":"http://hwcdn.themoviedb.org/posters/f30/4bffc4a2017a3c7031000f30/the-kite-runner-cover.jpg","id":"4bffc4a2017a3c7031000f30"}},{"image":{"type":"poster","size":"thumb","height":136,"width":92,"url":"http://hwcdn.themoviedb.org/posters/f30/4bffc4a2017a3c7031000f30/the-kite-runner-thumb.jpg","id":"4bffc4a2017a3c7031000f30"}}],"backdrops":[{"image":{"type":"backdrop","size":"original","height":1080,"width":1920,"url":"http://hwcdn.themoviedb.org/backdrops/9a3/4bc91fd7017a3c57fe00c9a3/the-kite-runner-original.jpg","id":"4bc91fd7017a3c57fe00c9a3"}},{"image":{"type":"backdrop","size":"poster","height":439,"width":780,"url":"http://hwcdn.themoviedb.org/backdrops/9a3/4bc91fd7017a3c57fe00c9a3/the-kite-runner-poster.jpg","id":"4bc91fd7017a3c57fe00c9a3"}},{"image":{"type":"backdrop","size":"thumb","height":169,"width":300,"url":"http://hwcdn.themoviedb.org/backdrops/9a3/4bc91fd7017a3c57fe00c9a3/the-kite-runner-thumb.jpg","id":"4bc91fd7017a3c57fe00c9a3"}}],"version":21,"last_modified_at":"2010-08-18 22:41:46"},{"score":null,"popularity":3,"translated":true,"adult":false,"language":"en","original_name":"The Last Emperor","name":"The Last Emperor","alternative_name":"L'Ultimo Imperatore","movie_type":"movie","id":746,"imdb_id":"tt0093389","url":"http://www.themoviedb.org/movie/746","votes":5,"rating":9.4,"certification":"","overview":"The Last Emeror is a monumental film about the life of the last emperor of the Chinese Quinn dynasty. Director Bertolucci illustrates the life of Pu-Yi who was crowned emperor at the age of two only to loose it at the age of five. The film won a total of nine Oscars in 1987.","released":"1987-10-29","posters":[{"image":{"type":"poster","size":"original","height":1500,"width":1000,"url":"http://hwcdn.themoviedb.org/posters/21c/4bc90bc1017a3c57fe00421c/the-last-emperor-original.jpg","id":"4bc90bc1017a3c57fe00421c"}},{"image":{"type":"poster","size":"mid","height":750,"width":500,"url":"http://hwcdn.themoviedb.org/posters/21c/4bc90bc1017a3c57fe00421c/the-last-emperor-mid.jpg","id":"4bc90bc1017a3c57fe00421c"}},{"image":{"type":"poster","size":"cover","height":278,"width":185,"url":"http://hwcdn.themoviedb.org/posters/21c/4bc90bc1017a3c57fe00421c/the-last-emperor-cover.jpg","id":"4bc90bc1017a3c57fe00421c"}},{"image":{"type":"poster","size":"thumb","height":138,"width":92,"url":"http://hwcdn.themoviedb.org/posters/21c/4bc90bc1017a3c57fe00421c/the-last-emperor-thumb.jpg","id":"4bc90bc1017a3c57fe00421c"}}],"backdrops":[{"image":{"type":"backdrop","size":"original","height":720,"width":1280,"url":"http://hwcdn.themoviedb.org/backdrops/213/4bc90bc0017a3c57fe004213/the-last-emperor-original.jpg","id":"4bc90bc0017a3c57fe004213"}},{"image":{"type":"backdrop","size":"poster","height":439,"width":780,"url":"http://hwcdn.themoviedb.org/backdrops/213/4bc90bc0017a3c57fe004213/the-last-emperor-poster.jpg","id":"4bc90bc0017a3c57fe004213"}},{"image":{"type":"backdrop","size":"thumb","height":169,"width":300,"url":"http://hwcdn.themoviedb.org/backdrops/213/4bc90bc0017a3c57fe004213/the-last-emperor-thumb.jpg","id":"4bc90bc0017a3c57fe004213"}}],"version":37,"last_modified_at":"2010-10-27 02:02:52"},{"score":null,"popularity":3,"translated":true,"adult":false,"language":"en","original_name":"Das Verlangen","name":"Das Verlangen","alternative_name":null,"movie_type":"movie","id":6179,"imdb_id":"tt0328727","url":"http://www.themoviedb.org/movie/6179","votes":5,"rating":9.2,"certification":"","overview":"No overview found.","released":"2002-08-08","posters":[],"backdrops":[],"version":19,"last_modified_at":"2010-08-18 22:50:41"},{"score":null,"popularity":3,"translated":true,"adult":false,"language":"en","original_name":"Elephant","name":"Elephant","alternative_name":null,"movie_type":"movie","id":1807,"imdb_id":"tt0363589","url":"http://www.themoviedb.org/movie/1807","votes":5,"rating":9.2,"certification":"","overview":"Elephant is a Gus Van Sant film depicting the story of a high school just before and after a massive shooting. The film is shot in a way that makes the viewer seem like they are there, in the high school, slowly walking around witnessing ever characters story unfold. The film won the Palme d\u2019Or and Best Director at the 2003 Cannes Film Festival.","released":"2003-05-18","posters":[{"image":{"type":"poster","size":"original","height":1500,"width":1000,"url":"http://hwcdn.themoviedb.org/posters/015/4c1f544a7b9aa13123000015/elephant-original.jpg","id":"4c1f544a7b9aa13123000015"}},{"image":{"type":"poster","size":"mid","height":750,"width":500,"url":"http://hwcdn.themoviedb.org/posters/015/4c1f544a7b9aa13123000015/elephant-mid.jpg","id":"4c1f544a7b9aa13123000015"}},{"image":{"type":"poster","size":"cover","height":278,"width":185,"url":"http://hwcdn.themoviedb.org/posters/015/4c1f544a7b9aa13123000015/elephant-cover.jpg","id":"4c1f544a7b9aa13123000015"}},{"image":{"type":"poster","size":"thumb","height":138,"width":92,"url":"http://hwcdn.themoviedb.org/posters/015/4c1f544a7b9aa13123000015/elephant-thumb.jpg","id":"4c1f544a7b9aa13123000015"}}],"backdrops":[{"image":{"type":"backdrop","size":"original","height":720,"width":1280,"url":"http://hwcdn.themoviedb.org/backdrops/0e0/4bc912ef017a3c57fe0070e0/elephant-original.jpg","id":"4bc912ef017a3c57fe0070e0"}},{"image":{"type":"backdrop","size":"poster","height":439,"width":780,"url":"http://hwcdn.themoviedb.org/backdrops/0e0/4bc912ef017a3c57fe0070e0/elephant-poster.jpg","id":"4bc912ef017a3c57fe0070e0"}},{"image":{"type":"backdrop","size":"thumb","height":169,"width":300,"url":"http://hwcdn.themoviedb.org/backdrops/0e0/4bc912ef017a3c57fe0070e0/elephant-thumb.jpg","id":"4bc912ef017a3c57fe0070e0"}}],"version":29,"last_modified_at":"2010-08-18 22:51:06"},{"score":null,"popularity":3,"translated":true,"adult":false,"language":"en","original_name":"Infernal Affairs","name":"Infernal Affairs","alternative_name":"Wu Jian Dao","movie_type":"movie","id":10775,"imdb_id":"tt0338564","url":"http://www.themoviedb.org/movie/10775","votes":5,"rating":9.2,"certification":"","overview":"Chan Wing Yan, a young police officer, has been sent undercover as a mole in the local mafia. Lau Kin Ming, a young mafia member, infiltrates the police force. Years later, their older counterparts, Chen Wing Yan and Inspector Lau Kin Ming, respectively, race against time to expose the mole within their midst. ","released":"2002-12-12","posters":[{"image":{"type":"poster","size":"original","height":1290,"width":900,"url":"http://hwcdn.themoviedb.org/posters/31c/4bf4736a017a3c6d9200031c/10775-original.jpg","id":"4bf4736a017a3c6d9200031c"}},{"image":{"type":"poster","size":"mid","height":717,"width":500,"url":"http://hwcdn.themoviedb.org/posters/31c/4bf4736a017a3c6d9200031c/10775-mid.jpg","id":"4bf4736a017a3c6d9200031c"}},{"image":{"type":"poster","size":"cover","height":265,"width":185,"url":"http://hwcdn.themoviedb.org/posters/31c/4bf4736a017a3c6d9200031c/10775-cover.jpg","id":"4bf4736a017a3c6d9200031c"}},{"image":{"type":"poster","size":"thumb","height":132,"width":92,"url":"http://hwcdn.themoviedb.org/posters/31c/4bf4736a017a3c6d9200031c/10775-thumb.jpg","id":"4bf4736a017a3c6d9200031c"}}],"backdrops":[{"image":{"type":"backdrop","size":"original","height":720,"width":1280,"url":"http://hwcdn.themoviedb.org/backdrops/438/4cc966d75e73d65024000438/infernal-affairs-original.jpg","id":"4cc966d75e73d65024000438"}},{"image":{"type":"backdrop","size":"poster","height":439,"width":780,"url":"http://hwcdn.themoviedb.org/backdrops/438/4cc966d75e73d65024000438/infernal-affairs-poster.jpg","id":"4cc966d75e73d65024000438"}},{"image":{"type":"backdrop","size":"thumb","height":169,"width":300,"url":"http://hwcdn.themoviedb.org/backdrops/438/4cc966d75e73d65024000438/infernal-affairs-thumb.jpg","id":"4cc966d75e73d65024000438"}}],"version":38,"last_modified_at":"2010-10-29 14:17:00"},{"score":null,"popularity":3,"translated":true,"adult":false,"language":"en","original_name":"Bride of Frankenstein","name":"Bride of Frankenstein","alternative_name":"Frankensteins R\u00fcckkehr","movie_type":"movie","id":229,"imdb_id":"tt0026138","url":"http://www.themoviedb.org/movie/229","votes":6,"rating":9.2,"certification":"PG","overview":"Bride of Frankenstein begins where James Whale's Frankenstein from 1931 ended. Dr. Frankenstein has not been killed as previously portrayed and now he wants to get away from the mad experiments. Yet when his wife is kidnapped by his creation, Frankenstein agrees to help him create a new monster, this time a woman.","released":"1935-04-22","posters":[{"image":{"type":"poster","size":"original","height":1785,"width":1200,"url":"http://hwcdn.themoviedb.org/posters/9be/4bc9056b017a3c57fe0019be/bride-of-frankenstein-original.jpg","id":"4bc9056b017a3c57fe0019be"}},{"image":{"type":"poster","size":"mid","height":744,"width":500,"url":"http://hwcdn.themoviedb.org/posters/9be/4bc9056b017a3c57fe0019be/bride-of-frankenstein-mid.jpg","id":"4bc9056b017a3c57fe0019be"}},{"image":{"type":"poster","size":"cover","height":275,"width":185,"url":"http://hwcdn.themoviedb.org/posters/9be/4bc9056b017a3c57fe0019be/bride-of-frankenstein-cover.jpg","id":"4bc9056b017a3c57fe0019be"}},{"image":{"type":"poster","size":"thumb","height":137,"width":92,"url":"http://hwcdn.themoviedb.org/posters/9be/4bc9056b017a3c57fe0019be/bride-of-frankenstein-thumb.jpg","id":"4bc9056b017a3c57fe0019be"}}],"backdrops":[{"image":{"type":"backdrop","size":"original","height":1080,"width":1920,"url":"http://hwcdn.themoviedb.org/backdrops/9ba/4bc9056a017a3c57fe0019ba/bride-of-frankenstein-original.jpg","id":"4bc9056a017a3c57fe0019ba"}},{"image":{"type":"backdrop","size":"poster","height":439,"width":780,"url":"http://hwcdn.themoviedb.org/backdrops/9ba/4bc9056a017a3c57fe0019ba/bride-of-frankenstein-poster.jpg","id":"4bc9056a017a3c57fe0019ba"}},{"image":{"type":"backdrop","size":"thumb","height":169,"width":300,"url":"http://hwcdn.themoviedb.org/backdrops/9ba/4bc9056a017a3c57fe0019ba/bride-of-frankenstein-thumb.jpg","id":"4bc9056a017a3c57fe0019ba"}}],"version":45,"last_modified_at":"2010-11-06 00:31:08"},{"score":null,"popularity":3,"translated":true,"adult":false,"language":"en","original_name":"Mean Streets","name":"Mean Streets","alternative_name":null,"movie_type":"movie","id":203,"imdb_id":"tt0070379","url":"http://www.themoviedb.org/movie/203","votes":6,"rating":9.0,"certification":"","overview":"Mean Streets is the pioneering artistic film from director Martin Scorseses. With it\u2019s experimental ease this gangster film documented the rules and rights structure and laws of the Italian-American small time criminal ambiance from 1960\u2019s New York.","released":"1973-10-02","posters":[{"image":{"type":"poster","size":"original","height":2793,"width":1920,"url":"http://hwcdn.themoviedb.org/posters/5bf/4be1a272017a3c35bf0005bf/mean-streets-original.jpg","id":"4be1a272017a3c35bf0005bf"}},{"image":{"type":"poster","size":"mid","height":727,"width":500,"url":"http://hwcdn.themoviedb.org/posters/5bf/4be1a272017a3c35bf0005bf/mean-streets-mid.jpg","id":"4be1a272017a3c35bf0005bf"}},{"image":{"type":"poster","size":"cover","height":269,"width":185,"url":"http://hwcdn.themoviedb.org/posters/5bf/4be1a272017a3c35bf0005bf/mean-streets-cover.jpg","id":"4be1a272017a3c35bf0005bf"}},{"image":{"type":"poster","size":"thumb","height":134,"width":92,"url":"http://hwcdn.themoviedb.org/posters/5bf/4be1a272017a3c35bf0005bf/mean-streets-thumb.jpg","id":"4be1a272017a3c35bf0005bf"}}],"backdrops":[{"image":{"type":"backdrop","size":"original","height":1080,"width":1920,"url":"http://hwcdn.themoviedb.org/backdrops/7e6/4bc90525017a3c57fe0017e6/mean-streets-original.jpg","id":"4bc90525017a3c57fe0017e6"}},{"image":{"type":"backdrop","size":"poster","height":439,"width":780,"url":"http://hwcdn.themoviedb.org/backdrops/7e6/4bc90525017a3c57fe0017e6/mean-streets-poster.jpg","id":"4bc90525017a3c57fe0017e6"}},{"image":{"type":"backdrop","size":"thumb","height":169,"width":300,"url":"http://hwcdn.themoviedb.org/backdrops/7e6/4bc90525017a3c57fe0017e6/mean-streets-thumb.jpg","id":"4bc90525017a3c57fe0017e6"}}],"version":32,"last_modified_at":"2010-11-07 10:17:19"},{"score":null,"popularity":3,"translated":true,"adult":false,"language":"en","original_name":"Gegen\u00fcber","name":"Gegen\u00fcber","alternative_name":null,"movie_type":"movie","id":4213,"imdb_id":"tt1031932","url":"http://www.themoviedb.org/movie/4213","votes":5,"rating":9.0,"certification":"","overview":"No overview found.","released":"2007-05-20","posters":[],"backdrops":[],"version":21,"last_modified_at":"2010-08-18 22:49:49"}]

data/test/setup/url_mocks.rb

@@ -1,6 +1,5 @@
 def register_api_url_stubs  
   unless(TEST_LIVE_API)
-    
   
     File.open(File.join(File.dirname(__FILE__), "..", "fixtures", "movie_search.txt")) do |file|
       stub_request(:get, Regexp.new(Tmdb.base_api_url + "Movie.search/" + ".*")).to_return(file)
@@ -14,6 +13,10 @@ def register_api_url_stubs
       stub_request(:get, Regexp.new(Tmdb.base_api_url + "Movie.imdbLookup/" + ".*")).to_return(file)
     end
     
+    File.open(File.join(File.dirname(__FILE__), "..", "fixtures", "movie_browse.txt")) do |file|
+      stub_request(:get, Regexp.new(Tmdb.base_api_url + "Movie.browse/" + ".*")).to_return(file)
+    end
+    
     File.open(File.join(File.dirname(__FILE__), "..", "fixtures", "person_get_info.txt")) do |file|
       stub_request(:get, Regexp.new(Tmdb.base_api_url + "Person.getInfo/" + ".*")).to_return(file)
     end

data/test/test_helper.rb

@@ -2,6 +2,7 @@ TEST_LIVE_API = false
 
 require 'rubygems'
 require 'test/unit'
+require 'mocha'
 
 unless(TEST_LIVE_API)
   require 'webmock/test_unit'

data/test/unit/tmdb_cast_test.rb

@@ -84,6 +84,25 @@ class TmdbCastTest < Test::Unit::TestCase
     end
   end
   
+  test "should not pass language to Tmdb.api_call if language is not supplied" do
+    Tmdb.expects(:api_call).with("Person.getInfo", 1, nil).returns([])
+    Tmdb.expects(:api_call).with("Person.search", 1, nil).returns([])
+    TmdbCast.find(:id => 1, :name => 1)
+  end
+  
+  test "should pass through language to Tmdb.api_call when language is supplied" do
+    Tmdb.expects(:api_call).with("Person.getInfo", 1, "foo").returns([])
+    Tmdb.expects(:api_call).with("Person.search", 1, "foo").returns([])
+    TmdbCast.find(:id => 1, :name => 1, :language => "foo")
+  end
+  
+  test "TmdbCast.new should raise error if supplied with raw data for cast member that doesn't exist" do
+    Tmdb.expects(:api_call).with('Person.getInfo', "1").returns(nil)
+    assert_raise ArgumentError do
+      TmdbCast.new({"id" => "1"}, true)
+    end
+  end
+  
   private
   
     def assert_cast_methodized(actor, cast_id)

data/test/unit/tmdb_movie_test.rb

@@ -91,6 +91,46 @@ class TmdbMovieTest < Test::Unit::TestCase
       end
     end
   end
+  
+  test "find should not pass language to Tmdb.api_call if language is not supplied" do
+    Tmdb.expects(:api_call).with("Movie.getInfo", 1, nil).returns([])
+    Tmdb.expects(:api_call).with("Movie.imdbLookup", 1, nil).returns([])
+    Tmdb.expects(:api_call).with("Movie.search", 1, nil).returns([])
+    TmdbMovie.find(:id => 1, :imdb => 1, :title => 1)
+  end
+  
+  test "find should pass through language to Tmdb.api_call when language is supplied" do
+    Tmdb.expects(:api_call).with("Movie.getInfo", 1, "foo").returns([])
+    Tmdb.expects(:api_call).with("Movie.imdbLookup", 1, "foo").returns([])
+    Tmdb.expects(:api_call).with("Movie.search", 1, "foo").returns([])
+    TmdbMovie.find(:id => 1, :imdb => 1, :title => 1, :language => "foo")
+  end
+  
+  test "TmdbMovie.new should raise error if supplied with raw data for movie that doesn't exist" do
+    Tmdb.expects(:api_call).with('Movie.getInfo', "1").returns(nil)
+    assert_raise ArgumentError do
+      TmdbMovie.new({"id" => "1"}, true)
+    end
+  end
+
+  test "browse should return results" do
+    movies = TmdbMovie.browse(:order_by => "rating", :order => "desc", :genres => 18, :min_votes => 5, :page => 1, :per_page => 10)
+    assert_kind_of Array, movies
+    assert_equal 10, movies.length
+    movies.each do |movie|
+      assert_kind_of OpenStruct, movie
+    end
+  end
+  
+  test "browse should not pass language to Tmdb.api_call if language is not supplied" do
+    Tmdb.expects(:api_call).with("Movie.browse", {:option => 1}, nil).returns([])
+    TmdbMovie.browse(:option => 1)
+  end
+  
+  test "browse should pass through language to Tmdb.api_call when language is supplied" do
+    Tmdb.expects(:api_call).with("Movie.browse", {:option => 1}, "foo").returns([])
+    TmdbMovie.browse(:option => 1, :language => "foo")
+  end
 
   private
     

data/test/unit/tmdb_test.rb

@@ -6,7 +6,7 @@ class TmdbTest < Test::Unit::TestCase
     register_api_url_stubs
   end
 
-  test "allows setting of api_key" do
+  test "should allow setting and getting of api_key" do
     old_api_key = Tmdb.api_key
     api_key = "test1234567890"
     Tmdb.api_key = api_key
@@ -14,6 +14,18 @@ class TmdbTest < Test::Unit::TestCase
     Tmdb.api_key = old_api_key
   end
   
+  test "language should default to 'en'" do
+    assert_equal "en", Tmdb.default_language
+  end
+  
+  test "should allow setting and getting of language" do
+    old_language = Tmdb.default_language
+    new_language = "blah"
+    Tmdb.default_language = new_language
+    assert_equal new_language, Tmdb.default_language
+    Tmdb.default_language = old_language
+  end
+  
   test "should return base API url" do
     assert_equal "http://api.themoviedb.org/2.1/", Tmdb.base_api_url
   end
@@ -28,6 +40,27 @@ class TmdbTest < Test::Unit::TestCase
     assert_equal 404, test_response.code.to_i
   end
   
+  test "API call without explicit language setting should use default language" do
+    method = "Movie.getInfo"
+    data = "hello"
+    Tmdb.default_language = "es"
+    url = Tmdb.base_api_url + method + '/' + Tmdb.default_language + '/json/' + Tmdb.api_key + '/' + CGI::escape(data.to_s)
+    mock_response = stub(:code => "200", :body => '[""]')
+    Tmdb.expects(:get_url).with(url).returns(mock_response)
+    Tmdb.api_call(method, data)
+    Tmdb.default_language = "en"
+  end
+  
+  test "API call with explicit language setting should override default language" do
+    method = "Movie.getInfo"
+    data = "hello"
+    language = "blah"
+    url = Tmdb.base_api_url + method + '/' + language + '/json/' + Tmdb.api_key + '/' + CGI::escape(data.to_s)
+    mock_response = stub(:code => "200", :body => '[""]')
+    Tmdb.expects(:get_url).with(url).returns(mock_response)
+    Tmdb.api_call(method, data, language)
+  end
+  
   test "api_call should raise exception if api_key is not set" do
     old_api_key = Tmdb.api_key
     Tmdb.api_key = ""
@@ -97,15 +130,14 @@ class TmdbTest < Test::Unit::TestCase
     end
   end
   
-  test "failed API call should return nil" do
-    movies = Tmdb.api_call('Movie.blarg', 'Transformers')
-    assert_kind_of NilClass, movies
-    assert_nil movies
+  test "API call that returns 404 should raise exception" do
+    assert_raise RuntimeError do
+      movies = Tmdb.api_call('Movie.blarg', 'Transformers')
+    end
   end
   
   test "API call that finds no results should return nil" do
     movies = Tmdb.api_call('Search.empty', 'Transformers')
-    assert_kind_of NilClass, movies
     assert_nil movies
   end
   

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 2
   - 1
-  - 4
-  version: 0.1.4
+  version: 0.2.1
 platform: ruby
 authors: 
 - Aaron Gough
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-06 00:00:00 -04:00
+date: 2011-04-13 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,7 +46,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: webmock
+  name: addressable
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -56,8 +56,21 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: An ActiveRecord-style API wrapper for TheMovieDB.org
 email: aaron@aarongough.com
 executables: []
@@ -82,6 +95,7 @@ files:
 - test/fixtures/example_com.txt
 - test/fixtures/image.jpg
 - test/fixtures/incorrect_api_url.txt
+- test/fixtures/movie_browse.txt
 - test/fixtures/movie_get_info.txt
 - test/fixtures/movie_imdb_lookup.txt
 - test/fixtures/movie_search.txt