ruby-tmdb 0.1.0 → 0.1.1

data/README.rdoc

@@ -26,6 +26,9 @@ 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>]
+  
   @actor = TmdbCast.find(:name => "Brad Pitt", :limit => 1)
   # => <TmdbCast>
   

data/Rakefile

@@ -16,6 +16,7 @@ begin
     gemspec.authors = ["Aaron Gough"]
     gemspec.rdoc_options << '--line-numbers' << '--inline-source'
     gemspec.extra_rdoc_files = ['README.rdoc', 'MIT-LICENSE']
+    gemspec.add_dependency "deepopenstruct"
     gemspec.add_development_dependency "webmock"
   end
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/ruby-tmdb/tmdb.rb

@@ -4,6 +4,7 @@ class Tmdb
   require 'uri'
   require 'cgi'
   require 'yaml'
+  require 'deepopenstruct'
   
   @@api_key = ""
   @@api_response = {}
@@ -21,12 +22,8 @@ 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)
-    # Memoize this API call
-    response = @@api_response[url] ||= begin
-      Tmdb.get_url(url)
-    end
+    response = Tmdb.get_url(url)
     if(response.code.to_i != 200)
       return nil
     end
@@ -55,4 +52,35 @@ class Tmdb
     end
   end
   
+  def self.data_to_object(data)
+    object = DeepOpenStruct.load(data)
+    object.raw_data = data
+    ["posters", "backdrops", "profile"].each do |image_array_name|
+      if(object.respond_to?(image_array_name))
+        image_array = object.send(image_array_name)
+        image_array.each_index do |x|
+          image_array[x] = image_array[x].image
+          image_array[x].instance_eval <<-EOD
+            def self.data
+              return Tmdb.get_url(self.url).body
+            end
+          EOD
+        end
+      end
+      if(object.profile)
+        object.profiles = object.profile
+      end
+    end
+    unless(object.cast.nil?)
+      object.cast.each_index do |x|
+        object.cast[x].instance_eval <<-EOD
+          def self.bio
+            return TmdbCast.find(:id => self.id, :limit => 1)
+          end
+        EOD
+      end
+    end
+    return object
+  end
+  
 end

data/lib/ruby-tmdb/tmdb_cast.rb

@@ -1,6 +1,10 @@
 class TmdbCast
 
   def self.find(options)
+    options = {
+      :expand_results => true
+    }.merge(options)
+  
     raise ArgumentError, "At least one of: id, name, should be supplied" if(options[:id].nil? && options[:name].nil?)
     
     results = []
@@ -18,7 +22,7 @@ class TmdbCast
       results = results.slice(0, options[:limit])
     end
   
-    results.map!{|c| TmdbCast.new(c) }
+    results.map!{|c| TmdbCast.new(c, options[:expand_results]) }
   
     if(results.length == 1)
       return results[0]
@@ -27,45 +31,9 @@ class TmdbCast
     end
   end
   
-  def initialize(raw_data)
-    @raw_data = raw_data
-    @raw_data = Tmdb.api_call('Person.getInfo', @raw_data["id"]).first
-    @raw_data["profiles"] = @raw_data["profile"]
-    @raw_data.delete("profile")
-    @raw_data.each_pair do |key, value|
-      instance_eval <<-EOD
-        def #{key}
-          @raw_data["#{key}"]
-        end
-      EOD
-      if(value.is_a?(Array))
-        value.each_index do |x|
-          if(value[x].is_a?(Hash) && value[x].length == 1)
-            if(value[x].keys[0] == "image")
-              value[x][value[x].keys[0]].instance_eval <<-EOD
-                def self.data
-                  Tmdb.get_url(self["url"]).body
-                end
-              EOD
-            end
-            value[x] = value[x][value[x].keys[0]]
-          end
-          if(value[x].is_a?(Hash))
-            value[x].each_pair do |key2, value2|
-              value[x].instance_eval <<-EOD
-                def self.#{key2}
-                  self["#{key2}"]
-                end
-              EOD
-            end
-          end
-        end
-      end
-    end
-  end
-  
-  def raw_data
-    @raw_data
+  def self.new(raw_data, expand_results = false)
+    raw_data = Tmdb.api_call('Person.getInfo', raw_data["id"]).first
+    return Tmdb.data_to_object(raw_data)
   end
   
   def ==(other)

