royw-tmdb 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 Roy Wright
+
+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,9 @@
+= tmdb
+
+A helper library for accessing themovieDb.com.
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Roy Wright. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tmdb"
+    gem.summary = %Q{TODO}
+    gem.email = "roy@wright.org"
+    gem.homepage = "http://github.com/royw/tmdb"
+    gem.authors = ["Roy Wright"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tmdb #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 0
+:minor: 0

data/lib/file_extensions.rb

@@ -0,0 +1,14 @@
+# == Synopsis
+# add a mkdirs method to the File class
+class File
+  ##
+  # make directories including any missing in the path
+  #
+  # @param [String] dirspec the path to make sure exists
+  def File.mkdirs(dirspec)
+    unless File.exists?(dirspec)
+      mkdirs(File.dirname(dirspec))
+      Dir.mkdir(dirspec)
+    end
+  end
+end

data/lib/object_extensions.rb

@@ -0,0 +1,19 @@
+# == Synopsis
+# add a blank? method to all Objects
+class Object
+  # return asserted if object is nil or empty
+  # TODO: not the safest coding, probably should dup before stripping.  Maybe should also compact
+  def blank?
+    result = nil?
+    unless result
+      if respond_to? 'empty?'
+        if respond_to? 'strip'
+          result = strip.empty?
+        else
+          result = empty?
+        end
+      end
+    end
+    result
+  end
+end

data/lib/string_extensions.rb

@@ -0,0 +1,16 @@
+require 'cgi'
+require 'iconv'
+
+module ImdbStringExtensions
+  
+  def unescape_html
+    Iconv.conv("UTF-8", 'ISO-8859-1', CGI::unescapeHTML(self))
+  end
+  
+  def strip_tags
+    gsub(/<\/?[^>]*>/, "")
+  end
+  
+end
+
+String.send :include, ImdbStringExtensions

data/lib/tmdb.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'open-uri'
+require 'date'
+require 'xmlsimple'
+
+require File.dirname(__FILE__) + '/tmdb/optional_logger'
+require File.dirname(__FILE__) + '/tmdb/tmdb_movie'
+require File.dirname(__FILE__) + '/tmdb/tmdb_profile'
+require File.dirname(__FILE__) + '/string_extensions'
+require File.dirname(__FILE__) + '/file_extensions'
+require File.dirname(__FILE__) + '/object_extensions'

data/lib/tmdb/optional_logger.rb

@@ -0,0 +1,31 @@
+# An optional logger.
+# If initialized with a logger instance, uses the logger
+# otherwise doesn't do anything.
+# Basically trying to not require a particular logger class.
+class OptionalLogger
+  # logger may be nil or a logger instance
+  def initialize(logger)
+    @logger = logger
+  end
+
+  # debug {...}
+  def debug(&blk)
+    @logger.debug(blk.call) unless @logger.nil?
+  end
+
+  # info {...}
+  def info(&blk)
+    @logger.info(blk.call) unless @logger.nil?
+  end
+
+  # warn {...}
+  def warn(&blk)
+    @logger.warn(blk.call) unless @logger.nil?
+  end
+
+  # error {...}
+  def error(&blk)
+    @logger.error(blk.call) unless @logger.nil?
+  end
+end
+

data/lib/tmdb/tmdb_movie.rb

@@ -0,0 +1,136 @@
+class TmdbMovie
+
+  attr_reader :query, :document
+
+  API_KEY = '7a2f6eb9b6aa01651000f0a9324db835'
+
+  def initialize(ident)
+    @imdb_id = 'tt' + ident.gsub(/^tt/, '') unless ident.blank?
+    @query = "http://api.themoviedb.org/2.0/Movie.imdbLookup?imdb_id=#{@imdb_id}&api_key=#{API_KEY}"
+  end
+
+  def fanarts
+    result = []
+    begin
+      document['moviematches'].each do |moviematches|
+        moviematches['movie'].each do |movie|
+          backdrop = movie['backdrop']
+          unless backdrop.blank?
+            result += backdrop
+          end
+        end
+      end
+    rescue
+    end
+    result
+  end
+
+  def posters
+    result = []
+    begin
+      document['moviematches'].each do |moviematches|
+        moviematches['movie'].each do |movie|
+          result += movie['poster']
+        end
+      end
+    rescue
+    end
+    result
+  end
+
+  def idents
+    document['moviematches'].first['movie'].first['id']  rescue nil
+  end
+
+  def urls
+    document['moviematches'].first['movie'].first['url']  rescue nil
+  end
+
+  def imdb_ids
+    document['moviematches'].first['movie'].first['imdb']  rescue nil
+  end
+
+  def titles
+    document['moviematches'].first['movie'].first['title']  rescue nil
+  end
+
+  def short_overviews
+    document['moviematches'].first['movie'].first['short_overview']  rescue nil
+  end
+
+  def types
+    document['moviematches'].first['movie'].first['type']  rescue nil
+  end
+
+  def alternative_titles
+    document['moviematches'].first['movie'].first['alternative_title']  rescue nil
+  end
+
+  def releases
+    document['moviematches'].first['movie'].first['release']  rescue nil
+  end
+
+  def scores
+    document['moviematches'].first['movie'].first['score']  rescue nil
+  end
+
+  def to_hash
+    hash = {}
+    [:fanarts, :posters, :idents, :urls, :imdb_ids, :titles, :short_overviews,
+     :types, :alternative_titles, :releases, :scores
+    ].each do |sym|
+      begin
+        value = send(sym.to_s)
+        hash[sym.to_s] = value unless value.nil?
+      rescue Exception => e
+        puts "Error getting data for hash for #{sym} - #{e.to_s}"
+      end
+    end
+    hash
+  end
+
+  def to_xml
+    XmlSimple.xml_out(document, 'NoAttr' => true, 'RootName' => 'movie')
+  end
+
+  def to_yaml
+    YAML.dump(document)
+  end
+
+  private
+
+    # Fetch the document with retry to handle the occasional glitches
+  def document
+    if @document.nil?
+      html = fetch(self.query)
+      @document = XmlSimple.xml_in(html)
+      @document = nil if @document['totalResults'] == ['0']
+    end
+    @document
+  end
+
+  MAX_ATTEMPTS = 3
+  SECONDS_BETWEEN_RETRIES = 1.0
+
+  def fetch(page)
+    doc = nil
+    attempts = 0
+    begin
+      doc = read_page(page)
+    rescue Exception => e
+      attempts += 1
+      if attempts > MAX_ATTEMPTS
+        raise
+      else
+        sleep SECONDS_BETWEEN_RETRIES
+        retry
+      end
+    end
+    doc
+  end
+
+  def read_page(page)
+    open(page).read
+  end
+
+end

data/lib/tmdb/tmdb_profile.rb

@@ -0,0 +1,112 @@
+# This is the model for the themovieDb profile which is used
+# to find TmdbMovie meta data from either online or from
+# a cached file.
+#
+# Usage:
+#
+# profile = TmdbProfile.first(:imdb_id => 'tt0123456')
+#
+# puts profile.movie['key'].first
+# puts profile.to_xml
+# puts profile.imdb_id
+#
+class TmdbProfile
+
+  # options:
+  #  :imdb_id  => String (either with or without leading 'tt')
+  #  :filespec => nil or a valid pathspec
+  #  :logger   => nil or a logger instance
+  def self.all(options={})
+    result = []
+    if has_option?(options, :imdb_id) || (has_option?(options, :filespec) && File.exist?(options[:filespec]))
+      result << TmdbProfile.new(options[:imdb_id], options[:filespec], options[:logger])
+    end
+    result
+  end
+
+  # see TmdbProfile.all for description of options
+  def self.first(options={})
+    self.all(options).first
+  end
+
+  protected
+
+  def self.has_option?(options, key)
+    options.has_key?(key) && !options[key].blank?
+  end
+
+  def initialize(ident, filespec, logger)
+    @imdb_id = ident
+    @filespec = filespec
+    @logger = OptionalLogger.new(logger)
+    load
+  end
+
+
+  public
+
+  attr_reader :imdb_id, :movie
+
+  def to_xml
+    xml = ''
+    unless @movie.blank?
+      @movie.delete_if { |key, value| value.nil? }
+      xml = XmlSimple.xml_out(@movie, 'NoAttr' => true, 'RootName' => 'movie')
+    end
+    xml
+  end
+
+  protected
+
+  def load
+    @movie = nil
+    if !@filespec.blank? && File.exist?(@filespec)
+      @logger.debug { "loading movie filespec=> #{@filespec.inspect}" }
+      @movie = from_xml(open(@filespec).read)
+    elsif !@imdb_id.blank?
+      @logger.debug { "loading movie from tmdb.com, filespec=> #{@filespec.inspect}" }
+      @movie = TmdbMovie.new(@imdb_id.gsub(/^tt/, '')).to_hash
+      save(@filespec) unless @filespec.blank?
+    end
+    unless @movie.blank?
+      @imdb_id = @movie['imdb_ids']
+      @imdb_id = @imdb_id.first if @imdb_id.respond_to?('[]') && @imdb_id.length == 1
+    else
+      @movie = nil
+    end
+  end
+
+  def from_xml(xml)
+    begin
+      movie = XmlSimple.xml_in(xml)
+    rescue Exception => e
+      @logger.warn { "Error converting from xml: #{e.to_s}" }
+      movie = nil
+    end
+    movie
+  end
+
+  def save(filespec)
+    begin
+      xml = self.to_xml
+      unless xml.blank?
+        @logger.debug { "saving #{filespec}" }
+        save_to_file(filespec, xml)
+      end
+    rescue Exception => e
+      @logger.error { "Unable to save tmdb profile to #{filespec} - #{e.to_s}" }
+    end
+  end
+
+  def save_to_file(filespec, data)
+    new_filespec = filespec + '.new'
+    File.open(new_filespec, "w") do |file|
+      file.puts(data)
+    end
+    backup_filespec = filespec + '~'
+    File.delete(backup_filespec) if File.exist?(backup_filespec)
+    File.rename(filespec, backup_filespec) if File.exist?(filespec)
+    File.rename(new_filespec, filespec)
+    File.delete(new_filespec) if File.exist?(new_filespec)
+  end
+end

data/spec/cache_extensions.rb

@@ -0,0 +1,91 @@
+# NOTE extremely ugly and non-DRY.  Probably good candidate for meta programming.
+
+# override the classes' read_page method and replace with one
+# that will cache pages in spec/samples/{url}
+
+class ImdbMovie
+  private
+  def read_page(page)
+    html = nil
+    filespec = page.gsub(/^http:\//, 'spec/samples').gsub(/\/$/, '.html')
+    if File.exist?(filespec)
+      html = open(filespec).read
+    else
+      html = open(page).read
+      cache_html_files(page, html)
+    end
+    html
+  end
+
+  # this is used to save imdb pages so they may be used by rspec
+  def cache_html_files(page, html)
+    begin
+      filespec = page.gsub(/^http:\//, 'spec/samples').gsub(/\/$/, '.html')
+      unless File.exist?(filespec)
+        puts "caching #{filespec}"
+        File.mkdirs(File.dirname(filespec))
+        File.open(filespec, 'w') { |f| f.puts html }
+      end
+    rescue Exception => eMsg
+      puts eMsg.to_s
+    end
+  end
+end
+
+class ImdbSearch
+  private
+  def read_page(page)
+    html = nil
+    filespec = page.gsub(/^http:\//, 'spec/samples').gsub(/\/$/, '.html')
+    if File.exist?(filespec)
+      html = open(filespec).read
+    else
+      html = open(page).read
+      cache_html_files(page, html)
+    end
+    html
+  end
+
+  # this is used to save imdb pages so they may be used by rspec
+  def cache_html_files(page, html)
+    begin
+      filespec = page.gsub(/^http:\//, 'spec/samples').gsub(/\/$/, '.html')
+      unless File.exist?(filespec)
+        puts "caching #{filespec}"
+        File.mkdirs(File.dirname(filespec))
+        File.open(filespec, 'w') { |f| f.puts html }
+      end
+    rescue Exception => eMsg
+      puts eMsg.to_s
+    end
+  end
+end
+
+class ImdbImage
+  private
+  def read_page(page)
+    html = nil
+    filespec = page.gsub(/^http:\//, 'spec/samples').gsub(/\/$/, '.html')
+    if File.exist?(filespec)
+      html = open(filespec).read
+    else
+      html = open(page).read
+      cache_html_files(page, html)
+    end
+    html
+  end
+
+  # this is used to save imdb pages so they may be used by rspec
+  def cache_html_files(page, html)
+    begin
+      filespec = page.gsub(/^http:\//, 'spec/samples').gsub(/\/$/, '.html')
+      unless File.exist?(filespec)
+        puts "caching #{filespec}"
+        File.mkdirs(File.dirname(filespec))
+        File.open(filespec, 'w') { |f| f.puts html }
+      end
+    rescue Exception => eMsg
+      puts eMsg.to_s
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'tmdb'
+
+require 'cache_extensions'
+
+$samples_dir = File.dirname(__FILE__) + '/samples'
+
+TMPDIR = File.join(File.dirname(__FILE__), '../tmp')
+
+Spec::Runner.configure do |config|
+
+end
+

data/spec/tmdb_movie_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+# Time to add your specs!
+# http://rspec.info/
+
+describe "TmdbMovie" do
+
+  before(:all) do
+    File.mkdirs(TMPDIR)
+  end
+
+  before(:each) do
+    @profile = TmdbMovie.new('tt0465234')
+  end
+
+  after(:each) do
+    Dir.glob(File.join(TMPDIR,'tmdb_movie_spec*')).each { |filename| File.delete(filename) }
+  end
+
+  it "should find by imdb_id" do
+    @profile.should_not == nil
+  end
+
+  it "should find tmdb id" do
+    @profile.idents.first.should == '6637'
+  end
+
+  it "should find fanarts" do
+    @profile.fanarts.size.should == 3
+  end
+
+  it "should find posters" do
+    @profile.posters.size.should == 4
+  end
+
+  it "should find the tmdb url" do
+    @profile.urls.first.should == 'http://www.themoviedb.org/movie/6637'
+  end
+
+  it "should find the imdb_id" do
+    @profile.imdb_ids.first.should == 'tt0465234'
+  end
+
+  it "should find the title" do
+    @profile.titles.first.should == 'National Treasure: Book of Secrets'
+  end
+
+  it "should find the short_overview" do
+    @profile.short_overviews.first.should =~ /Benjamin Franklin Gates/
+  end
+
+  it "should find the type" do
+    @profile.types.first.should == 'movie'
+  end
+
+  it "should find the alternative_titles" do
+    @profile.alternative_titles.first.should == 'National Treasure 2'
+  end
+
+  it "should find the release" do
+    @profile.releases.first.should == '2007-12-13'
+  end
+
+  it "should find the  score" do
+    @profile.scores.first.should == '1.0'
+  end
+
+  it "should handle The Sand Pebble" do
+    profile = TmdbMovie.new('tt0060934')
+    profile.idents.should be_nil
+  end
+
+end
+

data/spec/tmdb_profile_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+require 'tempfile'
+
+# Time to add your specs!
+# http://rspec.info/
+
+describe "TmdbProfile" do
+
+  before(:all) do
+    File.mkdirs(TMPDIR)
+  end
+
+  before(:each) do
+    # tt0465234 => National Treasure: Book of Secrets
+    @profile = TmdbProfile.first(:imdb_id => 'tt0465234')
+  end
+
+  after(:each) do
+    Dir.glob(File.join(TMPDIR,'tmdb_profile_spec*')).each { |filename| File.delete(filename) }
+  end
+
+  it "should find by imdb_id" do
+    @profile.should_not == nil
+  end
+
+  it "should save the profile to a file" do
+    filespec = get_temp_filename
+    profile = TmdbProfile.first(:imdb_id => 'tt0465234', :filespec => filespec)
+    (File.exist?(filespec).should be_true) && (File.size(filespec).should > 0)
+  end
+
+  it "should be able to convert to xml" do
+    xml = @profile.to_xml
+    (xml.should_not be_nil) && (xml.length.should > 0)
+  end
+
+  it "should be able to convert to xml and then from xml" do
+    hash = nil
+    begin
+      xml = @profile.to_xml
+      hash = XmlSimple.xml_in(xml)
+    rescue
+      hash = nil
+    end
+    hash.should_not be_nil
+  end
+
+  it "should find tmdb id" do
+    @profile.movie['idents'].first.should == '6637'
+  end
+
+  it "should find fanarts" do
+    @profile.movie['fanarts'].size.should == 3
+  end
+
+  it "should find posters" do
+    @profile.movie['posters'].size.should == 4
+  end
+
+  it "should find the tmdb url" do
+    @profile.movie['urls'].first.should == 'http://www.themoviedb.org/movie/6637'
+  end
+
+  it "should find the imdb_id" do
+    @profile.movie['imdb_ids'].first.should == 'tt0465234'
+  end
+
+  it "should find the title" do
+    @profile.movie['titles'].first.should == 'National Treasure: Book of Secrets'
+  end
+
+  it "should find the short_overview" do
+    @profile.movie['short_overviews'].first.should =~ /Benjamin Franklin Gates/
+  end
+
+  it "should find the type" do
+    @profile.movie['types'].first.should == 'movie'
+  end
+
+  it "should find the alternative_titles" do
+    @profile.movie['alternative_titles'].first.should == 'National Treasure 2'
+  end
+
+  it "should find the release" do
+    @profile.movie['releases'].first.should == '2007-12-13'
+  end
+
+  it "should find the  score" do
+    @profile.movie['scores'].first.should == '1.0'
+  end
+
+    # let's make sure the generated xml from to_xml() is valid
+
+  it "should be able to convert to xml and then from xml" do
+    hash = nil
+    begin
+      profile = TmdbProfile.first(:imdb_id => 'tt0465234')
+      xml = profile.to_xml
+      hash = XmlSimple.xml_in(xml)
+    rescue
+      hash = nil
+    end
+    hash.should_not be_nil
+  end
+
+  # now let's test caching the profile to/from a file
+
+  it "should not create a file if a :filespec option is passed that is nil" do
+    profile = TmdbProfile.first(:imdb_id => 'tt0465234', :filespec => nil)
+    Dir.glob(File.join(TMPDIR, "imdb_profile_spec*")).empty?.should be_true
+  end
+
+  it "should create a file if a :filespec option is passed" do
+    filespec = get_temp_filename
+    profile = TmdbProfile.first(:imdb_id => 'tt0465234', :filespec => filespec)
+    (File.exist?(filespec) && (File.size(filespec) > 0)).should be_true
+  end
+
+  it "should load from a file if a :filespec option is passed and the file exists" do
+    filespec = get_temp_filename
+    profile1 = TmdbProfile.first(:imdb_id => 'tt0465234', :filespec => filespec)
+    profile2 = TmdbProfile.first(:filespec => filespec)
+    profile1.imdb_id.should == profile2.imdb_id
+  end
+
+  it "should not load from a file if a :filespec option is passed and the file does not exists" do
+    filespec = get_temp_filename
+    profile = TmdbProfile.first(:filespec => filespec)
+    profile.should be_nil
+  end
+
+  def get_temp_filename
+    outfile = Tempfile.new('tmdb_profile_spec', TMPDIR)
+    filespec = outfile.path
+    outfile.unlink
+    filespec
+  end
+
+end
+

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: royw-tmdb
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Roy Wright
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-15 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: roy@wright.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/file_extensions.rb
+- lib/object_extensions.rb
+- lib/string_extensions.rb
+- lib/tmdb.rb
+- lib/tmdb/optional_logger.rb
+- lib/tmdb/tmdb_movie.rb
+- lib/tmdb/tmdb_profile.rb
+- spec/cache_extensions.rb
+- spec/spec_helper.rb
+- spec/tmdb_movie_spec.rb
+- spec/tmdb_profile_spec.rb
+has_rdoc: true
+homepage: http://github.com/royw/tmdb
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- spec/cache_extensions.rb
+- spec/tmdb_profile_spec.rb
+- spec/spec_helper.rb
+- spec/tmdb_movie_spec.rb