ruby-tmdb 0.1.1 → 0.1.2

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.rdoc

@@ -1,12 +1,12 @@
-== ruby-tmdb
+= ruby-tmdb
 
-ruby-tmdb is an ActiveRecord-style API wrapper for {TheMovieDB.org}[http://www.themoviedb.org/] ({TMDb}[http://www.themoviedb.org/]). ruby-tmdb is designed to make common tasks like retrieving all movies that have a given actor in them and fetching image data much easier than they would be if dealing directly with the URL based API. ruby-tmdb also provides query caching to minimize duplicate remote API queries.
+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
   
-=== Usage
+=== Example
 
   require 'rubygems'
   require 'ruby-tmdb'
@@ -15,7 +15,7 @@ ruby-tmdb is an ActiveRecord-style API wrapper for {TheMovieDB.org}[http://www.t
   Tmdb.api_key = "t478f8de5776c799de5a"
   
   @movie = TmdbMovie.find(:title => "Iron Man", :limit => 1)
-  # => <TmdbMovie>
+  # => <OpenStruct>
   
   @movie.name
   # => "Iron Man"
@@ -26,31 +26,66 @@ ruby-tmdb is an ActiveRecord-style API wrapper for {TheMovieDB.org}[http://www.t
   @movie.posters.first.data
   # => [binary blob representing JPEG]
   
-  @movie.cast.first.bio.movies
-  # => [<TmdbMovie>,<TmdbMovie>,<TmdbMovie>,<TmdbMovie>]
+=== Usage
+
+ruby-tmdb provides 2 main objects that you will use to query the API
+  
+  TmdbMovie
+  TmdbCast
+  
+These objects provide access to movie and cast listing respectively.
+
+Each object provides a find() method which accepts a number of options:
+
+  TmdbMovie.find(:id => 123, :title => "fight club", :imdb => 'tt0401792', :limit => 10, :expand_results => true)
+
+
+[: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
+[: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'.
   
-  @actor = TmdbCast.find(:name => "Brad Pitt", :limit => 1)
-  # => <TmdbCast>
+
+  TmdbCast.find( :id => 123, :name => "Brad", :limit => 1, :expand_results => true)
   
-  @actor.birthplace
-  # => "Shawnee, Oklahoma, United States"
+[: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
 
-Find all movies whose titles match a given string
+
+=== Usage Examples
+
+Find all movies whose titles match a given string:
 
   @movies = TmdbMovie.find(:title => 'Iron Man')
   
-Find the movie most likely to be associated with a given title
+Find the movie most likely to be associated with a given title:
 
   @movie = TmdbMovie.find(:title => 'Sin City', :limit => 1)
   
-Find a single movie by it's TMDb ID
+Find a single movie by it's TMDb ID:
 
   @movie = TmdbMovie.find(:id => 187)
   
-Find a single movie by it's IMDB ID
+Find a single movie by it's IMDB ID:
 
   @movie = TmdbMovie.find(:imdb => 'tt0401792')
   
+Find all cast members whose names match a given string:
+
+  @actors = TmdbCast.find(:name => 'Fred')
+  
+Find an individual cast member via their TMDb ID:
+
+  @actor = TmdbCast.find(:id => 101)
+
+
+=== Item information
+  
+To find out more about the information each object offers on retrieved items have a look at the {TMDb API Docs}[http://api.themoviedb.org/2.1]. For the most accurate information about the information available have a look at the data directly through ruby-tmdb by calling @item.raw_data.inspect
+
 === Author & Credits
 
 Author:: {Aaron Gough}[mailto:aaron@aarongough.com]

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/ruby-tmdb/tmdb.rb

@@ -22,6 +22,7 @@ class Tmdb
   end
   
   def self.api_call(method, data, language = "en")
+    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 + '/yaml/' + Tmdb.api_key + '/' + CGI::escape(data.to_s)
     response = Tmdb.get_url(url)
     if(response.code.to_i != 200)

data/lib/ruby-tmdb/tmdb_cast.rb

@@ -32,7 +32,9 @@ class TmdbCast
   end
   
   def self.new(raw_data, expand_results = false)
-    raw_data = Tmdb.api_call('Person.getInfo', raw_data["id"]).first
+    # 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"))
     return Tmdb.data_to_object(raw_data)
   end
   

data/lib/ruby-tmdb/tmdb_movie.rb

@@ -36,7 +36,9 @@ class TmdbMovie
   end
   
   def self.new(raw_data, expand_results = false)
-    raw_data = Tmdb.api_call('Movie.getInfo', raw_data["id"]).first if(expand_results)
+    # 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"))
     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.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Gough"]
-  s.date = %q{2010-08-19}
+  s.date = %q{2010-08-20}
   s.description = %q{An ActiveRecord-style API wrapper for TheMovieDB.org}
   s.email = %q{aaron@aarongough.com}
   s.extra_rdoc_files = [
@@ -17,7 +17,8 @@ Gem::Specification.new do |s|
      "README.rdoc"
   ]
   s.files = [
-    "MIT-LICENSE",
+    ".gitignore",
+     "MIT-LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",
@@ -36,9 +37,11 @@ Gem::Specification.new do |s|
      "test/fixtures/person_get_info.txt",
      "test/fixtures/person_search.txt",
      "test/setup/.gitignore",
+     "test/setup/setup_api_key.rb",
      "test/setup/test_unit_extensions.rb",
      "test/setup/url_mocks.rb",
      "test/test_helper.rb",
+     "test/unit/test_direct_require.rb",
      "test/unit/tmdb_cast_test.rb",
      "test/unit/tmdb_movie_test.rb",
      "test/unit/tmdb_test.rb"
@@ -49,9 +52,11 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{An ActiveRecord-style API wrapper for TheMovieDB.org}
   s.test_files = [
-    "test/setup/test_unit_extensions.rb",
+    "test/setup/setup_api_key.rb",
+     "test/setup/test_unit_extensions.rb",
      "test/setup/url_mocks.rb",
      "test/test_helper.rb",
+     "test/unit/test_direct_require.rb",
      "test/unit/tmdb_cast_test.rb",
      "test/unit/tmdb_movie_test.rb",
      "test/unit/tmdb_test.rb"

data/test/setup/setup_api_key.rb

@@ -0,0 +1,3 @@
+File.open(File.join(File.dirname(__FILE__), 'tmdb_api_key.txt')) do |file|
+  Tmdb.api_key = file.read
+end

data/test/test_helper.rb

@@ -2,8 +2,6 @@ TEST_LIVE_API = false
 
 require 'rubygems'
 require 'test/unit'
-require 'yaml'
-require 'net/http'
 
 unless(TEST_LIVE_API)
   require 'webmock/test_unit'
@@ -18,6 +16,5 @@ require_files.each do |file|
   require File.expand_path(file)
 end
 
-File.open(File.join(File.dirname(__FILE__), 'setup', 'tmdb_api_key.txt')) do |file|
-  Tmdb.api_key = file.read
-end
+#load(File.join('unit', 'test_direct_require.rb'), true)
+system('ruby ' + File.expand_path(File.join(File.dirname(__FILE__), 'unit', 'test_direct_require.rb')))

data/test/unit/test_direct_require.rb

@@ -0,0 +1,25 @@
+require "test/unit"
+
+require_files = []
+require_files << File.join(File.dirname(__FILE__), "..", "..", "lib", "ruby-tmdb.rb")
+require_files.concat Dir[File.join(File.dirname(__FILE__), '..', 'setup', '*.rb')]
+
+require_files.each do |file|
+  require File.expand_path(file)
+end
+
+class DirectRequireTest < Test::Unit::TestCase
+  
+  test "TmdbMovie should not raise exception when directly required without using rubygems" do
+    assert_nothing_raised do
+      TmdbMovie.find(:id => 187)
+    end
+  end
+  
+  test "TmdbCast should not raise exception when directly required without using rubygems" do
+    assert_nothing_raised do
+      TmdbCast.find(:id => 287)
+    end
+  end
+  
+end

data/test/unit/tmdb_test.rb

@@ -28,6 +28,15 @@ class TmdbTest < Test::Unit::TestCase
     assert_equal 404, test_response.code.to_i
   end
   
+  test "api_call should raise exception if api_key is not set" do
+    old_api_key = Tmdb.api_key
+    Tmdb.api_key = ""
+    assert_raises ArgumentError do
+      Tmdb.api_call('Movie.search', 'Transformers')
+    end
+    Tmdb.api_key = old_api_key
+  end
+  
   test "should perform Movie.search API call and return array of results" do
     movies = Tmdb.api_call('Movie.search', 'Transformers')
     assert_kind_of Array, movies

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Aaron Gough
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-19 00:00:00 -04:00
+date: 2010-08-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +53,7 @@ extra_rdoc_files:
 - MIT-LICENSE
 - README.rdoc
 files: 
+- .gitignore
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
@@ -72,9 +73,11 @@ files:
 - test/fixtures/person_get_info.txt
 - test/fixtures/person_search.txt
 - test/setup/.gitignore
+- test/setup/setup_api_key.rb
 - test/setup/test_unit_extensions.rb
 - test/setup/url_mocks.rb
 - test/test_helper.rb
+- test/unit/test_direct_require.rb
 - test/unit/tmdb_cast_test.rb
 - test/unit/tmdb_movie_test.rb
 - test/unit/tmdb_test.rb
@@ -113,9 +116,11 @@ signing_key:
 specification_version: 3
 summary: An ActiveRecord-style API wrapper for TheMovieDB.org
 test_files: 
+- test/setup/setup_api_key.rb
 - test/setup/test_unit_extensions.rb
 - test/setup/url_mocks.rb
 - test/test_helper.rb
+- test/unit/test_direct_require.rb
 - test/unit/tmdb_cast_test.rb
 - test/unit/tmdb_movie_test.rb
 - test/unit/tmdb_test.rb