data/lib/ruby-tmdb/tmdb_movie.rb

@@ -1,6 +1,10 @@
 class TmdbMovie
   
   def self.find(options)
+    options = {
+      :expand_results => true
+    }.merge(options)
+    
     raise ArgumentError, "At least one of: id, title, imdb should be supplied" if(options[:id].nil? && options[:imdb].nil? && options[:title].nil?)
     
     results = []
@@ -9,6 +13,7 @@ class TmdbMovie
     end
     unless(options[:imdb].nil? || options[:imdb].to_s.empty?)
       results << Tmdb.api_call("Movie.imdbLookup", options[:imdb])
+      options[:expand_results] = true
     end
     unless(options[:title].nil? || options[:title].to_s.empty?)
       results << Tmdb.api_call("Movie.search", options[:title])
@@ -21,7 +26,7 @@ class TmdbMovie
       results = results.slice(0, options[:limit])
     end
     
-    results.map!{|m| TmdbMovie.new(m) }
+    results.map!{|m| TmdbMovie.new(m, options[:expand_results]) }
     
     if(results.length == 1)
       return results[0]
@@ -30,50 +35,9 @@ class TmdbMovie
     end
   end
   
-  def initialize(raw_data)
-    @raw_data = raw_data
-    @raw_data = Tmdb.api_call('Movie.getInfo', @raw_data["id"]).first
-    @raw_data.each_pair do |key, value|
-      instance_eval <<-EOD
-        def #{key}
-          @raw_data["#{key}"]
-        end
-      EOD
-      if(value.is_a?(Array))
-        value.each_index do |x|
-          if(value[x].is_a?(Hash) && value[x].length == 1)
-            if(value[x].keys[0] == "image")
-              value[x][value[x].keys[0]].instance_eval <<-EOD
-                def self.data
-                  Tmdb.get_url(self["url"]).body
-                end
-              EOD
-            end
-            value[x] = value[x][value[x].keys[0]]
-          end
-          if(value[x].is_a?(Hash))
-            value[x].each_pair do |key2, value2|
-              value[x].instance_eval <<-EOD
-                def self.#{key2}
-                  self["#{key2}"]
-                end
-              EOD
-              if(key == "cast")
-                value[x].instance_eval <<-EOD
-                  def self.bio
-                    TmdbCast.find(:id => #{value[x]["id"]}, :limit => 1)
-                  end
-                EOD
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-  
-  def raw_data
-    @raw_data
+  def self.new(raw_data, expand_results = false)
+    raw_data = Tmdb.api_call('Movie.getInfo', raw_data["id"]).first if(expand_results)
+    return Tmdb.data_to_object(raw_data)
   end
   
   def ==(other)

data/ruby-tmdb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-tmdb}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Gough"]
-  s.date = %q{2010-07-21}
+  s.date = %q{2010-08-19}
   s.description = %q{An ActiveRecord-style API wrapper for TheMovieDB.org}
   s.email = %q{aaron@aarongough.com}
   s.extra_rdoc_files = [
@@ -17,8 +17,7 @@ Gem::Specification.new do |s|
      "README.rdoc"
   ]
   s.files = [
-    ".gitignore",
-     "MIT-LICENSE",
+    "MIT-LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",
@@ -37,11 +36,9 @@ 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"
@@ -52,11 +49,9 @@ 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/setup_api_key.rb",
-     "test/setup/test_unit_extensions.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"
@@ -67,11 +62,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<deepopenstruct>, [">= 0"])
       s.add_development_dependency(%q<webmock>, [">= 0"])
     else
