ruby-tmdb 0.0.19

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Aaron Gough (http://thingsaaronmade.com/)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,58 @@
+== 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.
+
+=== Installation
+
+  gem install ruby-tmdb
+  
+=== Usage
+
+  require 'rubygems'
+  require 'ruby-tmdb'
+  
+  # setup your API key
+  Tmdb.api_key = "t478f8de5776c799de5a"
+  
+  @movie = TmdbMovie.find(:title => "Iron Man", :limit => 1)
+  # => <TmdbMovie>
+  
+  @movie.name
+  # => "Iron Man"
+  
+  @movie.posters.length
+  # => 12
+  
+  @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>
+  
+  @actor.birthplace
+  # => "Shawnee, Oklahoma, United States"
+
+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
+
+  @movie = TmdbMovie.find(:title => 'Sin City', :limit => 1)
+  
+Find a single movie by it's TMDb ID
+
+  @movie = TmdbMovie.find(:id => 187)
+  
+Find a single movie by it's IMDB ID
+
+  @movie = TmdbMovie.find(:imdb => 'tt0401792')
+  
+=== Author & Credits
+
+Author:: {Aaron Gough}[mailto:aaron@aarongough.com]
+
+Copyright (c) 2010 {Aaron Gough}[http://thingsaaronmade.com/] ({thingsaaronmade.com}[http://thingsaaronmade.com/]), released under the MIT license

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ruby-tmdb"
+    gemspec.summary = "An ActiveRecord-style API wrapper for TheMovieDB.org"
+    gemspec.description = "An ActiveRecord-style API wrapper for TheMovieDB.org"
+    gemspec.email = "aaron@aarongough.com"
+    gemspec.homepage = "https://github.com/aarongough/ruby-tmdb"
+    gemspec.authors = ["Aaron Gough"]
+    gemspec.rdoc_options << '--line-numbers' << '--inline-source'
+    gemspec.extra_rdoc_files = ['README.rdoc', 'MIT-LICENSE']
+    gemspec.add_development_dependency "webmock"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+
+desc 'Test ruby-tmdb.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib/*.rb'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+
+desc 'Generate documentation for ruby-tmdb.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ruby-tmdb'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('app/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.19

data/lib/ruby-tmdb/tmdb.rb

@@ -0,0 +1,50 @@
+class Tmdb
+  
+  require 'net/http'
+  require 'uri'
+  require 'cgi'
+  
+  @@api_key = ""
+  @@api_response = {}
+  
+  def self.api_key
+    @@api_key
+  end
+  
+  def self.api_key=(key)
+    @@api_key = key
+  end
+  
+  def self.base_api_url
+    "http://api.themoviedb.org/2.1/"
+  end
+  
+  def self.api_call(method, data, language = "en")
+    url = Tmdb.base_api_url + method + '/' + language + '/yaml/' + Tmdb.api_key + '/' + CGI::escape(data.to_s)
+    response = @@api_response[url] ||= begin
+      Tmdb.get_url(url)
+    end
+    if(response.code.to_i != 200)
+      return []
+    end
+    YAML::load(response.body)
+  end
+
+  # Get a URL and return a response object, follow upto 'limit' re-directs on the way
+  def self.get_url(uri_str, limit = 10)
+    return false if limit == 0
+    begin 
+      response = Net::HTTP.get_response(URI.parse(uri_str))
+    rescue SocketError, Errno::ENETDOWN
+      response = Net::HTTPBadRequest.new( '404', 404, "Not Found" )
+      return response
+    end 
+    case response
+      when Net::HTTPSuccess     then response
+      when Net::HTTPRedirection then get_url(response['location'], limit - 1)
+    else
+      Net::HTTPBadRequest.new( '404', 404, "Not Found" )
+    end
+  end
+  
+end

data/lib/ruby-tmdb/tmdb_cast.rb

@@ -0,0 +1,76 @@
+class TmdbCast
+
+  def self.find(options)
+    raise ArgumentError, "At least one of: id, name, should be supplied" if(options[:id].nil? && options[:name].nil?)
+    
+    results = []
+    unless(options[:id].nil? || options[:id].to_s.empty?)
+      results << Tmdb.api_call('Person.getInfo', options[:id])
+    end
+    unless(options[:name].nil? || options[:name].to_s.empty?)
+      results << Tmdb.api_call('Person.search', options[:name])
+    end
+    
+    results.flatten!
+    
+    unless(options[:limit].nil?)
+      raise ArgumentError, ":limit must be an integer greater than 0" unless(options[:limit].is_a?(Fixnum) && options[:limit] > 0)
+      results = results.slice(0, options[:limit])
+    end
+  
+    results.map!{|c| TmdbCast.new(c) }
+  
+    if(results.length == 1)
+      return results[0]
+    else
+      return results
+    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
+  end
+  
+  def ==(other)
+    return false unless(other.is_a?(TmdbCast))
+    @raw_data == other.raw_data
+  end
+  
+end

data/lib/ruby-tmdb/tmdb_movie.rb

@@ -0,0 +1,84 @@
+class TmdbMovie
+  
+  def self.find(options)
+    raise ArgumentError, "At least one of: id, title, imdb should be supplied" if(options[:id].nil? && options[:imdb].nil? && options[:title].nil?)
+    
+    results = []
+    unless(options[:id].nil? || options[:id].to_s.empty?)
+      results << Tmdb.api_call("Movie.getInfo", options[:id])
+    end
+    unless(options[:imdb].nil? || options[:imdb].to_s.empty?)
+      results << Tmdb.api_call("Movie.imdbLookup", options[:imdb])
+    end
+    unless(options[:title].nil? || options[:title].to_s.empty?)
+      results << Tmdb.api_call("Movie.search", options[:title])
+    end
+    
+    results.flatten!
+    
+    unless(options[:limit].nil?)
+      raise ArgumentError, ":limit must be an integer greater than 0" unless(options[:limit].is_a?(Fixnum) && options[:limit] > 0)
+      results = results.slice(0, options[:limit])
+    end
+    
+    results.map!{|m| TmdbMovie.new(m) }
+    
+    if(results.length == 1)
+      return results[0]
+    else
+      return results
+    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
+  end
+  
+  def ==(other)
+    return false unless(other.is_a?(TmdbMovie))
+    return @raw_data == other.raw_data
+  end
+    
+end

data/lib/ruby-tmdb.rb

@@ -0,0 +1,6 @@
+require_files = []
+require_files.concat Dir[File.join(File.dirname(__FILE__), 'ruby-tmdb', '*.rb')]
+
+require_files.each do |file|
+  require File.expand_path(file)
+end

data/ruby-tmdb.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby-tmdb}
+  s.version = "0.0.19"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Gough"]
+  s.date = %q{2010-05-26}
+  s.description = %q{An ActiveRecord-style API wrapper for TheMovieDB.org}
+  s.email = %q{aaron@aarongough.com}
+  s.extra_rdoc_files = [
+    "MIT-LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/ruby-tmdb.rb",
+     "lib/ruby-tmdb/tmdb.rb",
+     "lib/ruby-tmdb/tmdb_cast.rb",
+     "lib/ruby-tmdb/tmdb_movie.rb",
+     "ruby-tmdb.gemspec",
+     "test/fixtures/example_com.txt",
+     "test/fixtures/image.jpg",
+     "test/fixtures/incorrect_api_url.txt",
+     "test/fixtures/movie_get_info.txt",
+     "test/fixtures/movie_imdb_lookup.txt",
+     "test/fixtures/movie_search.txt",
+     "test/fixtures/person_get_info.txt",
+     "test/fixtures/person_search.txt",
+     "test/setup/.gitignore",
+     "test/setup/test_unit_extensions.rb",
+     "test/setup/url_mocks.rb",
+     "test/test_helper.rb",
+     "test/unit/tmdb_cast_test.rb",
+     "test/unit/tmdb_movie_test.rb",
+     "test/unit/tmdb_test.rb"
+  ]
+  s.homepage = %q{https://github.com/aarongough/ruby-tmdb}
+  s.rdoc_options = ["--charset=UTF-8", "--line-numbers", "--inline-source"]
+  s.require_paths = ["lib"]
+  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/url_mocks.rb",
+     "test/test_helper.rb",
+     "test/unit/tmdb_cast_test.rb",
+     "test/unit/tmdb_movie_test.rb",
+     "test/unit/tmdb_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+    else
+      s.add_dependency(%q<webmock>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<webmock>, [">= 0"])
+  end
+end
+

data/test/fixtures/example_com.txt

@@ -0,0 +1,25 @@
+HTTP/1.1 200 OK
+Server: Apache/2.2.3 (CentOS)
+Last-Modified: Tue, 15 Nov 2005 13:24:10 GMT
+ETag: "24ec5-1b6-4059a80bfd280"
+Accept-Ranges: bytes
+Content-Type: text/html; charset=UTF-8
+Connection: Keep-Alive
+Date: Sun, 16 May 2010 19:01:25 GMT
+Age: 6053   
+Content-Length: 438
+
+<HTML>
+<HEAD>
+  <TITLE>Example Web Page</TITLE>
+</HEAD> 
+<body>  
+<p>You have reached this web page by typing &quot;example.com&quot;,
+&quot;example.net&quot;,
+  or &quot;example.org&quot; into your web browser.</p>
+<p>These domain names are reserved for use in documentation and are not available 
+  for registration. See <a href="http://www.rfc-editor.org/rfc/rfc2606.txt">RFC 
+  2606</a>, Section 3.</p>
+</BODY>
+</HTML>
+

data/test/fixtures/incorrect_api_url.txt

@@ -0,0 +1,13 @@
+HTTP/1.1 404 Not Found
+Status: 404 Not Found
+Content-Type: text/html
+X-Cascade: pass
+Content-Length: 18
+Date: Sun, 16 May 2010 19:07:32 GMT
+X-Varnish: 4026308020 4014879260
+Age: 8217
+Via: 1.1 varnish
+Connection: keep-alive
+X-Cache: HIT
+
+<h1>Not Found</h1>