+      s.add_dependency(%q<deepopenstruct>, [">= 0"])
       s.add_dependency(%q<webmock>, [">= 0"])
     end
   else
+    s.add_dependency(%q<deepopenstruct>, [">= 0"])
     s.add_dependency(%q<webmock>, [">= 0"])
   end
 end

data/test/test_helper.rb

@@ -2,6 +2,8 @@ TEST_LIVE_API = false
 
 require 'rubygems'
 require 'test/unit'
+require 'yaml'
+require 'net/http'
 
 unless(TEST_LIVE_API)
   require 'webmock/test_unit'
@@ -16,5 +18,6 @@ require_files.each do |file|
   require File.expand_path(file)
 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')))
+File.open(File.join(File.dirname(__FILE__), 'setup', 'tmdb_api_key.txt')) do |file|
+  Tmdb.api_key = file.read
+end

data/test/unit/tmdb_cast_test.rb

@@ -6,6 +6,13 @@ class TmdbCastTest < Test::Unit::TestCase
     register_api_url_stubs
   end
   
+  test "cast data should be able to be dumped and re-loaded" do
+    assert_nothing_raised do
+      cast = TmdbCast.find(:id => 287)
+      TmdbCast.new(cast.raw_data)
+    end
+  end
+  
   test "find by id should return full cast data" do
     cast = TmdbCast.find(:id => 287)
     assert_cast_methodized(cast, 287)
@@ -17,8 +24,8 @@ class TmdbCastTest < Test::Unit::TestCase
     assert_equal cast1, cast2
   end
   
-  test "find by name should return full cast data" do
-    cast = TmdbCast.find(:name => "Brad Pitt").first
+  test "find by name should return full cast data when :expand_results = true" do
+    cast = TmdbCast.find(:name => "Brad Pitt", :expand_results => true).first
     assert_cast_methodized(cast, 287)
   end
 
@@ -29,14 +36,14 @@ class TmdbCastTest < Test::Unit::TestCase
   end
 
   test "find by id should return a single cast member" do
-    assert_kind_of TmdbCast, TmdbCast.find(:id => 287)
+    assert_kind_of OpenStruct, TmdbCast.find(:id => 287)
   end
   
   test "find by name should return an array of cast members" do
     cast_members = TmdbCast.find(:name => "vince")
     assert_kind_of Array, cast_members
     cast_members.each do |actor|
-      assert_kind_of TmdbCast, actor
+      assert_kind_of OpenStruct, actor
     end
   end
   
@@ -58,7 +65,7 @@ class TmdbCastTest < Test::Unit::TestCase
   
   test "should only return a single item if limit=1" do
     actor = TmdbCast.find(:name => "Vince", :limit => 1)
-    assert_kind_of TmdbCast, actor
+    assert_kind_of OpenStruct, actor
   end
   
   test "should return X items if limit=X" do
@@ -67,7 +74,7 @@ class TmdbCastTest < Test::Unit::TestCase
       assert_kind_of Array, actors
       assert_equal x, actors.length
       actors.each do |actor|
-        assert_kind_of TmdbCast, actor
+        assert_kind_of OpenStruct, actor
       end
     end
   end

data/test/unit/tmdb_movie_test.rb

@@ -6,6 +6,13 @@ class TmdbMovieTest < Test::Unit::TestCase
     register_api_url_stubs
   end
   
+  test "movie should be able to be dumped and re-loaded" do
+    assert_nothing_raised do
+      movie = TmdbMovie.find(:id => 187)
+      TmdbMovie.new(movie.raw_data)
+    end
+  end
+  
   test "find by id should return the full movie data" do
     movie = TmdbMovie.find(:id => 187)
     assert_movie_methodized(movie, 187)
@@ -22,8 +29,8 @@ class TmdbMovieTest < Test::Unit::TestCase
     assert_movie_methodized(movie, 187)
   end
   
-  test "find by title should return the full movie data" do
-    movie = TmdbMovie.find(:title => "Sin City", :limit => 1)
+  test "find by title should return the full movie data when expand_results set to true" do
+    movie = TmdbMovie.find(:title => "Transformers: Revenge of the Fallen", :limit => 1, :expand_results => true)
     assert_movie_methodized(movie, 187)
   end
   
@@ -34,23 +41,23 @@ class TmdbMovieTest < Test::Unit::TestCase
   end
 
   test "find by id should return a single movie" do
-    assert_kind_of TmdbMovie, TmdbMovie.find(:id => 187)
+    assert_kind_of OpenStruct, TmdbMovie.find(:id => 187)
   end
   
   test "find by imdb should return a single movie" do
-    assert_kind_of TmdbMovie, TmdbMovie.find(:imdb => "tt0401792")
+    assert_kind_of OpenStruct, TmdbMovie.find(:imdb => "tt0401792")
   end
   
   test "find by title should return an array of movies" do
     movies = TmdbMovie.find(:title => "Iron Man")
     assert_kind_of Array, movies
     movies.each do |movie|
-      assert_kind_of TmdbMovie, movie
+      assert_kind_of OpenStruct, movie
     end
   end
     
   test "find by title with limit=1 should return a single movie" do
-    assert_kind_of TmdbMovie, TmdbMovie.find(:title => "Iron Man", :limit => 1)
+    assert_kind_of OpenStruct, TmdbMovie.find(:title => "Iron Man", :limit => 1)
   end
   
   test "find by title with limit=X should return an array of X movies" do
@@ -59,7 +66,7 @@ class TmdbMovieTest < Test::Unit::TestCase
       assert_kind_of Array, movies
       assert_equal x, movies.length
       movies.each do |movie|
-        assert_kind_of TmdbMovie, movie
+        assert_kind_of OpenStruct, movie
       end
     end
   end

data/test/unit/tmdb_test.rb

@@ -28,15 +28,6 @@ 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
@@ -116,5 +107,43 @@ class TmdbTest < Test::Unit::TestCase
     person = Tmdb.api_call('Person.getInfo', 287)[0]
     assert_not_nil person[person.keys[0]]
   end
+  
+  test "data_to_object should create object from nested data structures" do
+    test_data = {
+      :test1 => [
+        1,2,3,4
+      ],
+      :test2 => 1
+    }
+    test_object = Tmdb.data_to_object(test_data)
+    assert_nothing_raised do
+      assert_equal [1,2,3,4], test_object.test1
+      assert_equal 1, test_object.test2
+    end
+  end
+  
+  test "data_to_object should include raw_data method that returns original data" do
+    test_data = {
+      :test1 => [1,2,3]
+    }
+    test_object = Tmdb.data_to_object(test_data)
+    assert_equal test_object.raw_data, test_data
+  end
+  
+  test "data_to_object should convert arrays containing images to nicer format" do
+    test_data = {
+      "backdrops" => [
+        {
+          "image" => {
+            :test => 1
+          }
+        }
+      ]
+    }
+    test_object = Tmdb.data_to_object(test_data)
+    assert_nothing_raised do
+      assert_equal 1, test_object.backdrops[0].test
+    end
+  end
 
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Aaron Gough
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-21 00:00:00 -04:00
+date: 2010-08-19 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: webmock
+  name: deepopenstruct
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -28,8 +28,21 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
 description: An ActiveRecord-style API wrapper for TheMovieDB.org
 email: aaron@aarongough.com
 executables: []
@@ -40,7 +53,6 @@ extra_rdoc_files:
 - MIT-LICENSE
 - README.rdoc
 files: 
-- .gitignore
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
@@ -60,11 +72,9 @@ 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
@@ -103,11 +113,9 @@ 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

data/.gitignore

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

data/test/setup/setup_api_key.rb

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

data/test/unit/test_direct_require.rb

@@ -1,25 +0,0 @@
-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